aprsd 1.0.0__py3-none-any.whl → 3.4.1__py3-none-any.whl

aprsd/client/drivers/fake.py

@@ -0,0 +1,73 @@
+import logging
+import threading
+import time
+
+import aprslib
+from oslo_config import cfg
+import wrapt
+
+from aprsd import conf  # noqa
+from aprsd.packets import core
+from aprsd.utils import trace
+
+
+CONF = cfg.CONF
+LOG = logging.getLogger("APRSD")
+
+
+class APRSDFakeClient(metaclass=trace.TraceWrapperMetaclass):
+    '''Fake client for testing.'''
+
+    # flag to tell us to stop
+    thread_stop = False
+
+    lock = threading.Lock()
+    path = []
+
+    def __init__(self):
+        LOG.info("Starting APRSDFakeClient client.")
+        self.path = ["WIDE1-1", "WIDE2-1"]
+
+    def stop(self):
+        self.thread_stop = True
+        LOG.info("Shutdown APRSDFakeClient client.")
+
+    def is_alive(self):
+        """If the connection is alive or not."""
+        return not self.thread_stop
+
+    @wrapt.synchronized(lock)
+    def send(self, packet: core.Packet):
+        """Send an APRS Message object."""
+        LOG.info(f"Sending packet: {packet}")
+        payload = None
+        if isinstance(packet, core.Packet):
+            packet.prepare()
+            payload = packet.payload.encode("US-ASCII")
+            if packet.path:
+                packet.path
+            else:
+                self.path
+        else:
+            msg_payload = f"{packet.raw}{{{str(packet.msgNo)}"
+            payload = (
+                ":{:<9}:{}".format(
+                    packet.to_call,
+                    msg_payload,
+                )
+            ).encode("US-ASCII")
+
+        LOG.debug(
+            f"FAKE::Send '{payload}' TO '{packet.to_call}' From "
+            f"'{packet.from_call}' with PATH \"{self.path}\"",
+        )
+
+    def consumer(self, callback, blocking=False, immortal=False, raw=False):
+        LOG.debug("Start non blocking FAKE consumer")
+        # 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.factory(pkt_raw)
+        callback(packet=pkt)
+        LOG.debug(f"END blocking FAKE consumer {self}")
+        time.sleep(8)

aprsd/client/drivers/kiss.py

@@ -0,0 +1,119 @@
+import logging
+
+from ax253 import Frame
+import kiss
+from oslo_config import cfg
+
+from aprsd import conf  # noqa
+from aprsd.packets import core
+from aprsd.utils import trace
+
+
+CONF = cfg.CONF
+LOG = logging.getLogger("APRSD")
+
+
+class KISS3Client:
+    path = []
+
+    def __init__(self):
+        self.setup()
+
+    def is_alive(self):
+        return True
+
+    def setup(self):
+        # we can be TCP kiss or Serial kiss
+        if CONF.kiss_serial.enabled:
+            LOG.debug(
+                "KISS({}) Serial connection to {}".format(
+                    kiss.__version__,
+                    CONF.kiss_serial.device,
+                ),
+            )
+            self.kiss = kiss.SerialKISS(
+                port=CONF.kiss_serial.device,
+                speed=CONF.kiss_serial.baudrate,
+                strip_df_start=True,
+            )
+            self.path = CONF.kiss_serial.path
+        elif CONF.kiss_tcp.enabled:
+            LOG.debug(
+                "KISS({}) TCP Connection to {}:{}".format(
+                    kiss.__version__,
+                    CONF.kiss_tcp.host,
+                    CONF.kiss_tcp.port,
+                ),
+            )
+            self.kiss = kiss.TCPKISS(
+                host=CONF.kiss_tcp.host,
+                port=CONF.kiss_tcp.port,
+                strip_df_start=True,
+            )
+            self.path = CONF.kiss_tcp.path
+
+        LOG.debug("Starting KISS interface connection")
+        self.kiss.start()
+
+    @trace.trace
+    def stop(self):
+        try:
+            self.kiss.stop()
+            self.kiss.loop.call_soon_threadsafe(
+                self.kiss.protocol.transport.close,
+            )
+        except Exception as ex:
+            LOG.exception(ex)
+
+    def set_filter(self, filter):
+        # This does nothing right now.
+        pass
+
+    def parse_frame(self, frame_bytes):
+        try:
+            frame = Frame.from_bytes(frame_bytes)
+            # Now parse it with aprslib
+            kwargs = {
+                "frame": frame,
+            }
+            self._parse_callback(**kwargs)
+        except Exception as ex:
+            LOG.error("Failed to parse bytes received from KISS interface.")
+            LOG.exception(ex)
+
+    def consumer(self, callback):
+        LOG.debug("Start blocking KISS consumer")
+        self._parse_callback = callback
+        self.kiss.read(callback=self.parse_frame, min_frames=None)
+        LOG.debug(f"END blocking KISS consumer {self.kiss}")
+
+    def send(self, packet):
+        """Send an APRS Message object."""
+
+        payload = None
+        path = self.path
+        if isinstance(packet, core.Packet):
+            packet.prepare()
+            payload = packet.payload.encode("US-ASCII")
+            if packet.path:
+                path = packet.path
+        else:
+            msg_payload = f"{packet.raw}{{{str(packet.msgNo)}"
+            payload = (
+                ":{:<9}:{}".format(
+                    packet.to_call,
+                    msg_payload,
+                )
+            ).encode("US-ASCII")
+
+        LOG.debug(
+            f"KISS Send '{payload}' TO '{packet.to_call}' From "
+            f"'{packet.from_call}' with PATH '{path}'",
+        )
+        frame = Frame.ui(
+            destination="APZ100",
+            source=packet.from_call,
+            path=path,
+            info=payload,
+        )
+        self.kiss.write(frame)

