qBitrr2 4.10.15__py3-none-any.whl → 5.4.5__py3-none-any.whl

qBitrr/main.py

@@ -1,12 +1,17 @@
 from __future__ import annotations
 
 import atexit
-import itertools
+import contextlib
+import glob
 import logging
-import pathlib
+import os
 import sys
 import time
-from multiprocessing import freeze_support
+from multiprocessing import Event, freeze_support
+from queue import SimpleQueue
+from threading import Event as ThreadEvent
+from threading import Thread
+from time import monotonic
 
 import pathos
 import qbittorrentapi
@@ -14,86 +19,90 @@ import requests
 from packaging import version as version_parser
 from packaging.version import Version as VersionClass
 from qbittorrentapi import APINames
-from qbittorrentapi.decorators import login_required  # , response_text
 
-from qBitrr.arss import ArrManager
+from qBitrr.auto_update import AutoUpdater, perform_self_update
 from qBitrr.bundled_data import patched_version
 from qBitrr.config import (
-    APPDATA_FOLDER,
     CONFIG,
     CONFIG_EXISTS,
-    ENABLE_LOGS,
     QBIT_DISABLED,
     SEARCH_ONLY,
+    get_auto_update_settings,
     process_flags,
 )
 from qBitrr.env_config import ENVIRO_CONFIG
 from qBitrr.ffprobe import FFprobeDownloader
-from qBitrr.home_path import HOME_PATH
+from qBitrr.home_path import APPDATA_FOLDER
 from qBitrr.logger import run_logs
-from qBitrr.utils import ExpiringSet, absolute_file_paths
+from qBitrr.utils import ExpiringSet
+from qBitrr.versioning import fetch_latest_release
+from qBitrr.webui import WebUI
 
 if CONFIG_EXISTS:
     from qBitrr.arss import ArrManager
 else:
     sys.exit(0)
 
-CHILD_PROCESSES = []
-
 logger = logging.getLogger("qBitrr")
-# if ENABLE_LOGS:
-#     logs_folder = HOME_PATH.joinpath("logs")
-#     logs_folder.mkdir(parents=True, exist_ok=True)
-#     logs_folder.chmod(mode=0o777)
-#     logfile = logs_folder.joinpath("qBitrr.log")
-#     if pathlib.Path(logfile).is_file():
-#         logold = logs_folder.joinpath( "qBitrr.log.old")
-#         if pathlib.Path(logold).exists():
-#             logold.unlink()
-#         logfile.rename(logold)
-#     fh = logging.FileHandler(logfile)
-#     logger.addHandler(fh)
-run_logs(logger)
+run_logs(logger, "Main")
+
+
+def _mask_secret(value: str | None) -> str:
+    return "[redacted]" if value else ""
+
+
+def _delete_all_databases() -> None:
+    """
+    Delete all database files from the APPDATA_FOLDER on startup.
+
+    This includes:
+    - All .db files (SQLite databases)
+    - All .db-wal files (Write-Ahead Log files)
+    - All .db-shm files (Shared Memory files)
+    """
+    db_patterns = ["*.db", "*.db-wal", "*.db-shm"]
+    deleted_files = []
+
+    for pattern in db_patterns:
+        for db_file in glob.glob(str(APPDATA_FOLDER.joinpath(pattern))):
+            try:
+                os.remove(db_file)
+                deleted_files.append(os.path.basename(db_file))
+            except Exception as e:
+                logger.error("Failed to delete database file %s: %s", db_file, e)
+
+    if deleted_files:
+        logger.info("Deleted database files on startup: %s", ", ".join(deleted_files))
+    else:
+        logger.debug("No database files found to delete on startup")
 
 
 class qBitManager:
     min_supported_version = VersionClass("4.3.9")
     soft_not_supported_supported_version = VersionClass("4.4.4")
-    max_supported_version = VersionClass("4.6.7")
+    # max_supported_version = VersionClass("5.1.2")
     _head_less_mode = False
 
     def __init__(self):
         self._name = "Manager"
