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

aprsd/cmds/list_plugins.py

@@ -4,12 +4,9 @@ import inspect
 import logging
 import os
 import pkgutil
-import re
 import sys
 from traceback import print_tb
-from urllib.parse import urljoin
 
-from bs4 import BeautifulSoup
 import click
 import requests
 from rich.console import Console
@@ -20,17 +17,14 @@ from thesmuggler import smuggle
 from aprsd import cli_helper
 from aprsd import plugin as aprsd_plugin
 from aprsd.main import cli
-from aprsd.plugins import (
-    email, fortune, location, notify, ping, time, version, weather,
-)
+from aprsd.plugins import fortune, notify, ping, time, version, weather
 
-
-LOG = logging.getLogger("APRSD")
-PYPI_URL = "https://pypi.org/search/"
+LOG = logging.getLogger('APRSD')
+PYPI_URL = 'https://pypi.org/search/'
 
 
 def onerror(name):
-    print(f"Error importing module {name}")
+    print(f'Error importing module {name}')
     type, value, traceback = sys.exc_info()
     print_tb(traceback)
 
@@ -46,19 +40,19 @@ def is_plugin(obj):
 def plugin_type(obj):
     for c in inspect.getmro(obj):
         if issubclass(c, aprsd_plugin.APRSDRegexCommandPluginBase):
-            return "RegexCommand"
+            return 'RegexCommand'
         if issubclass(c, aprsd_plugin.APRSDWatchListPluginBase):
-            return "WatchList"
+            return 'WatchList'
         if issubclass(c, aprsd_plugin.APRSDPluginBase):
-            return "APRSDPluginBase"
+            return 'APRSDPluginBase'
 
-    return "Unknown"
+    return 'Unknown'
 
 
 def walk_package(package):
     return pkgutil.walk_packages(
         package.__path__,
-        package.__name__ + ".",
+        package.__name__ + '.',
         onerror=onerror,
     )
 
@@ -68,22 +62,23 @@ def get_module_info(package_name, module_name, module_path):
         return None
 
     dir_path = os.path.realpath(module_path)
-    pattern = "*.py"
+    pattern = '*.py'
 
     obj_list = []
 
     for path, _subdirs, files in os.walk(dir_path):
         for name in files:
             if fnmatch.fnmatch(name, pattern):
-                module = smuggle(f"{path}/{name}")
+                module = smuggle(f'{path}/{name}')
                 for mem_name, obj in inspect.getmembers(module):
                     if inspect.isclass(obj) and is_plugin(obj):
                         obj_list.append(
                             {
-                                "package": package_name,
-                                "name": mem_name, "obj": obj,
-                                "version": obj.version,
-                                "path": f"{'.'.join([module_name, obj.__name__])}",
+                                'package': package_name,
+                                'name': mem_name,
+                                'obj': obj,
+                                'version': obj.version,
+                                'path': f'{".".join([module_name, obj.__name__])}',
                             },
                         )
 
@@ -94,18 +89,18 @@ def _get_installed_aprsd_items():
     # installed plugins
     plugins = {}
     extensions = {}
-    for finder, name, ispkg in pkgutil.iter_modules():
-        if name.startswith("aprsd_"):
-            print(f"Found aprsd_ module: {name}")
-            if ispkg:
-                module = importlib.import_module(name)
-                pkgs = walk_package(module)
-                for pkg in pkgs:
-                    pkg_info = get_module_info(module.__name__, pkg.name, module.__path__[0])
-                    if "plugin" in name:
-                        plugins[name] = pkg_info
-                    elif "extension" in name:
-                        extensions[name] = pkg_info
+    for _finder, name, ispkg in pkgutil.iter_modules():
+        if ispkg and name.startswith('aprsd_'):
+            module = importlib.import_module(name)
+            pkgs = walk_package(module)
+            for pkg in pkgs:
+                pkg_info = get_module_info(
+                    module.__name__, pkg.name, module.__path__[0]
+                )
+                if 'plugin' in name:
+                    plugins[name] = pkg_info
+                elif 'extension' in name:
+                    extensions[name] = pkg_info
     return plugins, extensions
 
 