aprsd/client/factory.py

@@ -0,0 +1,88 @@
+import logging
+from typing import Callable, Protocol, runtime_checkable
+
+from aprsd import exception
+from aprsd.packets import core
+
+
+LOG = logging.getLogger("APRSD")
+
+
+@runtime_checkable
+class Client(Protocol):
+
+    def __init__(self):
+        pass
+
+    def connect(self) -> bool:
+        pass
+
+    def disconnect(self) -> bool:
+        pass
+
+    def decode_packet(self, *args, **kwargs) -> type[core.Packet]:
+        pass
+
+    def is_enabled(self) -> bool:
+        pass
+
+    def is_configured(self) -> bool:
+        pass
+
+    def transport(self) -> str:
+        pass
+
+    def send(self, message: str) -> bool:
+        pass
+
+    def setup_connection(self) -> None:
+        pass
+
+
+class ClientFactory:
+    _instance = None
+    clients = []
+
+    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.
+        return cls._instance
+
+    def __init__(self):
+        self.clients: list[Callable] = []
+
+    def register(self, aprsd_client: Callable):
+        if isinstance(aprsd_client, Client):
+            raise ValueError("Client must be a subclass of Client protocol")
+
+        self.clients.append(aprsd_client)
+
+    def create(self, key=None):
+        for client in self.clients:
+            if client.is_enabled():
+                return client()
+        raise Exception("No client is configured!!")
+
+    def is_client_enabled(self):
+        """Make sure at least one client is enabled."""
+        enabled = False
+        for client in self.clients:
+            if client.is_enabled():
+                enabled = True
+        return enabled
+
+    def is_client_configured(self):
+        enabled = False
+        for client in self.clients:
+            try:
+                if client.is_configured():
+                    enabled = True
+            except exception.MissingConfigOptionException as ex:
+                LOG.error(ex.message)
+                return False
+            except exception.ConfigOptionBogusDefaultException as ex:
+                LOG.error(ex.message)
+                return False
+        return enabled

aprsd/client/fake.py

