redfetch 1.3.0__py3-none-any.whl

redfetch/push.py

@@ -0,0 +1,246 @@
+"""Publish resource updates to RedGuides."""
+
+import os
+import asyncio
+import httpx
+import keepachangelog
+import typer
+from md2bbcode.main import process_readme
+
+from redfetch import api
+from redfetch.net import BASE_URL
+from redfetch import auth
+
+XF_API_URL = f'{BASE_URL}/api'
+URI_MESSAGE = f'{XF_API_URL}/resource-updates'
+URI_ATTACHMENT = f'{XF_API_URL}/attachments/new-key'
+URI_RESOURCE_VERSIONS = f'{XF_API_URL}/resource-versions'
+MAX_MESSAGE_CHARS = 10_000
+
+
+def _get_api_headers_blocking() -> dict:
+    """Synchronous helper to obtain API headers from the async auth client."""
+    return asyncio.run(auth.get_api_headers())
+
+
+def update_resource_description(resource_id, new_description):
+    """Update resource description."""
+    url = f"{XF_API_URL}/resources/{resource_id}"
+    payload = {'description': new_description}
+    headers = _get_api_headers_blocking()
+    response = httpx.post(url, headers=headers, data=payload, timeout=30.0)
+    response.raise_for_status()
+    print("Successfully updated the resource description.")
+
+
+def add_xf_message(resource_id, msg_title, message):
+    """Post a new resource update message."""
+    headers = _get_api_headers_blocking()
+    form_message = {
+        'resource_id': resource_id,
+        'title': msg_title,
+        'message': message
+    }
+    response = httpx.post(URI_MESSAGE, headers=headers, data=form_message, timeout=30.0)
+    response.raise_for_status()
+    print(f"Response: {response.status_code}, {response.text}")
+    return response.json()
+
+
+def add_xf_attachment(resource_id, upfilename, version=None):
+    """Upload a file and attach it as a new resource version."""
+    headers = _get_api_headers_blocking()
+
+    # Prepare the data for getting an attachment key and uploading the file
+    data = {
+        "type": "resource_version",
+        "context[resource_id]": resource_id
+    }
+
+    try:
+        # Get an attachment key and also upload the file
+        with open(upfilename, "rb") as file:
+            files = {"attachment": (os.path.basename(upfilename), file, "application/octet-stream")}
+            response = httpx.post(URI_ATTACHMENT, headers=headers, data=data, files=files, timeout=60.0)
+            response.raise_for_status()
+            content = response.json()
+            attach_key = content.get("key")
+            if attach_key:
+                # Now associate the attachment(s) with the resource version
+                data_update = {
+                    "type": "resource_version",
+                    "resource_id": resource_id,
+                    "version_attachment_key": attach_key,
+                }
+                if version:
+                    data_update["version_string"] = version
+                response_update = httpx.post(URI_RESOURCE_VERSIONS, headers=headers, data=data_update, timeout=60.0)
+                response_update.raise_for_status()
+                print(f"Successfully added attachment for resource {resource_id}")
+            else:
+                print("[ERROR] No attachment key received from the server.")
+                raise RuntimeError("No attachment key received from the server.")
+    except httpx.HTTPStatusError as e:
+        print(f"HTTP Error: {e.response.status_code} - {e.response.text}")
+        raise
+    except FileNotFoundError:
+        print(f"Error: File '{upfilename}' not found.")
+        raise
+
+
+def update_resource(resource_id, version_info, upfilename=None):
+    """Create a version update (message + optional attachment)."""
+    message = version_info.get('message', '')
+    if message.strip():
+        add_xf_message(resource_id, version_info['version_string'], message)
+    else:
+        print("Warning: No message content provided, skipping update post.")
+
+    if upfilename:
+        add_xf_attachment(resource_id, upfilename, version_info['version_string'])
+
+
+def convert_markdown_to_bbcode(markdown_text, domain=None):
+    """Convert markdown text to BBCode."""
+    bbcode_output = process_readme(markdown_text, domain=domain)
+    return bbcode_output
+
+
+def _truncate_text(text: str, max_chars: int, suffix: str = "\n\n(truncated)") -> str:
+    """Truncate text to max_chars (including suffix), if needed."""
+    if not isinstance(text, str):
+        text = str(text)
+    if max_chars <= 0 or len(text) <= max_chars:
+        return text
+
+    suffix = suffix or ""
+    if len(suffix) >= max_chars:
+        return suffix[:max_chars]
+
+    allowed = max_chars - len(suffix)
+    return text[:allowed].rstrip() + suffix
+
+
+def _try_parse_keepachangelog_dict(changelog_path: str):
+    """
+    Attempt to parse a keep-a-changelog file.
+
+    Returns a non-empty dict if it looks like a changelog; otherwise returns None.
+    """
+    try:
+        changes = keepachangelog.to_dict(changelog_path)
+    except Exception:
+        return None
+
+    if not isinstance(changes, dict) or not changes:
+        return None
+
+    return changes
+
+
+def parse_changelog(changelog_path, version, domain=None, changes=None):
+    """
+    Parses the changelog file and returns the changelog entry for the given version as BBCode.
+    """
+    # Use keepachangelog to parse the changelog file
+    if changes is None:
+        changes = keepachangelog.to_dict(changelog_path)
+    # Remove 'v' prefix if present
+    version_key = version.lstrip('v')
+    if version_key in changes:
+        # Flatten the change notes into a markdown string
+        version_data = changes[version_key]
+        markdown_lines = []
+        for section, notes in version_data.items():
+            if section != 'metadata':
+                markdown_lines.append(f"### {section.capitalize()}")
+                for note in notes:
+                    markdown_lines.append(f"- {note}")
+                markdown_lines.append("")  # Add a newline
+        markdown_message = "\n".join(markdown_lines)
+        # Convert markdown to BBCode
+        bbcode_message = convert_markdown_to_bbcode(markdown_message, domain=domain)
+        return bbcode_message
+    else:
+        raise ValueError(f"Version {version} not found in {changelog_path}")
+
+
+def generate_version_message(args):
+    """
+    Build a version message from `--message` (file path or literal string).
+
+    If `--message` is a keep-a-changelog file, extract the entry for `--version`; otherwise post the
+    file contents (markdown is converted to BBCode). Large messages are truncated.
+    """
+    max_chars = MAX_MESSAGE_CHARS
+
+    # message can be a literal string, or a path-like string to a real file.
+    if args.message and os.path.isfile(args.message):
+        message_path = args.message
+        ext = os.path.splitext(message_path)[1].lower()
+
+        if ext == ".md":
+            # If it looks like keep-a-changelog, post the entry for --version; otherwise post the file.
+            changes = _try_parse_keepachangelog_dict(message_path)
+            if changes is not None:
+                try:
+                    message = parse_changelog(message_path, args.version, domain=args.domain, changes=changes)
+                except ValueError as e:
+                    with open(message_path, "r", encoding="utf-8", errors="replace") as f:
+                        markdown_text = f.read()
+                    message = convert_markdown_to_bbcode(markdown_text, domain=args.domain)
+                    print(f"Warning: {e}. Posting full file contents instead.")
+            else:
+                with open(message_path, "r", encoding="utf-8", errors="replace") as f:
+                    markdown_text = f.read()
+                message = convert_markdown_to_bbcode(markdown_text, domain=args.domain)
+        else:
+            # Plain text (or other) file: post as-is.
+            with open(message_path, "r", encoding="utf-8", errors="replace") as f:
+                message = f.read()
+
+        return _truncate_text(message, max_chars)
+
+    # If --message is a regular string, use it directly (still guard against extreme length).
+    return _truncate_text(args.message, max_chars)
+
+
+def update_description(resource_id, description_path, domain=None):
+    """Read description, convert markdown to BBCode if needed, then update."""
+    with open(description_path, 'r') as f:
+        new_description = f.read()
+    if description_path.lower().endswith('.md'):
+        new_description = convert_markdown_to_bbcode(new_description, domain=domain)
+    update_resource_description(resource_id, new_description)
+
+
+def handle_cli(args):
+    """Handle the push subcommand using existing push helpers."""
+
+    if not any([args.description, args.version, args.message, args.file]):
+        print("At least one option (--description, --version, --message, or --file) must be specified.")
+        raise typer.Exit(code=1)
+
+    if args.message and not args.version:
+        print("The --message option requires --version to be specified.")
+        raise typer.Exit(code=1)
+
+    # Ensure the user is authorized
+    auth.initialize_keyring()
+    auth.authorize()
+
+    # Blocking call is fine here; push is a short-lived CLI operation.
+    headers = _get_api_headers_blocking()
+    resource = asyncio.run(api.get_resource_details(args.resource_id, headers))
+    resource_id = resource['resource_id']
+
+    if args.description:
+        update_description(resource_id, args.description, domain=args.domain)
+
+    if args.version and args.message:
+        message = generate_version_message(args)
+        version_info = {'version_string': args.version, 'message': message}
+        update_resource(resource_id, version_info, args.file)
+    elif args.file:
+        # Allow publishing a version with a file but no changelog message.
+        add_xf_attachment(resource_id, args.file, args.version)

