quasarr 0.1.6__py3-none-any.whl → 1.23.0__py3-none-any.whl

quasarr/providers/myjd_api.py

@@ -35,8 +35,13 @@ import time
 from urllib.parse import quote
 
 import requests
+import urllib3
 from Cryptodome.Cipher import AES
 
+from quasarr.providers.log import info, debug
+from quasarr.providers.version import get_version
+
+urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
 BS = 16
 
 
@@ -60,6 +65,90 @@ def unpad(s):
     return s[0:-s[-1]]
 
 
+class Update:
+    """
+    Class that represents the update-functionality of a Device
+    """
+
+    def __init__(self, device):
+        self.device = device
+        self.url = '/update'
+
+    def restart_and_update(self):
+        """
+
+        :return:
+        """
+        resp = self.device.action(self.url + "/restartAndUpdate")
+        return resp
+
+    def run_update_check(self):
+        """
+
+        :return:
+        """
+        resp = self.device.action(self.url + "/runUpdateCheck")
+        return resp
+
+    def is_update_available(self):
+        """
+
+        :return:
+        """
+        resp = self.device.action(self.url + "/isUpdateAvailable")
+        return resp
+
+    def update_available(self):
+        self.run_update_check()
+        resp = self.is_update_available()
+        return resp
+
+
+class Config:
+    """
+    Class that represents the Config of a Device
+    """
+
+    def __init__(self, device):
+        self.device = device
+        self.url = '/config'
+
+    def list(self):
+        """
+        :return:  List<AdvancedConfigAPIEntry>
+        """
+        resp = self.device.action(self.url + "/list")
+        return resp
+
+    def get(self, interface_name, storage, key):
+        """
+        :param interfaceName: a valid interface name from List<AdvancedConfigAPIEntry>
+        :type: str:
+        :param storage: 'null' to use default or 'cfg/' + interfaceName
+        :type: str:
+        :param key: a valid key from from List<AdvancedConfigAPIEntry>
+        :type: str:
+        """
+        params = [interface_name, storage, key]
+        resp = self.device.action(self.url + "/get", params)
+        return resp
+
+    def set(self, interface_name, storage, key, value):
+        """
+        :param interfaceName:  a valid interface name from List<AdvancedConfigAPIEntry>
+        :type: str:
+        :param storage: 'null' to use default or 'cfg/' + interfaceName
+        :type: str:
+        :param key: a valid key from from List<AdvancedConfigAPIEntry>
+        :type: str:
+        :param value: a valid value for the given key (see type value from List<AdvancedConfigAPIEntry>)
+        :type: Object:
+        """
+        params = [interface_name, storage, key, value]
+        resp = self.device.action(self.url + "/set", params)
+        return resp
+
+
 class DownloadController:
     """
     Class that represents the downloads-controller of a Device
@@ -96,7 +185,7 @@ class Linkgrabber:
         self.url = '/linkgrabberv2'
 
     def is_collecting(self):
-        resp = self.device.action("/linkgrabberv2/isCollecting")
+        resp = self.device.action(self.url + "/isCollecting")
         return resp
 
     def add_links(self,
@@ -123,7 +212,33 @@ class Linkgrabber:
         "destinationFolder" : null
         }
         """
-        resp = self.device.action("/linkgrabberv2/addLinks", params)
+        resp = self.device.action(self.url + "/addLinks", params)
+        return resp
+
+    def cleanup(self,
+                action,
+                mode,
+                selection_type,
+                link_ids=[],
+                package_ids=[]):
+        """
+        Clean packages and/or links of the linkgrabber list.
+        Requires at least a package_ids or link_ids list, or both.
+
+        :param package_ids: Package UUID's.
+        :type: list of strings.
+        :param link_ids: link UUID's.
+        :type: list of strings
+        :param action: Action to be done. Actions: DELETE_ALL, DELETE_DISABLED, DELETE_FAILED, DELETE_FINISHED, DELETE_OFFLINE, DELETE_DUPE, DELETE_MODE
+        :type: str:
+        :param mode: Mode to use. Modes: REMOVE_LINKS_AND_DELETE_FILES, REMOVE_LINKS_AND_RECYCLE_FILES, REMOVE_LINKS_ONLY
+        :type: str:
+        :param selection_type: Type of selection to use. Types: SELECTED, UNSELECTED, ALL, NONE
+        :type: str:
+        """
+        params = [link_ids, package_ids]
+        params += [action, mode, selection_type]
+        resp = self.device.action(self.url + "/cleanup", params)
         return resp
 
     def remove_links(self, links_ids, packages_ids):