@@ -122,7 +117,7 @@ def get_installed_extensions():
 
 
 def show_built_in_plugins(console):
-    modules = [email, fortune, location, notify, ping, time, version, weather]
+    modules = [fortune, notify, ping, time, version, weather]
     plugins = []
 
     for module in modules:
@@ -131,132 +126,141 @@ def show_built_in_plugins(console):
             cls = entry[1]
             if issubclass(cls, aprsd_plugin.APRSDPluginBase):
                 info = {
-                    "name": cls.__qualname__,
-                    "path": f"{cls.__module__}.{cls.__qualname__}",
-                    "version": cls.version,
-                    "docstring": cls.__doc__,
-                    "short_desc": cls.short_description,
+                    'name': cls.__qualname__,
+                    'path': f'{cls.__module__}.{cls.__qualname__}',
+                    'version': cls.version,
+                    'docstring': cls.__doc__,
+                    'short_desc': cls.short_description,
                 }
 
                 if issubclass(cls, aprsd_plugin.APRSDRegexCommandPluginBase):
-                    info["command_regex"] = cls.command_regex
-                    info["type"] = "RegexCommand"
+                    info['command_regex'] = cls.command_regex
+                    info['type'] = 'RegexCommand'
 
                 if issubclass(cls, aprsd_plugin.APRSDWatchListPluginBase):
-                    info["type"] = "WatchList"
+                    info['type'] = 'WatchList'
 
                 plugins.append(info)
 
-    plugins = sorted(plugins, key=lambda i: i["name"])
+    plugins = sorted(plugins, key=lambda i: i['name'])
 
     table = Table(
-        title="[not italic]:snake:[/] [bold][magenta]APRSD Built-in Plugins [not italic]:snake:[/]",
+        title='[not italic]:snake:[/] [bold][magenta]APRSD Built-in Plugins [not italic]:snake:[/]',
     )
-    table.add_column("Plugin Name", style="cyan", no_wrap=True)
-    table.add_column("Info", style="bold yellow")
-    table.add_column("Type", style="bold green")
-    table.add_column("Plugin Path", style="bold blue")
+    table.add_column('Plugin Name', style='cyan', no_wrap=True)
+    table.add_column('Info', style='bold yellow')
+    table.add_column('Type', style='bold green')
+    table.add_column('Plugin Path', style='bold blue')
     for entry in plugins:
-        table.add_row(entry["name"], entry["short_desc"], entry["type"], entry["path"])
+        table.add_row(entry['name'], entry['short_desc'], entry['type'], entry['path'])
 
     console.print(table)
 
 
 def _get_pypi_packages():
-    query = "aprsd"
-    snippets = []
-    s = requests.Session()
-    for page in range(1, 3):
-        params = {"q": query, "page": page}
-        r = s.get(PYPI_URL, params=params)
-        soup = BeautifulSoup(r.text, "html.parser")
-        snippets += soup.select('a[class*="snippet"]')
-        if not hasattr(s, "start_url"):
-            s.start_url = r.url.rsplit("&page", maxsplit=1).pop(0)
-
-    return snippets
+    if simple_r := requests.get(
+        'https://pypi.org/simple',
+        headers={'Accept': 'application/vnd.pypi.simple.v1+json'},
+    ):
+        simple_response = simple_r.json()
+    else:
+        simple_response = {}
+
+    key = 'aprsd'
+    matches = [
+        p['name'] for p in simple_response['projects'] if p['name'].startswith(key)
+    ]
+
+    packages = []
+    for pkg in matches:
+        # Get info for first match
+        if r := requests.get(
+            f'https://pypi.org/pypi/{pkg}/json',
+            headers={'Accept': 'application/json'},
+        ):
+            packages.append(r.json())
+
+    return packages
 
 
 def show_pypi_plugins(installed_plugins, console):