redfetch/runtime_errors.py

@@ -0,0 +1,96 @@
+"""Shared fatal error helpers for startup/CLI boundaries."""
+
+from __future__ import annotations
+
+import os
+import sys
+import traceback
+from typing import NoReturn
+
+
+def is_windows_pyapp() -> bool:
+    """are we using the redfetch.exe executable on windows?"""
+    return sys.platform == "win32" and bool(os.getenv("PYAPP"))
+
+def normalize_error_message(
+    message: str | BaseException | None,
+    *,
+    fallback: str = "An unexpected error occurred.",
+) -> str:
+    """Make a safe non-empty string."""
+    if isinstance(message, BaseException):
+        normalized = str(message).strip()
+        if normalized:
+            return normalized
+        return f"{message.__class__.__name__} ({fallback})"
+
+    if message is None:
+        return fallback
+
+    normalized = str(message).strip()
+    if normalized:
+        return normalized
+    return fallback
+
+
+def _show_windows_error_dialog(message: str) -> None:
+    """Shows a Windows MessageBox."""
+    try:
+        import ctypes
+
+        ctypes.windll.user32.MessageBoxW(0, message, "redfetch", 0x10)
+    except Exception:
+        # Best effort only: CLI stderr output remains the source of truth.
+        pass
+
+
+def _format_error_details(error: BaseException) -> str:
+    """Summarize the exception with traceback and details."""
+    summary = f"{error.__class__.__name__}: {normalize_error_message(error)}"
+    traceback_text = "".join(
+        traceback.format_exception(type(error), error, error.__traceback__)
+    ).strip()
+    if not traceback_text:
+        return summary
+    return f"{summary}\n\n{traceback_text}"
+
+
+def display_fatal_error(
+    message: str | BaseException | None,
+) -> str:
+    """Print a fatal error and optionally show a Windows MessageBox."""
+    normalized_message = normalize_error_message(message)
+    error_details = (
+        _format_error_details(message)
+        if isinstance(message, BaseException)
+        else None
+    )
+
+    if is_windows_pyapp():
+        if error_details:
+            dialog_message = (
+                "Tip: Press Ctrl+C to copy this error report.\n\n"
+                f"{error_details}"
+            )
+            print(error_details, file=sys.stderr)
+        else:
+            dialog_message = normalized_message
+            print(normalized_message, file=sys.stderr)
+        _show_windows_error_dialog(dialog_message)
+    else:
+        # CLI behavior: print the raw normalized message without extra wrappers.
+        if error_details:
+            print(error_details, file=sys.stderr)
+        else:
+            print(normalized_message, file=sys.stderr)
+
+    return normalized_message
+
+
+def exit_with_fatal_error(
+    message: str | BaseException | None,
+    exit_code: int = 1,
+) -> NoReturn:
+    """Display a fatal error and terminate with a non-zero exit code."""
+    display_fatal_error(message)
+    raise SystemExit(exit_code)

