spothole/providers/callsigndata/countryfiles.py

from __future__ import annotations

import logging
from typing import Any

from pyhamtools import Callinfo, LookupLib

from core.data_store import DATA_STORE
from core.utils import get_callsign_object_from_pyhamtools_callinfo
from data.callsign import Callsign
from data.lookup_credentials import LookupCredentials
from providers.callsigndata.file_download_callsign_data_provider import (
    FileDownloadCallsignDataProvider,
)

logger = logging.getLogger(__name__)


class CountryFiles(FileDownloadCallsignDataProvider):
    """Callsign data provider for Country-files.com, which provides basic callsign to DXCC entity mapping."""

    POLL_INTERVAL_DAYS = 30
    DATA_URL = "https://www.country-files.com/cty/cty.plist"
    CACHE_PATH = "cache/cty.plist"
    _callinfo: Callinfo | None = None

    def __init__(self, provider_config: dict[str, Any]) -> None:
        super().__init__(
            "CountryFiles.com",
            provider_config,
            self.DATA_URL,
            self.CACHE_PATH,
            self.POLL_INTERVAL_DAYS,
            DATA_STORE.callsign_data_countryfiles,
        )

    def _handle_file(self, path: str) -> bool:
        try:
            lookuplib = LookupLib(lookuptype="countryfile", filename=path)
            self._callinfo = Callinfo(lookuplib)
            return True

        except Exception:
            logger.exception("Exception when loading Country Files cty.plist.")
            return False

    def _perform_new_lookup(self, callsign: str, lookup_credentials: LookupCredentials | None) -> Callsign | None:
        callsign_data = Callsign(call=callsign)

        try:
            if self._callinfo:
                callsign_data = get_callsign_object_from_pyhamtools_callinfo(callsign, self._callinfo)
                self.status = "OK"
                self.lookup_count += 1
            else:
                return None

        except Exception:
            self.status = "Error"
            logger.exception("Exception when looking up data from Country file")

        return callsign_data