aprsd 3.3.4__tar.gz → 3.4.0__tar.gz

{aprsd-3.3.4 → aprsd-3.4.0}/ChangeLog

@@ -1,16 +1,113 @@
 CHANGES
 =======
 
-v3.3.4
-------
-
-* Fixed entry\_points
-* Fix for entry\_points where python < 3.10
-
-v3.3.3
+v3.4.0
 ------
 
+* Change setup.h
+* Fixed docker setup.sh comparison
+* Fixed unit tests failing with WatchList
+* Added config enable\_packet\_logging
+* Make all the Objectstore children use the same lock
+* Fixed PacketTrack with UnknownPacket
+* Removed the requirement on click-completion
+* Update Dockerfiles
+* Added fox for entry\_points with old python
+* Added config for enable\_seen\_list
+* Fix APRSDStats start\_time
+* Added default\_packet\_send\_count config
+* Call packet collecter after prepare during tx
+* Added PacketTrack to packet collector
+* Webchat Send Beacon uses Path selected in UI
+* Added try except blocks in collectors
+* Remove error logs from watch list
+* Fixed issue with PacketList being empty
+* Added new PacketCollector
+* Fixed Keepalive access to email stats
+* Added support for RX replyacks
+* Changed Stats Collector registration
+* Added PacketList.set\_maxlen()
+* another fix for tx send
+* removed Packet.last\_send\_attempt and just use send\_count
+* Fix access to PacketList.\_maxlen
+* added packet\_count in packet\_list stats
+* force uwsgi to 2.0.24
+* ismall update
+* Added new config optons for PacketList
+* Update requirements
+* Added threads chart to admin ui graphs
+* set packetlist max back to 100
+* ensure thread count is updated
+* Added threads table in the admin web ui
+* Fixed issue with APRSDThreadList stats()
+* Added new default\_ack\_send\_count config option
+* Remove packet from tracker after max attempts
+* Limit packets to 50 in PacketList
+* syncronize the add for StatsStore
+* Lock on stats for PacketList
+* Fixed PacketList maxlen
+* Fixed a problem with the webchat tab notification
+* Another fix for ACK packets
+* Fix issue not tracking RX Ack packets for stats
+* Fix time plugin
+* add GATE route to webchat along with WIDE1, etc
+* Update webchat, include GATE route along with WIDE, ARISS, etc
+* Get rid of some useless warning logs
+* Added human\_info property to MessagePackets
+* Fixed scrolling problem with new webchat sent msg
+* Fix some issues with listen command
+* Admin interface catch empty stats
+* Ensure StatsStore has empty data
+* Ensure latest pip is in docker image
+* LOG failed requests post to admin ui
+* changed admin web\_ip to StrOpt
+* Updated prism to 1.29
+* Removed json-viewer
+* Remove rpyc as a requirement
+* Delete more stats from webchat
+* Admin UI working again
+* Removed RPC Server and client
+* Remove the logging of the conf password if not set
+* Lock around client reset
+* Allow stats collector to serialize upon creation
+* Fixed issues with watch list at startup
+* Fixed access to log\_monitor
+* Got unit tests working again
+* Fixed pep8 errors and missing files
+* Reworked the stats making the rpc server obsolete
+* Update client.py to add consumer in the API
 * Fix for sample-config warning
+* update requirements
+* Put packet.json back in
+* Change debug log color
+* Fix for filtering curse words
+* added packet counter random int
+* More packet cleanup and tests
+* Show comment in multiline packet output
+* Added new config option log\_packet\_format
+* Some packet cleanup
+* Added new webchat config option for logging
+* Fix some pep8 issues
+* Completely redo logging of packets!!
+* Fixed some logging in webchat
+* Added missing packet types in listen command
+* Don't call stats so often in webchat
+* Eliminated need for from\_aprslib\_dict
+* Fix for micE packet decoding with mbits
+* updated dev-requirements
+* Fixed some tox errors related to mypy
+* Refactored packets
+* removed print
+* small refactor of stats usage in version plugin
+* Added type setting on pluging.py for mypy
+* Moved Threads list for mypy
+* No need to synchronize on stats
+* Start to add types
+* Update tox for mypy runs
+* Bump black from 24.2.0 to 24.3.0
+* replaced access to conf from uwsgi
+* Fixed call to setup\_logging in uwsgi
+* Fixed access to conf.log in logging\_setup
 
 v3.3.2
 ------