redfetch/settings.toml

@@ -0,0 +1,303 @@
+# Hail adventurer! This file is not meant to be edited directly. 
+# Instead, you should make a settings.local.toml file, and edit that. It will override anything here.
+
+# ========================================
+# DEFAULT SETTINGS USED IN ALL ENVIRONMENTS
+# ========================================
+# These settings are the base configuration for all environments. You can override them with [LIVE], [TEST], or [EMU] sections.
+[DEFAULT]
+DOWNLOAD_FOLDER = "@format {env[REDFETCH_DATA_DIR]}/Downloads"
+EQPATH = ""
+
+# ========================================
+# XenForo OAuth2
+# ========================================
+OAUTH_CLIENT_ID = "4558786089326342"
+OAUTH_CLIENT_SECRET = ""
+OAUTH_SCOPE = "user:read resource:read resource:write attachment:write"
+OAUTH_REDIRECT_URI = "http://127.0.0.1:62897/"
+
+# ========================================
+# LIVE ENVIRONMENT SETTINGS
+# ========================================
+[LIVE]
+THEME = "textual-dark"
+
+[LIVE.PROTECTED_FILES_BY_RESOURCE]
+1974 = ["CharSelect.cfg", "Zoned.cfg", "MQ2Map.ini", "MQ2MoveUtils.ini"]
+
+[LIVE.SPECIAL_RESOURCES.1974]
+default_path = "VanillaMQ_LIVE"
+custom_path = ""
+opt_in = true
+
+[LIVE.SPECIAL_RESOURCES.151]
+default_path = "MySEQ_LIVE"
+custom_path = ""
+opt_in = false
+
+[LIVE.SPECIAL_RESOURCES.151.dependencies.153]
+subfolder = "maps"
+flatten = true
+opt_in = true
+
+[LIVE.SPECIAL_RESOURCES.151.dependencies.1865]
+subfolder = ""
+flatten = false
+opt_in = true
+
+[LIVE.SPECIAL_RESOURCES.153]
+default_path = "@format {this.eqpath}/maps"
+custom_path = ""
+opt_in = false
+
+[LIVE.SPECIAL_RESOURCES.303]
+default_path = "@format {this.eqpath}/maps"
+custom_path = ""
+opt_in = false
+
+# LIVE staff picks
+# kissassist
+[LIVE.SPECIAL_RESOURCES.4]
+opt_in = true
+staff_pick = true
+
+# lua event manager
+[LIVE.SPECIAL_RESOURCES.2539]
+opt_in = true
+staff_pick = true
+
+# guildclicky
+[LIVE.SPECIAL_RESOURCES.2318]
+opt_in = true
+staff_pick = true
+
+# buttonmaster
+[LIVE.SPECIAL_RESOURCES.2174]
+opt_in = true
+staff_pick = true
+
+# alertmaster
+[LIVE.SPECIAL_RESOURCES.2062]
+opt_in = true
+staff_pick = true
+
+# rgmercs
+[LIVE.SPECIAL_RESOURCES.3040]
+opt_in = true
+staff_pick = true
+
+# lootly
+[LIVE.SPECIAL_RESOURCES.2196]
+opt_in = true
+staff_pick = true
+
+# boxhud
+[LIVE.SPECIAL_RESOURCES.2088]
+opt_in = true
+staff_pick = true
+
+# scriber
+[LIVE.SPECIAL_RESOURCES.2391]
+opt_in = true
+staff_pick = true
+
+# bazaar / auction helper
+[LIVE.SPECIAL_RESOURCES.3001]
+opt_in = true
+staff_pick = true
+
+# skill skillup: spells and others
+[LIVE.SPECIAL_RESOURCES.2937]
+opt_in = true
+staff_pick = true
+
+# Ninjadvloot.inc
+[LIVE.SPECIAL_RESOURCES.973]
+opt_in = true
+staff_pick = true
+
+# ========================================
+# TEST ENVIRONMENT SETTINGS
+# ========================================
+[TEST]
+THEME = "gruvbox"
+
+[TEST.PROTECTED_FILES_BY_RESOURCE]
+2218 = ["CharSelect.cfg", "Zoned.cfg", "MQ2Map.ini", "MQ2MoveUtils.ini"]
+
+[TEST.SPECIAL_RESOURCES.2218]
+default_path = "VanillaMQ_TEST"
+custom_path = ""
+opt_in = true
+
+[TEST.SPECIAL_RESOURCES.164]
+default_path = "MySEQ_TEST"
+custom_path = ""
+opt_in = false
+
+[TEST.SPECIAL_RESOURCES.164.dependencies.153]
+subfolder = "maps"
+flatten = true
+opt_in = true
+
+[TEST.SPECIAL_RESOURCES.164.dependencies.1865]
+subfolder = ""
+flatten = false
+opt_in = true
+
+[TEST.SPECIAL_RESOURCES.153]
+default_path = "@format {this.eqpath}/maps"
+custom_path = ""
+opt_in = false
+
+[TEST.SPECIAL_RESOURCES.303]
+default_path = "@format {this.eqpath}/maps"
+custom_path = ""
+opt_in = false
+
+# TEST staff picks
+# kissassist
+[TEST.SPECIAL_RESOURCES.4]
+opt_in = true
+staff_pick = true
+
+# lua event manager
+[TEST.SPECIAL_RESOURCES.2539]
+opt_in = true
+staff_pick = true
+
+# guildclicky
+[TEST.SPECIAL_RESOURCES.2318]
+opt_in = true
+staff_pick = true
+
+# buttonmaster
+[TEST.SPECIAL_RESOURCES.2174]
+opt_in = true
+staff_pick = true
+
+# alertmaster
+[TEST.SPECIAL_RESOURCES.2062]
+opt_in = true
+staff_pick = true
+
+# rgmercs
+[TEST.SPECIAL_RESOURCES.3040]
+opt_in = true
+staff_pick = true
+
+# lootly
+[TEST.SPECIAL_RESOURCES.2196]
+opt_in = true
+staff_pick = true
+
+# boxhud
+[TEST.SPECIAL_RESOURCES.2088]
+opt_in = true
+staff_pick = true
+
+# scriber
+[TEST.SPECIAL_RESOURCES.2391]
+opt_in = true
+staff_pick = true
+
+# bazaar / auction helper
+[TEST.SPECIAL_RESOURCES.3001]
+opt_in = true
+staff_pick = true
+
+# skill skillup: spells and others
+[TEST.SPECIAL_RESOURCES.2937]
+opt_in = true
+staff_pick = true
+
+# Ninjadvloot.inc
+[TEST.SPECIAL_RESOURCES.973]
+opt_in = true
+staff_pick = true
+
+# ========================================
+# EMULATOR ENVIRONMENT SETTINGS
+# ========================================
+[EMU]
+THEME = "dracula"
+
+[EMU.PROTECTED_FILES_BY_RESOURCE]
+60 = ["CharSelect.cfg", "Zoned.cfg", "MQ2Map.ini", "MQ2MoveUtils.ini"]
+
+[EMU.SPECIAL_RESOURCES.60]
+default_path = "VanillaMQ_EMU"
+custom_path = ""
+opt_in = true
+
+[EMU.SPECIAL_RESOURCES.153]
+default_path = "@format {this.eqpath}/maps"
+custom_path = ""
+opt_in = false
+
+[EMU.SPECIAL_RESOURCES.303]
+default_path = "@format {this.eqpath}/maps"
+custom_path = ""
+opt_in = false
+
+# EMU staff picks
+# kissassist
+[EMU.SPECIAL_RESOURCES.4]
+opt_in = true
+staff_pick = true
+
+# lua event manager
+[EMU.SPECIAL_RESOURCES.2539]
+opt_in = true
+staff_pick = true
+
+# guildclicky
+[EMU.SPECIAL_RESOURCES.2318]
+opt_in = true
+staff_pick = true
+
+# buttonmaster
+[EMU.SPECIAL_RESOURCES.2174]
+opt_in = true
+staff_pick = true
+
+# alertmaster
+[EMU.SPECIAL_RESOURCES.2062]
+opt_in = true
+staff_pick = true
+
+# rgmercs
+[EMU.SPECIAL_RESOURCES.3040]
+opt_in = true
+staff_pick = true
+
+# boxhud
+[EMU.SPECIAL_RESOURCES.2088]
+opt_in = true
+staff_pick = true
+
+# scriber
+[EMU.SPECIAL_RESOURCES.2391]
+opt_in = true
+staff_pick = true
+
+# bazaar / auction helper
+[EMU.SPECIAL_RESOURCES.3001]
+opt_in = true
+staff_pick = true
+
+# skill skillup: spells and others
+[EMU.SPECIAL_RESOURCES.2937]
+opt_in = true
+staff_pick = true
+
+# lootnscoot (EMU only)
+[EMU.SPECIAL_RESOURCES.2675]
+opt_in = true
+staff_pick = true
+
+# Ninjadvloot.inc
+[EMU.SPECIAL_RESOURCES.973]
+opt_in = true
+staff_pick = true