aprsd 3.4.3__py3-none-any.whl → 3.4.4__py3-none-any.whl

aprsd/client/aprsis.py

@@ -23,13 +23,24 @@ class APRSISClient(base.APRSClient):
         max_timeout = {"hours": 0.0, "minutes": 2, "seconds": 0}
         self.max_delta = datetime.timedelta(**max_timeout)
 
-    def stats(self) -> dict:
+    def stats(self, serializable=False) -> dict:
         stats = {}
         if self.is_configured():
+            if self._client:
+                keepalive = self._client.aprsd_keepalive
+                server_string = self._client.server_string
+                if serializable:
+                    keepalive = keepalive.isoformat()
+            else:
+                keepalive = "None"
+                server_string = "None"
             stats = {
-                "server_string": self._client.server_string,
-                "sever_keepalive": self._client.aprsd_keepalive,
+                "connected": self.is_connected,
                 "filter": self.filter,
+                "login_status": self.login_status,
+                "connection_keepalive": keepalive,
+                "server_string": server_string,
+                "transport": self.transport(),
             }
 
         return stats
@@ -99,22 +110,31 @@ class APRSISClient(base.APRSClient):
         self.connected = False
         backoff = 1
         aprs_client = None
+        retries = 3
+        retry_count = 0
         while not self.connected:
+            retry_count += 1
+            if retry_count >= retries:
+                break
             try:
                 LOG.info(f"Creating aprslib client({host}:{port}) and logging in {user}.")
                 aprs_client = aprsis.Aprsdis(user, passwd=password, host=host, port=port)
                 # Force the log to be the same
                 aprs_client.logger = LOG
                 aprs_client.connect()
-                self.connected = True
+                self.connected = self.login_status["success"] = True
+                self.login_status["message"] = aprs_client.server_string
                 backoff = 1
             except LoginError as e:
                 LOG.error(f"Failed to login to APRS-IS Server '{e}'")
-                self.connected = False
+                self.connected = self.login_status["success"] = False
+                self.login_status["message"] = e.message
+                LOG.error(e.message)
                 time.sleep(backoff)
             except Exception as e:
                 LOG.error(f"Unable to connect to APRS-IS server. '{e}' ")
-                self.connected = False
+                self.connected = self.login_status["success"] = False
+                self.login_status["message"] = e.message
                 time.sleep(backoff)
                 # Don't allow the backoff to go to inifinity.
                 if backoff > 5:
@@ -126,7 +146,16 @@ class APRSISClient(base.APRSClient):
         return aprs_client
 
     def consumer(self, callback, blocking=False, immortal=False, raw=False):
-        self._client.consumer(
-            callback, blocking=blocking,
-            immortal=immortal, raw=raw,
-        )
+        if self._client:
+            try:
+                self._client.consumer(
+                    callback, blocking=blocking,
+                    immortal=immortal, raw=raw,
+                )
+            except Exception as e:
+                LOG.error(e)
+                LOG.info(e.__cause__)
+                raise e
+        else:
+            LOG.warning("client is None, might be resetting.")
+            self.connected = False

aprsd/client/base.py

@@ -19,6 +19,10 @@ class APRSClient:
     _client = None
 
     connected = False
+    login_status = {
+        "success": False,
+        "message": None,
+    }
     filter = None
     lock = threading.Lock()
 
@@ -32,7 +36,23 @@ class APRSClient:
 
     @abc.abstractmethod
     def stats(self) -> dict:
-        pass
+        """Return statistics about the client connection.
+
+        Returns:
+            dict: Statistics about the connection and packet handling
+        """
+
+    @property
+    def is_connected(self):
+        return self.connected
+
+    @property
+    def login_success(self):
+        return self.login_status.get("success", False)
+
+    @property
+    def login_failure(self):
+        return self.login_status["message"]
 
     def set_filter(self, filter):
         self.filter = filter
@@ -46,22 +66,31 @@ class APRSClient:
         return self._client
 
     def _create_client(self):
-        self._client = self.setup_connection()
-        if self.filter:
-            LOG.info("Creating APRS client filter")
-            self._client.set_filter(self.filter)
+        try:
+            self._client = self.setup_connection()
+            if self.filter:
+                LOG.info("Creating APRS client filter")
+                self._client.set_filter(self.filter)
+        except Exception as e:
+            LOG.error(f"Failed to create APRS client: {e}")
+            self._client = None
+            raise
 
     def stop(self):
         if self._client:
             LOG.info("Stopping client connection.")
             self._client.stop()
 
-    def send(self, packet: core.Packet):
-        """Send a packet to the network."""
+    def send(self, packet: core.Packet) -> None:
+        """Send a packet to the network.
+
+        Args:
+            packet: The APRS packet to send
+        """
         self.client.send(packet)
 
     @wrapt.synchronized(lock)