@@ -208,6 +323,32 @@ class Downloads:
         self.device = device
         self.url = "/downloadsV2"
 
+    def cleanup(self,
+                action,
+                mode,
+                selection_type,
+                link_ids=[],
+                package_ids=[]):
+        """
+        Clean packages and/or links of the linkgrabber list.
+        Requires at least a package_ids or link_ids list, or both.
+
+        :param package_ids: Package UUID's.
+        :type: list of strings.
+        :param link_ids: link UUID's.
+        :type: list of strings
+        :param action: Action to be done. Actions: DELETE_ALL, DELETE_DISABLED, DELETE_FAILED, DELETE_FINISHED, DELETE_OFFLINE, DELETE_DUPE, DELETE_MODE
+        :type: str:
+        :param mode: Mode to use. Modes: REMOVE_LINKS_AND_DELETE_FILES, REMOVE_LINKS_AND_RECYCLE_FILES, REMOVE_LINKS_ONLY
+        :type: str:
+        :param selection_type: Type of selection to use. Types: SELECTED, UNSELECTED, ALL, NONE
+        :type: str:
+        """
+        params = [link_ids, package_ids]
+        params += [action, mode, selection_type]
+        resp = self.device.action(self.url + "/cleanup", params)
+        return resp
+
     def query_links(self,
                     params=[{
                         "bytesTotal": True,
@@ -258,46 +399,27 @@ class Downloads:
         resp = self.device.action(self.url + "/queryPackages", params)
         return resp
 
-    def remove_links(self, links_ids, packages_ids):
-        params = [links_ids, packages_ids]
-        resp = self.device.action(self.url + "/removeLinks", params)
-        return resp
-
 
 class Extraction:
     """
-    Class that represents the extraction functionalities of a Device.
+    Class that represents the extraction details of a Device
     """
 
     def __init__(self, device):
         self.device = device
-        self.url = '/extraction'
-
-    def get_archive_info(self, link_ids, package_ids):
-        params = [link_ids, package_ids]
-        resp = self.device.action(self.url + "/getArchiveInfo", params)
-        return resp
+        self.url = "/extraction"
 
-    def set_archive_settings(self, archive_id, archive_settings=None):
+    def get_archive_info(self, link_ids=[], package_ids=[]):
         """
-        Sets the extraction settings for a specific archive.
+        Get ArchiveStatus for links and/or packages.
 
-        :param archive_id: The ID of the archive.
-        :type archive_id: string
-        :param archive_settings: Dictionary of archive settings.
-        :type archive_settings: dict
-        :rtype: boolean indicating success or failure
+        :param package_ids: Package UUID's.
+        :type: list of strings.
+        :param link_ids: link UUID's.
+        :type: list of strings
         """
-        if archive_settings is None:
-            archive_settings = {
-                "autoExtract": True,
-                "removeDownloadLinksAfterExtraction": True,
-                "removeFilesAfterExtraction": True
-            }
-
-        params = [archive_id, archive_settings]
-
-        resp = self.device.action(self.url + "/setArchiveSettings", params)
+        params = [link_ids, package_ids]
+        resp = self.device.action(self.url + "/getArchiveInfo", params)
         return resp
 
 
@@ -316,10 +438,12 @@ class Jddevice:
         self.device_id = device_dict["id"]
         self.device_type = device_dict["type"]
         self.myjd = jd
+        self.config = Config(self)
         self.linkgrabber = Linkgrabber(self)
         self.downloads = Downloads(self)
-        self.downloadcontroller = DownloadController(self)
         self.extraction = Extraction(self)
+        self.downloadcontroller = DownloadController(self)
+        self.update = Update(self)
         self.__direct_connection_info = None
         self.__refresh_direct_connections()
         self.__direct_connection_enabled = True
@@ -398,7 +522,7 @@ class Jddevice:
                 return response['data']
         else:
             # Direct connection info available, we try to use it.
-            for conn in self.__direct_connection_info:
+            for conn in self.__direct_connection_info[:]:
                 connection_ip = conn['conn']['ip']
                 # prevent connection to internal docker ip
                 if time.time() > conn['cooldown']:
@@ -445,6 +569,8 @@ class Myjdapi:
     Main class for connecting to JD API.
 
     """
+    # Class variable to track connection failures across all instances
+    _connection_failed_at = None
 
     def __init__(self):
         """
@@ -453,7 +579,7 @@ class Myjdapi:
         """
         self.__request_id = int(time.time() * 1000)
         self.__api_url = "https://api.jdownloader.org"
-        self.__app_key = "http://git.io/vmcsk"
+        self.__app_key = "quasarr"
         self.__api_version = 1
         self.__devices = None
         self.__login_secret = None
@@ -584,6 +710,15 @@ class Myjdapi:
         :returns: boolean -- True if succesful, False if there was any error.
 
         """
+        # Check if we're in cooldown period (5 minutes = 300 seconds)
+        if Myjdapi._connection_failed_at is not None:
+            time_since_failure = time.time() - Myjdapi._connection_failed_at
+            if time_since_failure < 300:
+                # Silently return False during cooldown - don't log anything
+                return False
+            # Cooldown expired, reset for retry
+            Myjdapi._connection_failed_at = None
+
         self.update_request_id()
         self.__login_secret = None
         self.__device_secret = None
@@ -599,6 +734,15 @@ class Myjdapi:
         response = self.request_api("/my/connect", "GET", [("email", email),
                                                            ("appkey",
                                                             self.__app_key)])
+
+        if response is None:
+            # Log and set failure timestamp
+            info("JDownloader API is currently unavailable! Stopping connection attempts for 5 minutes.")
+            Myjdapi._connection_failed_at = time.time()
+            return False
+
+        # Connection successful, reset failure timestamp
+        Myjdapi._connection_failed_at = None
         self.__connected = True
         self.update_request_id()
         self.__session_token = response["sessiontoken"]
@@ -696,11 +840,22 @@ class Myjdapi:
                                                   query[0] + "&".join(query[1:])))
                 ]
             query = query[0] + "&".join(query[1:])
