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

quasarr/__init__.py

@@ -10,12 +10,18 @@ import socket
 import sys
 import tempfile
 import time
+from urllib.parse import urlparse
 
-from quasarr.arr import api
+import requests
+
+from quasarr.api import get_api
+from quasarr.providers import shared_state, version
+from quasarr.providers.log import info, debug
+from quasarr.providers.notifications import send_discord_message
 from quasarr.storage.config import Config, get_clean_hostnames
+from quasarr.storage.setup import path_config, hostnames_config, hostname_credentials_config, flaresolverr_config, \
+    jdownloader_config
 from quasarr.storage.sqlite_database import DataBase
-from quasarr.providers import shared_state, version
-from quasarr.storage.setup import path_config, hostnames_config, nx_credentials_config, jdownloader_config
 
 
 def run():
@@ -29,6 +35,7 @@ def run():
         parser.add_argument("--internal_address", help="Must be provided when running in Docker")
         parser.add_argument("--external_address", help="External address for CAPTCHA notifications")
         parser.add_argument("--discord", help="Discord Webhook URL")
+        parser.add_argument("--hostnames", help="Public HTTP(s) Link that contains hostnames definition.")
         arguments = parser.parse_args()
 
         sys.stdout = Unbuffered(sys.stdout)
@@ -38,8 +45,13 @@ def run():
   https://github.com/rix1337/Quasarr
 └────────────────────────────────────┘""")
 
-        port = int('8080')
+        print("\n===== Recommended Services =====")
+        print('For convenient universal premium downloads use: "https://linksnappy.com/?ref=397097"')
+        print(
+            'Sponsors get automated CAPTCHA solutions: "https://github.com/rix1337/Quasarr?tab=readme-ov-file#sponsorshelper"')
 
+        print("\n===== Startup Info =====")
+        port = int('8080')
         config_path = ""
         if os.environ.get('DOCKER'):
             config_path = "/config"
@@ -52,7 +64,7 @@ def run():
         else:
             if arguments.port:
                 port = int(arguments.port)
-            internal_address = f'http://{check_ip()}'
+            internal_address = f'http://{check_ip()}:{port}'
 
         if arguments.internal_address:
             internal_address = arguments.internal_address
@@ -61,6 +73,9 @@ def run():
         else:
             external_address = internal_address
 
+        validate_address(internal_address, "--internal_address")
+        validate_address(external_address, "--external_address")
+
         shared_state.set_connection_info(internal_address, external_address, port)
 
         if not config_path:
@@ -83,22 +98,95 @@ def run():
         shared_state.set_files(config_path)
         shared_state.update("config", Config)
         shared_state.update("database", DataBase)
-        shared_state.update("user_agent",
-                            "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36")
+        supported_hostnames = extract_allowed_keys(Config._DEFAULT_CONFIG, 'Hostnames')
+        shared_state.update("sites", [key.upper() for key in supported_hostnames])
+        shared_state.update("user_agent", "")  # will be set by FlareSolverr
+        shared_state.update("helper_active", False)
 
         print(f'Config path: "{config_path}"')
 
-        shared_state.set_sites()
+        flaresolverr_url = Config('FlareSolverr').get('url')
+        if not flaresolverr_url:
+            flaresolverr_config(shared_state)
+        else:
+            print(f'Flaresolverr URL: "{flaresolverr_url}"')
+            flaresolverr_check = check_flaresolverr(shared_state, flaresolverr_url)
+            if flaresolverr_check:
+                print(f'User Agent: "{shared_state.values["user_agent"]}"')
+
+        print("\n===== Hostnames =====")
+        try:
+            if arguments.hostnames:
+                hostnames_link = make_raw_pastebin_link(arguments.hostnames)
+
+                if is_valid_url(hostnames_link):
+                    print(f"Extracting hostnames from {hostnames_link}...")
+                    allowed_keys = supported_hostnames
+                    max_keys = len(allowed_keys)
+                    shorthand_list = ', '.join(
+                        [f'"{key}"' for key in allowed_keys[:-1]]) + ' and ' + f'"{allowed_keys[-1]}"'
+                    print(f'There are up to {max_keys} hostnames currently supported: {shorthand_list}')
+                    data = requests.get(hostnames_link).text
+                    results = extract_kv_pairs(data, allowed_keys)
+
+                    extracted_hostnames = 0
+
+                    if results:
+                        hostnames = Config('Hostnames')
+                        for shorthand, hostname in results.items():
+                            domain_check = shared_state.extract_valid_hostname(hostname, shorthand)
+                            valid_domain = domain_check.get('domain', None)
+                            if valid_domain:
+                                hostnames.save(shorthand, hostname)
+                                extracted_hostnames += 1
+                                print(f'Hostname for "{shorthand}" successfully set to "{hostname}"')
+                            else:
+                                print(f'Skipping invalid hostname for "{shorthand}" ("{hostname}")')
+                        if extracted_hostnames == max_keys:
+                            print(f'All {max_keys} hostnames successfully extracted!')
+                            print('You can now remove the hostnames link from the command line / environment variable.')
+                    else:
+                        print(f'No Hostnames found at "{hostnames_link}". '
+                              'Ensure to pass a plain hostnames list, not html or json!')
+                else:
+                    print(f'Invalid hostnames URL: "{hostnames_link}"')
+        except Exception as e:
+            print(f'Error parsing hostnames link: "{e}"')
 
-        if not get_clean_hostnames(shared_state):
+        hostnames = get_clean_hostnames(shared_state)
+        if not hostnames:
             hostnames_config(shared_state)
-            get_clean_hostnames(shared_state)
+            hostnames = get_clean_hostnames(shared_state)
+        print(f"You have [{len(hostnames)} of {len(Config._DEFAULT_CONFIG['Hostnames'])}] supported hostnames set up")
+        print(f"For efficiency it is recommended to set up as few hostnames as needed.")
+
+        al = Config('Hostnames').get('al')
+        if al:
+            user = Config('AL').get('user')
+            password = Config('AL').get('password')
+            if not user or not password:
+                hostname_credentials_config(shared_state, "AL", al)
+
+        dd = Config('Hostnames').get('dd')
+        if dd:
+            user = Config('DD').get('user')
+            password = Config('DD').get('password')
+            if not user or not password:
+                hostname_credentials_config(shared_state, "DD", dd)
 
-        if Config('Hostnames').get('nx'):
+        nx = Config('Hostnames').get('nx')
+        if nx:
             user = Config('NX').get('user')
             password = Config('NX').get('password')
             if not user or not password:
-                nx_credentials_config(shared_state)
+                hostname_credentials_config(shared_state, "NX", nx)
+
+        dl = Config('Hostnames').get('dl')
+        if dl:
+            user = Config('DL').get('user')
+            password = Config('DL').get('password')
+            if not user or not password:
+                hostname_credentials_config(shared_state, "DL", dl)
 
         config = Config('JDownloader')
         user = config.get('user')
@@ -108,12 +196,13 @@ def run():
         if not user or not password or not device:
             jdownloader_config(shared_state)
 
+        print("\n===== Notifications =====")
         discord_url = ""
         if arguments.discord:
             discord_webhook_pattern = r'^https://discord\.com/api/webhooks/\d+/[\w-]+$'
             if re.match(discord_webhook_pattern, arguments.discord):
                 shared_state.update("webhook", arguments.discord)
-                print(f"Using Discord Webhook URL for CAPTCHA notifications")
+                print(f"Using Discord Webhook URL for notifications.")
                 discord_url = arguments.discord
             else:
                 print(f"Invalid Discord Webhook URL provided: {arguments.discord}")
@@ -121,48 +210,123 @@ def run():
             print("No Discord Webhook URL provided")
         shared_state.update("discord", discord_url)
 
-        jdownloader = multiprocessing.Process(target=jdownloader_connection,
-                                              args=(shared_state_dict, shared_state_lock))
-        jdownloader.start()
+        print("\n===== API Information =====")
+        api_key = Config('API').get('key')
+        if not api_key:
+            api_key = shared_state.generate_api_key()
+
+        print('Setup instructions: "https://github.com/rix1337/Quasarr?tab=readme-ov-file#instructions"')
+        print(f'URL: "{shared_state.values['internal_address']}"')
+        print(f'API key: "{api_key}" (without quotes)')
 
-        print(f'\nQuasarr API now running at "{shared_state.values["internal_address"]}"')
-        print('Use this exact URL as "Newznab Indexer" and "SABnzbd Download Client" in Sonarr/Radarr')
-        print("Leave settings at default and use this API key: 'quasarr'")
+        if external_address != internal_address:
+            print(f'External URL: "{shared_state.values["external_address"]}"')
+
+        print("\n===== Quasarr Info Log =====")
+        if os.getenv('DEBUG'):
+            print("=====    / Debug Log   =====")
 
         protected = shared_state.get_db("protected").retrieve_all_titles()
         if protected:
             package_count = len(protected)
-            print(f"\nCAPTCHA-Solution required for {package_count} package{'s' if package_count > 1 else ''} at "
-                  f'{shared_state.values["external_address"]}/captcha"!\n')
+            info(f'CAPTCHA-Solution required for {package_count} package{'s' if package_count > 1 else ''} at: '
+                 f'"{shared_state.values["external_address"]}/captcha"!')
+
+        jdownloader = multiprocessing.Process(
+            target=jdownloader_connection,
+            args=(shared_state_dict, shared_state_lock)
+        )
+        jdownloader.start()
+
+        updater = multiprocessing.Process(
+            target=update_checker,
+            args=(shared_state_dict, shared_state_lock)
+        )
+        updater.start()
 
         try:
-            api(shared_state_dict, shared_state_lock)
+            get_api(shared_state_dict, shared_state_lock)
         except KeyboardInterrupt:
+            jdownloader.kill()
+            updater.kill()
             sys.exit(0)
 
 
-def jdownloader_connection(shared_state_dict, shared_state_lock):
-    shared_state.set_state(shared_state_dict, shared_state_lock)
-
-    shared_state.set_device_from_config()
-
-    connection_established = shared_state.get_device() and shared_state.get_device().name
-    if not connection_established:
-        i = 0
-        while i < 10:
-            i += 1
-            print(f'Connection {i} to JDownloader failed. Device name: "{shared_state.values["device"]}"')
-            time.sleep(60)
-            shared_state.set_device_from_config()
-            connection_established = shared_state.get_device() and shared_state.get_device().name
-            if connection_established:
-                break
+def update_checker(shared_state_dict, shared_state_lock):
+    try:
+        shared_state.set_state(shared_state_dict, shared_state_lock)
+
+        message = "!!! UPDATE AVAILABLE !!!"
+        link = "https://github.com/rix1337/Quasarr/releases/latest"
+
+        shared_state.update("last_checked_version", f"v.{version.get_version()}")
+
+        while True:
+            try:
+                update_available = version.newer_version_available()
+            except Exception as e:
+                info(f"Error getting latest version: {e}")
+                info(f'Please manually check: "{link}" for more information!')
+                update_available = None
+
+            if update_available and shared_state.values["last_checked_version"] != update_available:
+                shared_state.update("last_checked_version", update_available)
+                info(message)
+                info(f"Please update to {update_available} as soon as possible!")
+                info(f'Release notes at: "{link}"')
+                update_available = {
+                    "version": update_available,
+                    "link": link
+                }
+                send_discord_message(shared_state, message, "quasarr_update", details=update_available)
+
+            # wait one hour before next check
+            time.sleep(60 * 60)
+    except KeyboardInterrupt:
+        pass
 
+
+def jdownloader_connection(shared_state_dict, shared_state_lock):
     try:
-        print(f'Connection to JDownloader successful. Device name: "{shared_state.get_device().name}"')
-    except:
-        print('Error connecting to JDownloader! Stopping Quasarr!')
-        sys.exit(1)
+        shared_state.set_state(shared_state_dict, shared_state_lock)
+
+        shared_state.set_device_from_config()
+
+        connection_established = shared_state.get_device() and shared_state.get_device().name
+        if not connection_established:
+            i = 0
+            while i < 10:
+                i += 1
+                info(f'Connection {i} to JDownloader failed. Device name: "{shared_state.values["device"]}"')
+                time.sleep(60)
+                shared_state.set_device_from_config()
+                connection_established = shared_state.get_device() and shared_state.get_device().name
+                if connection_established:
+                    break
+
+        try:
+            info(f'Connection to JDownloader successful. Device name: "{shared_state.get_device().name}"')
+        except Exception as e:
+            info(f'Error connecting to JDownloader: {e}! Stopping Quasarr!')
+            sys.exit(1)
+
+        try:
+            shared_state.set_device_settings()
+        except Exception as e:
+            print(f"Error checking settings: {e}")
+
+        try:
+            shared_state.update_jdownloader()
+        except Exception as e:
+            print(f"Error updating JDownloader: {e}")
+
+        try:
+            shared_state.start_downloads()
+        except Exception as e:
+            print(f"Error starting downloads: {e}")
+
+    except KeyboardInterrupt:
+        pass
 
 
 class Unbuffered(object):
@@ -191,3 +355,113 @@ def check_ip():
     finally:
         s.close()
     return ip
+
+
+def check_flaresolverr(shared_state, flaresolverr_url):
+    # Ensure it ends with /v<digit+>
+    if not re.search(r"/v\d+$", flaresolverr_url):
+        print(f"FlareSolverr URL does not end with /v#: {flaresolverr_url}")
+        return False
+
+    # Try sending a simple test request
+    headers = {"Content-Type": "application/json"}
+    data = {
+        "cmd": "request.get",
+        "url": "http://www.google.com/",
+        "maxTimeout": 10000
+    }
+
+    try:
+        response = requests.post(flaresolverr_url, headers=headers, json=data, timeout=10)
+        response.raise_for_status()
+        json_data = response.json()
+
+        # Check if the structure looks like a valid FlareSolverr response
+        if "status" in json_data and json_data["status"] == "ok":
+            solution = json_data["solution"]
+            solution_ua = solution.get("userAgent", None)
+            if solution_ua:
+                shared_state.update("user_agent", solution_ua)
+            return True
+        else:
+            print(f"Unexpected FlareSolverr response: {json_data}")
+            return False
+
+    except Exception as e:
+        print(f"Failed to connect to FlareSolverr: {e}")
+        return False
+
+
+def make_raw_pastebin_link(url):
+    """
+    Takes a Pastebin URL and ensures it is a raw link.
+    If it's not a Pastebin URL, it returns the URL unchanged.
+    """
+    # Check if the URL is already a raw Pastebin link
+    if re.match(r"https?://(?:www\.)?pastebin\.com/raw/\w+", url):
+        return url  # Already raw, return as is
+
+    # Check if the URL is a standard Pastebin link
+    pastebin_pattern = r"https?://(?:www\.)?pastebin\.com/(\w+)"
+    match = re.match(pastebin_pattern, url)
+
+    if match:
+        paste_id = match.group(1)
+        print(f"The link you provided is not a raw Pastebin link. Attempting to convert it to a raw link from {url}...")
+        return f"https://pastebin.com/raw/{paste_id}"
+
+    return url  # Not a Pastebin link, return unchanged
+
+
+def is_valid_url(url):
+    if "https://pastebin.com/raw/eX4Mpl3" in url:
+        print("Example URL detected. Please provide a valid URL found on pastebin or another public site!")
+        return False
+
+    parsed = urlparse(url)
+    return parsed.scheme in ("http", "https") and bool(parsed.netloc)
+
+
+def validate_address(address, name):
+    if not address.startswith("http"):
+        sys.exit(f"Error: {name} '{address}' is invalid. It must start with 'http'.")
+
+    colon_count = address.count(":")
+    if colon_count < 1 or colon_count > 2:
+        sys.exit(
+            f"Error: {name} '{address}' is invalid. It must contain 1 or 2 colons, but it has {colon_count}.")
+
+
+def extract_allowed_keys(config, section):
+    """
+    Extracts allowed keys from the specified section in the configuration.
+
+    :param config: The configuration dictionary.
+    :param section: The section from which to extract keys.
+    :return: A list of allowed keys.
+    """
+    if section not in config:
+        raise ValueError(f"Section '{section}' not found in configuration.")
+    return [key for key, *_ in config[section]]
+
+
+def extract_kv_pairs(input_text, allowed_keys):
+    """
+    Extracts key-value pairs from the given text where keys match allowed_keys.
+
+    :param input_text: The input text containing key-value pairs.
+    :param allowed_keys: A list of allowed two-letter shorthand keys.
+    :return: A dictionary of extracted key-value pairs.
+    """
+    kv_pattern = re.compile(rf"^({'|'.join(map(re.escape, allowed_keys))})\s*=\s*(.*)$")
+    kv_pairs = {}
+
+    for line in input_text.splitlines():
+        match = kv_pattern.match(line.strip())
+        if match:
+            key, value = match.groups()
+            kv_pairs[key] = value
+        else:
+            print(f"Skipping line because it does not contain any supported hostname: {line}")
+
+    return kv_pairs

quasarr/api/__init__.py

@@ -0,0 +1,187 @@
+# -*- coding: utf-8 -*-
+# Quasarr
+# Project by https://github.com/rix1337
+
+from bottle import Bottle
+
+import quasarr.providers.html_images as images
+from quasarr.api.arr import setup_arr_routes
+from quasarr.api.captcha import setup_captcha_routes
+from quasarr.api.config import setup_config
+from quasarr.api.sponsors_helper import setup_sponsors_helper_routes
+from quasarr.api.statistics import setup_statistics
+from quasarr.providers import shared_state
+from quasarr.providers.html_templates import render_button, render_centered_html
+from quasarr.providers.web_server import Server
+from quasarr.storage.config import Config
+
+
+def get_api(shared_state_dict, shared_state_lock):
+    shared_state.set_state(shared_state_dict, shared_state_lock)
+
+    app = Bottle()
+
+    setup_arr_routes(app)
+    setup_captcha_routes(app)
+    setup_config(app, shared_state)
+    setup_statistics(app, shared_state)
+    setup_sponsors_helper_routes(app)
+
+    @app.get('/')
+    def index():
+        protected = shared_state.get_db("protected").retrieve_all_titles()
+        api_key = Config('API').get('key')
+
+        captcha_hint = ""
+        if protected:
+            plural = 's' if len(protected) > 1 else ''
+            captcha_hint += f"""
+            <div class="section">
+                <h2>🔒 Link{plural} waiting for CAPTCHA solution</h2>
+                """
+
+            if not shared_state.values.get("helper_active"):
+                captcha_hint += f"""
+                <p>
+                    <a href="https://github.com/rix1337/Quasarr?tab=readme-ov-file#sponsorshelper" target="_blank">
+                        Sponsors get automated CAPTCHA solutions!
+                    </a>
+                </p>
+                """
+
+            plural = 's' if len(protected) > 1 else ''
+            captcha_hint += f"""
+                <p>{render_button(f"Solve CAPTCHA{plural}", 'primary', {'onclick': "location.href='/captcha'"})}</p>
+            </div>
+            <hr>
+            """
+
+        info = f"""
+        <h1><img src="{images.logo}" type="image/png" alt="Quasarr logo" class="logo"/>Quasarr</h1>
+
+        {captcha_hint}
+
+        <div class="section">
+            <h2>📖 Setup Instructions</h2>
+            <p>
+                <a href="https://github.com/rix1337/Quasarr?tab=readme-ov-file#instructions" target="_blank">
+                    Refer to the README for detailed instructions.
+                </a>
+            </p>
+        </div>
+
+        <hr>
+
+        <div class="section">
+            <h2>⚙️ API Configuration</h2>
+            <p>Use the URL and API Key below to set up a <strong>Newznab Indexer</strong> and <strong>SABnzbd Download Client</strong> in Radarr/Sonarr:</p>
+
+            <details id="apiDetails">
+                <summary id="apiSummary">Show API Settings</summary>
+                <div class="api-settings">
+
+                    <h3>URL</h3>
+                    <div class="url-wrapper">
+                      <input id="urlInput" class="copy-input" type="text" readonly value="{shared_state.values['internal_address']}" />
+                      <button id="copyUrl" class="btn-primary small">Copy</button>
+                    </div>
+
+                    <h3>API Key</h3>
+                    <div class="api-key-wrapper">
+                      <input id="apiKeyInput" class="copy-input" type="password" readonly value="{api_key}" />
+                      <button id="toggleKey" class="btn-secondary small">Show</button>
+                      <button id="copyKey" class="btn-primary small">Copy</button>
+                    </div>
+
+                    <p>{render_button("Regenerate API key", "secondary", {"onclick": "if(confirm('Regenerate API key?')) location.href='/regenerate-api-key';"})}</p>
+                </div>
+            </details>
+        </div>
+
+        <hr>
+
+        <div class="section">
+            <h2>🔧 Quick Actions</h2>
+            <p><button class="btn-primary" onclick="location.href='/hostnames'">Update Hostnames</button></p>
+            <p><button class="btn-primary" onclick="location.href='/statistics'">View Statistics</button></p>
+        </div>
+
+        <style>
+            .section {{ margin: 20px 0; }}
+            .api-settings {{ padding: 15px 0; }}
+            hr {{ margin: 25px 0; border: none; border-top: 1px solid #ddd; }}
+            details {{ margin: 10px 0; }}
+            summary {{ 
+                cursor: pointer; 
+                padding: 8px 0; 
+                font-weight: 500;
+            }}
+            summary:hover {{ 
+                color: #0066cc; 
+            }}
+        </style>
+
+        <script>
+          const urlInput = document.getElementById('urlInput');
+          const copyUrlBtn = document.getElementById('copyUrl');
+
+          if (copyUrlBtn) {{
+            copyUrlBtn.onclick = () => {{
+              urlInput.select();
+              document.execCommand('copy');
+              copyUrlBtn.innerText = 'Copied!';
+              setTimeout(() => {{ copyUrlBtn.innerText = 'Copy'; }}, 2000);
+            }};
+          }}
+
+          const apiInput = document.getElementById('apiKeyInput');
+          const toggleBtn = document.getElementById('toggleKey');
+          const copyBtn = document.getElementById('copyKey');
+
+          if (toggleBtn) {{
+            toggleBtn.onclick = () => {{
+              const isHidden = apiInput.type === 'password';
+              apiInput.type = isHidden ? 'text' : 'password';
+              toggleBtn.innerText = isHidden ? 'Hide' : 'Show';
+            }};
+          }}
+
+          if (copyBtn) {{
+            copyBtn.onclick = () => {{
+              apiInput.type = 'text';
+              apiInput.select();
+              document.execCommand('copy');
+              copyBtn.innerText = 'Copied!';
+              toggleBtn.innerText = 'Hide';
+              setTimeout(() => {{ copyBtn.innerText = 'Copy'; }}, 2000);
+            }};
+          }}
+
+          // Handle details toggle
+          const apiDetails = document.getElementById('apiDetails');
+          const apiSummary = document.getElementById('apiSummary');
+
+          if (apiDetails && apiSummary) {{
+            apiDetails.addEventListener('toggle', () => {{
+              if (apiDetails.open) {{
+                apiSummary.textContent = 'Hide API Settings';
+              }} else {{
+                apiSummary.textContent = 'Show API Settings';
+              }}
+            }});
+          }}
+        </script>
+        """
+        return render_centered_html(info)
+
+    @app.get('/regenerate-api-key')
+    def regenerate_api_key():
+        api_key = shared_state.generate_api_key()
+        return f"""
+        <script>
+          alert('API key replaced with: {api_key}');
+          window.location.href = '/';
+        </script>
+        """
+
+    Server(app, listen='0.0.0.0', port=shared_state.values["port"]).serve_forever()