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

aprsd/conf/__init__.py

@@ -0,0 +1,56 @@
+from oslo_config import cfg
+
+from aprsd.conf import client, common, log, plugin_common, plugin_email
+
+
+CONF = cfg.CONF
+
+log.register_opts(CONF)
+common.register_opts(CONF)
+client.register_opts(CONF)
+
+# plugins
+plugin_common.register_opts(CONF)
+plugin_email.register_opts(CONF)
+
+
+def set_lib_defaults():
+    """Update default value for configuration options from other namespace.
+    Example, oslo lib config options. This is needed for
+    config generator tool to pick these default value changes.
+    https://docs.openstack.org/oslo.config/latest/cli/
+    generator.html#modifying-defaults-from-other-namespaces
+    """
+
+    # Update default value of oslo_log default_log_levels and
+    # logging_context_format_string config option.
+    set_log_defaults()
+
+
+def set_log_defaults():
+    # log.set_defaults(default_log_levels=log.get_default_log_levels())
+    pass
+
+
+def conf_to_dict():
+    """Convert the CONF options to a single level dictionary."""
+    entries = {}
+
+    def _sanitize(opt, value):
+        """Obfuscate values of options declared secret."""
+        return value if not opt.secret else "*" * 4
+
+    for opt_name in sorted(CONF._opts):
+        opt = CONF._get_opt_info(opt_name)["opt"]
+        val = str(_sanitize(opt, getattr(CONF, opt_name)))
+        entries[str(opt)] = val
+
+    for group_name in list(CONF._groups):
+        group_attr = CONF.GroupAttr(CONF, CONF._get_group(group_name))
+        for opt_name in sorted(CONF._groups[group_name]._opts):
+            opt = CONF._get_opt_info(opt_name, group_name)["opt"]
+            val = str(_sanitize(opt, getattr(group_attr, opt_name)))
+            gname_opt_name = f"{group_name}.{opt_name}"
+            entries[gname_opt_name] = val
+
+    return entries

aprsd/conf/client.py

@@ -0,0 +1,131 @@
+"""
+The options for log setup
+"""
+
+from oslo_config import cfg
+
+
+DEFAULT_LOGIN = "NOCALL"
+
+aprs_group = cfg.OptGroup(
+    name="aprs_network",
+    title="APRS-IS Network settings",
+)
+
+kiss_serial_group = cfg.OptGroup(
+    name="kiss_serial",
+    title="KISS Serial device connection",
+)
+
+kiss_tcp_group = cfg.OptGroup(
+    name="kiss_tcp",
+    title="KISS TCP/IP Device connection",
+)
+
+fake_client_group = cfg.OptGroup(
+    name="fake_client",
+    title="Fake Client settings",
+)
+aprs_opts = [
+    cfg.BoolOpt(
+        "enabled",
+        default=True,
+        help="Set enabled to False if there is no internet connectivity."
+             "This is useful for a direwolf KISS aprs connection only.",
+    ),
+    cfg.StrOpt(
+        "login",
+        default=DEFAULT_LOGIN,
+        help="APRS Username",
+    ),
+    cfg.StrOpt(
+        "password",
+        secret=True,
+        help="APRS Password "
+             "Get the passcode for your callsign here: "
+             "https://apps.magicbug.co.uk/passcode",
+    ),
+    cfg.HostAddressOpt(
+        "host",
+        default="noam.aprs2.net",
+        help="The APRS-IS hostname",
+    ),
+    cfg.PortOpt(
+        "port",
+        default=14580,
+        help="APRS-IS port",
+    ),
+]
+
+kiss_serial_opts = [
+    cfg.BoolOpt(
+        "enabled",
+        default=False,
+        help="Enable Serial KISS interface connection.",
+    ),
+    cfg.StrOpt(
+        "device",
+        help="Serial Device file to use.  /dev/ttyS0",
+    ),
+    cfg.IntOpt(
+        "baudrate",
+        default=9600,
+        help="The Serial device baud rate for communication",
+    ),
+    cfg.ListOpt(
+        "path",
+        default=["WIDE1-1", "WIDE2-1"],
+        help="The APRS path to use for wide area coverage.",
+    ),
+]
+
+kiss_tcp_opts = [
+    cfg.BoolOpt(
+        "enabled",
+        default=False,
+        help="Enable Serial KISS interface connection.",
+    ),
+    cfg.HostAddressOpt(
+        "host",
+        help="The KISS TCP Host to connect to.",
+    ),
+    cfg.PortOpt(
+        "port",
+        default=8001,
+        help="The KISS TCP/IP network port",
+    ),
+    cfg.ListOpt(
+        "path",
+        default=["WIDE1-1", "WIDE2-1"],
+        help="The APRS path to use for wide area coverage.",
+    ),
+]
+
+fake_client_opts = [
+    cfg.BoolOpt(
+        "enabled",
+        default=False,
+        help="Enable fake client connection.",
+    ),
+]
+
+
+def register_opts(config):
+    config.register_group(aprs_group)
+    config.register_opts(aprs_opts, group=aprs_group)
+    config.register_group(kiss_serial_group)
+    config.register_group(kiss_tcp_group)
+    config.register_opts(kiss_serial_opts, group=kiss_serial_group)
+    config.register_opts(kiss_tcp_opts, group=kiss_tcp_group)
+
+    config.register_group(fake_client_group)
+    config.register_opts(fake_client_opts, group=fake_client_group)
+
+
+def list_opts():
+    return {
+        aprs_group.name: aprs_opts,
+        kiss_serial_group.name: kiss_serial_opts,
+        kiss_tcp_group.name: kiss_tcp_opts,
+        fake_client_group.name: fake_client_opts,
+    }

