meshcore-gui/meshcore_gui/config.py

"""
Application configuration for MeshCore GUI.

Contains only global runtime settings.
Bot configuration lives in :mod:`meshcore_gui.services.bot`.
UI display constants live in :mod:`meshcore_gui.gui.constants`.

The ``DEBUG`` flag defaults to False and can be activated at startup
with the ``--debug-on`` command-line option.

Debug output is written to both stdout and a rotating log file at
``~/.meshcore-gui/logs/meshcore_gui.log``.
"""

import json
import logging
import sys
from logging.handlers import RotatingFileHandler
from pathlib import Path
from typing import Any, Dict, List


# ==============================================================================
# VERSION
# ==============================================================================


VERSION: str = "1.24.5"


# ==============================================================================
# OPERATOR / LANDING PAGE
# ==============================================================================

# Operator callsign shown on the landing page SVG and drawer footer.
# Change this to your own callsign (e.g. "PE1HVH", "PE1HVH/MIT").
OPERATOR_CALLSIGN: str = "PE1HVH"

# Path to the landing page SVG file.
# The placeholder ``{callsign}`` inside the SVG is replaced at runtime
# with ``OPERATOR_CALLSIGN``.
#
# Default: the bundled DOMCA splash (static/landing_default.svg).
# To use a custom SVG, point this to your own file, e.g.:
#   LANDING_SVG_PATH = DATA_DIR / "landing.svg"
LANDING_SVG_PATH: Path = Path(__file__).parent / "static" / "landing_default.svg"


# ==============================================================================
# MAP DEFAULTS
# ==============================================================================

# Default map centre used as the initial view *before* the device reports
# its own GPS position.  Once the device advertises a valid adv_lat/adv_lon
# pair, every map will re-centre on the device's actual location.
#
# Change these values to match the location of your device / station.
# Current default: Zwolle, The Netherlands (52.5168, 6.0830).
DEFAULT_MAP_CENTER: tuple[float, float] = (52.5168, 6.0830)

# Default zoom level for all Leaflet maps (higher = more zoomed in).
DEFAULT_MAP_ZOOM: int = 9



# ==============================================================================
# DIRECTORY STRUCTURE
# ==============================================================================

# Base data directory — all persistent data lives under this root.
# Existing services (cache, pins, archive) each define their own
# sub-directory; this constant centralises the root for new consumers.
DATA_DIR: Path = Path.home() / ".meshcore-gui"

# Log directory for debug and error log files.
LOG_DIR: Path = DATA_DIR / "logs"

# Bot configuration directory — bot JSON files live here.
# File naming: _<safe_dev_id>_bot.json (e.g. _dev_ttyUSB1_bot.json).
BOT_DIR: Path = DATA_DIR / "bot"

# Repeater configuration directory — one JSON file per device, holding
# the repeaters that are polled for statistics.  The file contains the
# repeater login password, so RepeaterConfigStore creates the directory
# with mode 0700 and the file with mode 0600.
# File naming: _<safe_dev_id>_repeaters.json.
REPEATERS_DIR: Path = DATA_DIR / "repeaters"

# Log file path (rotating: max 5 MB per file, 3 backups = 20 MB total).
LOG_FILE: Path = LOG_DIR / "meshcore_gui.log"


def set_log_file_for_device(device_id: str) -> None:
    """Set the log file name based on the device identifier.

    Transforms ``F0:9E:9E:75:A3:01`` into
    ``~/.meshcore-gui/logs/F0_9E_9E_75_A3_01_meshcore_gui.log`` and
    ``/dev/ttyUSB0`` into ``~/.meshcore-gui/logs/_dev_ttyUSB0_meshcore_gui.log``.

    Must be called **before** the first ``debug_print()`` call so the
    lazy logger initialisation picks up the correct path.
    """
    global LOG_FILE
    safe_name = (
        device_id
        .replace("literal:", "")
        .replace(":", "_")
        .replace("/", "_")
    )
    LOG_FILE = LOG_DIR / f"{safe_name}_meshcore_gui.log"

# Maximum size per log file in bytes (5 MB).
LOG_MAX_BYTES: int = 5 * 1024 * 1024

