aprsd 4.0.1__py3-none-any.whl → 4.1.0__py3-none-any.whl

aprsd/conf/common.py

@@ -3,220 +3,219 @@ from pathlib import Path
 from oslo_config import cfg
 
 home = str(Path.home())
-DEFAULT_CONFIG_DIR = f"{home}/.config/aprsd/"
-APRSD_DEFAULT_MAGIC_WORD = "CHANGEME!!!"
+DEFAULT_CONFIG_DIR = f'{home}/.config/aprsd/'
+APRSD_DEFAULT_MAGIC_WORD = 'CHANGEME!!!'
 
 watch_list_group = cfg.OptGroup(
-    name="watch_list",
-    title="Watch List settings",
+    name='watch_list',
+    title='Watch List settings',
 )
 
 registry_group = cfg.OptGroup(
-    name="aprs_registry",
-    title="APRS Registry settings",
+    name='aprs_registry',
+    title='APRS Registry settings',
 )
 
 aprsd_opts = [
     cfg.StrOpt(
-        "callsign",
+        'callsign',
         required=True,
-        help="Callsign to use for messages sent by APRSD",
+        help='Callsign to use for messages sent by APRSD',
     ),
     cfg.BoolOpt(
-        "enable_save",
+        'enable_save',
         default=True,
-        help="Enable saving of watch list, packet tracker between restarts.",
+        help='Enable saving of watch list, packet tracker between restarts.',
     ),
     cfg.StrOpt(
-        "save_location",
+        'save_location',
         default=DEFAULT_CONFIG_DIR,
-        help="Save location for packet tracking files.",
+        help='Save location for packet tracking files.',
     ),
     cfg.BoolOpt(
-        "trace_enabled",
+        'trace_enabled',
         default=False,
-        help="Enable code tracing",
+        help='Enable code tracing',
     ),
     cfg.StrOpt(
-        "units",
-        default="imperial",
-        help="Units for display, imperial or metric",
+        'units',
+        default='imperial',
+        help='Units for display, imperial or metric',
     ),
     cfg.IntOpt(
-        "ack_rate_limit_period",
+        'ack_rate_limit_period',
         default=1,
-        help="The wait period in seconds per Ack packet being sent."
-        "1 means 1 ack packet per second allowed."
-        "2 means 1 pack packet every 2 seconds allowed",
+        help='The wait period in seconds per Ack packet being sent.'
+        '1 means 1 ack packet per second allowed.'
+        '2 means 1 pack packet every 2 seconds allowed',
     ),
     cfg.IntOpt(
-        "msg_rate_limit_period",
+        'msg_rate_limit_period',
         default=2,
-        help="Wait period in seconds per non AckPacket being sent."
-        "2 means 1 packet every 2 seconds allowed."
-        "5 means 1 pack packet every 5 seconds allowed",
+        help='Wait period in seconds per non AckPacket being sent.'
+        '2 means 1 packet every 2 seconds allowed.'
+        '5 means 1 pack packet every 5 seconds allowed',
     ),
     cfg.IntOpt(
-        "packet_dupe_timeout",
+        'packet_dupe_timeout',
         default=300,
-        help="The number of seconds before a packet is not considered a duplicate.",
+        help='The number of seconds before a packet is not considered a duplicate.',
     ),
     cfg.BoolOpt(
-        "enable_beacon",
+        'enable_beacon',
         default=False,
-        help="Enable sending of a GPS Beacon packet to locate this service. "
-        "Requires latitude and longitude to be set.",
+        help='Enable sending of a GPS Beacon packet to locate this service. '
+        'Requires latitude and longitude to be set.',
     ),
     cfg.IntOpt(
-        "beacon_interval",
+        'beacon_interval',
         default=1800,
-        help="The number of seconds between beacon packets.",
+        help='The number of seconds between beacon packets.',
     ),
     cfg.StrOpt(
-        "beacon_symbol",
-        default="/",
-        help="The symbol to use for the GPS Beacon packet. See: http://www.aprs.net/vm/DOS/SYMBOLS.HTM",
+        'beacon_symbol',
+        default='/',
+        help='The symbol to use for the GPS Beacon packet. See: http://www.aprs.net/vm/DOS/SYMBOLS.HTM',
     ),
     cfg.StrOpt(
-        "latitude",
+        'latitude',
         default=None,
-        help="Latitude for the GPS Beacon button.  If not set, the button will not be enabled.",
+        help='Latitude for the GPS Beacon button.  If not set, the button will not be enabled.',
     ),
     cfg.StrOpt(
-        "longitude",
+        'longitude',
         default=None,
-        help="Longitude for the GPS Beacon button.  If not set, the button will not be enabled.",
+        help='Longitude for the GPS Beacon button.  If not set, the button will not be enabled.',
     ),
     cfg.StrOpt(
-        "log_packet_format",
-        choices=["compact", "multiline", "both"],
-        default="compact",
+        'log_packet_format',
+        choices=['compact', 'multiline', 'both'],
+        default='compact',
         help="When logging packets 'compact' will use a single line formatted for each packet."
         "'multiline' will use multiple lines for each packet and is the traditional format."
-        "both will log both compact and multiline.",
+        'both will log both compact and multiline.',
     ),
     cfg.IntOpt(
-        "default_packet_send_count",
+        'default_packet_send_count',
         default=3,
-        help="The number of times to send a non ack packet before giving up.",
+        help='The number of times to send a non ack packet before giving up.',
     ),
     cfg.IntOpt(
-        "default_ack_send_count",
+        'default_ack_send_count',
         default=3,
-        help="The number of times to send an ack packet in response to recieving a packet.",
+        help='The number of times to send an ack packet in response to recieving a packet.',
     ),
     cfg.IntOpt(
-        "packet_list_maxlen",
+        'packet_list_maxlen',
         default=100,
-        help="The maximum number of packets to store in the packet list.",
+        help='The maximum number of packets to store in the packet list.',
     ),
     cfg.IntOpt(
-        "packet_list_stats_maxlen",
+        'packet_list_stats_maxlen',
         default=20,
-        help="The maximum number of packets to send in the stats dict for admin ui.",
+        help='The maximum number of packets to send in the stats dict for admin ui. -1 means no max.',
     ),
     cfg.BoolOpt(
-        "enable_seen_list",
+        'enable_seen_list',
         default=True,
-        help="Enable the Callsign seen list tracking feature.  This allows aprsd to keep track of "
-        "callsigns that have been seen and when they were last seen.",
+        help='Enable the Callsign seen list tracking feature.  This allows aprsd to keep track of '
+        'callsigns that have been seen and when they were last seen.',
     ),
     cfg.BoolOpt(
-        "enable_packet_logging",
+        'enable_packet_logging',
         default=True,
-        help="Set this to False, to disable logging of packets to the log file.",
+        help='Set this to False, to disable logging of packets to the log file.',
     ),
     cfg.BoolOpt(
-        "load_help_plugin",
+        'load_help_plugin',
         default=True,
-        help="Set this to False to disable the help plugin.",
+        help='Set this to False to disable the help plugin.',
     ),
     cfg.BoolOpt(
-        "enable_sending_ack_packets",
+        'enable_sending_ack_packets',
         default=True,
-        help="Set this to False, to disable sending of ack packets. This will entirely stop"
-        "APRSD from sending ack packets.",
+        help='Set this to False, to disable sending of ack packets. This will entirely stop'
+        'APRSD from sending ack packets.',
     ),
 ]
 
 watch_list_opts = [
     cfg.BoolOpt(
-        "enabled",
+        'enabled',
         default=False,
-        help="Enable the watch list feature.  Still have to enable "
-        "the correct plugin.  Built-in plugin to use is "
-        "aprsd.plugins.notify.NotifyPlugin",
+        help='Enable the watch list feature.  Still have to enable '
+        'the correct plugin.  Built-in plugin to use is '
+        'aprsd.plugins.notify.NotifyPlugin',
     ),
     cfg.ListOpt(
-        "callsigns",
-        help="Callsigns to watch for messsages",
+        'callsigns',
+        help='Callsigns to watch for messsages',
     ),
     cfg.StrOpt(
-        "alert_callsign",
-        help="The Ham Callsign to send messages to for watch list alerts.",
+        'alert_callsign',
+        help='The Ham Callsign to send messages to for watch list alerts.',
     ),
     cfg.IntOpt(
-        "packet_keep_count",
+        'packet_keep_count',
         default=10,
-        help="The number of packets to store.",
+        help='The number of packets to store.',
     ),
     cfg.IntOpt(
-        "alert_time_seconds",
+        'alert_time_seconds',
         default=3600,
-        help="Time to wait before alert is sent on new message for "
-        "users in callsigns.",
+        help='Time to wait before alert is sent on new message for users in callsigns.',
     ),
 ]
 
 
 enabled_plugins_opts = [
     cfg.ListOpt(
-        "enabled_plugins",
+        'enabled_plugins',
         default=[
-            "aprsd.plugins.fortune.FortunePlugin",
-            "aprsd.plugins.location.LocationPlugin",
-            "aprsd.plugins.ping.PingPlugin",
-            "aprsd.plugins.time.TimePlugin",
-            "aprsd.plugins.weather.OWMWeatherPlugin",
-            "aprsd.plugins.version.VersionPlugin",
-            "aprsd.plugins.notify.NotifySeenPlugin",
+            'aprsd.plugins.fortune.FortunePlugin',
+            'aprsd.plugins.location.LocationPlugin',
+            'aprsd.plugins.ping.PingPlugin',
+            'aprsd.plugins.time.TimePlugin',
+            'aprsd.plugins.weather.OWMWeatherPlugin',
+            'aprsd.plugins.version.VersionPlugin',
+            'aprsd.plugins.notify.NotifySeenPlugin',
         ],
-        help="Comma separated list of enabled plugins for APRSD."
-        "To enable installed external plugins add them here."
-        "The full python path to the class name must be used",
+        help='Comma separated list of enabled plugins for APRSD.'
+        'To enable installed external plugins add them here.'
+        'The full python path to the class name must be used',
     ),
 ]
 
 registry_opts = [
     cfg.BoolOpt(
-        "enabled",
+        'enabled',
         default=False,
-        help="Enable sending aprs registry information.  This will let the "
+        help='Enable sending aprs registry information.  This will let the '
         "APRS registry know about your service and it's uptime.  "
-        "No personal information is sent, just the callsign, uptime and description. "
-        "The service callsign is the callsign set in [DEFAULT] section.",
+        'No personal information is sent, just the callsign, uptime and description. '
+        'The service callsign is the callsign set in [DEFAULT] section.',
     ),
     cfg.StrOpt(
-        "description",
+        'description',
         default=None,
-        help="Description of the service to send to the APRS registry. "
-        "This is what will show up in the APRS registry."
-        "If not set, the description will be the same as the callsign.",
+        help='Description of the service to send to the APRS registry. '
+        'This is what will show up in the APRS registry.'
+        'If not set, the description will be the same as the callsign.',
     ),
     cfg.StrOpt(
-        "registry_url",
-        default="https://aprs.hemna.com/api/v1/registry",
-        help="The APRS registry domain name to send the information to.",
+        'registry_url',
+        default='https://aprs.hemna.com/api/v1/registry',
+        help='The APRS registry domain name to send the information to.',
     ),
     cfg.StrOpt(
-        "service_website",
+        'service_website',
         default=None,
-        help="The website for your APRS service to send to the APRS registry.",
+        help='The website for your APRS service to send to the APRS registry.',
     ),
     cfg.IntOpt(
-        "frequency_seconds",
+        'frequency_seconds',
         default=3600,
-        help="The frequency in seconds to send the APRS registry information.",
+        help='The frequency in seconds to send the APRS registry information.',
     ),
 ]
 