+        self.shutdown_event = Event()
         self.qBit_Host = CONFIG.get("qBit.Host", fallback="localhost")
         self.qBit_Port = CONFIG.get("qBit.Port", fallback=8105)
         self.qBit_UserName = CONFIG.get("qBit.UserName", fallback=None)
         self.qBit_Password = CONFIG.get("qBit.Password", fallback=None)
-        self.qBit_v5 = CONFIG.get("qBit.v5", fallback=False)
         self.logger = logging.getLogger(f"qBitrr.{self._name}")
-        if ENABLE_LOGS:
-            logs_folder = HOME_PATH.joinpath("logs")
-            logs_folder.mkdir(parents=True, exist_ok=True)
-            logs_folder.chmod(mode=0o777)
-            logfile = logs_folder.joinpath(self._name + ".log")
-            if pathlib.Path(logfile).is_file():
-                logold = logs_folder.joinpath(self._name + ".log.old")
-                if pathlib.Path(logold).exists():
-                    logold.unlink()
-                logfile.rename(logold)
-            fh = logging.FileHandler(logfile)
-            self.logger.addHandler(fh)
-        run_logs(self.logger)
+        run_logs(self.logger, self._name)
         self.logger.debug(
             "qBitTorrent Config: Host: %s Port: %s, Username: %s, Password: %s",
             self.qBit_Host,
             self.qBit_Port,
             self.qBit_UserName,
-            self.qBit_Password,
+            _mask_secret(self.qBit_Password),
         )
         self._validated_version = False
         self.client = None
         self.current_qbit_version = None