-    snippets = _get_pypi_packages()
+    packages = _get_pypi_packages()
 
     title = Text.assemble(
-        ("Pypi.org APRSD Installable Plugin Packages\n\n", "bold magenta"),
-        ("Install any of the following plugins with\n", "bold yellow"),
-        ("'pip install ", "bold white"),
-        ("<Plugin Package Name>'", "cyan"),
+        ('Pypi.org APRSD Installable Plugin Packages\n\n', 'bold magenta'),
+        ('Install any of the following plugins with\n', 'bold yellow'),
+        ("'pip install ", 'bold white'),
+        ("<Plugin Package Name>'", 'cyan'),
     )
 
     table = Table(title=title)
-    table.add_column("Plugin Package Name", style="cyan", no_wrap=True)
-    table.add_column("Description", style="yellow")
-    table.add_column("Version", style="yellow", justify="center")
-    table.add_column("Released", style="bold green", justify="center")
-    table.add_column("Installed?", style="red", justify="center")
-    for snippet in snippets:
-        link = urljoin(PYPI_URL, snippet.get("href"))
-        package = re.sub(r"\s+", " ", snippet.select_one('span[class*="name"]').text.strip())
-        version = re.sub(r"\s+", " ", snippet.select_one('span[class*="version"]').text.strip())
-        created = re.sub(r"\s+", " ", snippet.select_one('span[class*="created"]').text.strip())
-        description = re.sub(r"\s+", " ", snippet.select_one('p[class*="description"]').text.strip())
-        emoji = ":open_file_folder:"
-
-        if "aprsd-" not in package or "-plugin" not in package:
+    table.add_column('Plugin Package Name', style='cyan', no_wrap=True)
+    table.add_column('Description', style='yellow')
+    table.add_column('Version', style='yellow', justify='center')
+    table.add_column('Released', style='bold green', justify='center')
+    table.add_column('Installed?', style='red', justify='center')
+    emoji = ':open_file_folder:'
+    for package in packages:
+        link = package['info']['package_url']
+        version = package['info']['version']
+        package_name = package['info']['name']
+        description = package['info']['summary']
+        created = package['releases'][version][0]['upload_time']
+
+        if 'aprsd-' not in package_name or '-plugin' not in package_name:
             continue
 
-        under = package.replace("-", "_")
-        if under in installed_plugins:
-            installed = "Yes"
-        else:
-            installed = "No"
-
+        under = package_name.replace('-', '_')
+        installed = 'Yes' if under in installed_plugins else 'No'
         table.add_row(
-            f"[link={link}]{emoji}[/link] {package}",
-            description, version, created, installed,
+            f'[link={link}]{emoji}[/link] {package_name}',
+            description,
+            version,
+            created,
+            installed,
         )
 
-    console.print("\n")
+    console.print('\n')
     console.print(table)
 
 
 def show_pypi_extensions(installed_extensions, console):
-    snippets = _get_pypi_packages()
+    packages = _get_pypi_packages()
 
     title = Text.assemble(
-        ("Pypi.org APRSD Installable Extension Packages\n\n", "bold magenta"),
-        ("Install any of the following extensions by running\n", "bold yellow"),
-        ("'pip install ", "bold white"),
-        ("<Plugin Package Name>'", "cyan"),
+        ('Pypi.org APRSD Installable Extension Packages\n\n', 'bold magenta'),
+        ('Install any of the following extensions by running\n', 'bold yellow'),
+        ("'pip install ", 'bold white'),
+        ("<Plugin Package Name>'", 'cyan'),
     )
     table = Table(title=title)
