using System; using System.Collections.Generic; using System.IO; using System.Linq; using System.Threading.Tasks; using API.Constants; using API.Data; using API.DTOs.Jobs; using API.DTOs.MediaErrors; using API.DTOs.Stats; using API.DTOs.Update; using API.Entities.Enums; using API.Extensions; using API.Helpers; using API.Services; using API.Services.Tasks; using EasyCaching.Core; using Hangfire; using Hangfire.Storage; using Kavita.Common; using Microsoft.AspNetCore.Authorization; using Microsoft.AspNetCore.Mvc; using Microsoft.Extensions.Logging; using MimeTypes; using TaskScheduler = API.Services.TaskScheduler; namespace API.Controllers; #nullable enable [Authorize(Policy = "RequireAdminRole")] public class ServerController : BaseApiController { private readonly ILogger _logger; private readonly IBackupService _backupService; private readonly IArchiveService _archiveService; private readonly IVersionUpdaterService _versionUpdaterService; private readonly IStatsService _statsService; private readonly ICleanupService _cleanupService; private readonly IScannerService _scannerService; private readonly ITaskScheduler _taskScheduler; private readonly IUnitOfWork _unitOfWork; private readonly IEasyCachingProviderFactory _cachingProviderFactory; private readonly ILocalizationService _localizationService; public ServerController(ILogger logger, IBackupService backupService, IArchiveService archiveService, IVersionUpdaterService versionUpdaterService, IStatsService statsService, ICleanupService cleanupService, IScannerService scannerService, ITaskScheduler taskScheduler, IUnitOfWork unitOfWork, IEasyCachingProviderFactory cachingProviderFactory, ILocalizationService localizationService) { _logger = logger; _backupService = backupService; _archiveService = archiveService; _versionUpdaterService = versionUpdaterService; _statsService = statsService; _cleanupService = cleanupService; _scannerService = scannerService; _taskScheduler = taskScheduler; _unitOfWork = unitOfWork; _cachingProviderFactory = cachingProviderFactory; _localizationService = localizationService; } /// /// Performs an ad-hoc cleanup of Cache /// /// [HttpPost("clear-cache")] public ActionResult ClearCache() { _logger.LogInformation("{UserName} is clearing cache of server from admin dashboard", User.GetUsername()); _cleanupService.CleanupCacheAndTempDirectories(); return Ok(); } /// /// Performs an ad-hoc cleanup of Want To Read, by removing want to read series for users, where the series are fully read and in Completed publication status. /// /// [HttpPost("cleanup-want-to-read")] public ActionResult CleanupWantToRead() { _logger.LogInformation("{UserName} is clearing running want to read cleanup from admin dashboard", User.GetUsername()); RecurringJob.TriggerJob(TaskScheduler.RemoveFromWantToReadTaskId); return Ok(); } /// /// Performs an ad-hoc backup of the Database /// /// [HttpPost("backup-db")] public ActionResult BackupDatabase() { _logger.LogInformation("{UserName} is backing up database of server from admin dashboard", User.GetUsername()); RecurringJob.TriggerJob(TaskScheduler.BackupTaskId); return Ok(); } /// /// This is a one time task that needs to be ran for v0.7 statistics to work /// /// [HttpPost("analyze-files")] public async Task AnalyzeFiles() { _logger.LogInformation("{UserName} is performing file analysis from admin dashboard", User.GetUsername()); if (TaskScheduler.HasAlreadyEnqueuedTask(ScannerService.Name, "AnalyzeFiles", Array.Empty(), TaskScheduler.DefaultQueue, true)) return Ok(await _localizationService.Translate(User.GetUserId(), "job-already-running")); BackgroundJob.Enqueue(() => _scannerService.AnalyzeFiles()); return Ok(); } /// /// Returns non-sensitive information about the current system /// /// [HttpGet("server-info")] public async Task> GetVersion() { return Ok(await _statsService.GetServerInfo()); } /// /// Returns non-sensitive information about the current system /// /// This is just for the UI and is extremely lightweight /// [HttpGet("server-info-slim")] public async Task> GetSlimVersion() { return Ok(await _statsService.GetServerInfoSlim()); } /// /// Triggers the scheduling of the convert media job. This will convert all media to the target encoding (except for PNG). Only one job will run at a time. /// /// [HttpPost("convert-media")] public async Task ScheduleConvertCovers() { var encoding = (await _unitOfWork.SettingsRepository.GetSettingsDtoAsync()).EncodeMediaAs; if (encoding == EncodeFormat.PNG) { return BadRequest(await _localizationService.Translate(User.GetUserId(), "encode-as-warning")); } _taskScheduler.CovertAllCoversToEncoding(); return Ok(); } /// /// Downloads all the log files via a zip /// /// [HttpGet("logs")] public async Task GetLogs() { var files = _backupService.GetLogFiles(); try { var zipPath = _archiveService.CreateZipForDownload(files, "logs"); return PhysicalFile(zipPath, MimeTypeMap.GetMimeType(Path.GetExtension(zipPath)), System.Web.HttpUtility.UrlEncode(Path.GetFileName(zipPath)), true); } catch (KavitaException ex) { return BadRequest(await _localizationService.Translate(User.GetUserId(), ex.Message)); } } /// /// Checks for updates and pushes an event to the UI /// /// Some users have websocket issues so this is not always reliable to alert the user [HttpGet("check-for-updates")] public async Task CheckForAnnouncements() { await _taskScheduler.CheckForUpdate(); return Ok(); } /// /// Checks for updates, if no updates that are > current version installed, returns null /// [HttpGet("check-update")] public async Task> CheckForUpdates() { return Ok(await _versionUpdaterService.CheckForUpdate()); } /// /// Returns how many versions out of date this install is /// [HttpGet("check-out-of-date")] public async Task> CheckHowOutOfDate() { return Ok(await _versionUpdaterService.GetNumberOfReleasesBehind()); } /// /// Pull the Changelog for Kavita from Github and display /// /// [AllowAnonymous] [HttpGet("changelog")] public async Task>> GetChangelog() { // Strange bug where [Authorize] doesn't work if (User.GetUserId() == 0) return Unauthorized(); return Ok(await _versionUpdaterService.GetAllReleases()); } /// /// Returns a list of reoccurring jobs. Scheduled ad-hoc jobs will not be returned. /// /// [HttpGet("jobs")] public async Task>> GetJobs() { var jobDtoTasks = JobStorage.Current.GetConnection().GetRecurringJobs().Select(async dto => new JobDto() { Id = dto.Id, Title = await _localizationService.Translate(User.GetUserId(), dto.Id), Cron = dto.Cron, LastExecutionUtc = dto.LastExecution.HasValue ? new DateTime(dto.LastExecution.Value.Ticks, DateTimeKind.Utc) : null }); return Ok(await Task.WhenAll(jobDtoTasks)); } /// /// Returns a list of issues found during scanning or reading in which files may have corruption or bad metadata (structural metadata) /// /// [Authorize("RequireAdminRole")] [HttpGet("media-errors")] public ActionResult> GetMediaErrors() { return Ok(_unitOfWork.MediaErrorRepository.GetAllErrorDtosAsync()); } /// /// Deletes all media errors /// /// [Authorize("RequireAdminRole")] [HttpPost("clear-media-alerts")] public async Task ClearMediaErrors() { await _unitOfWork.MediaErrorRepository.DeleteAll(); return Ok(); } /// /// Bust Kavita+ Cache /// /// [Authorize("RequireAdminRole")] [HttpPost("bust-kavitaplus-cache")] public async Task BustReviewAndRecCache() { _logger.LogInformation("Busting Kavita+ Cache"); var provider = _cachingProviderFactory.GetCachingProvider(EasyCacheProfiles.KavitaPlusExternalSeries); await provider.FlushAsync(); return Ok(); } }