@@ -232,7 +231,7 @@ def register_opts(config):
 
 def list_opts():
     return {
-        "DEFAULT": (aprsd_opts + enabled_plugins_opts),
+        'DEFAULT': (aprsd_opts + enabled_plugins_opts),
         watch_list_group.name: watch_list_opts,
         registry_group.name: registry_opts,
     }

aprsd/conf/log.py

@@ -7,47 +7,52 @@ import logging
 from oslo_config import cfg
 
 LOG_LEVELS = {
-    "CRITICAL": logging.CRITICAL,
-    "ERROR": logging.ERROR,
-    "WARNING": logging.WARNING,
-    "INFO": logging.INFO,
-    "DEBUG": logging.DEBUG,
+    'CRITICAL': logging.CRITICAL,
+    'ERROR': logging.ERROR,
+    'WARNING': logging.WARNING,
+    'INFO': logging.INFO,
+    'DEBUG': logging.DEBUG,
 }
 
-DEFAULT_DATE_FORMAT = "%m/%d/%Y %I:%M:%S %p"
+DEFAULT_DATE_FORMAT = '%m/%d/%Y %I:%M:%S %p'
 DEFAULT_LOG_FORMAT = (
-    "[%(asctime)s] [%(threadName)-20.20s] [%(levelname)-5.5s]"
-    " %(message)s - [%(pathname)s:%(lineno)d]"
+    '[%(asctime)s] [%(threadName)-20.20s] [%(levelname)-5.5s]'
+    ' %(message)s - [%(pathname)s:%(lineno)d]'
 )
 
 DEFAULT_LOG_FORMAT = (
-    "<green>{time:YYYY-MM-DD HH:mm:ss.SSS}</green> | "
-    "<yellow>{thread.name: <18}</yellow> | "
-    "<level>{level: <8}</level> | "
-    "<level>{message}</level> | "
-    "<cyan>{name}</cyan>:<cyan>{function:}</cyan>:<magenta>{line:}</magenta>"
+    '<green>{time:YYYY-MM-DD HH:mm:ss.SSS}</green> | '
+    '<yellow>{thread.name: <18}</yellow> | '
+    '<level>{level: <8}</level> | '
+    '<level>{message}</level> | '
+    '<cyan>{name}</cyan>:<cyan>{function:}</cyan>:<magenta>{line:}</magenta>'
 )
 
 logging_group = cfg.OptGroup(
-    name="logging",
-    title="Logging options",
+    name='logging',
+    title='Logging options',
 )
 logging_opts = [
     cfg.StrOpt(
-        "logfile",
+        'logfile',
         default=None,
-        help="File to log to",
+        help='File to log to',
     ),
     cfg.StrOpt(
-        "logformat",
+        'logformat',
         default=DEFAULT_LOG_FORMAT,
-        help="Log file format, unless rich_logging enabled.",
+        help='Log file format, unless rich_logging enabled.',
     ),
     cfg.StrOpt(
-        "log_level",
-        default="INFO",
+        'log_level',
+        default='INFO',
         choices=LOG_LEVELS.keys(),
-        help="Log level for logging of events.",
+        help='Log level for logging of events.',
+    ),
+    cfg.BoolOpt(
+        'enable_color',
+        default=True,
+        help='Enable ANSI color codes in logging',
     ),
 ]
 

aprsd/log/log.py

@@ -63,11 +63,21 @@ def setup_logging(loglevel=None, quiet=False):
 
     # We don't really want to see the aprslib parsing debug output.
     disable_list = [
-        "aprslib",
-        "aprslib.parsing",
-        "aprslib.exceptions",
+        'aprslib',
+        'aprslib.parsing',
+        'aprslib.exceptions',
     ]
 
+    chardet_list = [
+        'chardet',
+        'chardet.charsetprober',
+        'chardet.eucjpprober',
+    ]
+
+    for name in chardet_list:
+        disable = logging.getLogger(name)
+        disable.setLevel(logging.ERROR)
+
     # remove every other logger's handlers
     # and propagate to root logger
     for name in logging.root.manager.loggerDict.keys():
@@ -76,24 +86,24 @@ def setup_logging(loglevel=None, quiet=False):
 
     handlers = [
         {
-            "sink": sys.stdout,
-            "serialize": False,
-            "format": CONF.logging.logformat,
-            "colorize": True,
-            "level": log_level,
+            'sink': sys.stdout,
+            'serialize': False,
+            'format': CONF.logging.logformat,
+            'colorize': CONF.logging.enable_color,
+            'level': log_level,
         },
     ]
     if CONF.logging.logfile:
         handlers.append(
             {
-                "sink": CONF.logging.logfile,
-                "serialize": False,
-                "format": CONF.logging.logformat,
-                "colorize": False,
-                "level": log_level,
+                'sink': CONF.logging.logfile,
+                'serialize': False,
+                'format': CONF.logging.logformat,
+                'colorize': False,
+                'level': log_level,
             },
         )
 
     # configure loguru
     logger.configure(handlers=handlers)
