mirror of
https://github.com/Cleanuparr/Cleanuparr.git
synced 2025-12-31 18:08:44 -05:00
84 lines
3.5 KiB
C#
84 lines
3.5 KiB
C#
using System.Collections.Concurrent;
|
|
using System.Text.RegularExpressions;
|
|
using Cleanuparr.Domain.Entities;
|
|
using Cleanuparr.Domain.Enums;
|
|
using Cleanuparr.Persistence.Models.Configuration;
|
|
using Cleanuparr.Persistence.Models.Configuration.DownloadCleaner;
|
|
|
|
namespace Cleanuparr.Infrastructure.Features.DownloadClient;
|
|
|
|
public interface IDownloadService : IDisposable
|
|
{
|
|
DownloadClientConfig ClientConfig { get; }
|
|
|
|
public Task LoginAsync();
|
|
|
|
/// <summary>
|
|
/// Performs a health check on the download client
|
|
/// </summary>
|
|
/// <returns>The health check result</returns>
|
|
public Task<HealthCheckResult> HealthCheckAsync();
|
|
|
|
/// <summary>
|
|
/// Checks whether the download should be removed from the *arr queue.
|
|
/// </summary>
|
|
/// <param name="hash">The download hash.</param>
|
|
/// <param name="ignoredDownloads">Downloads to ignore from processing.</param>
|
|
public Task<DownloadCheckResult> ShouldRemoveFromArrQueueAsync(string hash, IReadOnlyList<string> ignoredDownloads);
|
|
|
|
/// <summary>
|
|
/// Fetches all seeding downloads.
|
|
/// </summary>
|
|
/// <returns>A list of downloads that are seeding.</returns>
|
|
Task<List<ITorrentItemWrapper>> GetSeedingDownloads();
|
|
|
|
/// <summary>
|
|
/// Filters downloads that should be cleaned.
|
|
/// </summary>
|
|
/// <param name="downloads">The downloads to filter.</param>
|
|
/// <param name="seedingRules">The seeding rules by which to filter the downloads.</param>
|
|
/// <returns>A list of downloads for the provided categories.</returns>
|
|
List<ITorrentItemWrapper>? FilterDownloadsToBeCleanedAsync(List<ITorrentItemWrapper>? downloads, List<SeedingRule> seedingRules);
|
|
|
|
/// <summary>
|
|
/// Filters downloads that should have their category changed.
|
|
/// </summary>
|
|
/// <param name="downloads">The downloads to filter.</param>
|
|
/// <param name="categories">The categories by which to filter the downloads.</param>
|
|
/// <returns>A list of downloads for the provided categories.</returns>
|
|
List<ITorrentItemWrapper>? FilterDownloadsToChangeCategoryAsync(List<ITorrentItemWrapper>? downloads, List<string> categories);
|
|
|
|
/// <summary>
|
|
/// Cleans the downloads.
|
|
/// </summary>
|
|
/// <param name="downloads">The downloads to clean.</param>
|
|
/// <param name="seedingRules">The seeding rules.</param>
|
|
Task CleanDownloadsAsync(List<ITorrentItemWrapper>? downloads, List<SeedingRule> seedingRules);
|
|
|
|
/// <summary>
|
|
/// Changes the category for downloads that have no hardlinks.
|
|
/// </summary>
|
|
/// <param name="downloads">The downloads to change.</param>
|
|
Task ChangeCategoryForNoHardLinksAsync(List<ITorrentItemWrapper>? downloads);
|
|
|
|
/// <summary>
|
|
/// Deletes a download item.
|
|
/// </summary>
|
|
/// <param name="hash">The torrent hash.</param>
|
|
/// <param name="deleteSourceFiles">Whether to delete the source files along with the torrent. Defaults to true.</param>
|
|
public Task DeleteDownload(string hash, bool deleteSourceFiles);
|
|
|
|
/// <summary>
|
|
/// Creates a category.
|
|
/// </summary>
|
|
/// <param name="name">The category name.</param>
|
|
public Task CreateCategoryAsync(string name);
|
|
|
|
/// <summary>
|
|
/// Blocks unwanted files from being fully downloaded.
|
|
/// </summary>
|
|
/// <param name="hash">The torrent hash.</param>
|
|
/// <param name="ignoredDownloads">Downloads to ignore from processing.</param>
|
|
/// <returns>True if all files have been blocked; otherwise false.</returns>
|
|
public Task<BlockFilesResult> BlockUnwantedFilesAsync(string hash, IReadOnlyList<string> ignoredDownloads);
|
|
} |