Theme Viewer + Theme Updater (#2952)
This commit is contained in:
Joe Milazzo
GitHub
parent
24302d4fcc
commit
38e7c1c131
35 changed files with 4563 additions and 284 deletions
|
|
@ -1,5 +1,10 @@
|
|||
using System;
|
||||
using System.IO;
|
||||
using System.IO.Abstractions;
|
||||
using System.Runtime.Intrinsics.Arm;
|
||||
using System.Security.Cryptography;
|
||||
using System.Text;
|
||||
using System.Text.Unicode;
|
||||
using API.Extensions;
|
||||
|
||||
namespace API.Services;
|
||||
|
|
@ -9,6 +14,7 @@ public interface IFileService
|
|||
IFileSystem GetFileSystem();
|
||||
bool HasFileBeenModifiedSince(string filePath, DateTime time);
|
||||
bool Exists(string filePath);
|
||||
bool ValidateSha(string filepath, string sha);
|
||||
}
|
||||
|
||||
public class FileService : IFileService
|
||||
|
|
@ -43,4 +49,28 @@ public class FileService : IFileService
|
|||
{
|
||||
return _fileSystem.File.Exists(filePath);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Validates the Sha256 hash matches
|
||||
/// </summary>
|
||||
/// <param name="filepath"></param>
|
||||
/// <param name="sha"></param>
|
||||
/// <returns></returns>
|
||||
public bool ValidateSha(string filepath, string sha)
|
||||
{
|
||||
if (!Exists(filepath)) return false;
|
||||
if (string.IsNullOrEmpty(sha)) throw new ArgumentException("Sha cannot be null");
|
||||
|
||||
using var fs = _fileSystem.File.OpenRead(filepath);
|
||||
fs.Position = 0;
|
||||
|
||||
using var reader = new StreamReader(fs, Encoding.UTF8, detectEncodingFromByteOrderMarks: true);
|
||||
var content = reader.ReadToEnd();
|
||||
|
||||
// Compute SHA hash
|
||||
var checksum = SHA256.HashData(Encoding.UTF8.GetBytes(content));
|
||||
|
||||
return BitConverter.ToString(checksum).Replace("-", string.Empty).Equals(sha);
|
||||
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -32,7 +32,6 @@ public interface ITaskScheduler
|
|||
void AnalyzeFilesForLibrary(int libraryId, bool forceUpdate = false);
|
||||
void CancelStatsTasks();
|
||||
Task RunStatCollection();
|
||||
void ScanSiteThemes();
|
||||
void CovertAllCoversToEncoding();
|
||||
Task CleanupDbEntries();
|
||||
Task CheckForUpdate();
|
||||
|
|
@ -64,6 +63,7 @@ public class TaskScheduler : ITaskScheduler
|
|||
public const string DefaultQueue = "default";
|
||||
public const string RemoveFromWantToReadTaskId = "remove-from-want-to-read";
|
||||
public const string UpdateYearlyStatsTaskId = "update-yearly-stats";
|
||||
public const string SyncThemesTaskId = "sync-themes";
|
||||
public const string CheckForUpdateId = "check-updates";
|
||||
public const string CleanupDbTaskId = "cleanup-db";
|
||||
public const string CleanupTaskId = "cleanup";
|
||||
|
|
@ -161,6 +161,9 @@ public class TaskScheduler : ITaskScheduler
|
|||
RecurringJob.AddOrUpdate(UpdateYearlyStatsTaskId, () => _statisticService.UpdateServerStatistics(),
|
||||
Cron.Monthly, RecurringJobOptions);
|
||||
|
||||
RecurringJob.AddOrUpdate(SyncThemesTaskId, () => _themeService.SyncThemes(),
|
||||
Cron.Weekly, RecurringJobOptions);
|
||||
|
||||
await ScheduleKavitaPlusTasks();
|
||||
}
|
||||
|
||||
|
|
@ -200,7 +203,7 @@ public class TaskScheduler : ITaskScheduler
|
|||
|
||||
public async Task ScheduleStatsTasks()
|
||||
{
|
||||
var allowStatCollection = (await _unitOfWork.SettingsRepository.GetSettingsDtoAsync()).AllowStatCollection;
|
||||
var allowStatCollection = (await _unitOfWork.SettingsRepository.GetSettingsDtoAsync()).AllowStatCollection;
|
||||
if (!allowStatCollection)
|
||||
{
|
||||
_logger.LogDebug("User has opted out of stat collection, not registering tasks");
|
||||
|
|
@ -241,18 +244,6 @@ public class TaskScheduler : ITaskScheduler
|
|||
BackgroundJob.Schedule(() => _statsService.Send(), DateTimeOffset.Now.AddDays(1));
|
||||
}
|
||||
|
||||
public void ScanSiteThemes()
|
||||
{
|
||||
if (HasAlreadyEnqueuedTask("ThemeService", "Scan", Array.Empty<object>(), ScanQueue))
|
||||
{
|
||||
_logger.LogInformation("A Theme Scan is already running");
|
||||
return;
|
||||
}
|
||||
|
||||
_logger.LogInformation("Enqueueing Site Theme scan");
|
||||
BackgroundJob.Enqueue(() => _themeService.Scan());
|
||||
}
|
||||
|
||||
public void CovertAllCoversToEncoding()
|
||||
{
|
||||
var defaultParams = Array.Empty<object>();
|
||||
|
|
|
|||
|
|
@ -1,35 +1,105 @@
|
|||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.IO;
|
||||
using System.Linq;
|
||||
using System.Threading.Tasks;
|
||||
using API.Data;
|
||||
using API.DTOs.Theme;
|
||||
using API.Entities;
|
||||
using API.Entities.Enums.Theme;
|
||||
using API.Extensions;
|
||||
using API.SignalR;
|
||||
using Flurl.Http;
|
||||
using HtmlAgilityPack;
|
||||
using Kavita.Common;
|
||||
using Microsoft.AspNetCore.Authorization;
|
||||
using Kavita.Common.EnvironmentInfo;
|
||||
using MarkdownDeep;
|
||||
using Microsoft.Extensions.Caching.Memory;
|
||||
using Microsoft.Extensions.Logging;
|
||||
using Newtonsoft.Json;
|
||||
|
||||
namespace API.Services.Tasks;
|
||||
#nullable enable
|
||||
|
||||
internal class GitHubContent
|
||||
{
|
||||
[JsonProperty("name")]
|
||||
public string Name { get; set; }
|
||||
|
||||
[JsonProperty("path")]
|
||||
public string Path { get; set; }
|
||||
|
||||
[JsonProperty("type")]
|
||||
public string Type { get; set; }
|
||||
|
||||
[JsonProperty("download_url")]
|
||||
public string DownloadUrl { get; set; }
|
||||
|
||||
[JsonProperty("sha")]
|
||||
public string Sha { get; set; }
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// The readme of the Theme repo
|
||||
/// </summary>
|
||||
internal class ThemeMetadata
|
||||
{
|
||||
public string Author { get; set; }
|
||||
public string AuthorUrl { get; set; }
|
||||
public string Description { get; set; }
|
||||
public Version LastCompatible { get; set; }
|
||||
}
|
||||
|
||||
|
||||
public interface IThemeService
|
||||
{
|
||||
Task<string> GetContent(int themeId);
|
||||
Task Scan();
|
||||
Task UpdateDefault(int themeId);
|
||||
/// <summary>
|
||||
/// Browse theme repo for themes to download
|
||||
/// </summary>
|
||||
/// <returns></returns>
|
||||
Task<List<DownloadableSiteThemeDto>> GetDownloadableThemes();
|
||||
|
||||
Task<SiteTheme> DownloadRepoTheme(DownloadableSiteThemeDto dto);
|
||||
Task DeleteTheme(int siteThemeId);
|
||||
Task<SiteTheme> CreateThemeFromFile(string tempFile, string username);
|
||||
Task SyncThemes();
|
||||
}
|
||||
|
||||
|
||||
|
||||
public class ThemeService : IThemeService
|
||||
{
|
||||
private readonly IDirectoryService _directoryService;
|
||||
private readonly IUnitOfWork _unitOfWork;
|
||||
private readonly IEventHub _eventHub;
|
||||
private readonly IFileService _fileService;
|
||||
private readonly ILogger<ThemeService> _logger;
|
||||
private readonly Markdown _markdown = new();
|
||||
private readonly IMemoryCache _cache;
|
||||
private readonly MemoryCacheEntryOptions _cacheOptions;
|
||||
|
||||
public ThemeService(IDirectoryService directoryService, IUnitOfWork unitOfWork, IEventHub eventHub)
|
||||
private const string GithubBaseUrl = "https://api.github.com";
|
||||
|
||||
/// <summary>
|
||||
/// Used for refreshing metadata around themes
|
||||
/// </summary>
|
||||
private const string GithubReadme = "https://raw.githubusercontent.com/Kareadita/Themes/main/README.md";
|
||||
|
||||
public ThemeService(IDirectoryService directoryService, IUnitOfWork unitOfWork,
|
||||
IEventHub eventHub, IFileService fileService, ILogger<ThemeService> logger, IMemoryCache cache)
|
||||
{
|
||||
_directoryService = directoryService;
|
||||
_unitOfWork = unitOfWork;
|
||||
_eventHub = eventHub;
|
||||
_fileService = fileService;
|
||||
_logger = logger;
|
||||
_cache = cache;
|
||||
|
||||
_cacheOptions = new MemoryCacheEntryOptions()
|
||||
.SetSize(1)
|
||||
.SetAbsoluteExpiration(TimeSpan.FromMinutes(30));
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
|
|
@ -39,8 +109,7 @@ public class ThemeService : IThemeService
|
|||
/// <returns></returns>
|
||||
public async Task<string> GetContent(int themeId)
|
||||
{
|
||||
var theme = await _unitOfWork.SiteThemeRepository.GetThemeDto(themeId);
|
||||
if (theme == null) throw new KavitaException("theme-doesnt-exist");
|
||||
var theme = await _unitOfWork.SiteThemeRepository.GetThemeDto(themeId) ?? throw new KavitaException("theme-doesnt-exist");
|
||||
var themeFile = _directoryService.FileSystem.Path.Join(_directoryService.SiteThemeDirectory, theme.FileName);
|
||||
if (string.IsNullOrEmpty(themeFile) || !_directoryService.FileSystem.File.Exists(themeFile))
|
||||
throw new KavitaException("theme-doesnt-exist");
|
||||
|
|
@ -48,78 +117,350 @@ public class ThemeService : IThemeService
|
|||
return await _directoryService.FileSystem.File.ReadAllTextAsync(themeFile);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Scans the site theme directory for custom css files and updates what the system has on store
|
||||
/// </summary>
|
||||
public async Task Scan()
|
||||
public async Task<List<DownloadableSiteThemeDto>> GetDownloadableThemes()
|
||||
{
|
||||
_directoryService.ExistOrCreate(_directoryService.SiteThemeDirectory);
|
||||
var reservedNames = Seed.DefaultThemes.Select(t => t.NormalizedName).ToList();
|
||||
var themeFiles = _directoryService
|
||||
.GetFilesWithExtension(Scanner.Parser.Parser.NormalizePath(_directoryService.SiteThemeDirectory), @"\.css")
|
||||
.Where(name => !reservedNames.Contains(name.ToNormalized()) && !name.Contains(" "))
|
||||
.ToList();
|
||||
|
||||
var allThemes = (await _unitOfWork.SiteThemeRepository.GetThemes()).ToList();
|
||||
|
||||
// First remove any files from allThemes that are User Defined and not on disk
|
||||
var userThemes = allThemes.Where(t => t.Provider == ThemeProvider.User).ToList();
|
||||
foreach (var userTheme in userThemes)
|
||||
const string cacheKey = "browse";
|
||||
var existingThemes = (await _unitOfWork.SiteThemeRepository.GetThemeDtos()).ToDictionary(k => k.Name);
|
||||
if (_cache.TryGetValue(cacheKey, out List<DownloadableSiteThemeDto>? themes) && themes != null)
|
||||
{
|
||||
var filepath = Scanner.Parser.Parser.NormalizePath(
|
||||
_directoryService.FileSystem.Path.Join(_directoryService.SiteThemeDirectory, userTheme.FileName));
|
||||
if (_directoryService.FileSystem.File.Exists(filepath)) continue;
|
||||
|
||||
// I need to do the removal different. I need to update all user preferences to use DefaultTheme
|
||||
allThemes.Remove(userTheme);
|
||||
await RemoveTheme(userTheme);
|
||||
}
|
||||
|
||||
// Add new custom themes
|
||||
var allThemeNames = allThemes.Select(t => t.NormalizedName).ToList();
|
||||
foreach (var themeFile in themeFiles)
|
||||
{
|
||||
var themeName =
|
||||
_directoryService.FileSystem.Path.GetFileNameWithoutExtension(themeFile).ToNormalized();
|
||||
if (allThemeNames.Contains(themeName)) continue;
|
||||
|
||||
_unitOfWork.SiteThemeRepository.Add(new SiteTheme()
|
||||
foreach (var t in themes)
|
||||
{
|
||||
Name = _directoryService.FileSystem.Path.GetFileNameWithoutExtension(themeFile),
|
||||
NormalizedName = themeName,
|
||||
FileName = _directoryService.FileSystem.Path.GetFileName(themeFile),
|
||||
Provider = ThemeProvider.User,
|
||||
IsDefault = false,
|
||||
});
|
||||
|
||||
await _eventHub.SendMessageAsync(MessageFactory.NotificationProgress,
|
||||
MessageFactory.SiteThemeProgressEvent(_directoryService.FileSystem.Path.GetFileName(themeFile), themeName,
|
||||
ProgressEventType.Updated));
|
||||
t.AlreadyDownloaded = existingThemes.ContainsKey(t.Name);
|
||||
}
|
||||
return themes;
|
||||
}
|
||||
|
||||
// Fetch contents of the Native Themes directory
|
||||
var themesContents = await GetDirectoryContent("Native%20Themes");
|
||||
|
||||
if (_unitOfWork.HasChanges())
|
||||
{
|
||||
await _unitOfWork.CommitAsync();
|
||||
}
|
||||
// Filter out directories
|
||||
var themeDirectories = themesContents.Where(c => c.Type == "dir").ToList();
|
||||
|
||||
// if there are no default themes, reselect Dark as default
|
||||
var postSaveThemes = (await _unitOfWork.SiteThemeRepository.GetThemes()).ToList();
|
||||
if (!postSaveThemes.Exists(t => t.IsDefault))
|
||||
// Get the Readme and augment the theme data
|
||||
var themeMetadata = await GetReadme();
|
||||
|
||||
var themeDtos = new List<DownloadableSiteThemeDto>();
|
||||
foreach (var themeDir in themeDirectories)
|
||||
{
|
||||
var defaultThemeName = Seed.DefaultThemes.Single(t => t.IsDefault).NormalizedName;
|
||||
var theme = postSaveThemes.SingleOrDefault(t => t.NormalizedName == defaultThemeName);
|
||||
if (theme != null)
|
||||
var themeName = themeDir.Name.Trim();
|
||||
|
||||
// Fetch contents of the theme directory
|
||||
var themeContents = await GetDirectoryContent(themeDir.Path);
|
||||
|
||||
// Find css and preview files
|
||||
var cssFile = themeContents.FirstOrDefault(c => c.Name.EndsWith(".css"));
|
||||
var previewUrls = GetPreviewUrls(themeContents);
|
||||
|
||||
if (cssFile == null) continue;
|
||||
|
||||
var cssUrl = cssFile.DownloadUrl;
|
||||
|
||||
|
||||
var dto = new DownloadableSiteThemeDto()
|
||||
{
|
||||
theme.IsDefault = true;
|
||||
_unitOfWork.SiteThemeRepository.Update(theme);
|
||||
await _unitOfWork.CommitAsync();
|
||||
Name = themeName,
|
||||
CssUrl = cssUrl,
|
||||
CssFile = cssFile.Name,
|
||||
PreviewUrls = previewUrls,
|
||||
Sha = cssFile.Sha,
|
||||
Path = themeDir.Path,
|
||||
};
|
||||
|
||||
if (themeMetadata.TryGetValue(themeName, out var metadata))
|
||||
{
|
||||
dto.Author = metadata.Author;
|
||||
dto.LastCompatibleVersion = metadata.LastCompatible.ToString();
|
||||
dto.IsCompatible = BuildInfo.Version <= metadata.LastCompatible;
|
||||
dto.AlreadyDownloaded = existingThemes.ContainsKey(themeName);
|
||||
dto.Description = metadata.Description;
|
||||
}
|
||||
|
||||
themeDtos.Add(dto);
|
||||
}
|
||||
|
||||
_cache.Set(themeDtos, themes, _cacheOptions);
|
||||
|
||||
return themeDtos;
|
||||
}
|
||||
|
||||
private static IList<string> GetPreviewUrls(IEnumerable<GitHubContent> themeContents)
|
||||
{
|
||||
return themeContents.Where(c => c.Name.ToLower().EndsWith(".jpg") || c.Name.ToLower().EndsWith(".png") )
|
||||
.Select(p => p.DownloadUrl)
|
||||
.ToList();
|
||||
}
|
||||
|
||||
private static async Task<IList<GitHubContent>> GetDirectoryContent(string path)
|
||||
{
|
||||
return await $"{GithubBaseUrl}/repos/Kareadita/Themes/contents/{path}"
|
||||
.WithHeader("Accept", "application/vnd.github+json")
|
||||
.WithHeader("User-Agent", "Kavita")
|
||||
.GetJsonAsync<List<GitHubContent>>();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Returns a map of all Native Themes names mapped to their metadata
|
||||
/// </summary>
|
||||
/// <returns></returns>
|
||||
private async Task<IDictionary<string, ThemeMetadata>> GetReadme()
|
||||
{
|
||||
var tempDownloadFile = await GithubReadme.DownloadFileAsync(_directoryService.TempDirectory);
|
||||
|
||||
// Read file into Markdown
|
||||
var htmlContent = _markdown.Transform(await _directoryService.FileSystem.File.ReadAllTextAsync(tempDownloadFile));
|
||||
var htmlDoc = new HtmlDocument();
|
||||
htmlDoc.LoadHtml(htmlContent);
|
||||
|
||||
// Find the table of Native Themes
|
||||
var tableContent = htmlDoc.DocumentNode
|
||||
.SelectSingleNode("//h2[contains(text(),'Native Themes')]/following-sibling::p").InnerText;
|
||||
|
||||
// Initialize dictionary to store theme metadata
|
||||
var themes = new Dictionary<string, ThemeMetadata>();
|
||||
|
||||
|
||||
// Split the table content by rows
|
||||
var rows = tableContent.Split("\r\n").Select(row => row.Trim()).Where(row => !string.IsNullOrWhiteSpace(row)).ToList();
|
||||
|
||||
// Parse each row in the Native Themes table
|
||||
foreach (var row in rows.Skip(2))
|
||||
{
|
||||
|
||||
var cells = row.Split('|').Skip(1).Select(cell => cell.Trim()).ToList();
|
||||
|
||||
// Extract information from each cell
|
||||
var themeName = cells[0];
|
||||
var authorName = cells[1];
|
||||
var description = cells[2];
|
||||
var compatibility = Version.Parse(cells[3]);
|
||||
|
||||
// Create ThemeMetadata object
|
||||
var themeMetadata = new ThemeMetadata
|
||||
{
|
||||
Author = authorName,
|
||||
Description = description,
|
||||
LastCompatible = compatibility
|
||||
};
|
||||
|
||||
// Add theme metadata to dictionary
|
||||
themes.Add(themeName, themeMetadata);
|
||||
}
|
||||
|
||||
return themes;
|
||||
}
|
||||
|
||||
|
||||
private async Task<string> DownloadSiteTheme(DownloadableSiteThemeDto dto)
|
||||
{
|
||||
if (string.IsNullOrEmpty(dto.Sha))
|
||||
{
|
||||
throw new ArgumentException("SHA cannot be null or empty for already downloaded themes.");
|
||||
}
|
||||
|
||||
_directoryService.ExistOrCreate(_directoryService.SiteThemeDirectory);
|
||||
var existingTempFile = _directoryService.FileSystem.Path.Join(_directoryService.SiteThemeDirectory,
|
||||
_directoryService.FileSystem.FileInfo.New(dto.CssUrl).Name);
|
||||
_directoryService.DeleteFiles([existingTempFile]);
|
||||
|
||||
var tempDownloadFile = await dto.CssUrl.DownloadFileAsync(_directoryService.TempDirectory);
|
||||
|
||||
// Validate the hash on the downloaded file
|
||||
// if (!_fileService.ValidateSha(tempDownloadFile, dto.Sha))
|
||||
// {
|
||||
// throw new KavitaException("Cannot download theme, hash does not match");
|
||||
// }
|
||||
|
||||
_directoryService.CopyFileToDirectory(tempDownloadFile, _directoryService.SiteThemeDirectory);
|
||||
var finalLocation = _directoryService.FileSystem.Path.Join(_directoryService.SiteThemeDirectory, dto.CssFile);
|
||||
|
||||
return finalLocation;
|
||||
}
|
||||
|
||||
|
||||
public async Task<SiteTheme> DownloadRepoTheme(DownloadableSiteThemeDto dto)
|
||||
{
|
||||
|
||||
// Validate we don't have a collision with existing or existing doesn't already exist
|
||||
var existingThemes = _directoryService.ScanFiles(_directoryService.SiteThemeDirectory, string.Empty);
|
||||
if (existingThemes.Any(f => Path.GetFileName(f) == dto.CssFile))
|
||||
{
|
||||
throw new KavitaException("Cannot download file, file already on disk");
|
||||
}
|
||||
|
||||
var finalLocation = await DownloadSiteTheme(dto);
|
||||
|
||||
// Create a new entry and note that this is downloaded
|
||||
var theme = new SiteTheme()
|
||||
{
|
||||
Name = dto.Name,
|
||||
NormalizedName = dto.Name.ToNormalized(),
|
||||
FileName = _directoryService.FileSystem.Path.GetFileName(finalLocation),
|
||||
Provider = ThemeProvider.Custom,
|
||||
IsDefault = false,
|
||||
GitHubPath = dto.Path,
|
||||
Description = dto.Description,
|
||||
PreviewUrls = string.Join('|', dto.PreviewUrls),
|
||||
Author = dto.Author,
|
||||
ShaHash = dto.Sha,
|
||||
CompatibleVersion = dto.LastCompatibleVersion,
|
||||
};
|
||||
_unitOfWork.SiteThemeRepository.Add(theme);
|
||||
|
||||
await _unitOfWork.CommitAsync();
|
||||
|
||||
// Inform about the new theme
|
||||
await _eventHub.SendMessageAsync(MessageFactory.NotificationProgress,
|
||||
MessageFactory.SiteThemeProgressEvent("", "", ProgressEventType.Ended));
|
||||
MessageFactory.SiteThemeProgressEvent(_directoryService.FileSystem.Path.GetFileName(theme.FileName), theme.Name,
|
||||
ProgressEventType.Ended));
|
||||
return theme;
|
||||
}
|
||||
|
||||
public async Task SyncThemes()
|
||||
{
|
||||
var themes = await _unitOfWork.SiteThemeRepository.GetThemes();
|
||||
var themeMetadata = await GetReadme();
|
||||
foreach (var theme in themes)
|
||||
{
|
||||
await SyncTheme(theme, themeMetadata);
|
||||
}
|
||||
_logger.LogInformation("Sync Themes complete");
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// If the Theme is from the Theme repo, see if there is a new version that is compatible
|
||||
/// </summary>
|
||||
/// <param name="theme"></param>
|
||||
/// <param name="themeMetadata">The Readme information</param>
|
||||
private async Task SyncTheme(SiteTheme? theme, IDictionary<string, ThemeMetadata> themeMetadata)
|
||||
{
|
||||
// Given a theme, first validate that it is applicable
|
||||
if (theme == null || theme.Provider == ThemeProvider.System || string.IsNullOrEmpty(theme.GitHubPath))
|
||||
{
|
||||
_logger.LogInformation("Cannot Sync {ThemeName} as it is not valid", theme?.Name);
|
||||
return;
|
||||
}
|
||||
|
||||
if (new Version(theme.CompatibleVersion) > BuildInfo.Version)
|
||||
{
|
||||
_logger.LogDebug("{ThemeName} theme supports a more up-to-date version ({Version}) of Kavita. Please update", theme.Name, theme.CompatibleVersion);
|
||||
return;
|
||||
}
|
||||
|
||||
|
||||
var themeContents = await GetDirectoryContent(theme.GitHubPath);
|
||||
var cssFile = themeContents.FirstOrDefault(c => c.Name.EndsWith(".css"));
|
||||
|
||||
if (cssFile == null) return;
|
||||
|
||||
// Update any metadata
|
||||
if (themeMetadata.TryGetValue(theme.Name, out var metadata))
|
||||
{
|
||||
theme.Description = metadata.Description;
|
||||
theme.Author = metadata.Author;
|
||||
theme.CompatibleVersion = metadata.LastCompatible.ToString();
|
||||
theme.PreviewUrls = string.Join('|', GetPreviewUrls(themeContents));
|
||||
}
|
||||
|
||||
var hasUpdated = cssFile.Sha != theme.ShaHash;
|
||||
if (hasUpdated)
|
||||
{
|
||||
_logger.LogDebug("Theme {ThemeName} is out of date, updating", theme.Name);
|
||||
var tempLocation = _directoryService.FileSystem.Path.Join(_directoryService.TempDirectory, theme.FileName);
|
||||
|
||||
_directoryService.DeleteFiles([tempLocation]);
|
||||
|
||||
var location = await cssFile.DownloadUrl.DownloadFileAsync(_directoryService.TempDirectory);
|
||||
if (_directoryService.FileSystem.File.Exists(location))
|
||||
{
|
||||
_directoryService.CopyFileToDirectory(location, _directoryService.SiteThemeDirectory);
|
||||
_logger.LogInformation("Updated Theme on disk for {ThemeName}", theme.Name);
|
||||
}
|
||||
}
|
||||
|
||||
await _unitOfWork.CommitAsync();
|
||||
|
||||
|
||||
if (hasUpdated)
|
||||
{
|
||||
await _eventHub.SendMessageAsync(MessageFactory.SiteThemeUpdated,
|
||||
MessageFactory.SiteThemeUpdatedEvent(theme.Name));
|
||||
}
|
||||
|
||||
// Send an update to refresh metadata around the themes
|
||||
await _eventHub.SendMessageAsync(MessageFactory.NotificationProgress,
|
||||
MessageFactory.SiteThemeProgressEvent(_directoryService.FileSystem.Path.GetFileName(theme.FileName), theme.Name,
|
||||
ProgressEventType.Ended));
|
||||
|
||||
_logger.LogInformation("Theme Sync complete");
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Deletes a SiteTheme. The CSS file will be moved to temp/ to allow user to recover data
|
||||
/// </summary>
|
||||
/// <param name="siteThemeId"></param>
|
||||
public async Task DeleteTheme(int siteThemeId)
|
||||
{
|
||||
// Validate no one else is using this theme
|
||||
var inUse = await _unitOfWork.SiteThemeRepository.IsThemeInUse(siteThemeId);
|
||||
if (inUse)
|
||||
{
|
||||
throw new KavitaException("errors.delete-theme-in-use");
|
||||
}
|
||||
|
||||
var siteTheme = await _unitOfWork.SiteThemeRepository.GetTheme(siteThemeId);
|
||||
if (siteTheme == null) return;
|
||||
|
||||
await RemoveTheme(siteTheme);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// This assumes a file is already in temp directory and will be used for
|
||||
/// </summary>
|
||||
/// <param name="tempFile"></param>
|
||||
/// <returns></returns>
|
||||
public async Task<SiteTheme> CreateThemeFromFile(string tempFile, string username)
|
||||
{
|
||||
if (!_directoryService.FileSystem.File.Exists(tempFile))
|
||||
{
|
||||
_logger.LogInformation("Unable to create theme from manual upload as file not in temp");
|
||||
throw new KavitaException("errors.theme-manual-upload");
|
||||
}
|
||||
|
||||
|
||||
var filename = _directoryService.FileSystem.FileInfo.New(tempFile).Name;
|
||||
var themeName = Path.GetFileNameWithoutExtension(filename);
|
||||
|
||||
if (await _unitOfWork.SiteThemeRepository.GetThemeDtoByName(themeName) != null)
|
||||
{
|
||||
throw new KavitaException("errors.theme-already-in-use");
|
||||
}
|
||||
|
||||
_directoryService.CopyFileToDirectory(tempFile, _directoryService.SiteThemeDirectory);
|
||||
var finalLocation = _directoryService.FileSystem.Path.Join(_directoryService.SiteThemeDirectory, filename);
|
||||
|
||||
|
||||
// Create a new entry and note that this is downloaded
|
||||
var theme = new SiteTheme()
|
||||
{
|
||||
Name = Path.GetFileNameWithoutExtension(filename),
|
||||
NormalizedName = themeName.ToNormalized(),
|
||||
FileName = _directoryService.FileSystem.Path.GetFileName(finalLocation),
|
||||
Provider = ThemeProvider.Custom,
|
||||
IsDefault = false,
|
||||
Description = $"Manually uploaded via UI by {username}",
|
||||
PreviewUrls = string.Empty,
|
||||
Author = username,
|
||||
};
|
||||
_unitOfWork.SiteThemeRepository.Add(theme);
|
||||
|
||||
await _unitOfWork.CommitAsync();
|
||||
|
||||
// Inform about the new theme
|
||||
await _eventHub.SendMessageAsync(MessageFactory.NotificationProgress,
|
||||
MessageFactory.SiteThemeProgressEvent(_directoryService.FileSystem.Path.GetFileName(theme.FileName), theme.Name,
|
||||
ProgressEventType.Ended));
|
||||
return theme;
|
||||
|
||||
}
|
||||
|
||||
|
||||
|
|
@ -130,6 +471,7 @@ public class ThemeService : IThemeService
|
|||
/// <param name="theme"></param>
|
||||
private async Task RemoveTheme(SiteTheme theme)
|
||||
{
|
||||
_logger.LogInformation("Removing {ThemeName}. File can be found in temp/ until nightly cleanup", theme.Name);
|
||||
var prefs = await _unitOfWork.UserRepository.GetAllPreferencesByThemeAsync(theme.Id);
|
||||
var defaultTheme = await _unitOfWork.SiteThemeRepository.GetDefaultTheme();
|
||||
foreach (var pref in prefs)
|
||||
|
|
@ -137,6 +479,20 @@ public class ThemeService : IThemeService
|
|||
pref.Theme = defaultTheme;
|
||||
_unitOfWork.UserRepository.Update(pref);
|
||||
}
|
||||
|
||||
try
|
||||
{
|
||||
// Copy the theme file to temp for nightly removal (to give user time to reclaim if made a mistake)
|
||||
var existingLocation =
|
||||
_directoryService.FileSystem.Path.Join(_directoryService.SiteThemeDirectory, theme.FileName);
|
||||
var newLocation =
|
||||
_directoryService.FileSystem.Path.Join(_directoryService.TempDirectory, theme.FileName);
|
||||
_directoryService.CopyFileToDirectory(existingLocation, newLocation);
|
||||
_directoryService.DeleteFiles([existingLocation]);
|
||||
}
|
||||
catch (Exception) { /* Swallow */ }
|
||||
|
||||
|
||||
_unitOfWork.SiteThemeRepository.Remove(theme);
|
||||
await _unitOfWork.CommitAsync();
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue