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

aprsd/conf/plugin_common.py

@@ -0,0 +1,191 @@
+from oslo_config import cfg
+
+
+aprsfi_group = cfg.OptGroup(
+    name="aprs_fi",
+    title="APRS.FI website settings",
+)
+query_group = cfg.OptGroup(
+    name="query_plugin",
+    title="Options for the Query Plugin",
+)
+avwx_group = cfg.OptGroup(
+    name="avwx_plugin",
+    title="Options for the AVWXWeatherPlugin",
+)
+owm_wx_group = cfg.OptGroup(
+    name="owm_weather_plugin",
+    title="Options for the OWMWeatherPlugin",
+)
+
+location_group = cfg.OptGroup(
+    name="location_plugin",
+    title="Options for the LocationPlugin",
+)
+
+aprsfi_opts = [
+    cfg.StrOpt(
+        "apiKey",
+        help="Get the apiKey from your aprs.fi account here:"
+             "http://aprs.fi/account",
+    ),
+]
+
+query_plugin_opts = [
+    cfg.StrOpt(
+        "callsign",
+        help="The Ham callsign to allow access to the query plugin from RF.",
+    ),
+]
+
+owm_wx_opts = [
+    cfg.StrOpt(
+        "apiKey",
+        help="OWMWeatherPlugin api key to OpenWeatherMap's API."
+             "This plugin uses the openweathermap API to fetch"
+             "location and weather information."
+             "To use this plugin you need to get an openweathermap"
+             "account and apikey."
+             "https://home.openweathermap.org/api_keys",
+    ),
+]
+
+avwx_opts = [
+    cfg.StrOpt(
+        "apiKey",
+        help="avwx-api is an opensource project that has"
+             "a hosted service here: https://avwx.rest/"
+             "You can launch your own avwx-api in a container"
+             "by cloning the githug repo here:"
+             "https://github.com/avwx-rest/AVWX-API",
+    ),
+    cfg.StrOpt(
+        "base_url",
+        default="https://avwx.rest",
+        help="The base url for the avwx API.  If you are hosting your own"
+             "Here is where you change the url to point to yours.",
+    ),
+]
+
+location_opts = [
+    cfg.StrOpt(
+        "geopy_geocoder",
+        choices=[
+            "ArcGIS", "AzureMaps", "Baidu", "Bing", "GoogleV3", "HERE",
+            "Nominatim", "OpenCage", "TomTom", "USGov", "What3Words", "Woosmap",
+        ],
+        default="Nominatim",
+        help="The geopy geocoder to use.  Default is Nominatim."
+             "See https://geopy.readthedocs.io/en/stable/#module-geopy.geocoders"
+             "for more information.",
+    ),
+    cfg.StrOpt(
+        "user_agent",
+        default="APRSD",
+        help="The user agent to use for the Nominatim geocoder."
+             "See https://geopy.readthedocs.io/en/stable/#module-geopy.geocoders"
+             "for more information.",
+    ),
+    cfg.StrOpt(
+        "arcgis_username",
+        default=None,
+        help="The username to use for the ArcGIS geocoder."
+             "See https://geopy.readthedocs.io/en/latest/#arcgis"
+             "for more information."
+             "Only used for the ArcGIS geocoder.",
+    ),
+    cfg.StrOpt(
+        "arcgis_password",
+        default=None,
+        help="The password to use for the ArcGIS geocoder."
+             "See https://geopy.readthedocs.io/en/latest/#arcgis"
+             "for more information."
+             "Only used for the ArcGIS geocoder.",
+    ),
+    cfg.StrOpt(
+        "azuremaps_subscription_key",
+        help="The subscription key to use for the AzureMaps geocoder."
+             "See https://geopy.readthedocs.io/en/latest/#azuremaps"
+             "for more information."
+             "Only used for the AzureMaps geocoder.",
+    ),
+    cfg.StrOpt(
+        "baidu_api_key",
+        help="The API key to use for the Baidu geocoder."
+             "See https://geopy.readthedocs.io/en/latest/#baidu"
+             "for more information."
+             "Only used for the Baidu geocoder.",
+    ),
+    cfg.StrOpt(
+        "bing_api_key",
+        help="The API key to use for the Bing geocoder."
+             "See https://geopy.readthedocs.io/en/latest/#bing"
+             "for more information."
+             "Only used for the Bing geocoder.",
+    ),
+    cfg.StrOpt(
+        "google_api_key",
+        help="The API key to use for the Google geocoder."
+             "See https://geopy.readthedocs.io/en/latest/#googlev3"
+             "for more information."
+             "Only used for the Google geocoder.",
+    ),
+    cfg.StrOpt(
+        "here_api_key",
+        help="The API key to use for the HERE geocoder."
+             "See https://geopy.readthedocs.io/en/latest/#here"
+             "for more information."
+             "Only used for the HERE geocoder.",
+    ),
+    cfg.StrOpt(
+        "opencage_api_key",
+        help="The API key to use for the OpenCage geocoder."
+             "See https://geopy.readthedocs.io/en/latest/#opencage"
+             "for more information."
+             "Only used for the OpenCage geocoder.",
+    ),
+    cfg.StrOpt(
+        "tomtom_api_key",
+        help="The API key to use for the TomTom geocoder."
+             "See https://geopy.readthedocs.io/en/latest/#tomtom"
+             "for more information."
+             "Only used for the TomTom geocoder.",
+    ),
+    cfg.StrOpt(
+        "what3words_api_key",
+        help="The API key to use for the What3Words geocoder."
+             "See https://geopy.readthedocs.io/en/latest/#what3words"
+             "for more information."
+             "Only used for the What3Words geocoder.",
+    ),
+    cfg.StrOpt(
+        "woosmap_api_key",
+        help="The API key to use for the Woosmap geocoder."
+             "See https://geopy.readthedocs.io/en/latest/#woosmap"
+             "for more information."
+             "Only used for the Woosmap geocoder.",
+    ),
+]
+
+
+def register_opts(config):
+    config.register_group(aprsfi_group)
+    config.register_opts(aprsfi_opts, group=aprsfi_group)
+    config.register_group(query_group)
+    config.register_opts(query_plugin_opts, group=query_group)
+    config.register_group(owm_wx_group)
+    config.register_opts(owm_wx_opts, group=owm_wx_group)
+    config.register_group(avwx_group)
+    config.register_opts(avwx_opts, group=avwx_group)
+    config.register_group(location_group)
+    config.register_opts(location_opts, group=location_group)
+
+
+def list_opts():
+    return {
+        aprsfi_group.name: aprsfi_opts,
+        query_group.name: query_plugin_opts,
+        owm_wx_group.name: owm_wx_opts,
+        avwx_group.name: avwx_opts,
+        location_group.name: location_opts,
+    }