{aprsd-3.3.4 → aprsd-3.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: aprsd
-Version: 3.3.4
+Version: 3.4.0
 Summary: Amateur radio APRS daemon which listens for messages and responds
 Home-page: http://aprsd.readthedocs.org
 Author: Craig Lamparter
@@ -31,14 +31,13 @@ Requires-Dist: click==8.1.7
 Requires-Dist: click-completion==0.5.2
 Requires-Dist: click-params==0.5.0
 Requires-Dist: commonmark==0.9.1
-Requires-Dist: dacite2==2.0.0
 Requires-Dist: dataclasses==0.6
 Requires-Dist: dataclasses-json==0.6.4
 Requires-Dist: debtcollector==3.0.0
 Requires-Dist: deprecated==1.2.14
 Requires-Dist: dnspython==2.6.1
-Requires-Dist: eventlet==0.35.2
-Requires-Dist: flask==3.0.2
+Requires-Dist: eventlet==0.36.1
+Requires-Dist: flask==3.0.3
 Requires-Dist: flask-httpauth==4.8.0
 Requires-Dist: flask-socketio==5.3.6
 Requires-Dist: geographiclib==2.0
@@ -46,10 +45,10 @@ Requires-Dist: geopy==2.4.1
 Requires-Dist: gevent==24.2.1
 Requires-Dist: greenlet==3.0.3
 Requires-Dist: h11==0.14.0
-Requires-Dist: idna==3.6
+Requires-Dist: idna==3.7
 Requires-Dist: imapclient==3.0.1
-Requires-Dist: importlib-metadata==7.0.1
-Requires-Dist: itsdangerous==2.1.2
+Requires-Dist: importlib-metadata==7.1.0
+Requires-Dist: itsdangerous==2.2.0
 Requires-Dist: jinja2==3.1.3
 Requires-Dist: kiss3==8.0.0
 Requires-Dist: loguru==0.7.2
@@ -59,21 +58,19 @@ Requires-Dist: mypy-extensions==1.0.0
 Requires-Dist: netaddr==1.2.1
 Requires-Dist: oslo-config==9.4.0
 Requires-Dist: oslo-i18n==6.3.0
-Requires-Dist: packaging==23.2
+Requires-Dist: packaging==24.0
 Requires-Dist: pbr==6.0.0
-Requires-Dist: pluggy==1.4.0
-Requires-Dist: plumbum==1.8.2
+Requires-Dist: pluggy==1.5.0
 Requires-Dist: pygments==2.17.2
 Requires-Dist: pyserial==3.5
 Requires-Dist: pyserial-asyncio==0.6
 Requires-Dist: python-engineio==4.9.0
-Requires-Dist: python-socketio==5.11.1
+Requires-Dist: python-socketio==5.11.2
 Requires-Dist: pytz==2024.1
 Requires-Dist: pyyaml==6.0.1
 Requires-Dist: requests==2.31.0
 Requires-Dist: rfc3986==2.0.0
 Requires-Dist: rich==12.6.0
-Requires-Dist: rpyc==6.0.0
 Requires-Dist: rush==2021.4.0
 Requires-Dist: shellingham==1.5.4
 Requires-Dist: simple-websocket==1.0.0
@@ -82,17 +79,18 @@ Requires-Dist: soupsieve==2.5
 Requires-Dist: stevedore==5.2.0
 Requires-Dist: tabulate==0.9.0
 Requires-Dist: thesmuggler==1.0.1
-Requires-Dist: typing-extensions==4.10.0
+Requires-Dist: typing-extensions==4.11.0
 Requires-Dist: typing-inspect==0.9.0
+Requires-Dist: tzlocal==5.2
 Requires-Dist: update-checker==0.18.0
 Requires-Dist: urllib3==2.2.1
 Requires-Dist: validators==0.22.0
-Requires-Dist: werkzeug==3.0.1
+Requires-Dist: werkzeug==3.0.2
 Requires-Dist: wrapt==1.16.0
 Requires-Dist: wsproto==1.2.0
-Requires-Dist: zipp==3.17.0
+Requires-Dist: zipp==3.18.1
 Requires-Dist: zope-event==5.0
-Requires-Dist: zope-interface==6.2
+Requires-Dist: zope-interface==6.3
 
 ===============================================
 APRSD - Ham radio APRS-IS Message plugin server

{aprsd-3.3.4 → aprsd-3.4.0}/aprsd/client.py

@@ -1,15 +1,18 @@
 import abc
+import datetime
 import logging
+import threading
 import time
 
 import aprslib
 from aprslib.exceptions import LoginError
 from oslo_config import cfg
+import wrapt
 
 from aprsd import exception
 from aprsd.clients import aprsis, fake, kiss
-from aprsd.packets import core, packet_list
-from aprsd.utils import trace
+from aprsd.packets import core
+from aprsd.utils import singleton, trace
 
 
 CONF = cfg.CONF
@@ -25,6 +28,34 @@ TRANSPORT_FAKE = "fake"
 factory = None
 
 
+@singleton
+class APRSClientStats:
+
+    lock = threading.Lock()
+
+    @wrapt.synchronized(lock)
+    def stats(self, serializable=False):
+        client = factory.create()
+        stats = {
+            "transport": client.transport(),
+            "filter": client.filter,
+            "connected": client.connected,
+        }
+
+        if client.transport() == TRANSPORT_APRSIS:
+            stats["server_string"] = client.client.server_string
+            keepalive = client.client.aprsd_keepalive
+            if serializable:
+                keepalive = keepalive.isoformat()
+            stats["server_keepalive"] = keepalive
+        elif client.transport() == TRANSPORT_TCPKISS:
+            stats["host"] = CONF.kiss_tcp.host
+            stats["port"] = CONF.kiss_tcp.port
+        elif client.transport() == TRANSPORT_SERIALKISS:
+            stats["device"] = CONF.kiss_serial.device
+        return stats
+
+
 class Client:
     """Singleton client class that constructs the aprslib connection."""
 
@@ -32,16 +63,21 @@ class Client:
     _client = None
 
     connected = False
-    server_string = None
     filter = None
+    lock = threading.Lock()
 
     def __new__(cls, *args, **kwargs):
         """This magic turns this into a singleton."""
         if cls._instance is None:
             cls._instance = super().__new__(cls)
             # Put any initialization here.
+            cls._instance._create_client()
         return cls._instance
 
+    @abc.abstractmethod
+    def stats(self) -> dict:
+        pass
+
     def set_filter(self, filter):
         self.filter = filter
         if self._client:
@@ -50,21 +86,32 @@ class Client:
     @property
     def client(self):
         if not self._client:
-            LOG.info("Creating APRS client")
-            self._client = self.setup_connection()
-            if self.filter:
-                LOG.info("Creating APRS client filter")
-                self._client.set_filter(self.filter)
+            self._create_client()
         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)
