mirror of https://github.com/craigerl/aprsd.git
566 lines
17 KiB
Python
566 lines
17 KiB
Python
import datetime
|
|
import json
|
|
import logging
|
|
from logging.handlers import RotatingFileHandler
|
|
import signal
|
|
import sys
|
|
import threading
|
|
import time
|
|
|
|
from aprslib import util as aprslib_util
|
|
import click
|
|
import flask
|
|
from flask import request
|
|
from flask.logging import default_handler
|
|
import flask_classful
|
|
from flask_httpauth import HTTPBasicAuth
|
|
from flask_socketio import Namespace, SocketIO
|
|
from user_agents import parse as ua_parse
|
|
from werkzeug.security import check_password_hash, generate_password_hash
|
|
import wrapt
|
|
|
|
import aprsd
|
|
from aprsd import cli_helper, client
|
|
from aprsd import config as aprsd_config
|
|
from aprsd import packets, stats, threads, utils
|
|
from aprsd.aprsd import cli
|
|
from aprsd.logging import rich as aprsd_logging
|
|
from aprsd.threads import rx
|
|
from aprsd.utils import objectstore, trace
|
|
|
|
|
|
LOG = logging.getLogger("APRSD")
|
|
auth = HTTPBasicAuth()
|
|
users = None
|
|
|
|
|
|
def signal_handler(sig, frame):
|
|
|
|
click.echo("signal_handler: called")
|
|
LOG.info(
|
|
f"Ctrl+C, Sending all threads({len(threads.APRSDThreadList())}) exit! "
|
|
f"Can take up to 10 seconds {datetime.datetime.now()}",
|
|
)
|
|
threads.APRSDThreadList().stop_all()
|
|
if "subprocess" not in str(frame):
|
|
time.sleep(1.5)
|
|
# packets.WatchList().save()
|
|
# packets.SeenList().save()
|
|
LOG.info(stats.APRSDStats())
|
|
LOG.info("Telling flask to bail.")
|
|
signal.signal(signal.SIGTERM, sys.exit(0))
|
|
|
|
|
|
class SentMessages(objectstore.ObjectStoreMixin):
|
|
_instance = None
|
|
lock = threading.Lock()
|
|
|
|
data = {}
|
|
|
|
def __new__(cls, *args, **kwargs):
|
|
"""This magic turns this into a singleton."""
|
|
if cls._instance is None:
|
|
cls._instance = super().__new__(cls)
|
|
return cls._instance
|
|
|
|
@wrapt.synchronized(lock)
|
|
def add(self, msg):
|
|
self.data[msg.msgNo] = self.create(msg.msgNo)
|
|
self.data[msg.msgNo]["from"] = msg.from_call
|
|
self.data[msg.msgNo]["to"] = msg.to_call
|
|
self.data[msg.msgNo]["message"] = msg.message_text.rstrip("\n")
|
|
self.data[msg.msgNo]["raw"] = msg.message_text.rstrip("\n")
|
|
|
|
def create(self, id):
|
|
return {
|
|
"id": id,
|
|
"ts": time.time(),
|
|
"ack": False,
|
|
"from": None,
|
|
"to": None,
|
|
"raw": None,
|
|
"message": None,
|
|
"status": None,
|
|
"last_update": None,
|
|
"reply": None,
|
|
}
|
|
|
|
@wrapt.synchronized(lock)
|
|
def __len__(self):
|
|
return len(self.data.keys())
|
|
|
|
@wrapt.synchronized(lock)
|
|
def get(self, id):
|
|
if id in self.data:
|
|
return self.data[id]
|
|
|
|
@wrapt.synchronized(lock)
|
|
def get_all(self):
|
|
return self.data
|
|
|
|
@wrapt.synchronized(lock)
|
|
def set_status(self, id, status):
|
|
if id in self.data:
|
|
self.data[id]["last_update"] = str(datetime.datetime.now())
|
|
self.data[id]["status"] = status
|
|
|
|
@wrapt.synchronized(lock)
|
|
def ack(self, id):
|
|
"""The message got an ack!"""
|
|
if id in self.data:
|
|
self.data[id]["last_update"] = str(datetime.datetime.now())
|
|
self.data[id]["ack"] = True
|
|
|
|
@wrapt.synchronized(lock)
|
|
def reply(self, id, packet):
|
|
"""We got a packet back from the sent message."""
|
|
if id in self.data:
|
|
self.data[id]["reply"] = packet
|
|
|
|
|
|
# HTTPBasicAuth doesn't work on a class method.
|
|
# This has to be out here. Rely on the APRSDFlask
|
|
# class to initialize the users from the config
|
|
@auth.verify_password
|
|
def verify_password(username, password):
|
|
global users
|
|
|
|
if username in users and check_password_hash(users.get(username), password):
|
|
return username
|
|
|
|
|
|
class WebChatRXThread(rx.APRSDRXThread):
|
|
"""Class that connects to APRISIS/kiss and waits for messages.
|
|
|
|
After the packet is received from APRSIS/KISS, the packet is
|
|
sent to processing in the WebChatProcessPacketThread.
|
|
"""
|
|
def __init__(self, config, socketio):
|
|
super().__init__(None, config)
|
|
self.socketio = socketio
|
|
self.connected = False
|
|
|
|
def connected(self, connected=True):
|
|
self.connected = connected
|
|
|
|
def process_packet(self, *args, **kwargs):
|
|
# packet = self._client.decode_packet(*args, **kwargs)
|
|
if "packet" in kwargs:
|
|
packet = kwargs["packet"]
|
|
else:
|
|
packet = self._client.decode_packet(*args, **kwargs)
|
|
|
|
LOG.debug(f"GOT Packet {packet}")
|
|
thread = WebChatProcessPacketThread(
|
|
config=self.config,
|
|
packet=packet,
|
|
socketio=self.socketio,
|
|
)
|
|
thread.start()
|
|
|
|
|
|
class WebChatProcessPacketThread(rx.APRSDProcessPacketThread):
|
|
"""Class that handles packets being sent to us."""
|
|
def __init__(self, config, packet, socketio):
|
|
self.socketio = socketio
|
|
self.connected = False
|
|
super().__init__(config, packet)
|
|
|
|
def process_ack_packet(self, packet: packets.AckPacket):
|
|
super().process_ack_packet(packet)
|
|
ack_num = packet.get("msgNo")
|
|
SentMessages().ack(int(ack_num))
|
|
self.socketio.emit(
|
|
"ack", SentMessages().get(int(ack_num)),
|
|
namespace="/sendmsg",
|
|
)
|
|
self.got_ack = True
|
|
|
|
def process_our_message_packet(self, packet: packets.MessagePacket):
|
|
LOG.info(f"process non ack PACKET {packet}")
|
|
packet.get("addresse", None)
|
|
fromcall = packet.from_call
|
|
|
|
packets.PacketList().add(packet)
|
|
stats.APRSDStats().msgs_rx_inc()
|
|
message = packet.get("message_text", None)
|
|
msg = {
|
|
"id": 0,
|
|
"ts": packet.get("timestamp", time.time()),
|
|
"ack": False,
|
|
"from": fromcall,
|
|
"to": packet.to_call,
|
|
"raw": packet.raw,
|
|
"message": message,
|
|
"status": None,
|
|
"last_update": None,
|
|
"reply": None,
|
|
}
|
|
self.socketio.emit(
|
|
"new", msg,
|
|
namespace="/sendmsg",
|
|
)
|
|
|
|
|
|
class WebChatFlask(flask_classful.FlaskView):
|
|
config = None
|
|
|
|
def set_config(self, config):
|
|
global users
|
|
self.config = config
|
|
self.users = {}
|
|
for user in self.config["aprsd"]["web"]["users"]:
|
|
self.users[user] = generate_password_hash(
|
|
self.config["aprsd"]["web"]["users"][user],
|
|
)
|
|
|
|
users = self.users
|
|
|
|
def _get_transport(self, stats):
|
|
if self.config["aprs"].get("enabled", True):
|
|
transport = "aprs-is"
|
|
aprs_connection = (
|
|
"APRS-IS Server: <a href='http://status.aprs2.net' >"
|
|
"{}</a>".format(stats["stats"]["aprs-is"]["server"])
|
|
)
|
|
else:
|
|
# We might be connected to a KISS socket?
|
|
if client.KISSClient.is_enabled(self.config):
|
|
transport = client.KISSClient.transport(self.config)
|
|
if transport == client.TRANSPORT_TCPKISS:
|
|
aprs_connection = (
|
|
"TCPKISS://{}:{}".format(
|
|
self.config["kiss"]["tcp"]["host"],
|
|
self.config["kiss"]["tcp"]["port"],
|
|
)
|
|
)
|
|
elif transport == client.TRANSPORT_SERIALKISS:
|
|
# for pep8 violation
|
|
kiss_default = aprsd_config.DEFAULT_DATE_FORMAT["kiss"]
|
|
default_baudrate = kiss_default["serial"]["baudrate"]
|
|
aprs_connection = (
|
|
"SerialKISS://{}@{} baud".format(
|
|
self.config["kiss"]["serial"]["device"],
|
|
self.config["kiss"]["serial"].get(
|
|
"baudrate",
|
|
default_baudrate,
|
|
),
|
|
)
|
|
)
|
|
|
|
return transport, aprs_connection
|
|
|
|
@auth.login_required
|
|
def index(self):
|
|
ua_str = request.headers.get("User-Agent")
|
|
# this takes about 2 seconds :(
|
|
user_agent = ua_parse(ua_str)
|
|
LOG.debug(f"Is mobile? {user_agent.is_mobile}")
|
|
stats = self._stats()
|
|
|
|
if user_agent.is_mobile:
|
|
html_template = "mobile.html"
|
|
else:
|
|
html_template = "index.html"
|
|
|
|
# For development
|
|
# html_template = "mobile.html"
|
|
|
|
LOG.debug(f"Template {html_template}")
|
|
|
|
transport, aprs_connection = self._get_transport(stats)
|
|
LOG.debug(f"transport {transport} aprs_connection {aprs_connection}")
|
|
|
|
stats["transport"] = transport
|
|
stats["aprs_connection"] = aprs_connection
|
|
LOG.debug(f"initial stats = {stats}")
|
|
|
|
return flask.render_template(
|
|
html_template,
|
|
initial_stats=stats,
|
|
aprs_connection=aprs_connection,
|
|
callsign=self.config["aprsd"]["callsign"],
|
|
version=aprsd.__version__,
|
|
)
|
|
|
|
@auth.login_required
|
|
def send_message_status(self):
|
|
LOG.debug(request)
|
|
msgs = SentMessages()
|
|
info = msgs.get_all()
|
|
return json.dumps(info)
|
|
|
|
def _stats(self):
|
|
stats_obj = stats.APRSDStats()
|
|
now = datetime.datetime.now()
|
|
|
|
time_format = "%m-%d-%Y %H:%M:%S"
|
|
stats_dict = stats_obj.stats()
|
|
# Webchat doesnt need these
|
|
del stats_dict["aprsd"]["watch_list"]
|
|
del stats_dict["aprsd"]["seen_list"]
|
|
# del stats_dict["email"]
|
|
# del stats_dict["plugins"]
|
|
# del stats_dict["messages"]
|
|
|
|
result = {
|
|
"time": now.strftime(time_format),
|
|
"stats": stats_dict,
|
|
}
|
|
|
|
return result
|
|
|
|
def stats(self):
|
|
return json.dumps(self._stats())
|
|
|
|
|
|
class SendMessageNamespace(Namespace):
|
|
"""Class to handle the socketio interactions."""
|
|
_config = None
|
|
got_ack = False
|
|
reply_sent = False
|
|
msg = None
|
|
request = None
|
|
|
|
def __init__(self, namespace=None, config=None):
|
|
self._config = config
|
|
super().__init__(namespace)
|
|
|
|
def on_connect(self):
|
|
global socketio
|
|
LOG.debug("Web socket connected")
|
|
socketio.emit(
|
|
"connected", {"data": "/sendmsg Connected"},
|
|
namespace="/sendmsg",
|
|
)
|
|
|
|
def on_disconnect(self):
|
|
LOG.debug("WS Disconnected")
|
|
|
|
def on_send(self, data):
|
|
global socketio
|
|
LOG.debug(f"WS: on_send {data}")
|
|
self.request = data
|
|
data["from"] = self._config["aprs"]["login"]
|
|
pkt = packets.MessagePacket(
|
|
from_call=data["from"],
|
|
to_call=data["to"].upper(),
|
|
message_text=data["message"],
|
|
)
|
|
self.msg = pkt
|
|
msgs = SentMessages()
|
|
msgs.add(pkt)
|
|
pkt.send()
|
|
msgs.set_status(pkt.msgNo, "Sending")
|
|
obj = msgs.get(pkt.msgNo)
|
|
socketio.emit(
|
|
"sent", obj,
|
|
namespace="/sendmsg",
|
|
)
|
|
|
|
def on_gps(self, data):
|
|
LOG.debug(f"WS on_GPS: {data}")
|
|
lat = aprslib_util.latitude_to_ddm(data["latitude"])
|
|
long = aprslib_util.longitude_to_ddm(data["longitude"])
|
|
LOG.debug(f"Lat DDM {lat}")
|
|
LOG.debug(f"Long DDM {long}")
|
|
|
|
local_datetime = datetime.datetime.now()
|
|
utc_offset_timedelta = datetime.datetime.utcnow() - local_datetime
|
|
result_utc_datetime = local_datetime + utc_offset_timedelta
|
|
time_zulu = result_utc_datetime.strftime("%d%H%M")
|
|
|
|
# now construct a beacon to send over the client connection
|
|
txt = (
|
|
f"{self._config['aprs']['login']}>APZ100,WIDE2-1"
|
|
f":@{time_zulu}z{lat}/{long}l APRSD WebChat Beacon"
|
|
)
|
|
|
|
LOG.debug(f"Sending {txt}")
|
|
beacon = packets.GPSPacket(
|
|
from_call=self._config["aprs"]["login"],
|
|
to_call="APDW16",
|
|
raw=txt,
|
|
)
|
|
beacon.send_direct()
|
|
#beacon_msg = messaging.RawMessage(txt)
|
|
#beacon_msg.fromcall = self._config["aprs"]["login"]
|
|
#beacon_msg.tocall = "APDW16"
|
|
#beacon_msg.send_direct()
|
|
|
|
def handle_message(self, data):
|
|
LOG.debug(f"WS Data {data}")
|
|
|
|
def handle_json(self, data):
|
|
LOG.debug(f"WS json {data}")
|
|
|
|
|
|
def setup_logging(config, flask_app, loglevel, quiet):
|
|
flask_log = logging.getLogger("werkzeug")
|
|
flask_app.logger.removeHandler(default_handler)
|
|
flask_log.removeHandler(default_handler)
|
|
|
|
log_level = aprsd_config.LOG_LEVELS[loglevel]
|
|
flask_log.setLevel(log_level)
|
|
date_format = config["aprsd"].get(
|
|
"dateformat",
|
|
aprsd_config.DEFAULT_DATE_FORMAT,
|
|
)
|
|
|
|
if not config["aprsd"]["web"].get("logging_enabled", False):
|
|
# disable web logging
|
|
flask_log.disabled = True
|
|
flask_app.logger.disabled = True
|
|
# return
|
|
|
|
if config["aprsd"].get("rich_logging", False) and not quiet:
|
|
log_format = "%(message)s"
|
|
log_formatter = logging.Formatter(fmt=log_format, datefmt=date_format)
|
|
rh = aprsd_logging.APRSDRichHandler(
|
|
show_thread=True, thread_width=15,
|
|
rich_tracebacks=True, omit_repeated_times=False,
|
|
)
|
|
rh.setFormatter(log_formatter)
|
|
flask_log.addHandler(rh)
|
|
|
|
log_file = config["aprsd"].get("logfile", None)
|
|
|
|
if log_file:
|
|
log_format = config["aprsd"].get(
|
|
"logformat",
|
|
aprsd_config.DEFAULT_LOG_FORMAT,
|
|
)
|
|
log_formatter = logging.Formatter(fmt=log_format, datefmt=date_format)
|
|
fh = RotatingFileHandler(
|
|
log_file, maxBytes=(10248576 * 5),
|
|
backupCount=4,
|
|
)
|
|
fh.setFormatter(log_formatter)
|
|
flask_log.addHandler(fh)
|
|
|
|
|
|
@trace.trace
|
|
def init_flask(config, loglevel, quiet):
|
|
global socketio
|
|
|
|
flask_app = flask.Flask(
|
|
"aprsd",
|
|
static_url_path="/static",
|
|
static_folder="web/chat/static",
|
|
template_folder="web/chat/templates",
|
|
)
|
|
setup_logging(config, flask_app, loglevel, quiet)
|
|
server = WebChatFlask()
|
|
server.set_config(config)
|
|
flask_app.route("/", methods=["GET"])(server.index)
|
|
flask_app.route("/stats", methods=["GET"])(server.stats)
|
|
# flask_app.route("/send-message", methods=["GET"])(server.send_message)
|
|
flask_app.route("/send-message-status", methods=["GET"])(server.send_message_status)
|
|
|
|
socketio = SocketIO(
|
|
flask_app, logger=False, engineio_logger=False,
|
|
async_mode="threading",
|
|
)
|
|
# async_mode="gevent",
|
|
# async_mode="eventlet",
|
|
# import eventlet
|
|
# eventlet.monkey_patch()
|
|
|
|
socketio.on_namespace(
|
|
SendMessageNamespace(
|
|
"/sendmsg", config=config,
|
|
),
|
|
)
|
|
return socketio, flask_app
|
|
|
|
|
|
# main() ###
|
|
@cli.command()
|
|
@cli_helper.add_options(cli_helper.common_options)
|
|
@click.option(
|
|
"-f",
|
|
"--flush",
|
|
"flush",
|
|
is_flag=True,
|
|
show_default=True,
|
|
default=False,
|
|
help="Flush out all old aged messages on disk.",
|
|
)
|
|
@click.option(
|
|
"-p",
|
|
"--port",
|
|
"port",
|
|
show_default=True,
|
|
default=80,
|
|
help="Port to listen to web requests",
|
|
)
|
|
@click.pass_context
|
|
@cli_helper.process_standard_options
|
|
def webchat(ctx, flush, port):
|
|
"""Web based HAM Radio chat program!"""
|
|
ctx.obj["config_file"]
|
|
loglevel = ctx.obj["loglevel"]
|
|
quiet = ctx.obj["quiet"]
|
|
config = ctx.obj["config"]
|
|
|
|
signal.signal(signal.SIGINT, signal_handler)
|
|
signal.signal(signal.SIGTERM, signal_handler)
|
|
|
|
if not quiet:
|
|
click.echo("Load config")
|
|
|
|
level, msg = utils._check_version()
|
|
if level:
|
|
LOG.warning(msg)
|
|
else:
|
|
LOG.info(msg)
|
|
LOG.info(f"APRSD Started version: {aprsd.__version__}")
|
|
|
|
flat_config = utils.flatten_dict(config)
|
|
LOG.info("Using CONFIG values:")
|
|
for x in flat_config:
|
|
if "password" in x or "aprsd.web.users.admin" in x:
|
|
LOG.info(f"{x} = XXXXXXXXXXXXXXXXXXX")
|
|
else:
|
|
LOG.info(f"{x} = {flat_config[x]}")
|
|
|
|
stats.APRSDStats(config)
|
|
|
|
# Initialize the client factory and create
|
|
# The correct client object ready for use
|
|
client.ClientFactory.setup(config)
|
|
# Make sure we have 1 client transport enabled
|
|
if not client.factory.is_client_enabled():
|
|
LOG.error("No Clients are enabled in config.")
|
|
sys.exit(-1)
|
|
|
|
if not client.factory.is_client_configured():
|
|
LOG.error("APRS client is not properly configured in config file.")
|
|
sys.exit(-1)
|
|
|
|
packets.PacketList(config=config)
|
|
packets.PacketTrack(config=config)
|
|
packets.WatchList(config=config)
|
|
packets.SeenList(config=config)
|
|
|
|
(socketio, app) = init_flask(config, loglevel, quiet)
|
|
rx_thread = WebChatRXThread(
|
|
config=config,
|
|
socketio=socketio,
|
|
)
|
|
LOG.info("Start RX Thread")
|
|
rx_thread.start()
|
|
|
|
keepalive = threads.KeepAliveThread(config=config)
|
|
LOG.info("Start KeepAliveThread")
|
|
keepalive.start()
|
|
LOG.info("Start socketio.run()")
|
|
socketio.run(
|
|
app,
|
|
ssl_context="adhoc",
|
|
host=config["aprsd"]["web"]["host"],
|
|
port=port,
|
|
)
|
|
|
|
LOG.info("WebChat exiting!!!! Bye.")
|