# Number of rotated backup files to keep.
LOG_BACKUP_COUNT: int = 3


# ==============================================================================
# DEBUG
# ==============================================================================

DEBUG: bool = False

# Internal file logger — initialised lazily on first debug_print() call.
_file_logger: logging.Logger | None = None


def _init_file_logger() -> logging.Logger:
    """Create and configure the rotating file logger (called once)."""
    LOG_DIR.mkdir(parents=True, exist_ok=True)

    logger = logging.getLogger("meshcore_gui.debug")
    logger.setLevel(logging.DEBUG)
    logger.propagate = False

    handler = RotatingFileHandler(
        LOG_FILE,
        maxBytes=LOG_MAX_BYTES,
        backupCount=LOG_BACKUP_COUNT,
        encoding="utf-8",
    )
    handler.setFormatter(
        logging.Formatter("%(asctime)s  %(message)s", datefmt="%Y-%m-%d %H:%M:%S")
    )
    logger.addHandler(handler)
    return logger


def _caller_module() -> str:
    """Return a short module label for the calling code.

    Walks two frames up (debug_print -> caller) and extracts the
    module ``__name__``.  The common ``meshcore_gui.`` prefix is
    stripped for brevity, e.g. ``ble.worker`` instead of
    ``meshcore_gui.ble.worker``.
    """
    frame = sys._getframe(2)  # 0=_caller_module, 1=debug_print, 2=actual caller
    module = frame.f_globals.get("__name__", "<unknown>")
    if module.startswith("meshcore_gui."):
        module = module[len("meshcore_gui."):]
    return module


def _init_meshcore_logger() -> None:
    """Route meshcore library debug output to our rotating log file.

    The meshcore library uses ``logging.getLogger("meshcore")`` throughout,
    but never attaches a handler.  Without this function all library-level
    debug output (raw send/receive, event dispatching, command flow)
    is silently dropped because Python's root logger only forwards
    WARNING and above.

    Call once at startup (or lazily from ``debug_print``) so that
    ``MESHCORE_LIB_DEBUG=True`` actually produces visible output.
    """
    LOG_DIR.mkdir(parents=True, exist_ok=True)

    mc_logger = logging.getLogger("meshcore")
    # Guard against duplicate handlers on repeated calls
    if any(isinstance(h, RotatingFileHandler) for h in mc_logger.handlers):
        return

    handler = RotatingFileHandler(
        LOG_FILE,
        maxBytes=LOG_MAX_BYTES,
        backupCount=LOG_BACKUP_COUNT,
        encoding="utf-8",
    )
    handler.setFormatter(
        logging.Formatter(
            "%(asctime)s  LIB [%(name)s]: %(message)s",
            datefmt="%Y-%m-%d %H:%M:%S",
        )
    )
    mc_logger.addHandler(handler)

    # Also add a stdout handler so library output appears in the console
    stdout_handler = logging.StreamHandler(sys.stdout)
    stdout_handler.setFormatter(
        logging.Formatter(
            "%(asctime)s  LIB [%(name)s]: %(message)s",
            datefmt="%Y-%m-%d %H:%M:%S",
        )
    )
    mc_logger.addHandler(stdout_handler)


def debug_print(msg: str) -> None:
    """Print a debug message when ``DEBUG`` is enabled.

    Output goes to both stdout and the rotating log file.
    The calling module name is automatically included so that
    exception context is immediately clear, e.g.::

        DEBUG [ble.worker]: send_appstart attempt 3 exception: TimeoutError
    """
    global _file_logger

    if not DEBUG:
        return

    module = _caller_module()
    formatted = f"DEBUG [{module}]: {msg}"

    # stdout (existing behaviour, now with module tag)
    print(formatted)

    # Rotating log file
    if _file_logger is None:
        _file_logger = _init_file_logger()
        # Also wire up the meshcore library logger so MESHCORE_LIB_DEBUG
        # output actually appears in the same log file + stdout.
        _init_meshcore_logger()
    _file_logger.debug(formatted)