+
+    def stop(self):
+        if self._client:
+            LOG.info("Stopping client connection.")
+            self._client.stop()
+
     def send(self, packet: core.Packet):
-        packet_list.PacketList().tx(packet)
+        """Send a packet to the network."""
         self.client.send(packet)
 
+    @wrapt.synchronized(lock)
     def reset(self):
         """Call this to force a rebuild/reconnect."""
+        LOG.info("Resetting client connection.")
         if self._client:
+            self._client.close()
             del self._client
+            self._create_client()
         else:
             LOG.warning("Client not initialized, nothing to reset.")
 
@@ -89,11 +136,38 @@ class Client:
     def decode_packet(self, *args, **kwargs):
         pass
 
+    @abc.abstractmethod
+    def consumer(self, callback, blocking=False, immortal=False, raw=False):
+        pass
+
+    @abc.abstractmethod
+    def is_alive(self):
+        pass
+
+    @abc.abstractmethod
+    def close(self):
+        pass
+
 
 class APRSISClient(Client):
 
     _client = None
 
+    def __init__(self):
+        max_timeout = {"hours": 0.0, "minutes": 2, "seconds": 0}
+        self.max_delta = datetime.timedelta(**max_timeout)
+
+    def stats(self) -> dict:
+        stats = {}
+        if self.is_configured():
+            stats = {
+                "server_string": self._client.server_string,
+                "sever_keepalive": self._client.aprsd_keepalive,
+                "filter": self.filter,
+            }
+
+        return stats
+
     @staticmethod
     def is_enabled():
         # Defaults to True if the enabled flag is non existent