-    table.add_column("Extension Package Name", style="cyan", no_wrap=True)
-    table.add_column("Description", style="yellow")
-    table.add_column("Version", style="yellow", justify="center")
-    table.add_column("Released", style="bold green", justify="center")
-    table.add_column("Installed?", style="red", justify="center")
-    for snippet in snippets:
-        link = urljoin(PYPI_URL, snippet.get("href"))
-        package = re.sub(r"\s+", " ", snippet.select_one('span[class*="name"]').text.strip())
-        version = re.sub(r"\s+", " ", snippet.select_one('span[class*="version"]').text.strip())
-        created = re.sub(r"\s+", " ", snippet.select_one('span[class*="created"]').text.strip())
-        description = re.sub(r"\s+", " ", snippet.select_one('p[class*="description"]').text.strip())
-        emoji = ":open_file_folder:"
-
-        if "aprsd-" not in package or "-extension" not in package:
+    table.add_column('Extension Package Name', style='cyan', no_wrap=True)
+    table.add_column('Description', style='yellow')
+    table.add_column('Version', style='yellow', justify='center')
+    table.add_column('Released', style='bold green', justify='center')
+    table.add_column('Installed?', style='red', justify='center')
+    emoji = ':open_file_folder:'
+
+    for package in packages:
+        link = package['info']['package_url']
+        version = package['info']['version']
+        package_name = package['info']['name']
+        description = package['info']['summary']
+        created = package['releases'][version][0]['upload_time']
+        if 'aprsd-' not in package_name or '-extension' not in package_name:
             continue
 
-        under = package.replace("-", "_")
-        if under in installed_extensions:
-            installed = "Yes"
-        else:
-            installed = "No"
-
+        under = package_name.replace('-', '_')
+        installed = 'Yes' if under in installed_extensions else 'No'
         table.add_row(
-            f"[link={link}]{emoji}[/link] {package}",
-            description, version, created, installed,
+            f'[link={link}]{emoji}[/link] {package_name}',
+            description,
+            version,
+            created,
+            installed,
         )
 
-    console.print("\n")
+    console.print('\n')
     console.print(table)
 
 
@@ -265,24 +269,24 @@ def show_installed_plugins(installed_plugins, console):
         return
 
     table = Table(
-        title="[not italic]:snake:[/] [bold][magenta]APRSD Installed 3rd party Plugins [not italic]:snake:[/]",
+        title='[not italic]:snake:[/] [bold][magenta]APRSD Installed 3rd party Plugins [not italic]:snake:[/]',
     )
-    table.add_column("Package Name", style=" bold white", no_wrap=True)
-    table.add_column("Plugin Name", style="cyan", no_wrap=True)
-    table.add_column("Version", style="yellow", justify="center")
-    table.add_column("Type", style="bold green")
-    table.add_column("Plugin Path", style="bold blue")
+    table.add_column('Package Name', style=' bold white', no_wrap=True)
+    table.add_column('Plugin Name', style='cyan', no_wrap=True)
+    table.add_column('Version', style='yellow', justify='center')
+    table.add_column('Type', style='bold green')
+    table.add_column('Plugin Path', style='bold blue')
     for name in installed_plugins:
         for plugin in installed_plugins[name]:
             table.add_row(
-                name.replace("_", "-"),
-                plugin["name"],
-                plugin["version"],
-                plugin_type(plugin["obj"]),
-                plugin["path"],
+                name.replace('_', '-'),
+                plugin['name'],
+                plugin['version'],
+                plugin_type(plugin['obj']),
+                plugin['path'],
             )
 
-    console.print("\n")
+    console.print('\n')
     console.print(table)
 
 
@@ -294,14 +298,14 @@ def list_plugins(ctx):
     """List the built in plugins available to APRSD."""
     console = Console()
 
-    with console.status("Show Built-in Plugins") as status:
+    with console.status('Show Built-in Plugins') as status:
         show_built_in_plugins(console)
 
-        status.update("Fetching pypi.org plugins")
+        status.update('Fetching pypi.org plugins')
         installed_plugins = get_installed_plugins()
         show_pypi_plugins(installed_plugins, console)
 
-        status.update("Looking for installed APRSD plugins")
+        status.update('Looking for installed APRSD plugins')
         show_installed_plugins(installed_plugins, console)
 
 
@@ -313,7 +317,9 @@ def list_extensions(ctx):
     """List the built in plugins available to APRSD."""
     console = Console()
 