def pp(obj: Any, indent: int = 2) -> str:
    """Pretty-format a dict, list, or other object for debug output.

    Use inside f-strings::

        debug_print(f"payload={pp(r.payload)}")

    Dicts/lists get indented JSON; everything else falls back to repr().
    """
    if isinstance(obj, (dict, list)):
        try:
            return json.dumps(obj, indent=indent, default=str, ensure_ascii=False)
        except (TypeError, ValueError):
            return repr(obj)
    return repr(obj)


def debug_data(label: str, obj: Any) -> None:
    """Print a labelled data structure with pretty indentation.

    Combines a header line with pretty-printed data below it::

        debug_data("get_contacts result", r.payload)

    Output::

        DEBUG [worker]: get_contacts result ↓
          {
            "name": "PE1HVH",
            "contacts": 629,
            ...
          }
    """
    if not DEBUG:
        return
    formatted = pp(obj)
    # Single-line values stay on the same line
    if '\n' not in formatted:
        debug_print(f"{label}: {formatted}")
    else:
        # Multi-line: indent each line for readability
        indented = '\n'.join(f"  {line}" for line in formatted.splitlines())
        debug_print(f"{label} ↓\n{indented}")


# ==============================================================================
# CHANNELS
# ==============================================================================

# Maximum number of channel slots to probe on the device.
# MeshCore supports up to 8 channels (indices 0-7).
MAX_CHANNELS: int = 255

# Enable or disable caching of the channel list to disk.
# When False (default), channels are always fetched fresh from the
# device at startup, guaranteeing the GUI always reflects the actual
# device configuration.  When True, channels are loaded from cache
# for instant GUI population and then refreshed from the device.
# Note: channel *keys* (for packet decryption) are always cached
# regardless of this setting.
CHANNEL_CACHE_ENABLED: bool = False

# Number of consecutive unanswered channel slots after which discovery
# aborts.  A slot counts as unanswered when the device times out or
# returns ERROR; slots the device answers for (even empty ones) reset
# the counter.  Raising this makes discovery more patient with a slow
# device at the cost of a longer startup scan.
CHANNEL_DISCOVERY_ABORT_THRESHOLD: int = 3


# ==============================================================================
# PUBLIC API
# ==============================================================================

# Enable or disable the public REST API endpoints (/api/v1/*).
# When False, no routes are registered and the API is unreachable.
API_ENABLED: bool = True

# CORS origins allowed to call the public API.
# Set to the internal IP or hostname of the domca.nl Raspberry Pi.
# Example: ["http://192.168.1.10", "https://www.domca.nl"]
# Use ["*"] only on trusted internal networks.
API_CORS_ORIGINS: list[str] = ["*"]


# ==============================================================================
# BOT DEVICE NAME
# ==============================================================================

# Fixed device name applied when the BOT checkbox is enabled.
# The original device name is saved and restored when BOT is disabled.
BOT_DEVICE_NAME: str = "ZwolsBotje"

# Default device name used as fallback when restoring from BOT mode
# and no original name was saved (e.g. after a restart).
DEVICE_NAME: str = "PE1HVH T1000e"


# ==============================================================================
# CACHE / REFRESH
# ==============================================================================

# Default timeout (seconds) for meshcore command responses.
# Increase if you see frequent 'no_event_received' errors during startup.
DEFAULT_TIMEOUT: float = 10.0

# Enable debug logging inside the meshcore library itself.
# When True, raw send/receive data and event parsing are logged.
MESHCORE_LIB_DEBUG: bool = True

# ==============================================================================
# TRANSPORT MODE  (auto-detected from CLI argument)
# ==============================================================================

# "serial" or "ble" — set at startup by main() based on the device argument.
TRANSPORT: str = "serial"


def is_ble_address(device_id: str) -> bool:
    """Detect whether *device_id* looks like a BLE MAC address.

    Heuristic:
    - Starts with ``literal:`` → BLE
    - Matches ``XX:XX:XX:XX:XX:XX`` (6 colon-separated hex pairs) → BLE
    - Everything else (``/dev/…``, ``COM…``) → Serial
    """
    if device_id.lower().startswith("literal:"):
        return True
    parts = device_id.split(":")
    if len(parts) == 6 and all(len(p) == 2 for p in parts):
        try:
            for p in parts:
                int(p, 16)
            return True
        except ValueError:
            pass
    return False