@@ -125,44 +199,56 @@ class APRSISClient(Client):
             return True
         return True
 
+    def _is_stale_connection(self):
+        delta = datetime.datetime.now() - self._client.aprsd_keepalive
+        if delta > self.max_delta:
+            LOG.error(f"Connection is stale, last heard {delta} ago.")
+            return True
+
     def is_alive(self):
         if self._client:
-            return self._client.is_alive()
+            return self._client.is_alive() and not self._is_stale_connection()
         else:
+            LOG.warning(f"APRS_CLIENT {self._client} alive? NO!!!")
             return False
 
+    def close(self):
+        if self._client:
+            self._client.stop()
+            self._client.close()
+
     @staticmethod
     def transport():
         return TRANSPORT_APRSIS
 
     def decode_packet(self, *args, **kwargs):
         """APRS lib already decodes this."""
-        return core.Packet.factory(args[0])
+        return core.factory(args[0])
 
     def setup_connection(self):
         user = CONF.aprs_network.login
         password = CONF.aprs_network.password
         host = CONF.aprs_network.host
         port = CONF.aprs_network.port
-        connected = False
+        self.connected = False
         backoff = 1
         aprs_client = None
-        while not connected:
+        while not self.connected:
             try:
-                LOG.info("Creating aprslib client")
+                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()
-                connected = True
+                self.connected = True
                 backoff = 1
             except LoginError as e:
                 LOG.error(f"Failed to login to APRS-IS Server '{e}'")
-                connected = False
+                self.connected = False
                 time.sleep(backoff)
             except Exception as e:
                 LOG.error(f"Unable to connect to APRS-IS server. '{e}' ")
-                connected = False
+                self.connected = False
                 time.sleep(backoff)
                 # Don't allow the backoff to go to inifinity.
                 if backoff > 5:
@@ -170,15 +256,28 @@ class APRSISClient(Client):
                 else:
                     backoff += 1
                 continue
-        LOG.debug(f"Logging in to APRS-IS with user '{user}'")
         self._client = aprs_client
         return aprs_client
 
+    def consumer(self, callback, blocking=False, immortal=False, raw=False):
+        self._client.consumer(
+            callback, blocking=blocking,
+            immortal=immortal, raw=raw,
+        )
+
 
 class KISSClient(Client):
 
     _client = None
 
+    def stats(self) -> dict:
+        stats = {}
+        if self.is_configured():
+            return {
+                "transport": self.transport(),
+            }
+        return stats
+
     @staticmethod
     def is_enabled():
         """Return if tcp or serial KISS is enabled."""
@@ -217,6 +316,10 @@ class KISSClient(Client):
         else:
             return False
 
+    def close(self):
+        if self._client:
+            self._client.stop()
+
     @staticmethod
     def transport():
         if CONF.kiss_serial.enabled:
@@ -238,7 +341,7 @@ class KISSClient(Client):
         # LOG.debug(f"Decoding {msg}")
 
         raw = aprslib.parse(str(frame))
-        packet = core.Packet.factory(raw)
+        packet = core.factory(raw)
         if isinstance(packet, core.ThirdParty):
             return packet.subpacket
         else:
@@ -246,11 +349,18 @@ class KISSClient(Client):
 
     def setup_connection(self):
         self._client = kiss.KISS3Client()
+        self.connected = True
         return self._client
 
+    def consumer(self, callback, blocking=False, immortal=False, raw=False):
+        self._client.consumer(callback)
+
 
 class APRSDFakeClient(Client, metaclass=trace.TraceWrapperMetaclass):
 
+    def stats(self) -> dict:
+        return {}
+
     @staticmethod
     def is_enabled():
         if CONF.fake_client.enabled:
@@ -264,7 +374,11 @@ class APRSDFakeClient(Client, metaclass=trace.TraceWrapperMetaclass):
     def is_alive(self):
         return True
 