-        if not any([QBIT_DISABLED, SEARCH_ONLY]):
+        if not (QBIT_DISABLED or SEARCH_ONLY):
             self.client = qbittorrentapi.Client(
                 host=self.qBit_Host,
                 port=self.qBit_Port,
@@ -104,41 +113,292 @@ class qBitManager:
             try:
                 self.current_qbit_version = version_parser.parse(self.client.app_version())
                 self._validated_version = True
-            except BaseException:
+            except Exception as e:
                 self.current_qbit_version = self.min_supported_version
                 self.logger.error(
-                    "Could not establish qBitTorrent version, "
-                    "you may experience errors, please report this error."
+                    "Could not establish qBitTorrent version (%s). You may experience errors; please report this.",
+                    e,
                 )
             self._version_validator()
         self.expiring_bool = ExpiringSet(max_age_seconds=10)
         self.cache = {}
         self.name_cache = {}
         self.should_delay_torrent_scan = False  # If true torrent scan is delayed by 5 minutes.
-        self.child_processes = []
+        self.child_processes: list[pathos.helpers.mp.Process] = []
+        self._process_registry: dict[pathos.helpers.mp.Process, dict[str, str]] = {}
+        self.auto_updater = None
+        self.arr_manager = None
+        self._bootstrap_ready = ThreadEvent()
+        self._startup_thread: Thread | None = None
+        self._restart_requested = False
+        self._restart_thread: Thread | None = None
         self.ffprobe_downloader = FFprobeDownloader()
         try:
-            if not any([QBIT_DISABLED, SEARCH_ONLY]):
+            if not (QBIT_DISABLED or SEARCH_ONLY):
                 self.ffprobe_downloader.update()
         except Exception as e:
             self.logger.error(
                 "FFprobe manager error: %s while attempting to download/update FFprobe", e
             )
-        self.arr_manager = ArrManager(self).build_arr_instances()
-        run_logs(self.logger)
+        # Start WebUI as early as possible
+        try:
+            web_port = int(CONFIG.get("WebUI.Port", fallback=6969) or 6969)
+        except Exception:
+            web_port = 6969
+        web_host = CONFIG.get("WebUI.Host", fallback="127.0.0.1") or "127.0.0.1"
+        if os.environ.get("QBITRR_DOCKER_RUNNING") == "69420" and web_host in {
+            "127.0.0.1",
+            "localhost",
+        }:
+            web_host = "0.0.0.0"
+        if web_host in {"0.0.0.0", "::"}:
+            self.logger.warning(
+                "WebUI host configured for %s; ensure exposure is intentional and protected.",
+                web_host,
+            )
+        self.webui = WebUI(self, host=web_host, port=web_port)
+        self.webui.start()
+
+        # Finish bootstrap tasks (Arr manager, workers, auto-update) in the background
+        self._startup_thread = Thread(
+            target=self._complete_startup, name="qBitrr-Startup", daemon=True
+        )
+        self._startup_thread.start()
+
+    def configure_auto_update(self) -> None:
+        enabled, cron = get_auto_update_settings()
+        if self.auto_updater:
+            self.auto_updater.stop()
+            self.auto_updater = None
+        if not enabled:
+            self.logger.debug("Auto update is disabled")
+            return
+        updater = AutoUpdater(cron, self._perform_auto_update, self.logger)
+        if updater.start():
+            self.auto_updater = updater
+        else:
+            self.logger.error("Auto update could not be scheduled; leaving it disabled")
+
+    def _perform_auto_update(self) -> None:
+        """Check for updates and apply if available."""
+        self.logger.notice("Checking for updates...")
+
+        # Fetch latest release info from GitHub
+        release_info = fetch_latest_release()
+
+        if release_info.get("error"):
+            self.logger.error("Auto update skipped: %s", release_info["error"])
+            return
+
+        # Use normalized version for comparison, raw tag for display
+        target_version = release_info.get("normalized")
+        raw_tag = release_info.get("raw_tag")
+
+        if not release_info.get("update_available"):
+            if target_version:
+                self.logger.info(
+                    "Auto update skipped: already running the latest release (%s).",
+                    raw_tag or target_version,
+                )
+            else:
+                self.logger.info("Auto update skipped: no new release detected.")
+            return
+
+        # Detect installation type
+        from qBitrr.auto_update import get_installation_type
+
+        install_type = get_installation_type()
+
+        self.logger.notice(
+            "Update available: %s -> %s (installation: %s)",
+            patched_version,
+            raw_tag or target_version,
+            install_type,
+        )
+
+        # Perform the update with specific version
+        updated = perform_self_update(self.logger, target_version=target_version)
+
+        if not updated:
+            if install_type == "binary":
+                # Binary installations require manual update, this is expected
+                self.logger.info("Manual update required for binary installation")
+            else:
+                self.logger.error("Auto update failed; manual intervention may be required.")
+            return
+
+        # Verify update success (git/pip only)
+        if target_version and install_type != "binary":
+            from qBitrr.auto_update import verify_update_success
+
+            if verify_update_success(target_version, self.logger):
+                self.logger.notice("Update verified successfully")
+            else:
+                self.logger.warning(
+                    "Update completed but version verification failed. "
+                    "The system may not be running the expected version."
+                )
+                # Continue with restart anyway (Phase 1 approach)
+
+        self.logger.notice("Update applied successfully; restarting to load the new version.")
+        self.request_restart()
+
+    def request_restart(self, delay: float = 3.0) -> None:
+        if self._restart_requested:
+            return
+        self._restart_requested = True
+
+        def _restart():
+            if delay > 0:
+                time.sleep(delay)
+            self.logger.notice("Restarting qBitrr...")
+
+            # Set shutdown event to signal all loops to stop
+            try:
+                self.shutdown_event.set()
+            except Exception:
+                pass
+
+            # Wait for child processes to exit gracefully
+            for proc in list(self.child_processes):
+                with contextlib.suppress(Exception):
+                    proc.join(timeout=5)
+
+            # Force kill any remaining child processes
+            for proc in list(self.child_processes):
+                with contextlib.suppress(Exception):
+                    proc.kill()
+                with contextlib.suppress(Exception):
+                    proc.terminate()
+
+            # Close database connections explicitly
+            try:
+                if hasattr(self, "arr_manager") and self.arr_manager:
+                    for arr in self.arr_manager.managed_objects.values():
+                        if hasattr(arr, "db") and arr.db:
+                            with contextlib.suppress(Exception):
+                                arr.db.close()
+            except Exception:
+                pass
+
+            # Flush all log handlers
+            try:
+                for handler in logging.root.handlers[:]:
+                    with contextlib.suppress(Exception):
+                        handler.flush()
+                        handler.close()
+            except Exception:
+                pass
+
+            # Prepare restart arguments
+            python = sys.executable
+            args = [python] + sys.argv
+
+            self.logger.notice("Executing restart: %s", " ".join(args))
+
+            # Flush logs one final time before exec
+            try:
+                for handler in self.logger.handlers[:]:
+                    with contextlib.suppress(Exception):
+                        handler.flush()
+            except Exception:
+                pass
+
+            # Replace current process with new instance
+            # This works in Docker, native installs, and systemd
+            try:
+                os.execv(python, args)
+            except Exception as e:
+                # If execv fails, fall back to exit and hope external supervisor restarts us
+                self.logger.critical("Failed to restart via execv: %s. Exiting instead.", e)
+                os._exit(1)
+
+        self._restart_thread = Thread(target=_restart, name="qBitrr-Restart", daemon=True)
+        self._restart_thread.start()
+
+    def _prepare_arr_processes(self, arr, timeout_seconds: int = 30) -> None:
+        timeout = max(
+            1, int(CONFIG.get("Settings.ProcessSpawnTimeoutSeconds", fallback=timeout_seconds))
+        )
+        result_queue: SimpleQueue = SimpleQueue()
+
+        def _stage():
+            try:
+                result_queue.put((True, arr.spawn_child_processes()))
+            except Exception as exc:  # pragma: no cover - defensive logging
+                result_queue.put((False, exc))
+
+        spawn_thread = Thread(
+            target=_stage,
+            name=f"spawn-{getattr(arr, 'category', getattr(arr, '_name', 'arr'))}",
+            daemon=True,
+        )
+        spawn_thread.start()
+        spawn_thread.join(timeout)
+        if spawn_thread.is_alive():
+            self.logger.error(
+                "Timed out initialising worker processes for %s after %ss; skipping this instance.",
+                getattr(arr, "_name", getattr(arr, "category", "unknown")),
+                timeout,
+            )
+            return
+        if result_queue.empty():
+            self.logger.error(
+                "No startup result returned for %s; skipping this instance.",
+                getattr(arr, "_name", getattr(arr, "category", "unknown")),
+            )
+            return
+        success, payload = result_queue.get()
+        if not success:
+            self.logger.exception(
+                "Failed to initialise worker processes for %s",
+                getattr(arr, "_name", getattr(arr, "category", "unknown")),
+                exc_info=payload,
+            )
+            return
+        worker_count, processes = payload
+        if not worker_count:
+            return
+        for proc in processes:
+            role = "search" if getattr(arr, "process_search_loop", None) is proc else "torrent"
+            self._process_registry[proc] = {
+                "category": getattr(arr, "category", ""),
+                "name": getattr(arr, "_name", getattr(arr, "category", "")),
+                "role": role or "worker",
+            }
+        self.logger.debug(
+            "Prepared %s worker(s) for %s",
+            worker_count,
+            getattr(arr, "_name", getattr(arr, "category", "unknown")),
+        )
+
+    def _complete_startup(self) -> None:
+        started_at = monotonic()
+        try:
+            arr_manager = ArrManager(self)
+            self.arr_manager = arr_manager
+            arr_manager.build_arr_instances()
+            run_logs(self.logger)
+            for arr in arr_manager.managed_objects.values():
+                self._prepare_arr_processes(arr)
+            self.configure_auto_update()
+            elapsed = monotonic() - started_at
+            self.logger.info("Background startup completed in %.1fs", elapsed)
+        except Exception:
+            self.logger.exception(
+                "Background startup encountered an error; continuing with partial functionality."
+            )
+        finally:
+            self._bootstrap_ready.set()
 
     def _version_validator(self):
         validated = False
-        if self.qBit_v5:
-            if self.min_supported_version <= self.current_qbit_version:
-                validated = True
-        else:
-            if (
-                self.min_supported_version
-                <= self.current_qbit_version
-                <= self.max_supported_version
-            ):
-                validated = True
+        if (
+            self.min_supported_version
+            <= self.current_qbit_version
+            # <= self.max_supported_version
+        ):
+            validated = True
 
         if self._validated_version and validated:
             self.logger.info(
@@ -149,19 +409,18 @@ class qBitManager:
                 "Could not validate current qBitTorrent version, assuming: %s",
                 self.current_qbit_version,
             )
-            time.sleep(10)
         else:
             self.logger.critical(
-                "You are currently running qBitTorrent version %s, "
-                "Supported version range is %s to < %s",
+                "You are currently running qBitTorrent version %s which is not supported by qBitrr.",
+                # "Supported version range is %s to < %s",
                 self.current_qbit_version,
-                self.min_supported_version,
-                self.max_supported_version,
+                # self.min_supported_version,
+                # self.max_supported_version,
             )
             sys.exit(1)
 
     # @response_text(str)
-    @login_required
+    # @login_required
     def app_version(self, **kwargs):
         return self.client._get(
             _name=APINames.Application,
@@ -171,10 +430,18 @@ class qBitManager:
             **kwargs,
         )
 
+    def transfer_info(self, **kwargs):
+        """Proxy transfer info requests to the underlying qBittorrent client."""
+        if self.client is None:
+            return {"connection_status": "disconnected"}
+        return self.client.transfer_info(**kwargs)
+
     @property
     def is_alive(self) -> bool:
         try:
-            if 1 in self.expiring_bool or self.client is None:
+            if self.client is None:
+                return False
+            if 1 in self.expiring_bool:
                 return True
             self.client.app_version()
             self.logger.trace("Successfully connected to %s:%s", self.qBit_Host, self.qBit_Port)
@@ -185,44 +452,147 @@ class qBitManager:
         self.should_delay_torrent_scan = True
         return False
 
-    def get_child_processes(self) -> list[pathos.helpers.mp.Process]:
-        run_logs(self.logger)
-        self.logger.debug("Managing %s categories", len(self.arr_manager.managed_objects))
-        count = 0
-        procs = []
-        for arr in self.arr_manager.managed_objects.values():
-            numb, processes = arr.spawn_child_processes()
-            count += numb
-            procs.extend(processes)
-        return procs
-
-    def run(self):
+    def get_child_processes(self, timeout: float = 60.0) -> list[pathos.helpers.mp.Process]:
+        if not self._bootstrap_ready.wait(timeout):
+            self.logger.warning(
+                "Background startup did not finish within %.1fs. Continuing with the services currently available.",
+                timeout,
+            )
+        return list(self.child_processes)
+
+    def run(self) -> None:
         try:
-            self.logger.debug("Starting %s child processes", len(self.child_processes))
-            [p.start() for p in self.child_processes]
-            [p.join() for p in self.child_processes]
+            if not self._bootstrap_ready.wait(60.0):
+                self.logger.warning(
+                    "Startup thread still running after 60s; managing available workers."
+                )
+            for proc in list(self.child_processes):
+                try:
+                    proc.start()
+                    meta = self._process_registry.get(proc, {})
+                    self.logger.debug(
+                        "Started %s worker for category '%s'",
+                        meta.get("role", "worker"),
+                        meta.get("category", "unknown"),
+                    )
+                except Exception as exc:
+                    self.logger.exception(
+                        "Failed to start worker process %s",
+                        getattr(proc, "name", repr(proc)),
+                        exc_info=exc,
+                    )
+            while not self.shutdown_event.is_set():
+                any_alive = False
+                for proc in list(self.child_processes):
+                    if proc.is_alive():
+                        any_alive = True
+                        continue
+                    exit_code = proc.exitcode
+                    if exit_code is None:
+                        continue
+                    meta = self._process_registry.pop(proc, {})
+                    with contextlib.suppress(ValueError):
+                        self.child_processes.remove(proc)
+                    self.logger.warning(
+                        "Worker process exited (role=%s, category=%s, code=%s)",
+                        meta.get("role", "unknown"),
+                        meta.get("category", "unknown"),
+                        exit_code,
+                    )
+                if not self.child_processes:
+                    if not any_alive:
+                        break
+                self.shutdown_event.wait(timeout=5)
+                if not any(proc.is_alive() for proc in self.child_processes):
+                    if self.child_processes:
+                        continue
+                    break
         except KeyboardInterrupt:
             self.logger.info("Detected Ctrl+C - Terminating process")
             sys.exit(0)
         except BaseException as e:
-            self.logger.info("Detected Ctrl+C - Terminating process: %r", e)
+            self.logger.info("Detected unexpected error, shutting down: %r", e)
             sys.exit(1)
+        finally:
+            for proc in list(self.child_processes):
+                if proc.is_alive():
+                    proc.join(timeout=1)
+
+
+def _report_config_issues():
+    try:
+        issues = []
+        # Check required settings
+        from qBitrr.config import COMPLETED_DOWNLOAD_FOLDER, CONFIG, FREE_SPACE, FREE_SPACE_FOLDER
+
+        if not COMPLETED_DOWNLOAD_FOLDER or str(COMPLETED_DOWNLOAD_FOLDER).upper() == "CHANGE_ME":
+            issues.append("Settings.CompletedDownloadFolder is missing or set to CHANGE_ME")
+        if FREE_SPACE != "-1":
+            if not FREE_SPACE_FOLDER or str(FREE_SPACE_FOLDER).upper() == "CHANGE_ME":
+                issues.append("Settings.FreeSpaceFolder must be set when FreeSpace is enabled")
+        # Check Arr sections
+        for key in CONFIG.sections():
+            import re
+
+            m = re.match(r"radarr.*", key, re.IGNORECASE)
+            if not m:
+                continue
+            managed = CONFIG.get(f"{key}.Managed", fallback=False)
+            if not managed:
+                continue
+            uri = CONFIG.get(f"{key}.URI", fallback=None)
+            apikey = CONFIG.get(f"{key}.APIKey", fallback=None)
+            if not uri or str(uri).upper() == "CHANGE_ME":
+                issues.append(f"{key}.URI is missing or set to CHANGE_ME")
+            if not apikey or str(apikey).upper() == "CHANGE_ME":
+                issues.append(f"{key}.APIKey is missing or set to CHANGE_ME")
+        if issues:
+            logger.error("Configuration issues detected:")
+            for i in issues:
+                logger.error(" - %s", i)
+    except Exception as e:
+        logger.debug("Config validation skipped due to error: %s", e)
 
 
 def run():
-    global CHILD_PROCESSES
     early_exit = process_flags()
     if early_exit is True:
         sys.exit(0)
     logger.info("Starting qBitrr: Version: %s.", patched_version)
+
+    # Delete all databases on startup
+    _delete_all_databases()
+
     try:
         manager = qBitManager()
     except NameError:
         sys.exit(0)
     run_logs(logger)
+    # Early consolidated config validation feedback
+    _report_config_issues()
     logger.debug("Environment variables: %r", ENVIRO_CONFIG)
     try:
-        if CHILD_PROCESSES := manager.get_child_processes():
+        manager.get_child_processes()
+
+        # Register cleanup for child processes when the main process exits
+        def _cleanup():
+            # Signal loops to shutdown gracefully
+            try:
+                manager.shutdown_event.set()
+            except Exception:
+                pass
+            # Give processes a chance to exit
+            for p in manager.child_processes:
+                with contextlib.suppress(Exception):
+                    p.join(timeout=5)
+            for p in manager.child_processes:
+                with contextlib.suppress(Exception):
+                    p.kill()
+                with contextlib.suppress(Exception):
+                    p.terminate()
+
+        atexit.register(_cleanup)
+        if manager.child_processes:
             manager.run()
         else:
             logger.warning(
@@ -237,24 +607,6 @@ def run():
             child.kill()
 
 
-def cleanup():
-    for p in CHILD_PROCESSES:
-        p.kill()
-        p.terminate()
-
-
-def file_cleanup():
-    extensions = [".db", ".db-shm", ".db-wal"]
-    all_files_in_folder = list(absolute_file_paths(APPDATA_FOLDER))
-    for file, ext in itertools.product(all_files_in_folder, extensions):
-        if file.name.endswith(ext):
-            APPDATA_FOLDER.joinpath(file).unlink(missing_ok=True)
-
-
-atexit.register(cleanup)
-
-
 if __name__ == "__main__":
     freeze_support()
-    file_cleanup()
     run()