tak_client.py

"""
MIT License

Copyright (c) 2024 cemaxecuter

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
"""


import socket
import ssl
import logging
import time
from typing import Optional

logger = logging.getLogger(__name__)

class TAKClient:
    """Client for connecting to a TAK server using TLS and sending CoT messages."""

    def __init__(self, tak_host: str, tak_port: int, tak_tls_context: Optional[ssl.SSLContext], max_retries: int = 5, backoff_factor: float = 2.0):
        self.tak_host = tak_host
        self.tak_port = tak_port
        self.tak_tls_context = tak_tls_context
        self.sock = None
        self.max_retries = max_retries
        self.backoff_factor = backoff_factor
        self.retry_count = 0

    # Added Properties
    @property
    def host(self) -> str:
        """Returns the TAK server host."""
        return self.tak_host

    @property
    def port(self) -> int:
        """Returns the TAK server port."""
        return self.tak_port

    def connect(self):
        """Establishes a connection to the TAK server with exponential backoff."""
        while self.retry_count < self.max_retries:
            try:
                self.sock = socket.create_connection((self.tak_host, self.tak_port), timeout=10)
                if self.tak_tls_context:
                    self.sock = self.tak_tls_context.wrap_socket(self.sock, server_hostname=self.tak_host)
                logger.debug("Connected to TAK server via TCP/TLS")
                self.retry_count = 0  # Reset retry count after successful connection
                return
            except Exception as e:
                wait_time = self.backoff_factor ** self.retry_count
                logger.error(f"Error connecting to TAK server: {e}. Retrying in {wait_time} seconds...")
                time.sleep(wait_time)
                self.retry_count += 1

        logger.critical("Max retries exceeded. Failed to connect to TAK server via TCP/TLS.")
        self.sock = None

    def send(self, cot_xml: bytes):
        """Sends a CoT XML message to the TAK server via TCP/TLS."""
        try:
            if not self.sock:
                self.connect()
            if self.sock:
                self.sock.sendall(cot_xml)
                logger.debug(f"Sent CoT message via TCP/TLS: {cot_xml}")
            else:
                logger.error("No socket available to send CoT message via TCP/TLS.")
        except Exception as e:
            logger.error(f"Error sending CoT message via TCP/TLS: {e}")
            self.close()
            self.connect()

    def close(self):
        """Closes the connection to the TAK server."""
        if self.sock:
            try:
                self.sock.close()
                logger.debug("Closed TAKClient TCP/TLS socket")
            except Exception as e:
                logger.error(f"Error closing TAKClient TCP/TLS socket: {e}")
            finally:
                self.sock = None