-    with console.status("Show APRSD Extensions") as status:
-        status.update("Fetching pypi.org APRSD Extensions")
+    with console.status('Show APRSD Extensions') as status:
+        status.update('Fetching pypi.org APRSD Extensions')
+
+        status.update('Looking for installed APRSD Extensions')
         installed_extensions = get_installed_extensions()
         show_pypi_extensions(installed_extensions, console)

aprsd/cmds/listen.py

@@ -10,26 +10,28 @@ import sys
 import time
 
 import click
+from loguru import logger
 from oslo_config import cfg
 from rich.console import Console
 
 # local imports here
 import aprsd
-from aprsd import cli_helper, packets, plugin, threads
+from aprsd import cli_helper, packets, plugin, threads, utils
 from aprsd.client import client_factory
 from aprsd.main import cli
 from aprsd.packets import collector as packet_collector
 from aprsd.packets import log as packet_log
 from aprsd.packets import seen_list
 from aprsd.stats import collector
-from aprsd.threads import keep_alive, rx
+from aprsd.threads import keepalive, rx
 from aprsd.threads import stats as stats_thread
-
+from aprsd.threads.aprsd import APRSDThread
 
 # setup the global logger
 # log.basicConfig(level=log.DEBUG) # level=10
 LOG = logging.getLogger("APRSD")
 CONF = cfg.CONF
+LOGU = logger
 console = Console()
 
 
@@ -47,12 +49,20 @@ def signal_handler(sig, frame):
 
 
 class APRSDListenThread(rx.APRSDRXThread):
-    def __init__(self, packet_queue, packet_filter=None, plugin_manager=None):
+    def __init__(
+        self,
+        packet_queue,
+        packet_filter=None,
+        plugin_manager=None,
+        enabled_plugins=[],
+        log_packets=False,
+    ):
         super().__init__(packet_queue)
         self.packet_filter = packet_filter
         self.plugin_manager = plugin_manager
         if self.plugin_manager:
             LOG.info(f"Plugins {self.plugin_manager.get_message_plugins()}")
+        self.log_packets = log_packets
 
     def process_packet(self, *args, **kwargs):
         packet = self._client.decode_packet(*args, **kwargs)
@@ -73,13 +83,15 @@ class APRSDListenThread(rx.APRSDRXThread):
         if self.packet_filter:
             filter_class = filters[self.packet_filter]
             if isinstance(packet, filter_class):
-                packet_log.log(packet)
+                if self.log_packets:
+                    packet_log.log(packet)
                 if self.plugin_manager:
                     # Don't do anything with the reply
                     # This is the listen only command.
                     self.plugin_manager.run(packet)
         else:
-            packet_log.log(packet)
+            if self.log_packets:
+                packet_log.log(packet)
             if self.plugin_manager:
                 # Don't do anything with the reply.
                 # This is the listen only command.
@@ -88,6 +100,44 @@ class APRSDListenThread(rx.APRSDRXThread):
         packet_collector.PacketCollector().rx(packet)
 
 
+class ListenStatsThread(APRSDThread):
+    """Log the stats from the PacketList."""
+
+    def __init__(self):
+        super().__init__("PacketStatsLog")
+        self._last_total_rx = 0
+
+    def loop(self):
+        if self.loop_count % 10 == 0:
+            # log the stats every 10 seconds
+            stats_json = collector.Collector().collect()
+            stats = stats_json["PacketList"]
+            total_rx = stats["rx"]
+            packet_count = len(stats["packets"])
+            rx_delta = total_rx - self._last_total_rx
+            rate = rx_delta / 10
+
+            # Log summary stats
+            LOGU.opt(colors=True).info(
+                f"<green>RX Rate: {rate} pps</green>  "
+                f"<yellow>Total RX: {total_rx}</yellow> "
+                f"<red>RX Last 10 secs: {rx_delta}</red> "
+                f"<white>Packets in PacketList: {packet_count}</white>",
+            )
+            self._last_total_rx = total_rx
+
+            # Log individual type stats
+            for k, v in stats["types"].items():
+                thread_hex = f"fg {utils.hex_from_name(k)}"
+                LOGU.opt(colors=True).info(
+                    f"<{thread_hex}>{k:<15}</{thread_hex}> "
+                    f"<blue>RX: {v['rx']}</blue> <red>TX: {v['tx']}</red>",
+                )
+
+        time.sleep(1)
+        return True
+
+
 @cli.command()
 @cli_helper.add_options(cli_helper.common_options)
 @click.option(
@@ -122,6 +172,11 @@ class APRSDListenThread(rx.APRSDRXThread):
     ),
     help="Filter by packet type",
 )