+    def close(self):
+        pass
+
     def setup_connection(self):
+        self.connected = True
         return fake.APRSDFakeClient()
 
     @staticmethod
@@ -304,7 +418,6 @@ class ClientFactory:
                 key = TRANSPORT_FAKE
 
         builder = self._builders.get(key)
-        LOG.debug(f"Creating client {key}")
         if not builder:
             raise ValueError(key)
         return builder()

{aprsd-3.3.4 → aprsd-3.4.0}/aprsd/clients/aprsis.py

@@ -1,3 +1,4 @@
+import datetime
 import logging
 import select
 import threading
@@ -11,7 +12,6 @@ from aprslib.exceptions import (
 import wrapt
 
 import aprsd
-from aprsd import stats
 from aprsd.packets import core
 
 
@@ -24,6 +24,9 @@ class Aprsdis(aprslib.IS):
     # flag to tell us to stop
     thread_stop = False
 
+    # date for last time we heard from the server
+    aprsd_keepalive = datetime.datetime.now()
+
     # timeout in seconds
     select_timeout = 1
     lock = threading.Lock()
@@ -142,7 +145,6 @@ class Aprsdis(aprslib.IS):
 
             self.logger.info(f"Connected to {server_string}")
             self.server_string = server_string
-            stats.APRSDStats().set_aprsis_server(server_string)
 
         except LoginError as e:
             self.logger.error(str(e))
@@ -176,13 +178,14 @@ class Aprsdis(aprslib.IS):
             try:
                 for line in self._socket_readlines(blocking):
                     if line[0:1] != b"#":
+                        self.aprsd_keepalive = datetime.datetime.now()
                         if raw:
                             callback(line)
                         else:
                             callback(self._parse(line))
                     else:
                         self.logger.debug("Server: %s", line.decode("utf8"))
-                        stats.APRSDStats().set_aprsis_keepalive()
+                        self.aprsd_keepalive = datetime.datetime.now()
             except ParseError as exp:
                 self.logger.log(
                     11,

{aprsd-3.3.4 → aprsd-3.4.0}/aprsd/clients/fake.py

@@ -67,7 +67,7 @@ class APRSDFakeClient(metaclass=trace.TraceWrapperMetaclass):
         # Generate packets here?
         raw = "GTOWN>APDW16,WIDE1-1,WIDE2-1:}KM6LYW-9>APZ100,TCPIP,GTOWN*::KM6LYW   :KM6LYW: 19 Miles SW"
         pkt_raw = aprslib.parse(raw)
-        pkt = core.Packet.factory(pkt_raw)
+        pkt = core.factory(pkt_raw)
         callback(packet=pkt)
         LOG.debug(f"END blocking FAKE consumer {self}")
         time.sleep(8)

{aprsd-3.3.4 → aprsd-3.4.0}/aprsd/clients/kiss.py

@@ -81,7 +81,7 @@ class KISS3Client:
             LOG.error("Failed to parse bytes received from KISS interface.")
             LOG.exception(ex)
 
-    def consumer(self, callback, blocking=False, immortal=False, raw=False):
+    def consumer(self, callback):
         LOG.debug("Start blocking KISS consumer")
         self._parse_callback = callback
         self.kiss.read(callback=self.parse_frame, min_frames=None)

aprsd-3.4.0/aprsd/cmds/completion.py

@@ -0,0 +1,22 @@
+import click
+import click.shell_completion
+
+from aprsd.main import cli
+
+
+CONTEXT_SETTINGS = dict(help_option_names=["-h", "--help"])
+
+
+@cli.command()
+@click.argument("shell", type=click.Choice(list(click.shell_completion._available_shells)))
+def completion(shell):
+    """Show the shell completion code"""
+    from click.utils import _detect_program_name
+
+    cls = click.shell_completion.get_completion_class(shell)
+    prog_name = _detect_program_name()
+    complete_var = f"_{prog_name}_COMPLETE".replace("-", "_").upper()
+    print(cls(cli, {}, prog_name, complete_var).source())
+    print("# Add the following line to your shell configuration file to have aprsd command line completion")
+    print("# but remove the leading '#' character.")
+    print(f"# eval \"$(aprsd completion {shell})\"")