-    def reset(self):
+    def reset(self) -> None:
         """Call this to force a rebuild/reconnect."""
         LOG.info("Resetting client connection.")
         if self._client:
@@ -76,7 +105,11 @@ class APRSClient:
 
     @abc.abstractmethod
     def setup_connection(self):
-        pass
+        """Initialize and return the underlying APRS connection.
+
+        Returns:
+            object: The initialized connection object
+        """
 
     @staticmethod
     @abc.abstractmethod
@@ -90,7 +123,11 @@ class APRSClient:
 
     @abc.abstractmethod
     def decode_packet(self, *args, **kwargs):
-        pass
+        """Decode raw APRS packet data into a Packet object.
+
+        Returns:
+            Packet: Decoded APRS packet
+        """
 
     @abc.abstractmethod
     def consumer(self, callback, blocking=False, immortal=False, raw=False):

aprsd/client/drivers/aprsis.py

@@ -27,6 +27,9 @@ class Aprsdis(aprslib.IS):
     # date for last time we heard from the server
     aprsd_keepalive = datetime.datetime.now()
 
+    # Which server we are connected to?
+    server_string = "None"
+
     # timeout in seconds
     select_timeout = 1
     lock = threading.Lock()
@@ -193,14 +196,14 @@ class Aprsdis(aprslib.IS):
             except ParseError as exp:
                 self.logger.log(
                     11,
-                    "%s\n    Packet: %s",
+                    "%s    Packet: '%s'",
                     exp,
                     exp.packet,
                 )
             except UnknownFormat as exp:
                 self.logger.log(
                     9,
-                    "%s\n    Packet: %s",
+                    "%s    Packet: '%s'",
                     exp,
                     exp.packet,
                 )

aprsd/client/factory.py

@@ -42,6 +42,7 @@ class Client(Protocol):
 class ClientFactory:
     _instance = None
     clients = []
+    client = None
 
     def __new__(cls, *args, **kwargs):
         """This magic turns this into a singleton."""
@@ -62,9 +63,13 @@ class ClientFactory:
     def create(self, key=None):
         for client in self.clients:
             if client.is_enabled():
-                return client()
+                self.client = client()
+                return self.client
         raise Exception("No client is configured!!")
 
+    def client_exists(self):
+        return bool(self.client)
+
     def is_client_enabled(self):
         """Make sure at least one client is enabled."""
         enabled = False

aprsd/client/fake.py

@@ -14,8 +14,11 @@ LOG = logging.getLogger("APRSD")
 
 class APRSDFakeClient(base.APRSClient, metaclass=trace.TraceWrapperMetaclass):
 
-    def stats(self) -> dict:
-        return {}
+    def stats(self, serializable=False) -> dict:
+        return {
+            "transport": "Fake",
+            "connected": True,
+        }
 
     @staticmethod
     def is_enabled():

aprsd/client/kiss.py

@@ -1,3 +1,4 @@
+import datetime
 import logging
 
 import aprslib
@@ -16,13 +17,24 @@ LOG = logging.getLogger("APRSD")
 class KISSClient(base.APRSClient):
 
     _client = None
+    keepalive = datetime.datetime.now()
 
-    def stats(self) -> dict:
+    def stats(self, serializable=False) -> dict:
         stats = {}
         if self.is_configured():
