aprsd 4.0.2__py3-none-any.whl → 4.1.1__py3-none-any.whl

aprsd/cli_helper.py

@@ -13,35 +13,35 @@ from aprsd.utils import trace
 
 CONF = cfg.CONF
 home = str(Path.home())
-DEFAULT_CONFIG_DIR = f"{home}/.config/aprsd/"
-DEFAULT_SAVE_FILE = f"{home}/.config/aprsd/aprsd.p"
-DEFAULT_CONFIG_FILE = f"{home}/.config/aprsd/aprsd.conf"
+DEFAULT_CONFIG_DIR = f'{home}/.config/aprsd/'
+DEFAULT_SAVE_FILE = f'{home}/.config/aprsd/aprsd.p'
+DEFAULT_CONFIG_FILE = f'{home}/.config/aprsd/aprsd.conf'
 
 
-F = t.TypeVar("F", bound=t.Callable[..., t.Any])
+F = t.TypeVar('F', bound=t.Callable[..., t.Any])
 
 common_options = [
     click.option(
-        "--loglevel",
-        default="INFO",
+        '--loglevel',
+        default='INFO',
         show_default=True,
         type=click.Choice(
-            ["CRITICAL", "ERROR", "WARNING", "INFO", "DEBUG"],
+            ['CRITICAL', 'ERROR', 'WARNING', 'INFO', 'DEBUG'],
             case_sensitive=False,
         ),
         show_choices=True,
-        help="The log level to use for aprsd.log",
+        help='The log level to use for aprsd.log',
     ),
     click.option(
-        "-c",
-        "--config",
-        "config_file",
+        '-c',
+        '--config',
+        'config_file',
         show_default=True,
         default=DEFAULT_CONFIG_FILE,
-        help="The aprsd config file to use for options.",
+        help='The aprsd config file to use for options.',
     ),
     click.option(
-        "--quiet",
+        '--quiet',
         is_flag=True,
         default=False,
         help="Don't log to stdout",
@@ -59,7 +59,7 @@ class AliasedGroup(click.Group):
         """
 
         def decorator(f):
-            aliases = kwargs.pop("aliases", [])
+            aliases = kwargs.pop('aliases', [])
             cmd = click.decorators.command(*args, **kwargs)(f)
             self.add_command(cmd)
             for alias in aliases:
@@ -77,7 +77,7 @@ class AliasedGroup(click.Group):
         """
 
         def decorator(f):
-            aliases = kwargs.pop("aliases", [])
+            aliases = kwargs.pop('aliases', [])
             cmd = click.decorators.group(*args, **kwargs)(f)
             self.add_command(cmd)
             for alias in aliases:
@@ -101,36 +101,37 @@ def process_standard_options(f: F) -> F:
         ctx = args[0]
         ctx.ensure_object(dict)
         config_file_found = True
-        if kwargs["config_file"]:
-            default_config_files = [kwargs["config_file"]]
+        if kwargs['config_file']:
+            default_config_files = [kwargs['config_file']]
         else:
             default_config_files = None
+
         try:
             CONF(
                 [],
-                project="aprsd",
+                project='aprsd',
                 version=aprsd.__version__,
                 default_config_files=default_config_files,
             )
         except cfg.ConfigFilesNotFoundError:
             config_file_found = False
-        ctx.obj["loglevel"] = kwargs["loglevel"]
+        ctx.obj['loglevel'] = kwargs['loglevel']
         # ctx.obj["config_file"] = kwargs["config_file"]
-        ctx.obj["quiet"] = kwargs["quiet"]
+        ctx.obj['quiet'] = kwargs['quiet']
         log.setup_logging(
-            ctx.obj["loglevel"],
-            ctx.obj["quiet"],
+            ctx.obj['loglevel'],
+            ctx.obj['quiet'],
         )
         if CONF.trace_enabled:
-            trace.setup_tracing(["method", "api"])
+            trace.setup_tracing(['method', 'api'])
 
         if not config_file_found:
-            LOG = logging.getLogger("APRSD")  # noqa: N806
+            LOG = logging.getLogger('APRSD')  # noqa: N806
             LOG.error("No config file found!! run 'aprsd sample-config'")
 
-        del kwargs["loglevel"]
-        del kwargs["config_file"]
-        del kwargs["quiet"]
+        del kwargs['loglevel']
+        del kwargs['config_file']
+        del kwargs['quiet']
         return f(*args, **kwargs)
 
     return update_wrapper(t.cast(F, new_func), f)
@@ -142,17 +143,17 @@ def process_standard_options_no_config(f: F) -> F:
     def new_func(*args, **kwargs):
         ctx = args[0]
         ctx.ensure_object(dict)
-        ctx.obj["loglevel"] = kwargs["loglevel"]
-        ctx.obj["config_file"] = kwargs["config_file"]
-        ctx.obj["quiet"] = kwargs["quiet"]
+        ctx.obj['loglevel'] = kwargs['loglevel']
+        ctx.obj['config_file'] = kwargs['config_file']
+        ctx.obj['quiet'] = kwargs['quiet']
         log.setup_logging(
-            ctx.obj["loglevel"],
-            ctx.obj["quiet"],
+            ctx.obj['loglevel'],
+            ctx.obj['quiet'],
         )
 
-        del kwargs["loglevel"]
-        del kwargs["config_file"]
-        del kwargs["quiet"]
+        del kwargs['loglevel']
+        del kwargs['config_file']
+        del kwargs['quiet']
         return f(*args, **kwargs)
 
     return update_wrapper(t.cast(F, new_func), f)

aprsd/client/base.py

@@ -9,7 +9,7 @@ from aprsd.packets import core
 from aprsd.utils import keepalive_collector
 
 CONF = cfg.CONF
-LOG = logging.getLogger("APRSD")
+LOG = logging.getLogger('APRSD')
 
 
 class APRSClient:
@@ -20,8 +20,8 @@ class APRSClient:
 
     connected = False
     login_status = {
-        "success": False,
-        "message": None,
+        'success': False,
+        'message': None,
     }
     filter = None
     lock = threading.Lock()
@@ -59,17 +59,20 @@ class APRSClient:
 
     @property
     def login_success(self):
-        return self.login_status.get("success", False)
+        return self.login_status.get('success', False)
 
     @property
     def login_failure(self):
-        return self.login_status["message"]
+        return self.login_status['message']
 
     def set_filter(self, filter):
         self.filter = filter
         if self._client:
             self._client.set_filter(filter)
 
+    def get_filter(self):
+        return self.filter
+
     @property
     def client(self):
         if not self._client:
@@ -80,16 +83,16 @@ class APRSClient:
         try:
             self._client = self.setup_connection()
             if self.filter:
-                LOG.info("Creating APRS client 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}")
+            LOG.error(f'Failed to create APRS client: {e}')
             self._client = None
             raise
 
     def stop(self):
         if self._client:
-            LOG.info("Stopping client connection.")
+            LOG.info('Stopping client connection.')
             self._client.stop()
 
     def send(self, packet: core.Packet) -> None:
@@ -103,16 +106,16 @@ class APRSClient:
     @wrapt.synchronized(lock)
     def reset(self) -> None:
         """Call this to force a rebuild/reconnect."""
-        LOG.info("Resetting client connection.")
+        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.")
+            LOG.warning('Client not initialized, nothing to reset.')
 
         # Recreate the client
-        LOG.info(f"Creating new client {self.client}")
+        LOG.info(f'Creating new client {self.client}')
 
     @abc.abstractmethod
     def setup_connection(self):

aprsd/client/drivers/aprsis.py

@@ -1,6 +1,7 @@
 import datetime
 import logging
 import select
+import socket
 import threading
 
 import aprslib
@@ -18,7 +19,7 @@ from aprslib.exceptions import (
 import aprsd
 from aprsd.packets import core
 
-LOG = logging.getLogger("APRSD")
+LOG = logging.getLogger('APRSD')
 
 
 class Aprsdis(aprslib.IS):
@@ -31,7 +32,7 @@ class Aprsdis(aprslib.IS):
     aprsd_keepalive = datetime.datetime.now()
 
     # Which server we are connected to?
-    server_string = "None"
+    server_string = 'None'
 
     # timeout in seconds
     select_timeout = 1
@@ -39,10 +40,10 @@ class Aprsdis(aprslib.IS):
 
     def stop(self):
         self.thread_stop = True
-        LOG.warning("Shutdown Aprsdis client.")
+        LOG.warning('Shutdown Aprsdis client.')
 
     def close(self):
-        LOG.warning("Closing Aprsdis client.")
+        LOG.warning('Closing Aprsdis client.')
         super().close()
 
     @wrapt.synchronized(lock)
@@ -54,6 +55,57 @@ class Aprsdis(aprslib.IS):
         """If the connection is alive or not."""
         return self._connected
 
+    def _connect(self):
+        """
+        Attemps connection to the server
+        """
+
+        self.logger.info(
+            'Attempting connection to %s:%s', self.server[0], self.server[1]
+        )
+
+        try:
+            self._open_socket()
+
+            peer = self.sock.getpeername()
+
+            self.logger.info('Connected to %s', str(peer))
+
+            # 5 second timeout to receive server banner
+            self.sock.setblocking(1)
+            self.sock.settimeout(5)
+
+            self.sock.setsockopt(socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1)
+            # MACOS doesn't have TCP_KEEPIDLE
+            if hasattr(socket, 'TCP_KEEPIDLE'):
+                self.sock.setsockopt(socket.IPPROTO_TCP, socket.TCP_KEEPIDLE, 1)
+            self.sock.setsockopt(socket.IPPROTO_TCP, socket.TCP_KEEPINTVL, 3)
+            self.sock.setsockopt(socket.IPPROTO_TCP, socket.TCP_KEEPCNT, 5)
+
+            banner = self.sock.recv(512)
+            if is_py3:
+                banner = banner.decode('latin-1')
+
+            if banner[0] == '#':
+                self.logger.debug('Banner: %s', banner.rstrip())
+            else:
+                raise ConnectionError('invalid banner from server')
+
+        except ConnectionError as e:
+            self.logger.error(str(e))
+            self.close()
+            raise
+        except (socket.error, socket.timeout) as e:
+            self.close()
+
+            self.logger.error('Socket error: %s' % str(e))
+            if str(e) == 'timed out':
+                raise ConnectionError('no banner from server') from e
+            else:
+                raise ConnectionError(e) from e
+
+        self._connected = True
+
     def _socket_readlines(self, blocking=False):
         """
         Generator for complete lines, received from the server
@@ -61,12 +113,12 @@ class Aprsdis(aprslib.IS):
         try:
             self.sock.setblocking(0)
         except OSError as e:
-            self.logger.error(f"socket error when setblocking(0): {str(e)}")
-            raise aprslib.ConnectionDrop("connection dropped")
+            self.logger.error(f'socket error when setblocking(0): {str(e)}')
+            raise aprslib.ConnectionDrop('connection dropped') from e
 
         while not self.thread_stop:
-            short_buf = b""
-            newline = b"\r\n"
+            short_buf = b''
+            newline = b'\r\n'
 
             # set a select timeout, so we get a chance to exit
             # when user hits CTRL-C
@@ -91,11 +143,11 @@ class Aprsdis(aprslib.IS):
                         # We could just not be blocking, so empty is expected
                         continue
                     else:
-                        self.logger.error("socket.recv(): returned empty")
-                        raise aprslib.ConnectionDrop("connection dropped")
+                        self.logger.error('socket.recv(): returned empty')
+                        raise aprslib.ConnectionDrop('connection dropped')
             except OSError as e:
                 # self.logger.error("socket error on recv(): %s" % str(e))
-                if "Resource temporarily unavailable" in str(e):
+                if 'Resource temporarily unavailable' in str(e):
                     if not blocking:
                         if len(self.buf) == 0:
                             break
@@ -111,22 +163,22 @@ class Aprsdis(aprslib.IS):
         """
         Sends login string to server
         """
-        login_str = "user {0} pass {1} vers github.com/craigerl/aprsd {3}{2}\r\n"
+        login_str = 'user {0} pass {1} vers Python-APRSD {3}{2}\r\n'
         login_str = login_str.format(
             self.callsign,
             self.passwd,
-            (" filter " + self.filter) if self.filter != "" else "",
+            (' filter ' + self.filter) if self.filter != '' else '',
             aprsd.__version__,
         )
 
-        self.logger.debug("Sending login information")
+        self.logger.debug('Sending login information')
 
         try:
             self._sendall(login_str)
             self.sock.settimeout(5)
             test = self.sock.recv(len(login_str) + 100)
             if is_py3:
-                test = test.decode("latin-1")
+                test = test.decode('latin-1')
             test = test.rstrip()
 
             self.logger.debug("Server: '%s'", test)
@@ -134,26 +186,26 @@ class Aprsdis(aprslib.IS):
             if not test:
                 raise LoginError(f"Server Response Empty: '{test}'")
 
-            _, _, callsign, status, e = test.split(" ", 4)
-            s = e.split(",")
+            _, _, callsign, status, e = test.split(' ', 4)
+            s = e.split(',')
             if len(s):
-                server_string = s[0].replace("server ", "")
+                server_string = s[0].replace('server ', '')
             else:
-                server_string = e.replace("server ", "")
+                server_string = e.replace('server ', '')
 
-            if callsign == "":
-                raise LoginError("Server responded with empty callsign???")
+            if callsign == '':
+                raise LoginError('Server responded with empty callsign???')
             if callsign != self.callsign:
-                raise LoginError(f"Server: {test}")
-            if status != "verified," and self.passwd != "-1":
-                raise LoginError("Password is incorrect")
+                raise LoginError(f'Server: {test}')
+            if status != 'verified,' and self.passwd != '-1':
+                raise LoginError('Password is incorrect')
 
-            if self.passwd == "-1":
-                self.logger.info("Login successful (receive only)")
+            if self.passwd == '-1':
+                self.logger.info('Login successful (receive only)')
             else:
-                self.logger.info("Login successful")
+                self.logger.info('Login successful')
 
-            self.logger.info(f"Connected to {server_string}")
+            self.logger.info(f'Connected to {server_string}')
             self.server_string = server_string
 
         except LoginError as e:
@@ -164,7 +216,7 @@ class Aprsdis(aprslib.IS):
             self.close()
             self.logger.error(f"Failed to login '{e}'")
             self.logger.exception(e)
-            raise LoginError("Failed to login")
+            raise LoginError('Failed to login') from e
 
     def consumer(self, callback, blocking=True, immortal=False, raw=False):
         """
@@ -180,21 +232,21 @@ class Aprsdis(aprslib.IS):
         """
 
         if not self._connected:
-            raise ConnectionError("not connected to a server")
+            raise ConnectionError('not connected to a server')
 
-        line = b""
+        line = b''
 
         while True and not self.thread_stop:
             try:
                 for line in self._socket_readlines(blocking):
-                    if line[0:1] != b"#":
+                    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"))
+                        self.logger.debug('Server: %s', line.decode('utf8'))
                         self.aprsd_keepalive = datetime.datetime.now()
             except ParseError as exp:
                 self.logger.log(
@@ -211,7 +263,7 @@ class Aprsdis(aprslib.IS):
                     exp.packet,
                 )
             except LoginError as exp:
-                self.logger.error("%s: %s", exp.__class__.__name__, exp)
+                self.logger.error('%s: %s', exp.__class__.__name__, exp)
             except (KeyboardInterrupt, SystemExit):
                 raise
             except (ConnectionDrop, ConnectionError):
@@ -227,7 +279,7 @@ class Aprsdis(aprslib.IS):
             except StopIteration:
                 break
             except Exception:
-                self.logger.error("APRS Packet: %s", line)
+                self.logger.error('APRS Packet: %s', line)
                 raise
 
             if not blocking:

aprsd/client/drivers/kiss.py

@@ -18,12 +18,13 @@ class KISS3Client:
 
     # date for last time we heard from the server
     aprsd_keepalive = datetime.datetime.now()
+    _connected = False
 
     def __init__(self):
         self.setup()
 
     def is_alive(self):
-        return True
+        return self._connected
 
     def setup(self):
         # we can be TCP kiss or Serial kiss
@@ -56,17 +57,33 @@ class KISS3Client:
             self.path = CONF.kiss_tcp.path
 
         LOG.debug('Starting KISS interface connection')
-        self.kiss.start()
+        try:
+            self.kiss.start()
+            if self.kiss.protocol.transport.is_closing():
+                LOG.warning('KISS transport is closing, not setting consumer callback')
+                self._connected = False
+            else:
+                self._connected = True
+        except Exception:
+            LOG.error('Failed to start KISS interface.')
+            self._connected = False
 
     @trace.trace
     def stop(self):
+        if not self._connected:
+            # do nothing since we aren't connected
+            return
+
         try:
             self.kiss.stop()
             self.kiss.loop.call_soon_threadsafe(
                 self.kiss.protocol.transport.close,
             )
-        except Exception as ex:
-            LOG.exception(ex)
+        except Exception:
+            LOG.error('Failed to stop KISS interface.')
+
+    def close(self):
+        self.stop()
 
     def set_filter(self, filter):
         # This does nothing right now.
@@ -86,8 +103,14 @@ class KISS3Client:
             LOG.exception(ex)
 
     def consumer(self, callback):
+        if not self._connected:
+            raise Exception('KISS transport is not connected')
+
         self._parse_callback = callback
-        self.kiss.read(callback=self.parse_frame, min_frames=None)
+        if not self.kiss.protocol.transport.is_closing():
+            self.kiss.read(callback=self.parse_frame, min_frames=1)
+        else:
+            self._connected = False
 
     def send(self, packet):
         """Send an APRS Message object."""

aprsd/client/kiss.py

@@ -140,3 +140,4 @@ class KISSClient(base.APRSClient):
         except Exception as ex:
             LOG.error(f'Consumer failed {ex}')
             LOG.error(ex)
+            raise ex