-    logger.level("DEBUG", color="<fg #BABABA>")
+    logger.level('DEBUG', color='<fg #BABABA>')

aprsd/packets/__init__.py

@@ -15,6 +15,8 @@ from aprsd.packets.core import (  # noqa: F401
     WeatherPacket,
     factory,
 )
+from aprsd.packets.filter import PacketFilter
+from aprsd.packets.filters.dupe_filter import DupePacketFilter
 from aprsd.packets.packet_list import PacketList  # noqa: F401
 from aprsd.packets.seen_list import SeenList  # noqa: F401
 from aprsd.packets.tracker import PacketTrack  # noqa: F401
@@ -26,5 +28,9 @@ collector.PacketCollector().register(SeenList)
 collector.PacketCollector().register(PacketTrack)
 collector.PacketCollector().register(WatchList)
 
+# Register all the packet filters for normal processing
+# For specific commands you can deregister these if you don't want them.
+PacketFilter().register(DupePacketFilter)
+
 
 NULL_MESSAGE = -1

aprsd/packets/core.py

@@ -106,6 +106,8 @@ class Packet:
     last_send_time: float = field(repr=False, default=0, compare=False, hash=False)
     # Was the packet acked?
     acked: bool = field(repr=False, default=False, compare=False, hash=False)