TRANSPORT: str = "serial"

# Serial connection defaults.
SERIAL_BAUDRATE: int = 115200
SERIAL_CX_DELAY: float = 0.1

# BLE connection defaults.
# BLE pairing PIN for the MeshCore device (T1000e default: 123456).
# Used by the built-in D-Bus agent to answer pairing requests
# automatically — eliminates the need for bt-agent.service.
BLE_PIN: str = "123456"

# Maximum number of reconnect attempts after a disconnect.
RECONNECT_MAX_RETRIES: int = 5

# Base delay in seconds between reconnect attempts (multiplied by
# attempt number for linear backoff: 5s, 10s, 15s, 20s, 25s).
RECONNECT_BASE_DELAY: float = 5.0

# Interval in seconds between periodic contact refreshes from the device.
# Contacts are merged (new/changed contacts update the cache; contacts
# only present in cache are kept so offline nodes are preserved).
CONTACT_REFRESH_SECONDS: float = 300.0  # 5 minutes

# Interval in seconds between safety-net polls of the device message queue.
#
# The meshcore library fetches messages only in response to a
# ``messages_waiting`` event from the companion radio.  When that event is
# missed, incoming messages stay queued on the device indefinitely: the
# radio receives and ACKs the packet, but no ``CONTACT_MSG_RECV`` /
# ``CHANNEL_MSG_RECV`` event ever reaches the application.
#
# This poll drains the queue on a fixed interval regardless of the event,
# so a missed notification delays a message instead of losing it.  Set to
# ``0`` to disable the poll and rely on the event alone.
MSG_POLL_INTERVAL: float = 30.0

# ==============================================================================
# EXTERNAL LINKS (drawer menu)
# ==============================================================================

EXT_LINKS = [
    ('MeshCore',      'https://meshcore.co.uk'),
    ('Handleiding',   'https://www.pe1hvh.nl/pdf/MeshCore_Complete_Handleiding.pdf'),
    ('Netwerk kaart', 'https://meshcore.co.uk/map'),
    ('LocalMesh NL',  'https://www.localmesh.nl/'),
]
# ==============================================================================
# ARCHIVE / RETENTION
# ==============================================================================

# Retention period for archived messages (in days).
# Messages older than this are automatically removed during cleanup.
MESSAGE_RETENTION_DAYS: int = 30

# Retention period for RX log entries (in days).
# RX log entries older than this are automatically removed during cleanup.
RXLOG_RETENTION_DAYS: int = 14

# Retention period for contacts (in days).
# Contacts not seen for longer than this are removed from cache.
CONTACT_RETENTION_DAYS: int = 90

# Retention period for repeater statistics (in days).
# Records older than this are removed from the JSONL archive during
# the daily cleanup run.
REPEATER_STATS_RETENTION_DAYS: int = 90

# Retention period for repeater configuration readings (in days).
# One record per repeater per day, so a year of history is a few hundred
# lines.  Longer than the statistics retention on purpose: the value of
# this archive is spotting that a setting changed months ago.
REPEATER_CONFIG_RETENTION_DAYS: int = 365


# ==============================================================================
# REPEATER STATISTICS POLLING
# ==============================================================================

# Enable or disable periodic polling of repeater statistics.
# When False, no repeater is contacted regardless of what is configured.
REPEATER_POLL_ENABLED: bool = True

# Default seconds between polls of a single repeater (15 minutes).
# Overridable per repeater with "poll_interval" in the repeater
# configuration file.  Repeater statistics change slowly; polling more
# often costs airtime and makes the local node deaf for longer without
# yielding extra information.
REPEATER_POLL_INTERVAL: float = 900.0

# Seconds between checks for a repeater that is due to be polled.
# The poller itself decides whether anything is due; this only sets how
# often the main loop asks.
REPEATER_POLL_CHECK_INTERVAL: float = 10.0

# Minimum seconds to wait for the LOGIN_SUCCESS event after sending a
# login request.  The library derives a timeout from the value the device
# suggests; this raises it when that suggestion is too optimistic for a
# distant repeater.
REPEATER_LOGIN_TIMEOUT: float = 30.0

