using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using API.DTOs.Update;
using API.SignalR;
using Flurl.Http;
using Kavita.Common.EnvironmentInfo;
using Kavita.Common.Helpers;
using MarkdownDeep;
using Microsoft.Extensions.Logging;
namespace API.Services.Tasks;
#nullable enable
internal class GithubReleaseMetadata
{
///
/// Name of the Tag
/// v0.4.3
///
// ReSharper disable once InconsistentNaming
public required string Tag_Name { get; init; }
///
/// Name of the Release
///
public required string Name { get; init; }
///
/// Body of the Release
///
public required string Body { get; init; }
///
/// Url of the release on Github
///
// ReSharper disable once InconsistentNaming
public required string Html_Url { get; init; }
///
/// Date Release was Published
///
// ReSharper disable once InconsistentNaming
public required string Published_At { get; init; }
}
public interface IVersionUpdaterService
{
Task CheckForUpdate();
Task PushUpdate(UpdateNotificationDto update);
Task> GetAllReleases();
Task GetNumberOfReleasesBehind();
}
public class VersionUpdaterService : IVersionUpdaterService
{
private readonly ILogger _logger;
private readonly IEventHub _eventHub;
private readonly Markdown _markdown = new MarkdownDeep.Markdown();
#pragma warning disable S1075
private const string GithubLatestReleasesUrl = "https://api.github.com/repos/Kareadita/Kavita/releases/latest";
private const string GithubAllReleasesUrl = "https://api.github.com/repos/Kareadita/Kavita/releases";
#pragma warning restore S1075
public VersionUpdaterService(ILogger logger, IEventHub eventHub)
{
_logger = logger;
_eventHub = eventHub;
FlurlHttp.ConfigureClient(GithubLatestReleasesUrl, cli =>
cli.Settings.HttpClientFactory = new UntrustedCertClientFactory());
FlurlHttp.ConfigureClient(GithubAllReleasesUrl, cli =>
cli.Settings.HttpClientFactory = new UntrustedCertClientFactory());
}
///
/// Fetches the latest release from Github
///
/// Latest update
public async Task CheckForUpdate()
{
var update = await GetGithubRelease();
return CreateDto(update);
}
public async Task> GetAllReleases()
{
var updates = await GetGithubReleases();
var updateDtos = updates.Select(CreateDto)
.Where(d => d != null)
.OrderByDescending(d => d!.PublishDate)
.Select(d => d!)
.ToList();
// Find the latest dto
var latestRelease = updateDtos[0]!;
var updateVersion = new Version(latestRelease.UpdateVersion);
var isNightly = BuildInfo.Version > new Version(latestRelease.UpdateVersion);
// isNightly can be true when we compare something like v0.8.1 vs v0.8.1.0
if (IsVersionEqualToBuildVersion(updateVersion))
{
isNightly = false;
}
latestRelease.IsOnNightlyInRelease = isNightly;
return updateDtos;
}
private static bool IsVersionEqualToBuildVersion(Version updateVersion)
{
return updateVersion.Revision < 0 && BuildInfo.Version.Revision == 0 &&
CompareWithoutRevision(BuildInfo.Version, updateVersion);
}
private static bool CompareWithoutRevision(Version v1, Version v2)
{
if (v1.Major != v2.Major)
return v1.Major == v2.Major;
if (v1.Minor != v2.Minor)
return v1.Minor == v2.Minor;
if (v1.Build != v2.Build)
return v1.Build == v2.Build;
return true;
}
public async Task GetNumberOfReleasesBehind()
{
var updates = await GetAllReleases();
return updates.TakeWhile(update => update.UpdateVersion != update.CurrentVersion).Count();
}
private UpdateNotificationDto? CreateDto(GithubReleaseMetadata? update)
{
if (update == null || string.IsNullOrEmpty(update.Tag_Name)) return null;
var updateVersion = new Version(update.Tag_Name.Replace("v", string.Empty));
var currentVersion = BuildInfo.Version.ToString(4);
return new UpdateNotificationDto()
{
CurrentVersion = currentVersion,
UpdateVersion = updateVersion.ToString(),
UpdateBody = _markdown.Transform(update.Body.Trim()),
UpdateTitle = update.Name,
UpdateUrl = update.Html_Url,
IsDocker = OsInfo.IsDocker,
PublishDate = update.Published_At,
IsReleaseEqual = IsVersionEqualToBuildVersion(updateVersion),
IsReleaseNewer = BuildInfo.Version < updateVersion,
};
}
public async Task PushUpdate(UpdateNotificationDto? update)
{
if (update == null) return;
var updateVersion = new Version(update.UpdateVersion);
if (BuildInfo.Version < updateVersion)
{
_logger.LogWarning("Server is out of date. Current: {CurrentVersion}. Available: {AvailableUpdate}", BuildInfo.Version, updateVersion);
await _eventHub.SendMessageAsync(MessageFactory.UpdateAvailable, MessageFactory.UpdateVersionEvent(update),
true);
}
}
private static async Task GetGithubRelease()
{
var update = await GithubLatestReleasesUrl
.WithHeader("Accept", "application/json")
.WithHeader("User-Agent", "Kavita")
.GetJsonAsync();
return update;
}
private static async Task> GetGithubReleases()
{
var update = await GithubAllReleasesUrl
.WithHeader("Accept", "application/json")
.WithHeader("User-Agent", "Kavita")
.GetJsonAsync>();
return update;
}
}