cdmclient 1.2.4__tar.gz

cdmclient-1.2.4/.gitignore

@@ -0,0 +1,39 @@
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+build/
+dist/
+.venv/
+.ruff_cache/
+.pytest_cache/
+.mypy_cache/
+.coverage
+.coverage.*
+htmlcov/
+celerybeat-schedule
+celerybeat.pid
+
+# Environment
+.env
+.env.sh
+
+# Node / frontend
+node_modules/
+webapp/frontend/build/
+
+# Webapp built assets (generated by frontend build)
+webapp/assets/*
+webapp/templates/*
+!webapp/templates/email/
+!webapp/templates/email/**
+
+# Browser extension
+browser-extension/cdm.zip
+
+# Editor / OS
+.idea/
+.vscode/
+.claude/
+.DS_Store
+*.log

cdmclient-1.2.4/.python-version

@@ -0,0 +1 @@
+3.9

cdmclient-1.2.4/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Aron Radics
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

cdmclient-1.2.4/Makefile

@@ -0,0 +1,14 @@
+format:
+	uv run ruff format cdm_client/
+	uv run ruff check --fix cdm_client/
+
+check-format-ci:
+	uv run ruff format --check cdm_client/
+	uv run ruff check cdm_client/
+
+lint:
+	uv run ruff check cdm_client/
+	uv run ty check cdm_client/
+
+bump:
+	uv version --bump $(filter-out $@,$(MAKECMDGOALS))

cdmclient-1.2.4/PKG-INFO

@@ -0,0 +1,122 @@
+Metadata-Version: 2.4
+Name: cdmclient
+Version: 1.2.4
+Summary: CDM - Centralized Download Manager Client
+Project-URL: Homepage, https://github.com/radaron/CDMServer/tree/master/client
+Project-URL: Repository, https://github.com/radaron/CDMServer
+Author-email: Aron Radics <radics.aron.jozsef@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2024 Aron Radics
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+License-File: LICENSE
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.9
+Requires-Dist: cryptography
+Requires-Dist: qbittorrent-api>=2025.7.0
+Requires-Dist: requests
+Requires-Dist: sqlalchemy>=2.0.0
+Requires-Dist: transmission-rpc
+Description-Content-Type: text/markdown
+
+# CDMClient
+**CDM - Centralized Download Manager Client**
+CDMClient is the client application for the [CDM Server](../README.md).
+
+This client communicates with the CDM Server to periodically send the download status from Transmission/QBittorrent and check for new torrent files to download. If new torrents are available, they are downloaded and added to Transmission/QBittorrent client.
+
+## Installation
+
+### Install or Upgrade the Package
+Run the following command to install or upgrade CDMClient:
+```shell
+python3 -m pip install --upgrade cdmclient --user
+```
+
+### Create a Systemd Service
+To set up CDMClient as a systemd service, execute the following commands:
+
+1. Create the service file:
+   ```shell
+   echo "[Unit]
+   Description=cdm-client service
+   After=multi-user.target
+   Conflicts=getty@tty1.service
+
+   [Service]
+   User=${USER}
+   Type=simple
+   Environment=LC_ALL=C.UTF-8
+   Environment=LANG=C.UTF-8
+   ExecStart=${HOME}/.local/bin/cdm-client
+   Restart=on-failure
+   RestartSec=3
+
+   [Install]
+   WantedBy=multi-user.target" | sudo tee /etc/systemd/system/cdm-client.service
+   ```
+
+2. Reload systemd and enable the service:
+   ```shell
+   sudo systemctl daemon-reload
+   sudo systemctl enable cdm-client.service
+   sudo systemctl start cdm-client.service
+   ```
+
+### Add automatic update (optional)
+To keep CDMClient updated automatically, you can add a cron job. Run:
+```shell
+crontab -e
+```
+Then add the following line to the crontab file:
+```shell
+0 3 * * * /usr/bin/python3 -m pip install --upgrade cdmclient --user && systemctl restart cdm-client.service
+```
+
+## Configuration
+The configuration file is located at:
+```~/.config/cdm_client/config.ini```
+
+This file is automatically generated when the service starts. Below is an example configuration:
+
+```ini
+[connection]
+server_host = "https://cdmserver.com"
+api_key = "1409d6ed79280aadcbe20f8f21981e89"
+client_host =
+client_port =
+client_username =
+client_password =
+client_type= transmission # possible values: transmission or qbitorrent
+```
+
+### Configuration Details:
+- **`server_host`**: The full URL of the CDM Server (e.g., `https://cdmserver.com`).
+- **`api_key`**: The API key generated when adding a new device on the CDM Server's devices page. Refer to the [Devices Page Documentation](../doc/USAGE.md#devices-page).
+- **`client_username`** and **`client_password`**: Required authentication for the selected torrent client.
+- **`client_type`**: Specify either `transmission` or `qbitorrent`, depending on the torrent client you are using.
+- **`client_host`** and **`client_port`**: Optional. If not specified, defaults to `localhost` and the default port for the selected client type.
+
+## Viewing Logs
+To monitor the service logs, use the following command:
+```shell
+journalctl -fu cdm-client
+```

cdmclient-1.2.4/README.md

@@ -0,0 +1,83 @@
+# CDMClient
+**CDM - Centralized Download Manager Client**
+CDMClient is the client application for the [CDM Server](../README.md).
+
+This client communicates with the CDM Server to periodically send the download status from Transmission/QBittorrent and check for new torrent files to download. If new torrents are available, they are downloaded and added to Transmission/QBittorrent client.
+
+## Installation
+
+### Install or Upgrade the Package
+Run the following command to install or upgrade CDMClient:
+```shell
+python3 -m pip install --upgrade cdmclient --user
+```
+
+### Create a Systemd Service
+To set up CDMClient as a systemd service, execute the following commands:
+
+1. Create the service file:
+   ```shell
+   echo "[Unit]
+   Description=cdm-client service
+   After=multi-user.target
+   Conflicts=getty@tty1.service
+
+   [Service]
+   User=${USER}
+   Type=simple
+   Environment=LC_ALL=C.UTF-8
+   Environment=LANG=C.UTF-8
+   ExecStart=${HOME}/.local/bin/cdm-client
+   Restart=on-failure
+   RestartSec=3
+
+   [Install]
+   WantedBy=multi-user.target" | sudo tee /etc/systemd/system/cdm-client.service
+   ```
+
+2. Reload systemd and enable the service:
+   ```shell
+   sudo systemctl daemon-reload
+   sudo systemctl enable cdm-client.service
+   sudo systemctl start cdm-client.service
+   ```
+
+### Add automatic update (optional)
+To keep CDMClient updated automatically, you can add a cron job. Run:
+```shell
+crontab -e
+```
+Then add the following line to the crontab file:
+```shell
+0 3 * * * /usr/bin/python3 -m pip install --upgrade cdmclient --user && systemctl restart cdm-client.service
+```
+
+## Configuration
+The configuration file is located at:
+```~/.config/cdm_client/config.ini```
+
+This file is automatically generated when the service starts. Below is an example configuration:
+
+```ini
+[connection]
+server_host = "https://cdmserver.com"
+api_key = "1409d6ed79280aadcbe20f8f21981e89"
+client_host =
+client_port =
+client_username =
+client_password =
+client_type= transmission # possible values: transmission or qbitorrent
+```
+
+### Configuration Details:
+- **`server_host`**: The full URL of the CDM Server (e.g., `https://cdmserver.com`).
+- **`api_key`**: The API key generated when adding a new device on the CDM Server's devices page. Refer to the [Devices Page Documentation](../doc/USAGE.md#devices-page).
+- **`client_username`** and **`client_password`**: Required authentication for the selected torrent client.
+- **`client_type`**: Specify either `transmission` or `qbitorrent`, depending on the torrent client you are using.
+- **`client_host`** and **`client_port`**: Optional. If not specified, defaults to `localhost` and the default port for the selected client type.
+
+## Viewing Logs
+To monitor the service logs, use the following command:
+```shell
+journalctl -fu cdm-client
+```

cdmclient-1.2.4/cdm_client/cdm_client.py

@@ -0,0 +1,246 @@
+import logging
+import os
+import shutil
+from enum import Enum
+from logging.handlers import SysLogHandler
+from time import sleep
+from typing import Optional
+
+import requests
+
+from cdm_client.config import Config
+from cdm_client.database_adapter import DatabaseAdapter
+from cdm_client.torrent_client_factory import (
+    TorrentClientType,
+    create_torrent_client_adapter,
+)
+
+
+class InstructionAction(Enum):
+    STOP = "stop"
+    START = "start"
+    DELETE = "delete"
+    CLEAN = "clean"
+
+
+class CDMClient:
+    def __init__(self) -> None:
+        self._logger = self._init_logger()
+        self._config = Config()
+        self._torrent_client_adapter = create_torrent_client_adapter(
+            TorrentClientType.get_enum_from_value(self._config["client_type"]),
+            username=self._config["client_username"] or None,
+            password=self._config["client_password"] or None,
+            host=self._config["client_host"] or None,
+            port=int(self._config["client_port"])
+            if self._config["client_port"]
+            else None,
+        )
+        self._database_adapter = DatabaseAdapter()
+
+    def _init_logger(self) -> logging.Logger:
+        syslog = SysLogHandler(address="/dev/log")
+        syslog.setFormatter(
+            logging.Formatter("cdm-client %(name)s: %(levelname)s %(message)s")
+        )
+        logger = logging.getLogger("cdm-client")
+        logger.addHandler(syslog)
+        logger.setLevel(logging.INFO)
+        return logger
+
+    def _update_status(self, status_data: list[dict]) -> None:
+        resp = requests.post(
+            f"{self._config['server_host']}/api/client/status/",
+            json={"data": status_data},
+            headers={"x-api-key": self._config["api_key"]},
+            timeout=5,
+        )
+        resp.raise_for_status()
+
+    def _download_files(self, files: dict[int, str]) -> None:
+        for tracker_id, path in files.items():
+            resp = requests.get(
+                f"{self._config['server_host']}/api/client/download/{tracker_id}/",
+                headers={"x-api-key": self._config["api_key"]},
+                stream=True,
+                timeout=5,
+            )
+            resp.raise_for_status()
+            new_torrent = self._torrent_client_adapter.add_torrent(
+                resp.content, download_dir=path
+            )
+            if new_torrent is None:
+                self._logger.error(
+                    "Failed to add torrent for tracker_id=%s to %s", tracker_id, path
+                )
+                continue
+            with self._database_adapter as db_adapter:
+                status = db_adapter.create_or_update_download_torrent_mapping(
+                    tracker_id=tracker_id,
+                    torrent_hash=self._torrent_client_adapter.get_status_by_id(
+                        new_torrent.id
+                    )["hash"],
+                )
+                if not status:
+                    self._logger.error(
+                        "Failed to save download-torrent mapping: %s", status
+                    )
+            self._logger.info("Downloading torrent: %s to %s", tracker_id, path)
+
+    def _execute_instructions(self, instructions: list[dict]) -> None:
+        for instruction in instructions:
+            self._logger.info("Received instruction: %s", instruction)
+            for action, params in instruction.items():
+                if action == InstructionAction.STOP.value:
+                    self._torrent_client_adapter.pause_torrent(params["torrent_id"])
+                    self._logger.info("Stopped torrent: %s", params["torrent_id"])
+                elif action == InstructionAction.START.value:
+                    self._torrent_client_adapter.resume_torrent(params["torrent_id"])
+                    self._logger.info("Started torrent: %s", params["torrent_id"])
+                elif action == InstructionAction.DELETE.value:
+                    self.delete_download(params["torrent_id"])
+                elif action == InstructionAction.CLEAN.value:
+                    self.clean_download_paths(params["paths"])
+                else:
+                    self._logger.warning("Unknown instruction action: %s", action)
+
+    def _normalize_path(self, path: str) -> str:
+        return os.path.normpath(os.path.realpath(path))
+
+    def _is_protected_path(self, path: str, protected_paths: set[str]) -> bool:
+        normalized_path = self._normalize_path(path)
+        for protected_path in protected_paths:
+            if protected_path == normalized_path or protected_path.startswith(
+                f"{normalized_path}{os.sep}"
+            ):
+                return True
+        return False
+
+    def _delete_path(self, path: str) -> None:
+        if os.path.islink(path) or os.path.isfile(path):
+            os.remove(path)
+        else:
+            shutil.rmtree(path)
+
+    def clean_download_paths(self, paths: list[str]) -> None:
+        if not paths:
+            self._logger.warning("No clean paths provided")
+            return
+
+        status_entries = self._torrent_client_adapter.get_status()
+        protected_paths: set[str] = set()
+        for status_entry in status_entries:
+            download_dir = status_entry.get("downloadDir")
+            name = status_entry.get("name")
+            if not isinstance(download_dir, str) or not isinstance(name, str):
+                continue
+            protected_paths.add(self._normalize_path(os.path.join(download_dir, name)))
+
+        for path in paths:
+            clean_path = self._normalize_path(path)
+            if not os.path.isdir(clean_path):
+                self._logger.warning("Clean path does not exist: %s", clean_path)
+                continue
+
+            self._logger.info("Cleaning path: %s", clean_path)
+            for entry in os.scandir(clean_path):
+                entry_path = self._normalize_path(entry.path)
+                if self._is_protected_path(entry_path, protected_paths):
+                    continue
+                try:
+                    self._delete_path(entry_path)
+                    self._logger.info("Deleted stale path: %s", entry_path)
+                except FileNotFoundError:
+                    self._logger.warning(
+                        "Path disappeared during clean: %s", entry_path
+                    )
+                except OSError:
+                    self._logger.exception(
+                        "Failed to delete stale path: %s", entry_path
+                    )
+
+    def delete_download(self, torrent_id: int) -> None:
+        try:
+            status_data = self._get_download_status(
+                torrent_id=torrent_id, for_deletion=True
+            )
+            self._torrent_client_adapter.remove_torrent(torrent_id)
+            self._update_status(status_data)
+            self._force_delete_if_exists(
+                os.path.join(status_data[0]["downloadDir"], status_data[0]["name"])
+            )
+        finally:
+            with self._database_adapter as db_adapter:
+                deleted_mapping = db_adapter.delete_mapping(
+                    torrent_hash=status_data[0]["hash"]
+                )
+            self._update_status(status_data)
+
+        self._logger.info(
+            "Removed torrent and data: %s, deleted_mapping: %s",
+            torrent_id,
+            deleted_mapping,
+        )
+
+    def _force_delete_if_exists(self, file_path: str) -> None:
+        sleep(1)
+        if os.path.exists(file_path):
+            self._logger.info("Force deleting file: %s", file_path)
+            try:
+                self._delete_path(file_path)
+            except FileNotFoundError:
+                self._logger.warning("File not found during deletion")
+
+    def _get_order(self) -> None:
+        resp = requests.get(
+            f"{self._config['server_host']}/api/client/",
+            headers={"x-api-key": self._config["api_key"]},
+            timeout=5,
+        )
+        resp.raise_for_status()
+
+        files = resp.json()["data"]["files"]
+        if files:
+            self._download_files(files)
+        instructions = resp.json()["data"]["instructions"]
+        if instructions:
+            self._execute_instructions(instructions)
+            self._update_status(self._get_download_status())
+
+    def _get_download_status(
+        self, torrent_id: Optional[int] = None, for_deletion: bool = False
+    ) -> list[dict]:
+        status = []
+        if torrent_id:
+            status.append(self._torrent_client_adapter.get_status_by_id(torrent_id))
+        else:
+            status = self._torrent_client_adapter.get_status()
+        with self._database_adapter as db_adapter:
+            for status_entry in status:
+                tracker_id = db_adapter.get_tracker_id_by_torrent_hash(
+                    status_entry["hash"]
+                )
+                if tracker_id:
+                    status_entry["tracker_id"] = tracker_id
+                if for_deletion:
+                    status_entry["is_deleted"] = True
+        return status
+
+    def run(self) -> None:
+        self._logger.info("Starting cdm-client...")
+        while True:
+            try:
+                self._update_status(self._get_download_status())
+                self._get_order()
+            except Exception:
+                self._logger.exception("An error occurred.")
+            sleep(5)
+
+
+def main() -> None:
+    cdm_client = CDMClient()
+    cdm_client.run()
+
+
+if __name__ == "__main__":
+    main()

cdmclient-1.2.4/cdm_client/config.py

@@ -0,0 +1,90 @@
+import configparser
+import os
+from typing import Union
+
+from cryptography.fernet import Fernet
+
+
+class Config:
+    CONFIG_FOLDER_PATH = os.path.join(os.path.expanduser("~"), ".config", "cdm_client")
+    KEY_PATH = os.path.join(CONFIG_FOLDER_PATH, "key.key")
+    CONFIG_PATH = os.path.join(CONFIG_FOLDER_PATH, "config.ini")
+    DEFAULT_CONFIG = {
+        "connection": {
+            "server_host": "",
+            "api_key": "",
+            "client_host": "",
+            "client_port": "",
+            "client_username": "",
+            "client_password": "",
+            "client_type": "",
+        }
+    }
+    ENCRYPTED_CONFIG = ["client_password"]
+
+    def __init__(self) -> None:
+        self._key: Union[bytes, str] = ""
+        self._config = self._load_config()
+        self._check_key()
+
+    def _check_key(self) -> None:
+        if not self._key_exists:
+            self._create_key()
+        else:
+            self._read_key()
+
+    def _create_key(self) -> None:
+        self._key = Fernet.generate_key()
+        with open(self.KEY_PATH, "w", encoding="utf-8") as f:
+            f.write(self._key.decode())
+
+    def _read_key(self) -> None:
+        with open(self.KEY_PATH, "r", encoding="utf-8") as f:
+            self._key = f.read().encode()
+
+    def _load_config(self) -> configparser.ConfigParser:
+        config = configparser.ConfigParser()
+        if config.read(self.CONFIG_PATH):
+            return config
+        return self._create_config()
+
+    def _create_config(self) -> configparser.ConfigParser:
+        if not os.path.exists(self.CONFIG_FOLDER_PATH):
+            os.makedirs(self.CONFIG_FOLDER_PATH)
+        config = configparser.ConfigParser()
+        for section, configs in self.DEFAULT_CONFIG.items():
+            config[section] = {}
+            for config_key, config_value in configs.items():
+                config[section][config_key] = config_value
+        with open(self.CONFIG_PATH, "w", encoding="utf-8") as f:
+            config.write(f)
+        return config
+
+    def _decrypt(self, value: str) -> str:
+        f = Fernet(self._key)
+        return f.decrypt(value.encode()).decode()
+
+    def _encrypt(self, value: str) -> str:
+        f = Fernet(self._key)
+        return f.encrypt(value.encode()).decode()
+
+    def _write_creds(self) -> None:
+        with open(self.CONFIG_PATH, "w", encoding="utf-8") as f:
+            self._config.write(f)
+
+    @property
+    def _key_exists(self) -> bool:
+        return os.path.exists(self.KEY_PATH)
+
+    def __getitem__(self, name: str) -> str:
+        if name in self.ENCRYPTED_CONFIG:
+            try:
+                return self._decrypt(self._config["connection"][name])
+            except Exception:
+                raw_value = self._config["connection"][name]
+                self._config["connection"][name] = self._encrypt(
+                    self._config["connection"][name]
+                )
+                self._write_creds()
+                return raw_value
+        return self._config["connection"][name]