# Minimum seconds to wait for the STATUS_RESPONSE after a status request.
REPEATER_STATUS_TIMEOUT: float = 30.0

# Maximum number of attempts per poll of a single repeater.
# One attempt is a complete session: login, status request, logout.  A
# repeater that fails to answer is retried up to this many times before
# the poll is recorded as failed.  Set to 1 to disable retries entirely.
# A poll runs as a background task and is cancelled as soon as there is
# traffic to send, so a high budget no longer delays outgoing messages.
REPEATER_POLL_MAX_ATTEMPTS: int = 5

# Seconds to wait between two attempts within the same poll.
# Deliberately short: a longer pause does not make a stale path recover
# any faster, and every extra second is another second in which the poll
# can be cancelled before it has produced a measurement.
REPEATER_POLL_RETRY_DELAY: float = 5.0

# Maximum seconds to wait for a cancelled poll to finish its cleanup.
# Cancelling interrupts the poll, after which it still sends a logout to
# close the session on the repeater.  This bounds that cleanup so a
# unresponsive transport cannot hold up the command that preempted it.
REPEATER_POLL_CANCEL_TIMEOUT: float = 5.0


# ==============================================================================
# REPEATER CONFIGURATION POLLING (nightly)
# ==============================================================================
#
# Separate from the statistics poll above.  These settings are read over
# the repeater CLI, one round trip per setting, and change only when
# somebody edits them — so they are read once a day instead of every
# fifteen minutes.

# Enable or disable the nightly configuration read.
# When False, no CLI command is sent to any repeater.
REPEATER_CONFIG_POLL_ENABLED: bool = True

# Local hour at which the nightly window opens (0-23).
# Chosen at night because a full round costs one round trip per setting
# and competes with the least other traffic there.
REPEATER_CONFIG_POLL_HOUR: int = 3

# Length of the nightly window in hours.
# A repeater that is unreachable at the start of the window still gets
# its turn later that night, because the window is checked on every tick
# until the read succeeds or the window closes.
REPEATER_CONFIG_POLL_WINDOW_HOURS: int = 3

# CLI commands sent per repeater, in this order.
# The value is stored under the command name minus the "get " verb, so
# "get flood.max" ends up as "flood.max".  Adding or removing a command
# here needs no code change.
REPEATER_CONFIG_POLL_KEYS: List[str] = [
    "get flood.max",
    "get flood.max.unscoped",
    "get flood.max.advert",
    "get loop.detect",
    "get txdelay",
    "get rxdelay",
    "get int.thresh",
    "get radio.rxgain",
    "get agc.reset.interval",
    "region",
]

# Seconds to wait for the reply to a single CLI command.
# A setting that stays silent is recorded as missing and the next one is
# tried, so this is the cost of one unanswered setting, not of the round.
REPEATER_CONFIG_REPLY_TIMEOUT: float = 30.0

# Text type of a CLI reply from a repeater (CLI_DATA in the firmware).
# This is what separates a CLI answer from an ordinary direct message,
# both in the poller and in the event handler.  Only change this if the
# firmware starts using a different value.
REPEATER_CONFIG_REPLY_TXT_TYPE: int = 1


# ==============================================================================
# CHANNEL LIST SORT
# ==============================================================================

# Default sort mode for the drawer channel submenus (Messages and Archive).
# This value is applied the first time the application is run or whenever
# the stored preference file is missing/corrupt; once the user toggles
# the sort control the chosen mode is persisted to
# ``~/.meshcore-gui/channel_sort.json`` by :class:`ChannelSortStore`.
#
# Accepted values:
#   "index" — ascending channel index (native MeshCore order, default)
#   "name"  — case-insensitive alphabetical by channel name
#
# The Public channel (idx 0) is always rendered at the top regardless
# of this setting; see :func:`sort_channels` in services/channel_service.py.
CHANNEL_SORT_MODE_DEFAULT: str = "index"


# BBS channel configuration is managed at runtime via BbsConfigStore.
# Settings are persisted to ~/.meshcore-gui/bbs/bbs_config.json
# and edited through the BBS Settings panel in the GUI.