test

README.md

@@ -40,6 +40,7 @@ cleanuperr supports both qBittorrent's built-in exclusion features and its own b
   - [Windows](#windows)
   - [Linux](#linux)
   - [MacOS](#macos)
+  - [FreeBSD](#freebsd)
 - [Credits](#credits)
 
 ## Naming choice
@@ -300,6 +301,54 @@ services:
 > codesign --sign - --force --preserve-metadata=entitlements,requirements,flags,runtime /example/directory/cleanuperr
 > ```
 
+### <img src="https://raw.githubusercontent.com/FortAwesome/Font-Awesome/6.x/svgs/brands/freebsd.svg" height="20" style="vertical-align: middle;"> <span style="vertical-align: middle;">FreeBSD</span>
+
+1. Installation:
+    ```
+    # install dependencies
+    pkg install -y git icu libinotify libunwind wget
+
+    # set up the dotnet SDK
+    cd ~
+    wget -q https://github.com/Thefrank/dotnet-freebsd-crossbuild/releases/download/v9.0.104-amd64-freebsd-14/dotnet-sdk-9.0.104-freebsd-x64.tar.gz
+    export DOTNET_ROOT=$(pwd)/.dotnet
+    mkdir -p "$DOTNET_ROOT" && tar zxf dotnet-sdk-9.0.104-freebsd-x64.tar.gz -C "$DOTNET_ROOT"
+    export PATH=$PATH:$DOTNET_ROOT:$DOTNET_ROOT/tools
+
+    # download NuGet dependencies
+    mkdir -p /tmp/nuget
+    wget -q -P /tmp/nuget/ https://github.com/Thefrank/dotnet-freebsd-crossbuild/releases/download/v9.0.104-amd64-freebsd-14/Microsoft.AspNetCore.App.Runtime.freebsd-x64.9.0.3.nupkg
+    wget -q -P /tmp/nuget/ https://github.com/Thefrank/dotnet-freebsd-crossbuild/releases/download/v9.0.104-amd64-freebsd-14/Microsoft.NETCore.App.Host.freebsd-x64.9.0.3.nupkg
+    wget -q -P /tmp/nuget/ https://github.com/Thefrank/dotnet-freebsd-crossbuild/releases/download/v9.0.104-amd64-freebsd-14/Microsoft.NETCore.App.Runtime.freebsd-x64.9.0.3.nupkg
+
+    # add NuGet source
+    dotnet nuget add source /tmp/nuget --name tmp
+
+    # add GitHub NuGet source
+    # a PAT (Personal Access Token) can be generated here https://github.com/settings/tokens
+    dotnet nuget add source --username <YOUR_USERNAME> --password <YOUR_PERSONAL_ACCESS_TOKEN> --store-password-in-clear-text --name flmorg https://nuget.pkg.github.com/flmorg/index.json
+    ```
+2. Building:
+    ```
+    # clone the project
+    git clone https://github.com/flmorg/cleanuperr.git
+    cd cleanuperr
+
+    # build and publish the app
+    dotnet publish code/Executable/Executable.csproj -c Release --self-contained -o artifacts /p:PublishSingleFile=true
+
+    # move the files to permanent destination
+    mv artifacts/cleanuperr /example/directory/
+    mv artifacts/appsettings.json /example/directory/
+    ```
+3. Edit **appsettings.json**. The paths from this json file correspond with the docker env vars, as described [here](#environment-variables).
+4. Run the app:
+    ```
+    cd /example/directory
+    chmod +x cleanuperr
+    ./cleanuperr
+    ```
+
 # Credits
 Special thanks for inspiration go to:
 - [ThijmenGThN/swaparr](https://github.com/ThijmenGThN/swaparr)

blacklist_permissive

@@ -1,4 +1,5 @@
 *.apk
+*.arj
 *.bat
 *.bin
 *.bmp

code/Common/Enums/DownloadClient.cs

@@ -5,5 +5,6 @@ public enum DownloadClient
     QBittorrent,
     Deluge,
     Transmission,
-    None
+    None,
+    Disabled
 }

code/Executable/Program.cs

@@ -9,4 +9,7 @@ builder.Logging.AddLogging(builder.Configuration);
 var host = builder.Build();
 host.Init();
 
-host.Run();
+host.Run();
+
+
+

code/Infrastructure/Verticals/ContentBlocker/ContentBlocker.cs

@@ -55,9 +55,9 @@ public sealed class ContentBlocker : GenericHandler
 
     public override async Task ExecuteAsync()
     {
-        if (_downloadClientConfig.DownloadClient is Common.Enums.DownloadClient.None)
+        if (_downloadClientConfig.DownloadClient is Common.Enums.DownloadClient.None or Common.Enums.DownloadClient.Disabled)
         {
-            _logger.LogWarning("download client is set to none");
+            _logger.LogWarning("download client is not set");
             return;
         }
         

code/Infrastructure/Verticals/DownloadCleaner/DownloadCleaner.cs

@@ -50,9 +50,9 @@ public sealed class DownloadCleaner : GenericHandler
     
     public override async Task ExecuteAsync()
     {
-        if (_downloadClientConfig.DownloadClient is Common.Enums.DownloadClient.None)
+        if (_downloadClientConfig.DownloadClient is Common.Enums.DownloadClient.None or Common.Enums.DownloadClient.Disabled)
         {
-            _logger.LogWarning("download client is set to none");
+            _logger.LogWarning("download client is not set");
             return;
         }
         

code/Infrastructure/Verticals/DownloadClient/DownloadServiceFactory.cs

@@ -25,6 +25,7 @@ public sealed class DownloadServiceFactory
             Common.Enums.DownloadClient.Deluge => _serviceProvider.GetRequiredService<DelugeService>(),
             Common.Enums.DownloadClient.Transmission => _serviceProvider.GetRequiredService<TransmissionService>(),
             Common.Enums.DownloadClient.None => _serviceProvider.GetRequiredService<DummyDownloadService>(),
+            Common.Enums.DownloadClient.Disabled => _serviceProvider.GetRequiredService<DummyDownloadService>(),
             _ => throw new ArgumentOutOfRangeException()
         };
 }

code/Infrastructure/Verticals/QueueCleaner/QueueCleaner.cs

@@ -93,7 +93,7 @@ public sealed class QueueCleaner : GenericHandler
 
                 StalledResult stalledCheckResult = new();
 
-                if (record.Protocol is "torrent")
+                if (record.Protocol is "torrent" && _downloadClientConfig.DownloadClient is not Common.Enums.DownloadClient.Disabled)
                 {
                     if (_downloadClientConfig.DownloadClient is Common.Enums.DownloadClient.None)
                     {

variables.md

@@ -135,7 +135,7 @@
 - Required: No.
 
 > [!WARNING]
-> Setting `QUEUECLEANER__IMPORT_FAILED_DELETE_PRIVATE=true` means you don't care about seeding, ratio, H&R and potentially losing your tracker account.
+> Setting `QUEUECLEANER__IMPORT_FAILED_DELETE_PRIVATE=true` means you don't care about seeding, ratio, H&R and potentially losing your private tracker account.
 
 #### **`QUEUECLEANER__IMPORT_FAILED_IGNORE_PATTERNS`**
 - Patterns to look for in failed import messages that should be ignored.
@@ -182,7 +182,7 @@
 - Required: No.
 
 > [!WARNING]
-> Setting `QUEUECLEANER__STALLED_DELETE_PRIVATE=true` means you don't care about seeding, ratio, H&R and potentially losing your tracker account.
+> Setting `QUEUECLEANER__STALLED_DELETE_PRIVATE=true` means you don't care about seeding, ratio, H&R and potentially losing your private tracker account.
 
 #
 
@@ -246,7 +246,7 @@
 - Required: No.
 
 > [!WARNING]
-> Setting `CONTENTBLOCKER__DELETE_PRIVATE=true` means you don't care about seeding, ratio, H&R and potentially losing your tracker account.
+> Setting `CONTENTBLOCKER__DELETE_PRIVATE=true` means you don't care about seeding, ratio, H&R and potentially losing your private tracker account.
 
 #
 
@@ -302,7 +302,7 @@
 - Required: No.
 
 > [!WARNING]
-> Setting `DOWNLOADCLEANER__DELETE_PRIVATE=true` means you don't care about seeding, ratio, H&R and potentially losing your tracker account.
+> Setting `DOWNLOADCLEANER__DELETE_PRIVATE=true` means you don't care about seeding, ratio, H&R and potentially losing your private tracker account.
 
 #### **`DOWNLOADCLEANER__CATEGORIES__0__NAME`**
 - Name of the category to clean.
@@ -360,13 +360,18 @@
 #### **`DOWNLOAD_CLIENT`**
 - Specifies which download client is used by *arrs.
 - Type: String.
-- Possible values: `none`, `qbittorrent`, `deluge`, `transmission`.
+- Possible values: `none`, `qbittorrent`, `deluge`, `transmission`, `disabled`.
 - Default: `none`
 - Required: No.
 
 > [!NOTE]
 > Only one download client can be enabled at a time. If you have more than one download client, you should deploy multiple instances of cleanuperr.
 
+> [!IMPORTANT]
+> When the download client is set to `disabled`, the queue cleaner will be able to remove items that are failed to be imported even if there is no download client configured. This means that all downloads, including private ones, will be completely removed.
+>
+> Setting `DOWNLOAD_CLIENT=disabled` means you don't care about seeding, ratio, H&R and potentially losing your private tracker account.
+
 #### **`QBITTORRENT__URL`**
 - URL of the qBittorrent instance.
 - Type: String.