+
+            headers = {
+                "User-Agent": f"Quasarr/{get_version()}"
+            }
             try:
-                encrypted_response = requests.get(api + query, timeout=timeout)
+                encrypted_response = requests.get(api + query, timeout=timeout, headers=headers)
+            except requests.exceptions.ConnectionError:
+                return None
             except Exception:
-                encrypted_response = requests.get(api + query, timeout=timeout, verify=False)
-                print("Could not establish secure connection to JDownloader.")
+                try:
+                    encrypted_response = requests.get(api + query, timeout=timeout, headers=headers, verify=False)
+                    debug("Could not establish secure connection to JDownloader. Is your time / timezone correct?")
+                except requests.exceptions.ConnectionError:
+                    return None
+                except Exception:
+                    return None
         else:
             params_request = []
             if params is not None:
@@ -729,23 +884,29 @@ class Myjdapi:
                 encrypted_response = requests.post(
                     request_url,
                     headers={
-                        "Content-Type": "application/aesjson-jd; charset=utf-8"
+                        "Content-Type": "application/aesjson-jd; charset=utf-8",
+                        "User-Agent": f"Quasarr/{get_version()}"
                     },
                     data=encrypted_data,
                     timeout=timeout
                 )
+            except requests.exceptions.ConnectionError:
+                return None
             except Exception:
                 try:
                     encrypted_response = requests.post(
                         request_url,
                         headers={
-                            "Content-Type": "application/aesjson-jd; charset=utf-8"
+                            "Content-Type": "application/aesjson-jd; charset=utf-8",
+                            "User-Agent": f"Quasarr/{get_version()}"
                         },
                         data=encrypted_data,
                         timeout=timeout,
                         verify=False
                     )
-                    print("Could not establish secure connection to JDownloader.")
+                    debug("Could not establish secure connection to JDownloader. Is your time / timezone correct?")
+                except requests.exceptions.ConnectionError:
+                    return None
                 except Exception:
                     return None
         if encrypted_response.status_code == 403:

quasarr/providers/notifications.py

@@ -3,34 +3,122 @@
 # Project by https://github.com/rix1337
 
 import json
+import os
 
 import requests
 
+from quasarr.providers.imdb_metadata import get_imdb_id_from_title
+from quasarr.providers.imdb_metadata import get_poster_link
+from quasarr.providers.log import info
 