+    # Was the packet previously processed (for dupe checking)
+    processed: bool = field(repr=False, default=False, compare=False, hash=False)
 
     # Do we allow this packet to be saved to send later?
     allow_delay: bool = field(repr=False, default=True, compare=False, hash=False)
@@ -186,12 +188,11 @@ class Packet:
 
     def __repr__(self) -> str:
         """Build the repr version of the packet."""
-        repr = (
+        return (
             f"{self.__class__.__name__}:"
             f" From: {self.from_call}  "
             f"   To: {self.to_call}"
         )
-        return repr
 
 
 @dataclass_json
@@ -694,6 +695,8 @@ class UnknownPacket:
     path: List[str] = field(default_factory=list, compare=False, hash=False)
     packet_type: Optional[str] = field(default=None)
     via: Optional[str] = field(default=None, compare=False, hash=False)
+    # Was the packet previously processed (for dupe checking)
+    processed: bool = field(repr=False, default=False, compare=False, hash=False)
 
     @property
     def key(self) -> str:

aprsd/packets/filter.py

@@ -0,0 +1,58 @@
+import logging
+from typing import Callable, Protocol, runtime_checkable, Union, Dict
+
+from aprsd.packets import core
+from aprsd.utils import singleton
+
+LOG = logging.getLogger("APRSD")
+
+
+@runtime_checkable
+class PacketFilterProtocol(Protocol):
+    """Protocol API for a packet filter class.
+    """
+    def filter(self, packet: type[core.Packet]) -> Union[type[core.Packet], None]:
+        """When we get a packet from the network.
+
+        Return a Packet object if the filter passes. Return None if the
+        Packet is filtered out.
+        """
+        ...
+
+
+@singleton
+class PacketFilter:
+
+    def __init__(self):
+        self.filters: Dict[str, Callable] = {}
+
+    def register(self, packet_filter: Callable) -> None:
+        if not isinstance(packet_filter, PacketFilterProtocol):
+            raise TypeError(f"class {packet_filter} is not a PacketFilterProtocol object")
+
+        if packet_filter not in self.filters:
+            self.filters[packet_filter] = packet_filter()
+
+    def unregister(self, packet_filter: Callable) -> None:
+        if not isinstance(packet_filter, PacketFilterProtocol):
+            raise TypeError(f"class {packet_filter} is not a PacketFilterProtocol object")
+        if packet_filter in self.filters:
+            del self.filters[packet_filter]
+
+    def filter(self, packet: type[core.Packet]) -> Union[type[core.Packet], None]:
+        """Run through each of the filters.
+
+        This will step through each registered filter class
+        and call filter on it.
+
+        If the filter object returns None, we are done filtering.
+        If the filter object returns the packet, we continue filtering.
+        """
+        for packet_filter in self.filters:
+            try:
+                if not self.filters[packet_filter].filter(packet):
+                    LOG.debug(f"{self.filters[packet_filter].__class__.__name__} dropped {packet.__class__.__name__}:{packet.human_info}")
+                    return None
+            except Exception as ex:
+                LOG.error(f"{packet_filter.__clas__.__name__} failed filtering packet {packet.__class__.__name__} : {ex}")
+        return packet

aprsd/packets/filters/dupe_filter.py

@@ -0,0 +1,68 @@
+import logging
+from typing import Union
+
+from oslo_config import cfg
+
+from aprsd import packets
+from aprsd.packets import core
+
+CONF = cfg.CONF
+LOG = logging.getLogger('APRSD')
+
+
+class DupePacketFilter:
+    """This is a packet filter to detect duplicate packets.
+
+    This Uses the PacketList object to see if a packet exists
+    already.  If it does exist in the PacketList, then we need to
+    check the flag on the packet to see if it's been processed before.
+    If the packet has been processed already within the allowed
+    timeframe, then it's a dupe.
+    """
+
+    def filter(self, packet: type[core.Packet]) -> Union[type[core.Packet], None]:
+        # LOG.debug(f"{self.__class__.__name__}.filter called for packet {packet}")
+        """Filter a packet out if it's already been seen and processed."""
+        if isinstance(packet, core.AckPacket):
+            # We don't need to drop AckPackets, those should be
+            # processed.
+            # Send the AckPacket to the queue for processing elsewhere.
+            return packet
+        else:
+            # Make sure we aren't re-processing the same packet
+            # For RF based APRS Clients we can get duplicate packets
+            # So we need to track them and not process the dupes.
+            pkt_list = packets.PacketList()
+            found = False
+            try:
+                # Find the packet in the list of already seen packets
+                # Based on the packet.key
+                found = pkt_list.find(packet)
+                if not packet.msgNo:
+                    # If the packet doesn't have a message id
+                    # then there is no reliable way to detect
+                    # if it's a dupe, so we just pass it on.
+                    # it shouldn't get acked either.
+                    found = False
+            except KeyError:
+                found = False
+
+            if not found:
+                # We haven't seen this packet before, so we process it.
+                return packet
+
+            if not packet.processed:
+                # We haven't processed this packet through the plugins.
+                return packet
+            elif packet.timestamp - found.timestamp < CONF.packet_dupe_timeout:
+                # If the packet came in within N seconds of the
+                # Last time seeing the packet, then we drop it as a dupe.
+                LOG.warning(
+                    f'Packet {packet.from_call}:{packet.msgNo} already tracked, dropping.'
+                )
+            else:
+                LOG.warning(
+                    f'Packet {packet.from_call}:{packet.msgNo} already tracked '
+                    f'but older than {CONF.packet_dupe_timeout} seconds. processing.',
+                )
+                return packet