aprsd/conf/plugin_email.py

@@ -0,0 +1,105 @@
+from oslo_config import cfg
+
+
+email_group = cfg.OptGroup(
+    name="email_plugin",
+    title="Options for the APRSD Email plugin",
+)
+
+email_opts = [
+    cfg.StrOpt(
+        "callsign",
+        help="(Required) Callsign to validate for doing email commands."
+             "Only this callsign can check email. This is also where the "
+             "email notifications for new emails will be sent.",
+    ),
+    cfg.BoolOpt(
+        "enabled",
+        default=False,
+        help="Enable the Email plugin?",
+    ),
+    cfg.BoolOpt(
+        "debug",
+        default=False,
+        help="Enable the Email plugin Debugging?",
+    ),
+]
+
+email_imap_opts = [
+    cfg.StrOpt(
+        "imap_login",
+        help="Login username/email for IMAP server",
+    ),
+    cfg.StrOpt(
+        "imap_password",
+        secret=True,
+        help="Login password for IMAP server",
+    ),
+    cfg.HostnameOpt(
+        "imap_host",
+        help="Hostname/IP of the IMAP server",
+    ),
+    cfg.PortOpt(
+        "imap_port",
+        default=993,
+        help="Port to use for IMAP server",
+    ),
+    cfg.BoolOpt(
+        "imap_use_ssl",
+        default=True,
+        help="Use SSL for connection to IMAP Server",
+    ),
+]
+
+email_smtp_opts = [
+    cfg.StrOpt(
+        "smtp_login",
+        help="Login username/email for SMTP server",
+    ),
+    cfg.StrOpt(
+        "smtp_password",
+        secret=True,
+        help="Login password for SMTP server",
+    ),
+    cfg.HostnameOpt(
+        "smtp_host",
+        help="Hostname/IP of the SMTP server",
+    ),
+    cfg.PortOpt(
+        "smtp_port",
+        default=465,
+        help="Port to use for SMTP server",
+    ),
+    cfg.BoolOpt(
+        "smtp_use_ssl",
+        default=True,
+        help="Use SSL for connection to SMTP Server",
+    ),
+]
+
+email_shortcuts_opts = [
+    cfg.ListOpt(
+        "email_shortcuts",
+        help="List of email shortcuts for checking/sending email "
+             "For Exmaple: wb=walt@walt.com,cl=cl@cl.com\n"
+             "Means use 'wb' to send an email to walt@walt.com",
+    ),
+]
+
+ALL_OPTS = (
+    email_opts
+    + email_imap_opts
+    + email_smtp_opts
+    + email_shortcuts_opts
+)
+
+
+def register_opts(config):
+    config.register_group(email_group)
+    config.register_opts(ALL_OPTS, group=email_group)
+
+
+def list_opts():
+    return {
+        email_group.name: ALL_OPTS,
+    }