+@click.option(
+    "--enable-plugin",
+    multiple=True,
+    help="Enable a plugin.  This is the name of the file in the plugins directory.",
+)
 @click.option(
     "--load-plugins",
     default=False,
@@ -133,6 +188,18 @@ class APRSDListenThread(rx.APRSDRXThread):
     nargs=-1,
     required=True,
 )
+@click.option(
+    "--log-packets",
+    default=False,
+    is_flag=True,
+    help="Log incoming packets.",
+)
+@click.option(
+    "--enable-packet-stats",
+    default=False,
+    is_flag=True,
+    help="Enable packet stats periodic logging.",
+)
 @click.pass_context
 @cli_helper.process_standard_options
 def listen(
@@ -140,8 +207,11 @@ def listen(
     aprs_login,
     aprs_password,
     packet_filter,
+    enable_plugin,
     load_plugins,
     filter,
+    log_packets,
+    enable_packet_stats,
 ):
     """Listen to packets on the APRS-IS Network based on FILTER.
 
@@ -190,27 +260,43 @@ def listen(
     LOG.info("Creating client connection")
     aprs_client = client_factory.create()
     LOG.info(aprs_client)
+    if not aprs_client.login_success:
+        # We failed to login, will just quit!
+        msg = f"Login Failure: {aprs_client.login_failure}"
+        LOG.error(msg)
+        print(msg)
+        sys.exit(-1)
 
     LOG.debug(f"Filter by '{filter}'")
     aprs_client.set_filter(filter)
 
-    keepalive = keep_alive.KeepAliveThread()
-    # keepalive.start()
+    keepalive_thread = keepalive.KeepAliveThread()
 
     if not CONF.enable_seen_list:
         # just deregister the class from the packet collector
         packet_collector.PacketCollector().unregister(seen_list.SeenList)
 
     pm = None
-    pm = plugin.PluginManager()
     if load_plugins:
+        pm = plugin.PluginManager()
         LOG.info("Loading plugins")
         pm.setup_plugins(load_help_plugin=False)
+    elif enable_plugin:
+        pm = plugin.PluginManager()
+        pm.setup_plugins(
+            load_help_plugin=False,
+            plugin_list=enable_plugin,
+        )
     else:
         LOG.warning(
             "Not Loading any plugins use --load-plugins to load what's "
             "defined in the config file.",
         )
+
+    if pm:
+        for p in pm.get_plugins():
+            LOG.info("Loaded plugin %s", p.__class__.__name__)
+
     stats = stats_thread.APRSDStatsStoreThread()
     stats.start()
 
@@ -219,13 +305,18 @@ def listen(
         packet_queue=threads.packet_queue,
         packet_filter=packet_filter,
         plugin_manager=pm,
+        enabled_plugins=enable_plugin,
+        log_packets=log_packets,
     )
     LOG.debug("Start APRSDListenThread")
     listen_thread.start()
+    if enable_packet_stats:
+        listen_stats = ListenStatsThread()
+        listen_stats.start()
 
-    keepalive.start()
+    keepalive_thread.start()
     LOG.debug("keepalive Join")
-    keepalive.join()
+    keepalive_thread.join()
     LOG.debug("listen_thread Join")
     listen_thread.join()
     stats.join()