-def send_discord_captcha_alert(shared_state, title):
+# Discord message flag for suppressing notifications
+SUPPRESS_NOTIFICATIONS = 1 << 12  # 4096
+
+silent = False
+if os.getenv('SILENT'):
+    silent = True
+
+
+def send_discord_message(shared_state, title, case, imdb_id=None, details=None, source=None):
+    """
+    Sends a Discord message to the webhook provided in the shared state, based on the specified case.
+
+    :param shared_state: Shared state object containing configuration.
+    :param title: Title of the embed to be sent.
+    :param case: A string representing the scenario (e.g., 'captcha', 'failed', 'unprotected').
+    :param imdb_id: A string starting with "tt" followed by at least 7 digits, representing an object on IMDb
+    :param details: A dictionary containing additional details, such as version and link for updates.
+    :param source: Optional source of the notification, sent as a field in the embed.
+    :return: True if the message was sent successfully, False otherwise.
+    """
     if not shared_state.values.get("discord"):
         return False
 
+    poster_object = None
+    if case == "unprotected" or case == "captcha":
+        if not imdb_id and " " not in title:  # this should prevent imdb_search for ebooks and magazines
+            imdb_id = get_imdb_id_from_title(shared_state, title)
+        if imdb_id:
+            poster_link = get_poster_link(shared_state, imdb_id)
+            if poster_link:
+                poster_object = {
+                    'url': poster_link
+                }
+
+    # Decide the embed content based on the case
+    if case == "unprotected":
+        description = 'No CAPTCHA required. Links were added directly!'
+        fields = None
+    elif case == "solved":
+        description = 'CAPTCHA solved by SponsorsHelper!'
+        fields = None
+    elif case == "failed":
+        description = 'SponsorsHelper failed to solve the CAPTCHA! Package marked es failed.'
+        fields = None
+    elif case == "captcha":
+        description = 'Download will proceed, once the CAPTCHA has been solved.'
+        fields = [
+            {
+                'name': 'Solve CAPTCHA',
+                'value': f'Open [this link]({f"{shared_state.values['external_address']}/captcha"}) to solve the CAPTCHA.',
+            }
+        ]
+        if not shared_state.values.get("helper_active"):
+            fields.append({
+                'name': 'SponsorsHelper',
+                'value': f'[Sponsors get automated CAPTCHA solutions!](https://github.com/rix1337/Quasarr?tab=readme-ov-file#sponsorshelper)',
+            })
+    elif case == "quasarr_update":
+        description = f'Please update to {details["version"]} as soon as possible!'
+        if details:
+            fields = [
+                {
+                    'name': 'Release notes at: ',
+                    'value': f'[GitHub.com: rix1337/Quasarr/{details["version"]}]({details["link"]})',
+                }
+            ]
+        else:
+            fields = None
+    else:
+        info(f"Unknown notification case: {case}")
+        return False
+
     data = {
         'username': 'Quasarr',
-        'avatar_url': 'https://i.imgur.com/UXBdr1h.png',
+        'avatar_url': 'https://raw.githubusercontent.com/rix1337/Quasarr/main/Quasarr.png',
         'embeds': [{
             'title': title,
-            'description': 'Links are protected. Please solve the CAPTCHA to continue downloading.',
-            'fields': [
-                {
-                    'name': '',
-                    'value': f'[Solve the CAPTCHA here!]({f"{shared_state.values['external_address']}/captcha"})',
-                }
-
-            ]
+            'description': description,
         }]
     }
 
+    if source and source.startswith("http"):
+        if not fields:
+            fields = []
+        fields.append({
+            'name': 'Source',
+            'value': f'[View release details here]({source})',
+        })
+
+    if fields:
+        data['embeds'][0]['fields'] = fields
+
+    if poster_object:
+        data['embeds'][0]['thumbnail'] = poster_object
+        data['embeds'][0]['image'] = poster_object
+    elif case == "quasarr_update":
+        data['embeds'][0]['thumbnail'] = {
+            'url': "https://raw.githubusercontent.com/rix1337/Quasarr/main/Quasarr.png"
+        }
+
+    # Apply silent mode: suppress notifications for all cases except 'deleted'
+    if silent and case not in ["failed", "quasarr_update"]:
+        data['flags'] = SUPPRESS_NOTIFICATIONS
+
     response = requests.post(shared_state.values["discord"], data=json.dumps(data),
                              headers={"Content-Type": "application/json"})
     if response.status_code != 204:
-        print(f"Failed to send message to Discord webhook. Status code: {response.status_code}")
+        info(f"Failed to send message to Discord webhook. Status code: {response.status_code}")
         return False
 
     return True