Merge pull request #279 from Baretsky:add-sabnzbd-support

Add sabnzbd support

Author: ManiMatter

README.md

@@ -47,6 +47,7 @@ Looking to **upgrade from V1 to V2**? Look [here](#upgrading-from-v1-to-v2)
     - [WHISPARR](#whisparr)
   - [Downloaders](#download-clients)
     - [QBITTORRENT](#qbittorrent)
+    - [SABNZBD](#sabnzbd)
 - [Disclaimer](#disclaimer)
 
 ## Overview
@@ -518,10 +519,13 @@ This is the interesting section. It defines which job you want decluttarr to run
 -   Steers whether slow downloads are removed from the queue
 -   Blocklisted: Yes
 -   Note: 
-      - Does not apply to usenet downloads (since there users pay for certain speed, slowness should not occur)
-      - Applies only if qBittorrent is configured: The remove_slow check is automatically temporarily disabled if qBittorrent is already using more than 80% of your available download bandwidth.
-        For this to work, you must set a Global Download Rate Limit in qBittorrent. Otherwise, unlimited capacity is assumed, and the auto-disable feature will never trigger.
-        Make sure to configure the limit in the correct place — either the standard or the alternative limits, depending on which one is active in your setup.
+      Radarr, Sonarr, etc. only update the info about progress and speed of the queue items periodically.
+      Therefore, relying only on that information is imprecise to establish whether a download is slow.
+      It is advised that you configure qBittorrent (for torrents) and or SABnzbd (for Usenet), so that decluttarr can query those information real-time.
+      - Additional benefit when having qBittorrent configured:
+        - The remove_slow check is automatically temporarily disabled if qBittorrent is already using more than 80% of your available download bandwidth.
+        - For this to work, you must set a Global Download Rate Limit in qBittorrent. Otherwise, unlimited capacity is assumed, and the auto-disable feature will never trigger.
+        - Make sure to configure the limit in the correct place — either the standard or the alternative limits, depending on which one is active in your setup.
 -   Type: Boolean or Dict
 -   Permissible Values: 
       If bool: True, False 
@@ -602,7 +606,7 @@ Defines arr-instances on which download queue should be decluttered
 Certain jobs need access directly to the download clients, as the arr instances don't offer all the relevant APIs / data.
 You can perfectly use decluttarr without this; just certain features won't be available (as documented above).
 
-For time being, only qbittorrent is supported.
+Supported download clients: **qBittorrent** and **SABnzbd**.
 
 #### QBITTORRENT
 -   List of qbittorrent instances
@@ -613,6 +617,14 @@ For time being, only qbittorrent is supported.
     - password: Optional - see above
     - name: Optional. Needs to correspond with the name that you have set up in your Arr instance. Defaults to "qBittorrent"
 
+#### SABNZBD
+-   List of SABnzbd instances
+-   Type: List of SABnzbd instances
+-   Keys per instance
+    - base_url: URL under which SABnzbd can be reached (mandatory)
+    - api_key: SABnzbd API key (mandatory)
+    - name: Optional. Needs to correspond with the name that you have set up in your Arr instance. Defaults to "SABnzbd"
+
 
 ## Disclaimer
 

config/config_example.yaml

@@ -66,3 +66,7 @@ download_clients:
       # username: xxxx # (optional -> if not provided, assuming not needed)
       # password: xxxx # (optional -> if not provided, assuming not needed)
       # name: "qBittorrent" # (optional -> if not provided, assuming "qBittorrent". Must correspond with what is specified in your *arr as download client name)
+  # sabnzbd:
+  #   - base_url: "http://sabnzbd:8080" # SABnzbd server URL
+  #     api_key: "your_api_key_here" # (required -> SABnzbd API key)
+  #     # name: "SABnzbd" # (optional -> if not provided, assuming "SABnzbd". Must correspond with what is specified in your *arr as download client name)

main.py

@@ -44,7 +44,7 @@ async def main():
     while True:
         logger.info("-" * 50)
 
-        # Refresh qBit Cookies
+        # Refresh qBit Cookies (SABnzbd doesn't need cookie refresh)
         for qbit in settings.download_clients.qbittorrent:
             await qbit.refresh_cookie()
 

src/job_manager.py

@@ -35,7 +35,7 @@ async def removal_jobs(self):
         if not await self._queue_has_items():
             return
 
-        if not await self._qbit_connected():
+        if not await self._download_clients_connected():
             return
 
         # Refresh trackers
@@ -57,11 +57,17 @@ async def search_jobs(self):
             return
         if self.settings.jobs.search_missing.enabled:
             await SearchHandler(
-                arr=self.arr, settings=self.settings, missing_or_cutoff="missing", job_name="search_missing"
+                arr=self.arr,
+                settings=self.settings,
+                missing_or_cutoff="missing",
+                job_name="search_missing",
             ).handle_search()
         if self.settings.jobs.search_unmet_cutoff.enabled:
             await SearchHandler(
-                arr=self.arr, settings=self.settings, missing_or_cutoff="cutoff", job_name="search_cutoff_unmet"
+                arr=self.arr,
+                settings=self.settings,
+                missing_or_cutoff="cutoff",
+                job_name="search_cutoff_unmet",
             ).handle_search()
 
     async def _queue_has_items(self):
@@ -81,16 +87,22 @@ async def _queue_has_items(self):
         logger.verbose("Removal Jobs: None triggered (Queue is empty)")
         return False
 
-    async def _qbit_connected(self):
-        for qbit in self.settings.download_clients.qbittorrent:
+    async def _download_clients_connected(self):
+        for clients in [
+            self.settings.download_clients.qbittorrent,
+            self.settings.download_clients.sabnzbd,
+        ]:
+            if not await self._check_client_connection_status(clients):
+                return False
+        return True
+
+    async def _check_client_connection_status(self, clients):
+        for client in clients:
             logger.debug(
-                f"job_manager.py/_queue_has_items (Before any removal jobs): Checking if qbit is connected to the internet"
+                f"job_manager.py/_check_client_connection_status: Checking if {client.name} is connected"
             )
-            # Check if any client is disconnected
-            if not await qbit.check_qbit_connected():
-                logger.warning(
-                    f">>> qBittorrent is disconnected. Skipping queue cleaning on {self.arr.name}.",
-                )
+            if not await client.check_connected():
+                logger.warning(f">>> {client.name} is disconnected. Skipping queue cleaning on {self.arr.name}.")
                 return False
         return True
 

src/jobs/remove_bad_files.py

@@ -42,6 +42,10 @@ async def _find_affected_items(self):
             if download_client_type == "qbittorrent":
                 client_items = await self._handle_qbit(download_client, download_ids)
                 affected_items.extend(client_items)
+            elif download_client_type == "sabnzbd":
+                # SABnzbd doesn't support bad file removal in the same way as BitTorrent
+                # Usenet doesn't have the concept of "availability" or individual file selection
+                continue
         return affected_items
 
     def _group_download_ids_by_client(self):

src/jobs/remove_slow.py

@@ -29,10 +29,6 @@ async def _find_affected_items(self):
             if self._not_downloading(item):
                 continue
 
-            # Is Usenet -> skip
-            if self._is_usenet(item):
-                continue  # No need to check for speed for usenet, since there users pay for speed
-
             # Completed but stuck -> skip
             if self._is_completed_but_stuck(item):
                 logger.info(
@@ -75,9 +71,6 @@ def _missing_keys(item) -> bool:
         required_keys = {"downloadId", "size", "sizeleft", "status", "protocol", "download_client", "download_client_type"}
         return not required_keys.issubset(item)
 
-    @staticmethod
-    def _is_usenet(item) -> bool:
-        return item.get("protocol") == "usenet"
 
     @staticmethod
     def _not_downloading(item) -> bool:
@@ -98,19 +91,35 @@ async def _get_progress_stats(self, item):
             download_id, download_progress,
         )
 
+        # For SABnzbd, use calculated speed from API data
+        if item["download_client_type"] == "sabnzbd":
+            try:
+                api_speed = await item["download_client"].get_item_download_speed(download_id)
+                if api_speed is not None:
+                    speed = api_speed
+                    logger.debug(f"SABnzbd API speed for {item['title']}: {speed} KB/s")
+            except Exception as e:  # noqa: BLE001
+                logger.debug(f"SABnzbd get_item_download_speed failed: {e}")
         self.arr.tracker.download_progress[download_id] = download_progress
         return download_progress, previous_progress, increment, speed
 
 
     async def _get_download_progress(self, item, download_id):
-        # Grabs the progress from qbit if possible, else calculates it based on progress (imprecise)
+        # Grabs the progress from qbit or SABnzbd if possible, else calculates it based on progress (imprecise)
         if item["download_client_type"] == "qbittorrent":
             try:
                 progress = await item["download_client"].fetch_download_progress(download_id)
                 if progress is not None:
                     return progress
             except Exception:  # noqa: BLE001
                 pass  # fall back below
+        elif item["download_client_type"] == "sabnzbd":
+            try:
+                progress = await item["download_client"].fetch_download_progress(download_id)
+                if progress is not None:
+                    return progress
+            except Exception:  # noqa: BLE001
+                pass  # fall back below
         return item["size"] - item["sizeleft"]
 
     def _compute_increment_and_speed(self, download_id, current_progress):
@@ -135,6 +144,7 @@ def _high_bandwidth_usage(self, item):
             if download_client.bandwidth_usage > DISABLE_OVER_BANDWIDTH_USAGE:
                 self.strikes_handler.pause_entry(download_id, "High Bandwidth Usage")
                 return True
+        # SABnzbd: Bandwidth checking isn't applicable to usenet usage
 
         return False
 
@@ -157,4 +167,5 @@ async def update_bandwidth_usage(self):
                 continue
             if item["download_client_type"] == "qbittorrent":
                 await download_client.set_bandwidth_usage()
+            # SABnzbd: Since bandwith checking isn't applicable, setting bandwidth usage is irrelevant
             processed_clients.add(item["download_client"])

src/settings/_constants.py

@@ -35,6 +35,7 @@ class MinVersions:
     readarr = "0.4.15.2787"
     whisparr = "2.0.0.548"
     qbittorrent = "4.3.0"
+    sabnzbd = "4.0.0"
 
 
 class FullQueueParameter:

src/settings/_download_clients.py

@@ -1,16 +1,19 @@
 from src.settings._config_as_yaml import get_config_as_yaml
 from src.settings._download_clients_qbit import QbitClients
+from src.settings._download_clients_sabnzbd import SabnzbdClients
 
-DOWNLOAD_CLIENT_TYPES = ["qbittorrent"]
+DOWNLOAD_CLIENT_TYPES = ["qbittorrent", "sabnzbd"]
 
 
 class DownloadClients:
     """Represents all download clients."""
 
     qbittorrent = None
+    sabnzbd = None
 
     def __init__(self, config, settings):
         self._set_qbit_clients(config, settings)
+        self._set_sabnzbd_clients(config, settings)
         self.check_unique_download_client_types()
 
     def _set_qbit_clients(self, config, settings):
@@ -28,11 +31,18 @@ def _set_qbit_clients(self, config, settings):
                 ]:
                     setattr(settings.general, key, None)
 
+    def _set_sabnzbd_clients(self, config, settings):
+        download_clients = config.get("download_clients", {})
+        if isinstance(download_clients, dict):
+            self.sabnzbd = SabnzbdClients(config, settings)
+        if not self.sabnzbd:
+            self.sabnzbd = SabnzbdClients({}, settings)  # Initialize empty list
+
     def config_as_yaml(self):
         """Log all download clients."""
         return get_config_as_yaml(
-            {"qbittorrent": self.qbittorrent},
-            sensitive_attributes={"username", "password", "cookie"},
+            {"qbittorrent": self.qbittorrent, "sabnzbd": self.sabnzbd},
+            sensitive_attributes={"username", "password", "cookie", "api_key"},
             internal_attributes={"api_url", "cookie", "settings", "min_version"},
             hide_internal_attr=True,
         )
@@ -101,7 +111,7 @@ def get_download_client_type_from_implementation(
         """
         mapping = {
             "QBittorrent": "qbittorrent",
-            # Only qbit configured for now
+            "SABnzbd": "sabnzbd",
         }
         download_client_type = mapping.get(arr_download_client_implementation)
         return download_client_type

src/settings/_download_clients_qbit.py

@@ -220,7 +220,7 @@ async def check_qbit_reachability(self):
             logger.error(f"-- | qBittorrent\n❗️ {e}\n{tip}\n")
             wait_and_exit()
 
-    async def check_qbit_connected(self):
+    async def check_connected(self):
         """Check if the qBittorrent is connected to internet."""
         logger.debug(
             "_download_clients_qBit.py/check_qbit_reachability: Checking if qbit is connected to the internet"