mirror of
https://github.com/Kareadita/Kavita.git
synced 2025-06-16 12:04:17 -04:00
* Moved LibraryWatcher to utilize a queue for calculating the change event to ensure the Watcher doesn't get overwhelmed on large moves. * Fixed a security vulnerability (https://huntr.dev/bounties/8a3e652f-d6bf-436e-877e-0eaf5c69ef95/). This will be disclosed in Stable release changelog. * Tweaked the log message template * Removed some dead code from Configuration json patcher * Fixed a bug with the ComicInfo finding to properly handle root level. Fixed a bug where sometimes scanner wouldn't choose the first file with ComicInfo for filling out information. * Added new setting for managing how many logs files are allowed, just like how backups work. * Added unit tests for new CleanupLogs code * Fixed a bug where manga reader background color wasn't actually sending from the UI * Added new stats for tracking to help understand usage in the app and what features are used or not. * Fixed Stats url * Fixed a bug where volumes that had larger than 1 difference wouldn't properly return next/prev chapter (for continuous reader) * Remove a redundant test step in build pipeline, since it's already done at PR stage. * Updated dockerfile to use the new Heath check endpoint * Allow force to pass through to scan loop * Removed some old config stuff from a safety check on config in entrypoint.sh * Fixed broken unit tests due to new RBS check and how we setup mock data.
265 lines
9.6 KiB
C#
265 lines
9.6 KiB
C#
using System;
|
|
using System.Collections.Generic;
|
|
using System.IO;
|
|
using System.Linq;
|
|
using System.Net.Http;
|
|
using System.Runtime.InteropServices;
|
|
using System.Threading.Tasks;
|
|
using API.Data;
|
|
using API.Data.Repositories;
|
|
using API.DTOs.Stats;
|
|
using API.Entities.Enums;
|
|
using API.Entities.Enums.UserPreferences;
|
|
using Flurl.Http;
|
|
using Kavita.Common.EnvironmentInfo;
|
|
using Kavita.Common.Helpers;
|
|
using Microsoft.AspNetCore.Http;
|
|
using Microsoft.EntityFrameworkCore;
|
|
using Microsoft.Extensions.Logging;
|
|
|
|
namespace API.Services.Tasks;
|
|
|
|
public interface IStatsService
|
|
{
|
|
Task Send();
|
|
Task<ServerInfoDto> GetServerInfo();
|
|
Task SendCancellation();
|
|
}
|
|
public class StatsService : IStatsService
|
|
{
|
|
private readonly ILogger<StatsService> _logger;
|
|
private readonly IUnitOfWork _unitOfWork;
|
|
private readonly DataContext _context;
|
|
private const string ApiUrl = "https://stats.kavitareader.com";
|
|
|
|
public StatsService(ILogger<StatsService> logger, IUnitOfWork unitOfWork, DataContext context)
|
|
{
|
|
_logger = logger;
|
|
_unitOfWork = unitOfWork;
|
|
_context = context;
|
|
|
|
FlurlHttp.ConfigureClient(ApiUrl, cli =>
|
|
cli.Settings.HttpClientFactory = new UntrustedCertClientFactory());
|
|
}
|
|
|
|
/// <summary>
|
|
/// Due to all instances firing this at the same time, we can DDOS our server. This task when fired will schedule the task to be run
|
|
/// randomly over a 6 hour spread
|
|
/// </summary>
|
|
public async Task Send()
|
|
{
|
|
var allowStatCollection = (await _unitOfWork.SettingsRepository.GetSettingsDtoAsync()).AllowStatCollection;
|
|
if (!allowStatCollection)
|
|
{
|
|
return;
|
|
}
|
|
|
|
await SendData();
|
|
}
|
|
|
|
/// <summary>
|
|
/// This must be public for Hangfire. Do not call this directly.
|
|
/// </summary>
|
|
// ReSharper disable once MemberCanBePrivate.Global
|
|
public async Task SendData()
|
|
{
|
|
var data = await GetServerInfo();
|
|
await SendDataToStatsServer(data);
|
|
}
|
|
|
|
|
|
private async Task SendDataToStatsServer(ServerInfoDto data)
|
|
{
|
|
var responseContent = string.Empty;
|
|
|
|
try
|
|
{
|
|
var response = await (ApiUrl + "/api/v2/stats")
|
|
.WithHeader("Accept", "application/json")
|
|
.WithHeader("User-Agent", "Kavita")
|
|
.WithHeader("x-api-key", "MsnvA2DfQqxSK5jh")
|
|
.WithHeader("x-kavita-version", BuildInfo.Version)
|
|
.WithHeader("Content-Type", "application/json")
|
|
.WithTimeout(TimeSpan.FromSeconds(30))
|
|
.PostJsonAsync(data);
|
|
|
|
if (response.StatusCode != StatusCodes.Status200OK)
|
|
{
|
|
_logger.LogError("KavitaStats did not respond successfully. {Content}", response);
|
|
}
|
|
}
|
|
catch (HttpRequestException e)
|
|
{
|
|
var info = new
|
|
{
|
|
dataSent = data,
|
|
response = responseContent
|
|
};
|
|
|
|
_logger.LogError(e, "KavitaStats did not respond successfully. {Content}", info);
|
|
}
|
|
catch (Exception e)
|
|
{
|
|
_logger.LogError(e, "An error happened during the request to KavitaStats");
|
|
}
|
|
}
|
|
|
|
public async Task<ServerInfoDto> GetServerInfo()
|
|
{
|
|
var serverSettings = await _unitOfWork.SettingsRepository.GetSettingsDtoAsync();
|
|
|
|
var serverInfo = new ServerInfoDto
|
|
{
|
|
InstallId = serverSettings.InstallId,
|
|
Os = RuntimeInformation.OSDescription,
|
|
KavitaVersion = serverSettings.InstallVersion,
|
|
DotnetVersion = Environment.Version.ToString(),
|
|
IsDocker = new OsInfo().IsDocker,
|
|
NumOfCores = Math.Max(Environment.ProcessorCount, 1),
|
|
HasBookmarks = (await _unitOfWork.UserRepository.GetAllBookmarksAsync()).Any(),
|
|
NumberOfLibraries = (await _unitOfWork.LibraryRepository.GetLibrariesAsync()).Count(),
|
|
NumberOfCollections = (await _unitOfWork.CollectionTagRepository.GetAllTagsAsync()).Count(),
|
|
NumberOfReadingLists = await _unitOfWork.ReadingListRepository.Count(),
|
|
OPDSEnabled = serverSettings.EnableOpds,
|
|
NumberOfUsers = (await _unitOfWork.UserRepository.GetAllUsers()).Count(),
|
|
TotalFiles = await _unitOfWork.LibraryRepository.GetTotalFiles(),
|
|
TotalGenres = await _unitOfWork.GenreRepository.GetCountAsync(),
|
|
TotalPeople = await _unitOfWork.PersonRepository.GetCountAsync(),
|
|
UsingSeriesRelationships = await GetIfUsingSeriesRelationship(),
|
|
StoreBookmarksAsWebP = serverSettings.ConvertBookmarkToWebP,
|
|
MaxSeriesInALibrary = await MaxSeriesInAnyLibrary(),
|
|
MaxVolumesInASeries = await MaxVolumesInASeries(),
|
|
MaxChaptersInASeries = await MaxChaptersInASeries(),
|
|
MangaReaderBackgroundColors = await AllMangaReaderBackgroundColors(),
|
|
MangaReaderPageSplittingModes = await AllMangaReaderPageSplitting(),
|
|
MangaReaderLayoutModes = await AllMangaReaderLayoutModes(),
|
|
FileFormats = AllFormats(),
|
|
};
|
|
|
|
var usersWithPref = (await _unitOfWork.UserRepository.GetAllUsersAsync(AppUserIncludes.UserPreferences)).ToList();
|
|
serverInfo.UsersOnCardLayout =
|
|
usersWithPref.Count(u => u.UserPreferences.GlobalPageLayoutMode == PageLayoutMode.Cards);
|
|
serverInfo.UsersOnListLayout =
|
|
usersWithPref.Count(u => u.UserPreferences.GlobalPageLayoutMode == PageLayoutMode.List);
|
|
|
|
var firstAdminUser = (await _unitOfWork.UserRepository.GetAdminUsersAsync()).FirstOrDefault();
|
|
|
|
if (firstAdminUser != null)
|
|
{
|
|
var firstAdminUserPref = (await _unitOfWork.UserRepository.GetPreferencesAsync(firstAdminUser.UserName));
|
|
var activeTheme = firstAdminUserPref.Theme ?? Seed.DefaultThemes.First(t => t.IsDefault);
|
|
|
|
serverInfo.ActiveSiteTheme = activeTheme.Name;
|
|
serverInfo.MangaReaderMode = firstAdminUserPref.ReaderMode;
|
|
}
|
|
|
|
return serverInfo;
|
|
}
|
|
|
|
public async Task SendCancellation()
|
|
{
|
|
_logger.LogInformation("Informing KavitaStats that this instance is no longer sending stats");
|
|
var installId = (await _unitOfWork.SettingsRepository.GetSettingsDtoAsync()).InstallId;
|
|
|
|
var responseContent = string.Empty;
|
|
|
|
try
|
|
{
|
|
var response = await (ApiUrl + "/api/v2/stats/opt-out?installId=" + installId)
|
|
.WithHeader("Accept", "application/json")
|
|
.WithHeader("User-Agent", "Kavita")
|
|
.WithHeader("x-api-key", "MsnvA2DfQqxSK5jh")
|
|
.WithHeader("x-kavita-version", BuildInfo.Version)
|
|
.WithHeader("Content-Type", "application/json")
|
|
.WithTimeout(TimeSpan.FromSeconds(30))
|
|
.PostAsync();
|
|
|
|
if (response.StatusCode != StatusCodes.Status200OK)
|
|
{
|
|
_logger.LogError("KavitaStats did not respond successfully. {Content}", response);
|
|
}
|
|
}
|
|
catch (HttpRequestException e)
|
|
{
|
|
_logger.LogError(e, "KavitaStats did not respond successfully. {Response}", responseContent);
|
|
}
|
|
catch (Exception e)
|
|
{
|
|
_logger.LogError(e, "An error happened during the request to KavitaStats");
|
|
}
|
|
}
|
|
|
|
private Task<bool> GetIfUsingSeriesRelationship()
|
|
{
|
|
return _context.SeriesRelation.AnyAsync();
|
|
}
|
|
|
|
private async Task<int> MaxSeriesInAnyLibrary()
|
|
{
|
|
// If first time flow, just return 0
|
|
if (!await _context.Series.AnyAsync()) return 0;
|
|
return await _context.Series
|
|
.Select(s => _context.Library.Where(l => l.Id == s.LibraryId).SelectMany(l => l.Series).Count())
|
|
.MaxAsync();
|
|
}
|
|
|
|
private async Task<int> MaxVolumesInASeries()
|
|
{
|
|
// If first time flow, just return 0
|
|
if (!await _context.Volume.AnyAsync()) return 0;
|
|
return await _context.Volume
|
|
.Select(v => new
|
|
{
|
|
v.SeriesId,
|
|
Count = _context.Series.Where(s => s.Id == v.SeriesId).SelectMany(s => s.Volumes).Count()
|
|
})
|
|
.AsNoTracking()
|
|
.AsSplitQuery()
|
|
.MaxAsync(d => d.Count);
|
|
}
|
|
|
|
private async Task<int> MaxChaptersInASeries()
|
|
{
|
|
// If first time flow, just return 0
|
|
if (!await _context.Chapter.AnyAsync()) return 0;
|
|
return await _context.Series
|
|
.AsNoTracking()
|
|
.AsSplitQuery()
|
|
.MaxAsync(s => s.Volumes
|
|
.Where(v => v.Number == 0)
|
|
.SelectMany(v => v.Chapters)
|
|
.Count());
|
|
}
|
|
|
|
private async Task<IEnumerable<string>> AllMangaReaderBackgroundColors()
|
|
{
|
|
return await _context.AppUserPreferences.Select(p => p.BackgroundColor).Distinct().ToListAsync();
|
|
}
|
|
|
|
private async Task<IEnumerable<PageSplitOption>> AllMangaReaderPageSplitting()
|
|
{
|
|
return await _context.AppUserPreferences.Select(p => p.PageSplitOption).Distinct().ToListAsync();
|
|
}
|
|
|
|
private async Task<IEnumerable<LayoutMode>> AllMangaReaderLayoutModes()
|
|
{
|
|
return await _context.AppUserPreferences.Select(p => p.LayoutMode).Distinct().ToListAsync();
|
|
}
|
|
|
|
private IEnumerable<FileFormatDto> AllFormats()
|
|
{
|
|
var results = _context.MangaFile
|
|
.AsNoTracking()
|
|
.AsEnumerable()
|
|
.Select(m => new FileFormatDto()
|
|
{
|
|
Format = m.Format,
|
|
Extension = Path.GetExtension(m.FilePath)?.ToLowerInvariant()
|
|
})
|
|
.DistinctBy(f => f.Extension)
|
|
.ToList();
|
|
|
|
return results;
|
|
}
|
|
}
|