aprsd/exception.py

@@ -0,0 +1,13 @@
+class MissingConfigOptionException(Exception):
+    """Missing a config option."""
+    def __init__(self, config_option):
+        self.message = f"Option '{config_option}' was not in config file"
+
+
+class ConfigOptionBogusDefaultException(Exception):
+    """Missing a config option."""
+    def __init__(self, config_option, default_fail):
+        self.message = (
+            f"Config file option '{config_option}' needs to be "
+            f"changed from provided default of '{default_fail}'"
+        )

aprsd/log/log.py

@@ -0,0 +1,138 @@
+import logging
+from logging.handlers import QueueHandler
+import queue
+import sys
+
+from loguru import logger
+from oslo_config import cfg
+
+from aprsd.conf import log as conf_log
+
+
+CONF = cfg.CONF
+# LOG = logging.getLogger("APRSD")
+LOG = logger
+
+
+class QueueLatest(queue.Queue):
+    """Custom Queue to keep only the latest N items.
+
+    This prevents the queue from blowing up in size.
+    """
+    def put(self, *args, **kwargs):
+        try:
+            super().put(*args, **kwargs)
+        except queue.Full:
+            self.queue.popleft()
+            super().put(*args, **kwargs)
+
+
+logging_queue = QueueLatest(maxsize=200)
+
+
+class InterceptHandler(logging.Handler):
+    def emit(self, record):
+        # get corresponding Loguru level if it exists
+        try:
+            level = logger.level(record.levelname).name
+        except ValueError:
+            level = record.levelno
+
+        # find caller from where originated the logged message
+        frame, depth = sys._getframe(6), 6
+        while frame and frame.f_code.co_filename == logging.__file__:
+            frame = frame.f_back
+            depth += 1
+
+        logger.opt(depth=depth, exception=record.exc_info).log(level, record.getMessage())
+
+
+# Setup the log faciility
+# to disable log to stdout, but still log to file
+# use the --quiet option on the cmdln
+def setup_logging(loglevel=None, quiet=False):
+    if not loglevel:
+        log_level = CONF.logging.log_level
+    else:
+        log_level = conf_log.LOG_LEVELS[loglevel]
+
+    # intercept everything at the root logger
+    logging.root.handlers = [InterceptHandler()]
+    logging.root.setLevel(log_level)
+
+    imap_list = [
+        "imapclient.imaplib", "imaplib", "imapclient",
+        "imapclient.util",
+    ]
+    aprslib_list = [
+        "aprslib",
+        "aprslib.parsing",
+        "aprslib.exceptions",
+    ]
+    webserver_list = [
+        "werkzeug",
+        "werkzeug._internal",
+        "socketio",
+        "urllib3.connectionpool",
+        "chardet",
+        "chardet.charsetgroupprober",
+        "chardet.eucjpprober",
+        "chardet.mbcharsetprober",
+    ]
+
+    # We don't really want to see the aprslib parsing debug output.
+    disable_list = imap_list + aprslib_list + webserver_list
+
+    # remove every other logger's handlers
+    # and propagate to root logger
+    for name in logging.root.manager.loggerDict.keys():
+        logging.getLogger(name).handlers = []
+        if name in disable_list:
+            logging.getLogger(name).propagate = False
+        else:
+            logging.getLogger(name).propagate = True
+
+    if CONF.webchat.disable_url_request_logging:
+        for name in webserver_list:
+            logging.getLogger(name).handlers = []
+            logging.getLogger(name).propagate = True
+            logging.getLogger(name).setLevel(logging.ERROR)
+
+    handlers = [
+        {
+            "sink": sys.stdout,
+            "serialize": False,
+            "format": CONF.logging.logformat,
+            "colorize": True,
+            "level": log_level,
+        },
+    ]
+    if CONF.logging.logfile:
+        handlers.append(
+            {
+                "sink": CONF.logging.logfile,
+                "serialize": False,
+                "format": CONF.logging.logformat,
+                "colorize": False,
+                "level": log_level,
+            },
+        )
+
+    if CONF.email_plugin.enabled and CONF.email_plugin.debug:
+        for name in imap_list:
+            logging.getLogger(name).propagate = True
+
+    if CONF.admin.web_enabled:
+        qh = QueueHandler(logging_queue)
+        handlers.append(
+            {
+                "sink": qh, "serialize": False,
+                "format": CONF.logging.logformat,
+                "level": log_level,
+                "colorize": False,
+            },
+        )
+
+    # configure loguru
+    logger.configure(handlers=handlers)
+    logger.level("DEBUG", color="<fg #BABABA>")