-            return {
+            keepalive = self.keepalive
+            if serializable:
+                keepalive = keepalive.isoformat()
+            stats = {
+                "connected": self.is_connected,
+                "connection_keepalive": keepalive,
                 "transport": self.transport(),
             }
+            if self.transport() == client.TRANSPORT_TCPKISS:
+                stats["host"] = CONF.kiss_tcp.host
+                stats["port"] = CONF.kiss_tcp.port
+            elif self.transport() == client.TRANSPORT_SERIALKISS:
+                stats["device"] = CONF.kiss_serial.device
         return stats
 
     @staticmethod
@@ -95,9 +107,18 @@ class KISSClient(base.APRSClient):
             return packet
 
     def setup_connection(self):
-        self._client = kiss.KISS3Client()
-        self.connected = True
+        try:
+            self._client = kiss.KISS3Client()
+            self.connected = self.login_status["success"] = True
+        except Exception as ex:
+            self.connected = self.login_status["success"] = False
+            self.login_status["message"] = str(ex)
         return self._client
 
     def consumer(self, callback, blocking=False, immortal=False, raw=False):
-        self._client.consumer(callback)
+        try:
+            self._client.consumer(callback)
+            self.keepalive = datetime.datetime.now()
+        except Exception as ex:
+            LOG.error(f"Consumer failed {ex}")
+            LOG.error(ex)

aprsd/client/stats.py

@@ -17,22 +17,4 @@ class APRSClientStats:
 
     @wrapt.synchronized(lock)
     def stats(self, serializable=False):
-        cl = client.client_factory.create()
-        stats = {
-            "transport": cl.transport(),
-            "filter": cl.filter,
-            "connected": cl.connected,
-        }
-
-        if cl.transport() == client.TRANSPORT_APRSIS:
-            stats["server_string"] = cl.client.server_string
-            keepalive = cl.client.aprsd_keepalive
-            if serializable:
-                keepalive = keepalive.isoformat()
-            stats["server_keepalive"] = keepalive
-        elif cl.transport() == client.TRANSPORT_TCPKISS:
-            stats["host"] = CONF.kiss_tcp.host
-            stats["port"] = CONF.kiss_tcp.port
-        elif cl.transport() == client.TRANSPORT_SERIALKISS:
-            stats["device"] = CONF.kiss_serial.device
-        return stats
+        return client.client_factory.create().stats(serializable=serializable)

aprsd/cmds/admin.py

@@ -0,0 +1,57 @@
+import logging
+import os
+import signal
+
+import click
+from oslo_config import cfg
+import socketio
+
+import aprsd
+from aprsd import cli_helper
+from aprsd import main as aprsd_main
+from aprsd import utils
+from aprsd.main import cli
+
+
+os.environ["APRSD_ADMIN_COMMAND"] = "1"
+# this import has to happen AFTER we set the
+# above environment variable, so that the code
+# inside the wsgi.py has the value
+from aprsd import wsgi as aprsd_wsgi  # noqa
+
+
+CONF = cfg.CONF
+LOG = logging.getLogger("APRSD")
+
+
+# main() ###
+@cli.command()
+@cli_helper.add_options(cli_helper.common_options)
+@click.pass_context
+@cli_helper.process_standard_options
+def admin(ctx):
+    """Start the aprsd admin interface."""
+    signal.signal(signal.SIGINT, aprsd_main.signal_handler)
+    signal.signal(signal.SIGTERM, aprsd_main.signal_handler)
+
+    level, msg = utils._check_version()
+    if level:
+        LOG.warning(msg)
+    else:
+        LOG.info(msg)
+    LOG.info(f"APRSD Started version: {aprsd.__version__}")
+    # Dump all the config options now.
+    CONF.log_opt_values(LOG, logging.DEBUG)
+
+    async_mode = "threading"
+    sio = socketio.Server(logger=True, async_mode=async_mode)
+    aprsd_wsgi.app.wsgi_app = socketio.WSGIApp(sio, aprsd_wsgi.app.wsgi_app)
+    aprsd_wsgi.init_app()
+    sio.register_namespace(aprsd_wsgi.LoggingNamespace("/logs"))
+    CONF.log_opt_values(LOG, logging.DEBUG)
+    aprsd_wsgi.app.run(
+        threaded=True,
+        debug=False,
+        port=CONF.admin.web_port,
+        host=CONF.admin.web_ip,
+    )

aprsd/cmds/dev.py

@@ -101,7 +101,7 @@ def test_plugin(
 
     pm = plugin.PluginManager()
     if load_all:
-        pm.setup_plugins()
+        pm.setup_plugins(load_help_plugin=CONF.load_help_plugin)
     obj = pm._create_class(plugin_path, plugin.APRSDPluginBase)
     if not obj:
         click.echo(ctx.get_help())

aprsd/cmds/fetch_stats.py

@@ -11,6 +11,7 @@ from rich.table import Table
 import aprsd
 from aprsd import cli_helper
 from aprsd.main import cli
+from aprsd.threads.stats import StatsStore
 
 
 # setup the global logger
@@ -154,3 +155,157 @@ def fetch_stats(ctx, host, port):
             watch_table.add_row(key, value["last"])
 
         console.print(watch_table)
+
+
+@cli.command()
+@cli_helper.add_options(cli_helper.common_options)
+@click.option(
+    "--raw",
+    is_flag=True,
+    default=False,
+    help="Dump raw stats instead of formatted output.",
+)
+@click.option(
+    "--show-section",
+    default=["All"],
+    help="Show specific sections of the stats. "
+         " Choices: All, APRSDStats, APRSDThreadList, APRSClientStats,"
+         " PacketList, SeenList, WatchList",
+    multiple=True,
+    type=click.Choice(
+        [
+            "All",
+            "APRSDStats",
+            "APRSDThreadList",
+            "APRSClientStats",
+            "PacketList",
+            "SeenList",
+            "WatchList",
+        ],
+        case_sensitive=False,
+    ),
+)
+@click.pass_context
+@cli_helper.process_standard_options
+def dump_stats(ctx, raw, show_section):
+    """Dump the current stats from the running APRSD instance."""
+    console = Console()
+    console.print(f"APRSD Dump-Stats started version: {aprsd.__version__}")
+
+    with console.status("Dumping stats"):
+        ss = StatsStore()
+        ss.load()
+        stats = ss.data
+        if raw:
+            if "All" in show_section:
+                console.print(stats)
+                return
+            else:
+                for section in show_section:
+                    console.print(f"Dumping {section} section:")
+                    console.print(stats[section])
+                return
+
+        t = Table(title="APRSD Stats")
+        t.add_column("Key")
+        t.add_column("Value")
+        for key, value in stats["APRSDStats"].items():
+            t.add_row(key, str(value))
+
+        if "All" in show_section or "APRSDStats" in show_section:
+            console.print(t)
+
+        # Show the thread list
+        t = Table(title="Thread List")
+        t.add_column("Name")
+        t.add_column("Class")
+        t.add_column("Alive?")
+        t.add_column("Loop Count")
+        t.add_column("Age")
+        for name, value in stats["APRSDThreadList"].items():
+            t.add_row(
+                name,
+                value["class"],
+                str(value["alive"]),
+                str(value["loop_count"]),
+                str(value["age"]),
+            )
+
+        if "All" in show_section or "APRSDThreadList" in show_section:
+            console.print(t)
+
+        # Show the plugins
+        t = Table(title="Plugin List")
+        t.add_column("Name")
+        t.add_column("Enabled")
+        t.add_column("Version")
+        t.add_column("TX")
+        t.add_column("RX")
+        for name, value in stats["PluginManager"].items():
+            t.add_row(
+                name,
+                str(value["enabled"]),
+                value["version"],
+                str(value["tx"]),
+                str(value["rx"]),
+            )
+
+        if "All" in show_section or "PluginManager" in show_section:
+            console.print(t)
+
+        # Now show the client stats
+        t = Table(title="Client Stats")
+        t.add_column("Key")
+        t.add_column("Value")
+        for key, value in stats["APRSClientStats"].items():
+            t.add_row(key, str(value))
+
+        if "All" in show_section or "APRSClientStats" in show_section:
+            console.print(t)
+
+        # now show the packet list
+        packet_list = stats.get("PacketList")
+        t = Table(title="Packet List")
+        t.add_column("Key")
+        t.add_column("Value")
+        t.add_row("Total Received", str(packet_list["rx"]))
+        t.add_row("Total Sent", str(packet_list["tx"]))
+
+        if "All" in show_section or "PacketList" in show_section:
+            console.print(t)
+
+        # now show the seen list
+        seen_list = stats.get("SeenList")
+        sorted_seen_list = sorted(
+            seen_list.items(),
+        )
+        t = Table(title="Seen List")
+        t.add_column("Callsign")
+        t.add_column("Message Count")
+        t.add_column("Last Heard")
+        for key, value in sorted_seen_list:
+            t.add_row(
+                key,
+                str(value["count"]),
+                str(value["last"]),
+            )
+
+        if "All" in show_section or "SeenList" in show_section:
+            console.print(t)
+
+        # now show the watch list
+        watch_list = stats.get("WatchList")
+        sorted_watch_list = sorted(
+            watch_list.items(),
+        )
+        t = Table(title="Watch List")
+        t.add_column("Callsign")
+        t.add_column("Last Heard")
+        for key, value in sorted_watch_list:
+            t.add_row(
+                key,
+                str(value["last"]),
+            )
+
+        if "All" in show_section or "WatchList" in show_section:
+            console.print(t)

aprsd/cmds/healthcheck.py

@@ -63,7 +63,7 @@ def healthcheck(ctx, timeout):
 
                 if email_thread_last_update != "never":
                     d = now - email_thread_last_update
-                    max_timeout = {"hours": 0.0, "minutes": 5, "seconds": 0}
+                    max_timeout = {"hours": 0.0, "minutes": 5, "seconds": 30}
                     max_delta = datetime.timedelta(**max_timeout)
                     if d > max_delta:
                         console.log(f"Email thread is very old! {d}")
@@ -74,7 +74,7 @@ def healthcheck(ctx, timeout):
                 console.log("No APRSClientStats")
                 sys.exit(-1)
             else:
-                aprsis_last_update = client_stats["server_keepalive"]
+                aprsis_last_update = client_stats["connection_keepalive"]
                 d = now - aprsis_last_update
                 max_timeout = {"hours": 0.0, "minutes": 5, "seconds": 0}
                 max_delta = datetime.timedelta(**max_timeout)