aprsd/conf/common.py

@@ -0,0 +1,301 @@
+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!!!"
+
+admin_group = cfg.OptGroup(
+    name="admin",
+    title="Admin web interface settings",
+)
+watch_list_group = cfg.OptGroup(
+    name="watch_list",
+    title="Watch List settings",
+)
+webchat_group = cfg.OptGroup(
+    name="webchat",
+    title="Settings specific to the webchat command",
+)
+
+registry_group = cfg.OptGroup(
+    name="aprs_registry",
+    title="APRS Registry settings",
+)
+
+
+aprsd_opts = [
+    cfg.StrOpt(
+        "callsign",
+        required=True,
+        help="Callsign to use for messages sent by APRSD",
+    ),
+    cfg.BoolOpt(
+        "enable_save",
+        default=True,
+        help="Enable saving of watch list, packet tracker between restarts.",
+    ),
+    cfg.StrOpt(
+        "save_location",
+        default=DEFAULT_CONFIG_DIR,
+        help="Save location for packet tracking files.",
+    ),
+    cfg.BoolOpt(
+        "trace_enabled",
+        default=False,
+        help="Enable code tracing",
+    ),
+    cfg.StrOpt(
+        "units",
+        default="imperial",
+        help="Units for display, imperial or metric",
+    ),
+    cfg.IntOpt(
+        "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",
+    ),
+    cfg.IntOpt(
+        "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",
+    ),
+    cfg.IntOpt(
+        "packet_dupe_timeout",
+        default=300,
+        help="The number of seconds before a packet is not considered a duplicate.",
+    ),
+    cfg.BoolOpt(
+        "enable_beacon",
+        default=False,
+        help="Enable sending of a GPS Beacon packet to locate this service. "
+             "Requires latitude and longitude to be set.",
+    ),
+    cfg.IntOpt(
+        "beacon_interval",
+        default=1800,
+        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",
+    ),
+    cfg.StrOpt(
+        "latitude",
+        default=None,
+        help="Latitude for the GPS Beacon button.  If not set, the button will not be enabled.",
+    ),
+    cfg.StrOpt(
+        "longitude",
+        default=None,
+        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",
+        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.",
+    ),
+    cfg.IntOpt(
+        "default_packet_send_count",
+        default=3,
+        help="The number of times to send a non ack packet before giving up.",
+    ),
+    cfg.IntOpt(
+        "default_ack_send_count",
+        default=3,
+        help="The number of times to send an ack packet in response to recieving a packet.",
+    ),
+    cfg.IntOpt(
+        "packet_list_maxlen",
+        default=100,
+        help="The maximum number of packets to store in the packet list.",
+    ),
+    cfg.IntOpt(
+        "packet_list_stats_maxlen",
+        default=20,
+        help="The maximum number of packets to send in the stats dict for admin ui.",
+    ),
+    cfg.BoolOpt(
+        "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.",
+    ),
+    cfg.BoolOpt(
+        "enable_packet_logging",
+        default=True,
+        help="Set this to False, to disable logging of packets to the log file.",
+    ),
+]
+
+watch_list_opts = [
+    cfg.BoolOpt(
+        "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",
+    ),
+    cfg.ListOpt(
+        "callsigns",
+        help="Callsigns to watch for messsages",
+    ),
+    cfg.StrOpt(
+        "alert_callsign",
+        help="The Ham Callsign to send messages to for watch list alerts.",
+    ),
+    cfg.IntOpt(
+        "packet_keep_count",
+        default=10,
+        help="The number of packets to store.",
+    ),
+    cfg.IntOpt(
+        "alert_time_seconds",
+        default=3600,
+        help="Time to wait before alert is sent on new message for "
+             "users in callsigns.",
+    ),
+]
+
+admin_opts = [
+    cfg.BoolOpt(
+        "web_enabled",
+        default=False,
+        help="Enable the Admin Web Interface",
+    ),
+    cfg.StrOpt(
+        "web_ip",
+        default="0.0.0.0",
+        help="The ip address to listen on",
+    ),
+    cfg.PortOpt(
+        "web_port",
+        default=8001,
+        help="The port to listen on",
+    ),
+    cfg.StrOpt(
+        "user",
+        default="admin",
+        help="The admin user for the admin web interface",
+    ),
+    cfg.StrOpt(
+        "password",
+        default="password",
+        secret=True,
+        help="Admin interface password",
+    ),
+]
+
+
+enabled_plugins_opts = [
+    cfg.ListOpt(
+        "enabled_plugins",
+        default=[
+            "aprsd.plugins.email.EmailPlugin",
+            "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",
+    ),
+]
+
+webchat_opts = [
+    cfg.StrOpt(
+        "web_ip",
+        default="0.0.0.0",
+        help="The ip address to listen on",
+    ),
+    cfg.PortOpt(
+        "web_port",
+        default=8001,
+        help="The port to listen on",
+    ),
+    cfg.StrOpt(
+        "latitude",
+        default=None,
+        help="Latitude for the GPS Beacon button.  If not set, the button will not be enabled.",
+    ),
+    cfg.StrOpt(
+        "longitude",
+        default=None,
+        help="Longitude for the GPS Beacon button.  If not set, the button will not be enabled.",
+    ),
+    cfg.BoolOpt(
+        "disable_url_request_logging",
+        default=False,
+        help="Disable the logging of url requests in the webchat command.",
+    ),
+]
+
+registry_opts = [
+    cfg.BoolOpt(
+        "enabled",
+        default=False,
+        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.",
+    ),
+    cfg.StrOpt(
+        "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.",
+    ),
+    cfg.StrOpt(
+        "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",
+        default=None,
+        help="The website for your APRS service to send to the APRS registry.",
+    ),
+    cfg.IntOpt(
+        "frequency_seconds",
+        default=3600,
+        help="The frequency in seconds to send the APRS registry information.",
+    ),
+]
+
+
+def register_opts(config):
+    config.register_opts(aprsd_opts)
+    config.register_opts(enabled_plugins_opts)
+    config.register_group(admin_group)
+    config.register_opts(admin_opts, group=admin_group)
+    config.register_group(watch_list_group)
+    config.register_opts(watch_list_opts, group=watch_list_group)
+    config.register_group(webchat_group)
+    config.register_opts(webchat_opts, group=webchat_group)
+    config.register_group(registry_group)
+    config.register_opts(registry_opts, group=registry_group)
+
+
+def list_opts():
+    return {
+        "DEFAULT": (aprsd_opts + enabled_plugins_opts),
+        admin_group.name: admin_opts,
+        watch_list_group.name: watch_list_opts,
+        webchat_group.name: webchat_opts,
+        registry_group.name: registry_opts,
+    }

aprsd/conf/log.py

@@ -0,0 +1,65 @@
+"""
+The options for log setup
+"""
+import logging
+
+from oslo_config import cfg
+
+
+LOG_LEVELS = {
+    "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_LOG_FORMAT = (
+    "[%(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>"
+)
+
+logging_group = cfg.OptGroup(
+    name="logging",
+    title="Logging options",
+)
+logging_opts = [
+    cfg.StrOpt(
+        "logfile",
+        default=None,
+        help="File to log to",
+    ),
+    cfg.StrOpt(
+        "logformat",
+        default=DEFAULT_LOG_FORMAT,
+        help="Log file format, unless rich_logging enabled.",
+    ),
+    cfg.StrOpt(
+        "log_level",
+        default="INFO",
+        choices=LOG_LEVELS.keys(),
+        help="Log level for logging of events.",
+    ),
+]
+
+
+def register_opts(config):
+    config.register_group(logging_group)
+    config.register_opts(logging_opts, group=logging_group)
+
+
+def list_opts():
+    return {
+        logging_group.name: (
+            logging_opts
+        ),
+    }

aprsd/conf/opts.py

@@ -0,0 +1,80 @@
+# Copyright 2015 OpenStack Foundation
+# All Rights Reserved.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License"); you may
+#    not use this file except in compliance with the License. You may obtain
+#    a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#    License for the specific language governing permissions and limitations
+#    under the License.
+
+"""
+This is the single point of entry to generate the sample configuration
+file for Nova. It collects all the necessary info from the other modules
+in this package. It is assumed that:
+
+* every other module in this package has a 'list_opts' function which
+  return a dict where
+  * the keys are strings which are the group names
+  * the value of each key is a list of config options for that group
+* the nova.conf package doesn't have further packages with config options
+* this module is only used in the context of sample file generation
+"""
+
+import collections
+import importlib
+import os
+import pkgutil
+
+
+LIST_OPTS_FUNC_NAME = "list_opts"
+
+
+def _tupleize(dct):
+    """Take the dict of options and convert to the 2-tuple format."""
+    return [(key, val) for key, val in dct.items()]
+
+
+def list_opts():
+    opts = collections.defaultdict(list)
+    module_names = _list_module_names()
+    imported_modules = _import_modules(module_names)
+    _append_config_options(imported_modules, opts)
+    return _tupleize(opts)
+
+
+def _list_module_names():
+    module_names = []
+    package_path = os.path.dirname(os.path.abspath(__file__))
+    for _, modname, ispkg in pkgutil.iter_modules(path=[package_path]):
+        if modname == "opts" or ispkg:
+            continue
+        else:
+            module_names.append(modname)
+    return module_names
+
+
+def _import_modules(module_names):
+    imported_modules = []
+    for modname in module_names:
+        mod = importlib.import_module("aprsd.conf." + modname)
+        if not hasattr(mod, LIST_OPTS_FUNC_NAME):
+            msg = "The module 'aprsd.conf.%s' should have a '%s' "\
+                  "function which returns the config options." % \
+                  (modname, LIST_OPTS_FUNC_NAME)
+            raise Exception(msg)
+        else:
+            imported_modules.append(mod)
+    return imported_modules
+
+
+def _append_config_options(imported_modules, config_options):
+    for mod in imported_modules:
+        configs = mod.list_opts()
+        for key, val in configs.items():
+            config_options[key].extend(val)