@@ -0,0 +1,48 @@
+import logging
+
+from oslo_config import cfg
+
+from aprsd import client
+from aprsd.client import base
+from aprsd.client.drivers import fake as fake_driver
+from aprsd.utils import trace
+
+
+CONF = cfg.CONF
+LOG = logging.getLogger("APRSD")
+
+
+class APRSDFakeClient(base.APRSClient, metaclass=trace.TraceWrapperMetaclass):
+
+    def stats(self) -> dict:
+        return {}
+
+    @staticmethod
+    def is_enabled():
+        if CONF.fake_client.enabled:
+            return True
+        return False
+
+    @staticmethod
+    def is_configured():
+        return APRSDFakeClient.is_enabled()
+
+    def is_alive(self):
+        return True
+
+    def close(self):
+        pass
+
+    def setup_connection(self):
+        self.connected = True
+        return fake_driver.APRSDFakeClient()
+
+    @staticmethod
+    def transport():
+        return client.TRANSPORT_FAKE
+
+    def decode_packet(self, *args, **kwargs):
+        LOG.debug(f"kwargs {kwargs}")
+        pkt = kwargs["packet"]
+        LOG.debug(f"Got an APRS Fake Packet '{pkt}'")
+        return pkt

aprsd/client/kiss.py

@@ -0,0 +1,103 @@
+import logging
+
+import aprslib
+from oslo_config import cfg
+
+from aprsd import client, exception
+from aprsd.client import base
+from aprsd.client.drivers import kiss
+from aprsd.packets import core
+
+
+CONF = cfg.CONF
+LOG = logging.getLogger("APRSD")
+
+
+class KISSClient(base.APRSClient):
+
+    _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."""
+        if CONF.kiss_serial.enabled:
+            return True
+
+        if CONF.kiss_tcp.enabled:
+            return True
+
+        return False
+
+    @staticmethod
+    def is_configured():
+        # Ensure that the config vars are correctly set
+        if KISSClient.is_enabled():
+            transport = KISSClient.transport()
+            if transport == client.TRANSPORT_SERIALKISS:
+                if not CONF.kiss_serial.device:
+                    LOG.error("KISS serial enabled, but no device is set.")
+                    raise exception.MissingConfigOptionException(
+                        "kiss_serial.device is not set.",
+                    )
+            elif transport == client.TRANSPORT_TCPKISS:
+                if not CONF.kiss_tcp.host:
+                    LOG.error("KISS TCP enabled, but no host is set.")
+                    raise exception.MissingConfigOptionException(
+                        "kiss_tcp.host is not set.",
+                    )
+
+            return True
+        return False
+
+    def is_alive(self):
+        if self._client:
+            return self._client.is_alive()
+        else:
+            return False
+
+    def close(self):
+        if self._client:
+            self._client.stop()
+
+    @staticmethod
+    def transport():
+        if CONF.kiss_serial.enabled:
+            return client.TRANSPORT_SERIALKISS
+
+        if CONF.kiss_tcp.enabled:
+            return client.TRANSPORT_TCPKISS
+
+    def decode_packet(self, *args, **kwargs):
+        """We get a frame, which has to be decoded."""
+        LOG.debug(f"kwargs {kwargs}")
+        frame = kwargs["frame"]
+        LOG.debug(f"Got an APRS Frame '{frame}'")
+        # try and nuke the * from the fromcall sign.
+        # frame.header._source._ch = False
+        # payload = str(frame.payload.decode())
+        # msg = f"{str(frame.header)}:{payload}"
+        # msg = frame.tnc2
+        # LOG.debug(f"Decoding {msg}")
+
+        raw = aprslib.parse(str(frame))
+        packet = core.factory(raw)
+        if isinstance(packet, core.ThirdPartyPacket):
+            return packet.subpacket
+        else:
+            return packet
+
+    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)

aprsd/client/stats.py

@@ -0,0 +1,38 @@
+import threading
+
+from oslo_config import cfg
+import wrapt
+
+from aprsd import client
+from aprsd.utils import singleton
+
+
+CONF = cfg.CONF
+
+
+@singleton
+class APRSClientStats:
+
+    lock = threading.Lock()
+
+    @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

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})\"")

aprsd/cmds/dev.py

@@ -0,0 +1,162 @@
+#
+#  Dev.py is used to help develop plugins
+#
+#
+# python included libs
+import logging
+
+import click
+from oslo_config import cfg
+
+from aprsd import cli_helper, conf, packets, plugin
+# local imports here
+from aprsd.client import base
+from aprsd.main import cli
+from aprsd.utils import trace
+
+
+CONF = cfg.CONF
+LOG = logging.getLogger("APRSD")
+CONTEXT_SETTINGS = dict(help_option_names=["-h", "--help"])
+
+
+@cli.group(help="Development type subcommands", context_settings=CONTEXT_SETTINGS)
+@click.pass_context
+def dev(ctx):
+    pass
+
+
+@dev.command()
+@cli_helper.add_options(cli_helper.common_options)
+@click.option(
+    "--aprs-login",
+    envvar="APRS_LOGIN",
+    show_envvar=True,
+    help="What callsign to send the message from.",
+)
+@click.option(
+    "-p",
+    "--plugin",
+    "plugin_path",
+    show_default=True,
+    default=None,
+    help="The plugin to run.  Ex: aprsd.plugins.ping.PingPlugin",
+)
+@click.option(
+    "-a",
+    "--all",
+    "load_all",
+    show_default=True,
+    is_flag=True,
+    default=False,
+    help="Load all the plugins in config?",
+)
+@click.option(
+    "-n",
+    "--num",
+    "number",
+    show_default=True,
+    default=1,
+    help="Number of times to call the plugin",
+)
+@click.argument("message", nargs=-1, required=True)
+@click.pass_context
+@cli_helper.process_standard_options
+def test_plugin(
+    ctx,
+    aprs_login,
+    plugin_path,
+    load_all,
+    number,
+    message,
+):
+    """Test an individual APRSD plugin given a python path."""
+
+    CONF.log_opt_values(LOG, logging.DEBUG)
+
+    if not aprs_login:
+        if CONF.aprs_network.login == conf.client.DEFAULT_LOGIN:
+            click.echo("Must set --aprs_login or APRS_LOGIN")
+            ctx.exit(-1)
+            return
+        else:
+            fromcall = CONF.aprs_network.login
+    else:
+        fromcall = aprs_login
+
+    if not plugin_path:
+        click.echo(ctx.get_help())
+        click.echo("")
+        click.echo("Failed to provide -p option to test a plugin")
+        ctx.exit(-1)
+        return
+
+    if type(message) is tuple:
+        message = " ".join(message)
+
+    if CONF.trace_enabled:
+        trace.setup_tracing(["method", "api"])
+
+    base.APRSClient()
+
+    pm = plugin.PluginManager()
+    if load_all:
+        pm.setup_plugins()
+    obj = pm._create_class(plugin_path, plugin.APRSDPluginBase)
+    if not obj:
+        click.echo(ctx.get_help())
+        click.echo("")
+        ctx.fail(f"Failed to create object from plugin path '{plugin_path}'")
+        ctx.exit()
+
+    # Register the plugin they wanted tested.
+    LOG.info(
+        "Testing plugin {} Version {}".format(
+            obj.__class__, obj.version,
+        ),
+    )
+    pm.register_msg(obj)
+
+    packet = packets.MessagePacket(
+        from_call=fromcall,
+        to_call=CONF.callsign,
+        msgNo=1,
+        message_text=message,
+    )
+    LOG.info(f"P'{plugin_path}'  F'{fromcall}'   C'{message}'")
+
+    for x in range(number):
+        replies = pm.run(packet)
+        # Plugin might have threads, so lets stop them so we can exit.
+        # obj.stop_threads()
+        for reply in replies:
+            if isinstance(reply, list):
+                # one of the plugins wants to send multiple messages
+                for subreply in reply:
+                    if isinstance(subreply, packets.Packet):
+                        LOG.info(subreply)
+                    else:
+                        LOG.info(
+                            packets.MessagePacket(
+                                from_call=CONF.callsign,
+                                to_call=fromcall,
+                                message_text=subreply,
+                            ),
+                        )
+            elif isinstance(reply, packets.Packet):
+                # We have a message based object.
+                LOG.info(reply)
+            else:
+                # A plugin can return a null message flag which signals
+                # us that they processed the message correctly, but have
+                # nothing to reply with, so we avoid replying with a
+                # usage string
+                if reply is not packets.NULL_MESSAGE:
+                    LOG.info(
+                        packets.MessagePacket(
+                            from_call=CONF.callsign,
+                            to_call=fromcall,
+                            message_text=reply,
+                        ),
+                    )
+    pm.stop()