mirror of
https://git.ianrenton.com/ian/spothole.git
synced 2026-09-20 22:37:44 +00:00
Compare commits
19
Commits
3b575de36a
...
2.1
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
556ea56378 | ||
|
|
a367888e14 | ||
|
|
29d8654234 | ||
|
|
d79c8f72c8 | ||
|
|
a03e1336c8 | ||
|
|
0fa8cd763d | ||
|
|
4261c60d74 | ||
|
|
29eea1edc0 | ||
|
|
7c458a8c5b | ||
|
|
4a09e46fe0 | ||
|
|
e3df512b9e | ||
|
|
ee45a15b4e | ||
|
|
5e56cd3b19 | ||
|
|
04f5df5260 | ||
|
|
8f8ff46426 | ||
|
|
2e51d5fdb2 | ||
|
|
3bab3cb784 | ||
|
|
a4245ed5ce | ||
|
|
64bb8ef3eb |
@@ -4,5 +4,6 @@ WORKDIR /app
|
|||||||
COPY . .
|
COPY . .
|
||||||
RUN pip install --no-cache-dir -r requirements.txt
|
RUN pip install --no-cache-dir -r requirements.txt
|
||||||
EXPOSE 8080
|
EXPOSE 8080
|
||||||
|
EXPOSE 7373
|
||||||
|
|
||||||
CMD ["python3", "spothole.py"]
|
CMD ["python3", "spothole.py"]
|
||||||
@@ -1,7 +1,7 @@
|
|||||||
# 
|
# 
|
||||||
|
|
||||||
Spothole is a utility to aggregate "spots" from amateur radio DX clusters and xOTA spotting sites, and provide an open
|
Spothole is a utility to aggregate "spots" from amateur radio DX clusters and xOTA spotting sites, and provide an open
|
||||||
JSON API as well as a website to browse the data.
|
JSON API as well as a website to browse the data, and its own telnet server for integration with desktop loggers.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
@@ -17,10 +17,8 @@ Spothole itself is also open source, Public Domain licenced code that anyone can
|
|||||||
|
|
||||||
Supported data sources include DX Clusters, the Reverse Beacon Network (RBN), the APRS Internet Service (APRS-IS), POTA,
|
Supported data sources include DX Clusters, the Reverse Beacon Network (RBN), the APRS Internet Service (APRS-IS), POTA,
|
||||||
SOTA, WWFF, GMA, WWBOTA, HEMA, Parks 'n' Peaks, ZLOTA, WOTA, BOTA, LLOTA, WWTOTA, Tiles on the Air, the UK Packet
|
SOTA, WWFF, GMA, WWBOTA, HEMA, Parks 'n' Peaks, ZLOTA, WOTA, BOTA, LLOTA, WWTOTA, Tiles on the Air, the UK Packet
|
||||||
Repeater Network, NG3K, and any site based on the xOTA software by nischu.
|
Repeater Network, NG3K, and any site based on the xOTA software by nischu. It also integrates with QRZ.com and HamQTH,
|
||||||
|
retrieves solar data from various sources, provides information about upcoming contests, and more.
|
||||||
Additional Special Interest Groups (SIGs) without their own specific data source include KRMNPA, SANPCPA, WAB, WAI and
|
|
||||||
DME.
|
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
|||||||
+18
-6
@@ -17,6 +17,15 @@ api_only_mode: false
|
|||||||
# The base URL at which the software runs.
|
# The base URL at which the software runs.
|
||||||
base_url: "http://localhost:8080"
|
base_url: "http://localhost:8080"
|
||||||
|
|
||||||
|
# Whether to run a telnet spot server as well as the web interface
|
||||||
|
telnet_server_enabled: false
|
||||||
|
|
||||||
|
# Telnet server address. This is not really needed by the software itself, just displayed in documentation.
|
||||||
|
telnet_server_address: "localhost"
|
||||||
|
|
||||||
|
# Port to run the telnet server on
|
||||||
|
telnet_server_port: 7373
|
||||||
|
|
||||||
# Spot providers to use. This is an example set, tailor it to your liking by commenting and uncommenting.
|
# Spot providers to use. This is an example set, tailor it to your liking by commenting and uncommenting.
|
||||||
# RBN and APRS-IS are supported but have such a high data rate, you probably don't want them enabled.
|
# RBN and APRS-IS are supported but have such a high data rate, you probably don't want them enabled.
|
||||||
# Each provider needs a class and an enabled/disabled state. Some require more config such as hostnames/IP
|
# Each provider needs a class and an enabled/disabled state. Some require more config such as hostnames/IP
|
||||||
@@ -162,6 +171,9 @@ alert_providers:
|
|||||||
- class: "BOTA"
|
- class: "BOTA"
|
||||||
enabled: true
|
enabled: true
|
||||||
|
|
||||||
|
- class: "Hamsat"
|
||||||
|
enabled: true
|
||||||
|
|
||||||
- class: "NG3K"
|
- class: "NG3K"
|
||||||
enabled: true
|
enabled: true
|
||||||
|
|
||||||
@@ -308,27 +320,27 @@ callsign_data_providers:
|
|||||||
priority: 2
|
priority: 2
|
||||||
# No server-side credentials for HamQTH. Users must provide their own.
|
# No server-side credentials for HamQTH. Users must provide their own.
|
||||||
|
|
||||||
|
- class: "CountryFiles"
|
||||||
|
priority: 3
|
||||||
|
enabled: true
|
||||||
|
|
||||||
- class: "ClublogAPI"
|
- class: "ClublogAPI"
|
||||||
# Querying the Clublog API directly doesn't provide any more data than the XML version, it just provides slightly
|
# Querying the Clublog API directly doesn't provide any more data than the XML version, it just provides slightly
|
||||||
# more up-to-date information in the rare case that the prefix data changes, at a significant cost of looking up
|
# more up-to-date information in the rare case that the prefix data changes, at a significant cost of looking up
|
||||||
# every callsign via an API call. Normally left disabled but it exists as an option.
|
# every callsign via an API call. Normally left disabled but it exists as an option.
|
||||||
enabled: false
|
enabled: false
|
||||||
priority: 3
|
priority: 4
|
||||||
# API key for Clublog to look up information. Required in order to enable this provider. Unlike QRZ and HamQTH,
|
# API key for Clublog to look up information. Required in order to enable this provider. Unlike QRZ and HamQTH,
|
||||||
# Clublog uses an API key issued to Spothole, not to the end user.
|
# Clublog uses an API key issued to Spothole, not to the end user.
|
||||||
api_key: ""
|
api_key: ""
|
||||||
|
|
||||||
- class: "ClublogXML"
|
- class: "ClublogXML"
|
||||||
enabled: true
|
enabled: true
|
||||||
priority: 4
|
priority: 5
|
||||||
# API key for Clublog to look up information. Required in order to enable this provider. You will need to request
|
# API key for Clublog to look up information. Required in order to enable this provider. You will need to request
|
||||||
# one via their helpdesk portal if you want to use callsign lookups from Clublog.
|
# one via their helpdesk portal if you want to use callsign lookups from Clublog.
|
||||||
api_key: ""
|
api_key: ""
|
||||||
|
|
||||||
- class: "CountryFiles"
|
|
||||||
priority: 5
|
|
||||||
enabled: true
|
|
||||||
|
|
||||||
|
|
||||||
# Maximum time to keep spots and alerts in the system before deleting them. By default, one hour for spots and one week
|
# Maximum time to keep spots and alerts in the system before deleting them. By default, one hour for spots and one week
|
||||||
# for alerts.
|
# for alerts.
|
||||||
|
|||||||
@@ -34,6 +34,10 @@ class CleanupTimer:
|
|||||||
"""Stop any threads and prepare for application shutdown"""
|
"""Stop any threads and prepare for application shutdown"""
|
||||||
|
|
||||||
self._stop_event.set()
|
self._stop_event.set()
|
||||||
|
if self._thread:
|
||||||
|
self._thread.join(timeout=15)
|
||||||
|
if self._thread.is_alive():
|
||||||
|
logger.warning("Cleanup worker thread did not exit on time and will be killed.")
|
||||||
|
|
||||||
def _run(self):
|
def _run(self):
|
||||||
while not self._stop_event.wait(timeout=self._cleanup_interval):
|
while not self._stop_event.wait(timeout=self._cleanup_interval):
|
||||||
|
|||||||
@@ -24,6 +24,9 @@ MAX_SPOT_AGE = config.get("max_spot_age_sec", 3600)
|
|||||||
MAX_ALERT_AGE = config.get("max_alert_age_sec", 604800)
|
MAX_ALERT_AGE = config.get("max_alert_age_sec", 604800)
|
||||||
SERVER_OWNER_CALLSIGN = config.get("server_owner_callsign", "N0CALL")
|
SERVER_OWNER_CALLSIGN = config.get("server_owner_callsign", "N0CALL")
|
||||||
WEB_SERVER_PORT = config.get("web_server_port", 8080)
|
WEB_SERVER_PORT = config.get("web_server_port", 8080)
|
||||||
|
TELNET_SERVER_ENABLED = config.get("telnet_server_enabled", False)
|
||||||
|
TELNET_SERVER_ADDRESS = config.get("telnet_server_address", "localhost")
|
||||||
|
TELNET_SERVER_PORT = config.get("telnet_server_port", 7373)
|
||||||
ALLOW_SPOTTING = config.get("allow_spotting", True)
|
ALLOW_SPOTTING = config.get("allow_spotting", True)
|
||||||
ALLOW_UPSTREAM_SPOTTING = config.get("allow_upstream_spotting", True)
|
ALLOW_UPSTREAM_SPOTTING = config.get("allow_upstream_spotting", True)
|
||||||
WEB_UI_OPTIONS = config.get("web_ui_options", {})
|
WEB_UI_OPTIONS = config.get("web_ui_options", {})
|
||||||
|
|||||||
+27
-1
@@ -4,7 +4,7 @@ from data.band import Band
|
|||||||
from data.sig import SIG
|
from data.sig import SIG
|
||||||
|
|
||||||
# General software
|
# General software
|
||||||
SOFTWARE_VERSION = "2.1-pre"
|
SOFTWARE_VERSION = "2.1"
|
||||||
|
|
||||||
# HTTP headers used for spot providers that use HTTP
|
# HTTP headers used for spot providers that use HTTP
|
||||||
HTTP_HEADERS = {"User-Agent": f"Spothole v{SOFTWARE_VERSION} (operated by {SERVER_OWNER_CALLSIGN})"}
|
HTTP_HEADERS = {"User-Agent": f"Spothole v{SOFTWARE_VERSION} (operated by {SERVER_OWNER_CALLSIGN})"}
|
||||||
@@ -12,6 +12,22 @@ HAMQTH_PRG = f"Spothole v{SOFTWARE_VERSION} operated by {SERVER_OWNER_CALLSIGN}"
|
|||||||
|
|
||||||
# Special Interest Groups
|
# Special Interest Groups
|
||||||
SIGS = [
|
SIGS = [
|
||||||
|
SIG(
|
||||||
|
name="AMSAT",
|
||||||
|
comment_names=[],
|
||||||
|
description="Amateur Radio Satellites",
|
||||||
|
sig_type=SIGType.WORLDWIDE,
|
||||||
|
icon="fa-satellite",
|
||||||
|
refs_globally_unique=False,
|
||||||
|
),
|
||||||
|
SIG(
|
||||||
|
name="EME",
|
||||||
|
comment_names=[],
|
||||||
|
description="Moonbounce",
|
||||||
|
sig_type=SIGType.WORLDWIDE,
|
||||||
|
icon="fa-moon",
|
||||||
|
refs_globally_unique=False,
|
||||||
|
),
|
||||||
SIG(
|
SIG(
|
||||||
name="POTA",
|
name="POTA",
|
||||||
comment_names=["POTA"],
|
comment_names=["POTA"],
|
||||||
@@ -247,6 +263,16 @@ SIGS = [
|
|||||||
region_flag="🇮🇪",
|
region_flag="🇮🇪",
|
||||||
refs_globally_unique=False,
|
refs_globally_unique=False,
|
||||||
),
|
),
|
||||||
|
SIG(
|
||||||
|
name="DMF",
|
||||||
|
comment_names=["DMF"],
|
||||||
|
description="Diplôme des Moulins de France",
|
||||||
|
sig_type=SIGType.REGIONAL,
|
||||||
|
ref_type=SIGRefType.MILL,
|
||||||
|
icon="fa-fan",
|
||||||
|
region_flag="🇫🇷",
|
||||||
|
refs_globally_unique=False,
|
||||||
|
),
|
||||||
SIG(
|
SIG(
|
||||||
name="DME",
|
name="DME",
|
||||||
comment_names=["DME"],
|
comment_names=["DME"],
|
||||||
|
|||||||
+49
-30
@@ -1,5 +1,6 @@
|
|||||||
import logging
|
import logging
|
||||||
import threading
|
import threading
|
||||||
|
import time
|
||||||
|
|
||||||
from core.config import config, create_provider_from_config
|
from core.config import config, create_provider_from_config
|
||||||
|
|
||||||
@@ -16,6 +17,7 @@ class DataProviders:
|
|||||||
self.static_data_providers = []
|
self.static_data_providers = []
|
||||||
self.sig_ref_data_providers = []
|
self.sig_ref_data_providers = []
|
||||||
self.callsign_data_providers = []
|
self.callsign_data_providers = []
|
||||||
|
self._startup_timers = []
|
||||||
|
|
||||||
def setup(self):
|
def setup(self):
|
||||||
for entry in config["spot_providers"]:
|
for entry in config["spot_providers"]:
|
||||||
@@ -43,41 +45,58 @@ class DataProviders:
|
|||||||
def start(self):
|
def start(self):
|
||||||
# Start data providers before spot/alert providers so the lookup data is there already for incoming spots.
|
# Start data providers before spot/alert providers so the lookup data is there already for incoming spots.
|
||||||
# Each category is fired off after a small delay to give the rest of Spothole chance to start up.
|
# Each category is fired off after a small delay to give the rest of Spothole chance to start up.
|
||||||
threading.Timer(5.0, lambda: self.start_providers(self.static_data_providers, "static data")).start()
|
self._startup_timers = [
|
||||||
threading.Timer(
|
threading.Timer(5.0, lambda: self.start_providers(self.static_data_providers, "static data")),
|
||||||
10.0,
|
threading.Timer(10.0, lambda: self.start_providers(self.callsign_data_providers, "callsign data")),
|
||||||
lambda: self.start_providers(self.callsign_data_providers, "callsign data"),
|
threading.Timer(15.0, lambda: self.start_providers(self.spot_providers, "spot")),
|
||||||
).start()
|
threading.Timer(20.0, lambda: self.start_providers(self.alert_providers, "alert")),
|
||||||
threading.Timer(15.0, lambda: self.start_providers(self.spot_providers, "spot")).start()
|
|
||||||
threading.Timer(20.0, lambda: self.start_providers(self.alert_providers, "alert")).start()
|
|
||||||
threading.Timer(
|
threading.Timer(
|
||||||
25.0,
|
25.0,
|
||||||
lambda: self.start_providers(self.solar_condition_providers, "solar condition"),
|
lambda: self.start_providers(self.solar_condition_providers, "solar condition"),
|
||||||
).start()
|
),
|
||||||
threading.Timer(
|
threading.Timer(30.0, lambda: self.start_providers(self.sig_ref_data_providers, "SIG ref data")),
|
||||||
30.0,
|
]
|
||||||
lambda: self.start_providers(self.sig_ref_data_providers, "SIG ref data"),
|
for t in self._startup_timers:
|
||||||
).start()
|
t.daemon = True
|
||||||
|
t.start()
|
||||||
|
|
||||||
def stop(self):
|
def stop(self):
|
||||||
for sp in self.spot_providers:
|
# Cancel any startup timers that haven't fired yet
|
||||||
if sp.enabled:
|
for t in self._startup_timers:
|
||||||
sp.stop()
|
t.cancel()
|
||||||
for ap in self.alert_providers:
|
|
||||||
if ap.enabled:
|
# Stop all providers
|
||||||
ap.stop()
|
all_providers = [
|
||||||
for scp in self.solar_condition_providers:
|
p
|
||||||
if scp.enabled:
|
for p in (
|
||||||
scp.stop()
|
self.spot_providers
|
||||||
for srdp in self.sig_ref_data_providers:
|
+ self.alert_providers
|
||||||
if srdp.enabled:
|
+ self.solar_condition_providers
|
||||||
srdp.stop()
|
+ self.sig_ref_data_providers
|
||||||
for sdp in self.static_data_providers:
|
+ self.static_data_providers
|
||||||
if sdp.enabled:
|
+ self.callsign_data_providers
|
||||||
sdp.stop()
|
)
|
||||||
for cdp in self.callsign_data_providers:
|
if p.enabled
|
||||||
if cdp.enabled:
|
]
|
||||||
cdp.stop()
|
if not all_providers:
|
||||||
|
return
|
||||||
|
|
||||||
|
def stop_provider(p):
|
||||||
|
try:
|
||||||
|
p.stop()
|
||||||
|
except Exception:
|
||||||
|
logger.exception("Exception stopping provider")
|
||||||
|
|
||||||
|
threads = [threading.Thread(target=stop_provider, args=(p,), daemon=True) for p in all_providers]
|
||||||
|
for t in threads:
|
||||||
|
t.start()
|
||||||
|
|
||||||
|
deadline = time.monotonic() + 40
|
||||||
|
for t in threads:
|
||||||
|
t.join(timeout=max(0.0, deadline - time.monotonic()))
|
||||||
|
still_running = [t for t in threads if t.is_alive()]
|
||||||
|
if still_running:
|
||||||
|
logger.warning("Some threads did not stop in time!")
|
||||||
|
|
||||||
|
|
||||||
# Global object
|
# Global object
|
||||||
|
|||||||
@@ -106,6 +106,7 @@ class DataStore:
|
|||||||
and testing the callsign every time is expensive. So instead we build a separate in-memory lookup of compiled
|
and testing the callsign every time is expensive. So instead we build a separate in-memory lookup of compiled
|
||||||
regex against DXCC entity code, as a list of tuples we can iterate through."""
|
regex against DXCC entity code, as a list of tuples we can iterate through."""
|
||||||
|
|
||||||
|
self.dxcc_lookup_by_call_regex = []
|
||||||
for entry in [DATA_STORE.dxcc_data[key] for key in DATA_STORE.dxcc_data]:
|
for entry in [DATA_STORE.dxcc_data[key] for key in DATA_STORE.dxcc_data]:
|
||||||
self.dxcc_lookup_by_call_regex.append((re.compile(entry["prefixRegex"]), entry["entityCode"]))
|
self.dxcc_lookup_by_call_regex.append((re.compile(entry["prefixRegex"]), entry["entityCode"]))
|
||||||
|
|
||||||
|
|||||||
+1
-3
@@ -71,7 +71,6 @@ class ModeSource(str, Enum):
|
|||||||
SPOT = "SPOT"
|
SPOT = "SPOT"
|
||||||
COMMENT = "COMMENT"
|
COMMENT = "COMMENT"
|
||||||
BANDPLAN = "BANDPLAN"
|
BANDPLAN = "BANDPLAN"
|
||||||
NONE = "NONE"
|
|
||||||
|
|
||||||
|
|
||||||
class LocationSourceForSpot(str, Enum):
|
class LocationSourceForSpot(str, Enum):
|
||||||
@@ -82,7 +81,6 @@ class LocationSourceForSpot(str, Enum):
|
|||||||
GRID = "GRID"
|
GRID = "GRID"
|
||||||
HOME_QTH = "HOME QTH"
|
HOME_QTH = "HOME QTH"
|
||||||
DXCC = "DXCC"
|
DXCC = "DXCC"
|
||||||
NONE = "NONE"
|
|
||||||
|
|
||||||
|
|
||||||
class LocationSourceForCallsign(str, Enum):
|
class LocationSourceForCallsign(str, Enum):
|
||||||
@@ -90,7 +88,6 @@ class LocationSourceForCallsign(str, Enum):
|
|||||||
|
|
||||||
HOME_QTH = "HOME QTH"
|
HOME_QTH = "HOME QTH"
|
||||||
DXCC = "DXCC"
|
DXCC = "DXCC"
|
||||||
NONE = "NONE"
|
|
||||||
|
|
||||||
|
|
||||||
class SIGRefType(str, Enum):
|
class SIGRefType(str, Enum):
|
||||||
@@ -119,6 +116,7 @@ class AlertType(str, Enum):
|
|||||||
"""Type of an alert."""
|
"""Type of an alert."""
|
||||||
|
|
||||||
XOTA = "XOTA"
|
XOTA = "XOTA"
|
||||||
|
SATELLITE = "SATELLITE"
|
||||||
DXPEDITION = "DXPEDITION"
|
DXPEDITION = "DXPEDITION"
|
||||||
CONTEST = "CONTEST"
|
CONTEST = "CONTEST"
|
||||||
|
|
||||||
|
|||||||
+12
-4
@@ -22,6 +22,8 @@ class LiveDataCache:
|
|||||||
self._listeners_lock = threading.Lock()
|
self._listeners_lock = threading.Lock()
|
||||||
self._snapshot_dir = snapshot_dir
|
self._snapshot_dir = snapshot_dir
|
||||||
self._disk_cache = diskcache.Cache(str(snapshot_dir))
|
self._disk_cache = diskcache.Cache(str(snapshot_dir))
|
||||||
|
self._stop_event = threading.Event()
|
||||||
|
self._snapshot_thread = None
|
||||||
self._load_snapshot()
|
self._load_snapshot()
|
||||||
self._start_periodic_snapshot(snapshot_interval_sec)
|
self._start_periodic_snapshot(snapshot_interval_sec)
|
||||||
|
|
||||||
@@ -89,13 +91,19 @@ class LiveDataCache:
|
|||||||
|
|
||||||
def _start_periodic_snapshot(self, interval):
|
def _start_periodic_snapshot(self, interval):
|
||||||
def loop():
|
def loop():
|
||||||
while True:
|
while not self._stop_event.wait(timeout=interval):
|
||||||
time.sleep(interval)
|
|
||||||
self.save_snapshot()
|
self.save_snapshot()
|
||||||
|
|
||||||
t = threading.Thread(target=loop, name=f"LiveDataCache-Snapshot-{self._snapshot_dir}")
|
self._snapshot_thread = threading.Thread(
|
||||||
t.start()
|
target=loop, name=f"LiveDataCache-Snapshot-{self._snapshot_dir}", daemon=True
|
||||||
|
)
|
||||||
|
self._snapshot_thread.start()
|
||||||
|
|
||||||
def close(self):
|
def close(self):
|
||||||
|
self._stop_event.set()
|
||||||
|
if self._snapshot_thread:
|
||||||
|
self._snapshot_thread.join(timeout=15)
|
||||||
|
if self._snapshot_thread.is_alive():
|
||||||
|
logger.warning(f"LiveDataCache snapshot thread for {self._snapshot_dir} did not exit on time.")
|
||||||
self.save_snapshot()
|
self.save_snapshot()
|
||||||
self._disk_cache.close()
|
self._disk_cache.close()
|
||||||
|
|||||||
@@ -24,7 +24,7 @@ def get_sig_ref_info(sig_name, ref_id):
|
|||||||
|
|
||||||
# Sometimes we allow spaces instead of dashes in references due to common usage that way, but official reference
|
# Sometimes we allow spaces instead of dashes in references due to common usage that way, but official reference
|
||||||
# lists never do, so convert them here.
|
# lists never do, so convert them here.
|
||||||
ref_id.replace(" ", "-")
|
ref_id = ref_id.replace(" ", "-")
|
||||||
|
|
||||||
# Prepare the object to be returned
|
# Prepare the object to be returned
|
||||||
sig_ref = SIGRef(sig=sig_name, id=ref_id)
|
sig_ref = SIGRef(sig=sig_name, id=ref_id)
|
||||||
@@ -43,6 +43,7 @@ def get_sig_ref_info(sig_name, ref_id):
|
|||||||
# database.
|
# database.
|
||||||
if sig_name.upper() == "DME":
|
if sig_name.upper() == "DME":
|
||||||
match = re.match(r"DME[\- ](\d{3,5})", ref_id, re.IGNORECASE)
|
match = re.match(r"DME[\- ](\d{3,5})", ref_id, re.IGNORECASE)
|
||||||
|
if match:
|
||||||
number = match.group(1)
|
number = match.group(1)
|
||||||
ref_id = f"DME-{number.zfill(5)}"
|
ref_id = f"DME-{number.zfill(5)}"
|
||||||
|
|
||||||
@@ -113,17 +114,24 @@ def get_sig_ref_info(sig_name, ref_id):
|
|||||||
# OK, this is something we have to look up. Now check to see if our data store contains reference data and if
|
# OK, this is something we have to look up. Now check to see if our data store contains reference data and if
|
||||||
# so, copy the data into the sig_ref object
|
# so, copy the data into the sig_ref object
|
||||||
key = f"{sig_name}:{ref_id}"
|
key = f"{sig_name}:{ref_id}"
|
||||||
|
try:
|
||||||
lookup_data = DATA_STORE.sigrefs.get(key) if key in DATA_STORE.sigrefs else None
|
lookup_data = DATA_STORE.sigrefs.get(key) if key in DATA_STORE.sigrefs else None
|
||||||
if lookup_data:
|
if lookup_data:
|
||||||
for key, value in lookup_data.__dict__.items():
|
for attr, value in lookup_data.__dict__.items():
|
||||||
if value is not None and sig_ref.__dict__.get(key) is None:
|
if value is not None and sig_ref.__dict__.get(attr) is None:
|
||||||
sig_ref.__dict__[key] = value
|
sig_ref.__dict__[attr] = value
|
||||||
|
|
||||||
else:
|
else:
|
||||||
# Maybe a super new reference we don't know about yet, but more likely a typo or a test reference,
|
# Maybe a super new reference we don't know about yet, but more likely a typo or a test reference,
|
||||||
# just silently ignore it.
|
# just silently ignore it.
|
||||||
logger.debug(f"{sig_name} database did not contain data for ref {ref_id}")
|
logger.debug(f"{sig_name} database did not contain data for ref {ref_id}")
|
||||||
|
|
||||||
|
except (ValueError, KeyError):
|
||||||
|
# Catch exceptions due to e.g. old versions of objects in the cache that are no longer compatible,
|
||||||
|
# and remove them from the cache.
|
||||||
|
del DATA_STORE.sigrefs[key]
|
||||||
|
return None
|
||||||
|
|
||||||
except Exception:
|
except Exception:
|
||||||
logger.exception(f"Exception when looking up sig_ref info for {sig_name} ref {ref_id}")
|
logger.exception(f"Exception when looking up sig_ref info for {sig_name} ref {ref_id}")
|
||||||
return sig_ref
|
return sig_ref
|
||||||
|
|||||||
+17
-15
@@ -1,3 +1,4 @@
|
|||||||
|
import logging
|
||||||
import os
|
import os
|
||||||
from datetime import datetime
|
from datetime import datetime
|
||||||
from threading import Event, Thread
|
from threading import Event, Thread
|
||||||
@@ -11,7 +12,10 @@ from core.constants import SOFTWARE_VERSION
|
|||||||
from core.data_providers import DATA_PROVIDERS
|
from core.data_providers import DATA_PROVIDERS
|
||||||
from core.data_store import DATA_STORE
|
from core.data_store import DATA_STORE
|
||||||
from core.prometheus_metrics_handler import alerts_gauge, memory_use_gauge, spots_gauge
|
from core.prometheus_metrics_handler import alerts_gauge, memory_use_gauge, spots_gauge
|
||||||
from server.webserver import WEB_SERVER
|
from telnetserver.telnetserver import TELNET_SERVER
|
||||||
|
from webserver.webserver import WEB_SERVER
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
class StatusReporter:
|
class StatusReporter:
|
||||||
@@ -32,13 +36,17 @@ class StatusReporter:
|
|||||||
def start(self):
|
def start(self):
|
||||||
"""Start the reporter thread"""
|
"""Start the reporter thread"""
|
||||||
|
|
||||||
self._thread = Thread(target=self._run, name="StatusReporter")
|
self._thread = Thread(target=self._run, name="StatusReporter", daemon=True)
|
||||||
self._thread.start()
|
self._thread.start()
|
||||||
|
|
||||||
def stop(self):
|
def stop(self):
|
||||||
"""Stop any threads and prepare for application shutdown"""
|
"""Stop any threads and prepare for application shutdown"""
|
||||||
|
|
||||||
self._stop_event.set()
|
self._stop_event.set()
|
||||||
|
if self._thread:
|
||||||
|
self._thread.join(timeout=15)
|
||||||
|
if self._thread.is_alive():
|
||||||
|
logger.warning("Status reporter worker thread did not exit on time and will be killed.")
|
||||||
|
|
||||||
def _run(self):
|
def _run(self):
|
||||||
"""Thread entry point: report immediately on startup, then on each interval until stopped"""
|
"""Thread entry point: report immediately on startup, then on each interval until stopped"""
|
||||||
@@ -134,19 +142,13 @@ class StatusReporter:
|
|||||||
else 0,
|
else 0,
|
||||||
}
|
}
|
||||||
DATA_STORE.status.get()["webserver"] = {
|
DATA_STORE.status.get()["webserver"] = {
|
||||||
"status": WEB_SERVER.web_server_metrics["status"],
|
"status": WEB_SERVER.web_server_metrics.status,
|
||||||
"last_api_access": WEB_SERVER.web_server_metrics["last_api_access_time"]
|
"api_requests_per_hour": WEB_SERVER.web_server_metrics.api_requests_per_hour(),
|
||||||
.replace(tzinfo=pytz.UTC)
|
"page_requests_per_hour": WEB_SERVER.web_server_metrics.page_requests_per_hour(),
|
||||||
.timestamp()
|
"sse_client_count": WEB_SERVER.sse_client_count,
|
||||||
if WEB_SERVER.web_server_metrics["last_api_access_time"]
|
}
|
||||||
else 0,
|
DATA_STORE.status.get()["telnet"] = {
|
||||||
"api_access_count": WEB_SERVER.web_server_metrics["api_access_counter"],
|
"client_count": TELNET_SERVER.client_count,
|
||||||
"last_page_access": WEB_SERVER.web_server_metrics["last_page_access_time"]
|
|
||||||
.replace(tzinfo=pytz.UTC)
|
|
||||||
.timestamp()
|
|
||||||
if WEB_SERVER.web_server_metrics["last_page_access_time"]
|
|
||||||
else 0,
|
|
||||||
"page_access_count": WEB_SERVER.web_server_metrics["page_access_counter"],
|
|
||||||
}
|
}
|
||||||
DATA_STORE.status.store()
|
DATA_STORE.status.store()
|
||||||
|
|
||||||
|
|||||||
@@ -14,14 +14,13 @@ class URLDataCache(CachedSession):
|
|||||||
used across multiple threads, though note that URL lookups will block each other this way, so it is still better to
|
used across multiple threads, though note that URL lookups will block each other this way, so it is still better to
|
||||||
create one of these objects per thread if possible."""
|
create one of these objects per thread if possible."""
|
||||||
|
|
||||||
_lock = threading.Lock()
|
|
||||||
|
|
||||||
def __init__(self, name):
|
def __init__(self, name):
|
||||||
super().__init__(
|
super().__init__(
|
||||||
f"{CACHE_DIR}urls/{name}",
|
f"{CACHE_DIR}urls/{name}",
|
||||||
expire_after=timedelta(days=1),
|
expire_after=timedelta(days=1),
|
||||||
allowable_codes=(200, 400, 401, 403, 404),
|
allowable_codes=(200, 400, 401, 403, 404),
|
||||||
)
|
)
|
||||||
|
self._lock = threading.Lock()
|
||||||
|
|
||||||
def get(self, *args, **kwargs):
|
def get(self, *args, **kwargs):
|
||||||
with self._lock:
|
with self._lock:
|
||||||
|
|||||||
+7
-5
@@ -1,7 +1,7 @@
|
|||||||
import hashlib
|
import hashlib
|
||||||
import json
|
import json
|
||||||
import logging
|
import logging
|
||||||
from dataclasses import dataclass
|
from dataclasses import dataclass, field
|
||||||
from datetime import datetime, timedelta
|
from datetime import datetime, timedelta
|
||||||
|
|
||||||
import pytz
|
import pytz
|
||||||
@@ -64,7 +64,7 @@ class Alert:
|
|||||||
# Special Interest Group (SIG), e.g. outdoor activity programme such as POTA
|
# Special Interest Group (SIG), e.g. outdoor activity programme such as POTA
|
||||||
sig: str | None = None
|
sig: str | None = None
|
||||||
# SIG references. We allow multiple here for e.g. n-fer activations, unlike ADIF SIG_INFO
|
# SIG references. We allow multiple here for e.g. n-fer activations, unlike ADIF SIG_INFO
|
||||||
sig_refs: list | None = None
|
sig_refs: list = field(default_factory=list)
|
||||||
|
|
||||||
# Timing info
|
# Timing info
|
||||||
|
|
||||||
@@ -128,13 +128,13 @@ class Alert:
|
|||||||
# Fetch SIG data. In case a particular API doesn't provide a full set of name, lat, lon & grid for a reference
|
# Fetch SIG data. In case a particular API doesn't provide a full set of name, lat, lon & grid for a reference
|
||||||
# in its initial call, we use this code to populate the rest of the data. This includes working out grid refs
|
# in its initial call, we use this code to populate the rest of the data. This includes working out grid refs
|
||||||
# from WAB and WAI, which count as a SIG even though there's no real lookup, just maths
|
# from WAB and WAI, which count as a SIG even though there's no real lookup, just maths
|
||||||
if self.sig_refs and len(self.sig_refs) > 0:
|
if self.sig_refs:
|
||||||
for sig_ref in self.sig_refs:
|
for sig_ref in self.sig_refs:
|
||||||
populate_missing_sig_ref_info(sig_ref)
|
populate_missing_sig_ref_info(sig_ref)
|
||||||
|
|
||||||
# If the spot itself doesn't have a SIG yet, but we have at least one SIG reference, take that reference's SIG
|
# If the spot itself doesn't have a SIG yet, but we have at least one SIG reference, take that reference's SIG
|
||||||
# and apply it to the whole spot.
|
# and apply it to the whole spot.
|
||||||
if self.sig_refs and len(self.sig_refs) > 0 and self.sig_refs[0] and not self.sig:
|
if self.sig_refs and self.sig_refs[0] and not self.sig:
|
||||||
self.sig = self.sig_refs[0].sig
|
self.sig = self.sig_refs[0].sig
|
||||||
|
|
||||||
# Create an ID based on the source and source ID if possible, as these guaranee uniqueness. If there is no
|
# Create an ID based on the source and source ID if possible, as these guaranee uniqueness. If there is no
|
||||||
@@ -158,7 +158,9 @@ class Alert:
|
|||||||
self.icon = "fa-globe-africa"
|
self.icon = "fa-globe-africa"
|
||||||
elif self.alert_type == AlertType.CONTEST:
|
elif self.alert_type == AlertType.CONTEST:
|
||||||
self.icon = "fa-trophy"
|
self.icon = "fa-trophy"
|
||||||
elif self.sig_refs and len(self.sig_refs) > 0 and self.sig_refs[0].icon:
|
elif self.alert_type == AlertType.SATELLITE:
|
||||||
|
self.icon = "fa-satellite"
|
||||||
|
elif self.sig_refs and self.sig_refs[0].icon:
|
||||||
self.icon = self.sig_refs[0].icon
|
self.icon = self.sig_refs[0].icon
|
||||||
|
|
||||||
except Exception:
|
except Exception:
|
||||||
|
|||||||
+1
-1
@@ -38,7 +38,7 @@ class Callsign:
|
|||||||
# ITU zone in which the callsign indicates they are operating
|
# ITU zone in which the callsign indicates they are operating
|
||||||
itu_zone: int | None = None
|
itu_zone: int | None = None
|
||||||
# Location source
|
# Location source
|
||||||
location_source: LocationSourceForCallsign = LocationSourceForCallsign.NONE
|
location_source: LocationSourceForCallsign | None = None
|
||||||
|
|
||||||
def fully_populated(self):
|
def fully_populated(self):
|
||||||
"""Utility method to indicate that the callsign data is fully populated. Multiple providers can return data for
|
"""Utility method to indicate that the callsign data is fully populated. Multiple providers can return data for
|
||||||
|
|||||||
+2
-2
@@ -8,10 +8,10 @@ class SIGRef:
|
|||||||
"""Data class that defines a Special Interest Group "info" or reference. As well as the basic reference ID we include a
|
"""Data class that defines a Special Interest Group "info" or reference. As well as the basic reference ID we include a
|
||||||
name and a lookup URL."""
|
name and a lookup URL."""
|
||||||
|
|
||||||
# Reference ID, e.g. "GB-0001".
|
|
||||||
id: str
|
|
||||||
# SIG that this reference is in, e.g. "POTA".
|
# SIG that this reference is in, e.g. "POTA".
|
||||||
sig: str
|
sig: str
|
||||||
|
# Reference ID, e.g. "GB-0001".
|
||||||
|
id: str | None = None
|
||||||
# Name of the reference, e.g. "Null Country Park", if known.
|
# Name of the reference, e.g. "Null Country Park", if known.
|
||||||
name: str | None = None
|
name: str | None = None
|
||||||
# Type of the reference, e.g. "Park", if known.
|
# Type of the reference, e.g. "Park", if known.
|
||||||
|
|||||||
+34
-14
@@ -2,7 +2,7 @@ import hashlib
|
|||||||
import json
|
import json
|
||||||
import logging
|
import logging
|
||||||
import re
|
import re
|
||||||
from dataclasses import dataclass
|
from dataclasses import dataclass, field
|
||||||
from datetime import datetime, timedelta
|
from datetime import datetime, timedelta
|
||||||
from math import isnan
|
from math import isnan
|
||||||
|
|
||||||
@@ -12,6 +12,7 @@ from pyhamtools.locator import latlong_to_locator, locator_to_latlong
|
|||||||
from core.call_lookup_helper import get_call_info
|
from core.call_lookup_helper import get_call_info
|
||||||
from core.config import MAX_SPOT_AGE
|
from core.config import MAX_SPOT_AGE
|
||||||
from core.constants import PROPAGATION_MODES, SIGS
|
from core.constants import PROPAGATION_MODES, SIGS
|
||||||
|
from core.data_store import DATA_STORE
|
||||||
from core.enums import Continent, LocationSourceForSpot, Mode, ModeSource, ModeType
|
from core.enums import Continent, LocationSourceForSpot, Mode, ModeSource, ModeType
|
||||||
from core.geo_utils import lat_lon_to_cq_zone, lat_lon_to_itu_zone
|
from core.geo_utils import lat_lon_to_cq_zone, lat_lon_to_itu_zone
|
||||||
from core.sig_lookup_helper import populate_missing_sig_ref_info
|
from core.sig_lookup_helper import populate_missing_sig_ref_info
|
||||||
@@ -70,7 +71,7 @@ class Spot:
|
|||||||
dx_latitude: float | None = None
|
dx_latitude: float | None = None
|
||||||
dx_longitude: float | None = None
|
dx_longitude: float | None = None
|
||||||
# DX Location source. Indicates how accurate the location might be.
|
# DX Location source. Indicates how accurate the location might be.
|
||||||
dx_location_source: LocationSourceForSpot = LocationSourceForSpot.NONE
|
dx_location_source: LocationSourceForSpot | None = None
|
||||||
# DX Location good. Indicates that the software thinks the location data is good enough to plot on a map. This is
|
# DX Location good. Indicates that the software thinks the location data is good enough to plot on a map. This is
|
||||||
# true if the location source is "SPOT", "SIG REF LOOKUP" or "GRID", or if the location source is "HOME QTH" and the
|
# true if the location source is "SPOT", "SIG REF LOOKUP" or "GRID", or if the location source is "HOME QTH" and the
|
||||||
# DX callsign doesn't have a suffix like /P.
|
# DX callsign doesn't have a suffix like /P.
|
||||||
@@ -107,7 +108,7 @@ class Spot:
|
|||||||
# Inferred mode "family".
|
# Inferred mode "family".
|
||||||
mode_type: ModeType | None = None
|
mode_type: ModeType | None = None
|
||||||
# Source of the mode information.
|
# Source of the mode information.
|
||||||
mode_source: ModeSource = ModeSource.NONE
|
mode_source: ModeSource | None = None
|
||||||
# Frequency, in Hz
|
# Frequency, in Hz
|
||||||
freq: float | None = None
|
freq: float | None = None
|
||||||
# Band, defined by the frequency, e.g. "40m" or "70cm"
|
# Band, defined by the frequency, e.g. "40m" or "70cm"
|
||||||
@@ -124,7 +125,7 @@ class Spot:
|
|||||||
# Special Interest Group (SIG), e.g. outdoor activity programme such as POTA
|
# Special Interest Group (SIG), e.g. outdoor activity programme such as POTA
|
||||||
sig: str | None = None
|
sig: str | None = None
|
||||||
# SIG references. We allow multiple here for e.g. n-fer activations, unlike ADIF SIG_INFO
|
# SIG references. We allow multiple here for e.g. n-fer activations, unlike ADIF SIG_INFO
|
||||||
sig_refs: list | None = None
|
sig_refs: list = field(default_factory=list)
|
||||||
|
|
||||||
# Timing info
|
# Timing info
|
||||||
|
|
||||||
@@ -262,12 +263,12 @@ class Spot:
|
|||||||
self.dx_location_source = LocationSourceForSpot.SPOT
|
self.dx_location_source = LocationSourceForSpot.SPOT
|
||||||
|
|
||||||
# Set the top-level "SIG" if it is missing but we have at least one SIG ref.
|
# Set the top-level "SIG" if it is missing but we have at least one SIG ref.
|
||||||
if not self.sig and self.sig_refs and len(self.sig_refs) > 0:
|
if not self.sig and self.sig_refs:
|
||||||
self.sig = self.sig_refs[0].sig.upper()
|
self.sig = self.sig_refs[0].sig.upper()
|
||||||
|
|
||||||
# See if we already have a SIG reference, but the comment looks like it contains more for the same SIG. This
|
# See if we already have a SIG reference, but the comment looks like it contains more for the same SIG. This
|
||||||
# should catch e.g. POTA comments like "2-fer: GB-0001 GB-0002".
|
# should catch e.g. POTA comments like "2-fer: GB-0001 GB-0002".
|
||||||
if self.comment and self.sig_refs and len(self.sig_refs) > 0 and self.sig_refs[0].sig:
|
if self.comment and self.sig_refs and self.sig_refs[0].sig:
|
||||||
sig = self.sig_refs[0].sig.upper()
|
sig = self.sig_refs[0].sig.upper()
|
||||||
regex = get_ref_regex_for_sig(sig)
|
regex = get_ref_regex_for_sig(sig)
|
||||||
if regex:
|
if regex:
|
||||||
@@ -315,7 +316,7 @@ class Spot:
|
|||||||
# Fetch SIG data. In case a particular API doesn't provide a full set of name, lat, lon & grid for a reference
|
# Fetch SIG data. In case a particular API doesn't provide a full set of name, lat, lon & grid for a reference
|
||||||
# in its initial call, we use this code to populate the rest of the data. This includes working out grid refs
|
# in its initial call, we use this code to populate the rest of the data. This includes working out grid refs
|
||||||
# from WAB and WAI, which count as a SIG even though there's no real lookup, just maths
|
# from WAB and WAI, which count as a SIG even though there's no real lookup, just maths
|
||||||
if self.sig_refs and len(self.sig_refs) > 0:
|
if self.sig_refs:
|
||||||
for sig_ref in self.sig_refs:
|
for sig_ref in self.sig_refs:
|
||||||
sig_ref = populate_missing_sig_ref_info(sig_ref)
|
sig_ref = populate_missing_sig_ref_info(sig_ref)
|
||||||
# If the spot itself doesn't have location yet, but the SIG ref does, extract it
|
# If the spot itself doesn't have location yet, but the SIG ref does, extract it
|
||||||
@@ -331,7 +332,7 @@ class Spot:
|
|||||||
|
|
||||||
# If the spot itself doesn't have a SIG yet, but we have at least one SIG reference, take that reference's SIG
|
# If the spot itself doesn't have a SIG yet, but we have at least one SIG reference, take that reference's SIG
|
||||||
# and apply it to the whole spot.
|
# and apply it to the whole spot.
|
||||||
if self.sig_refs and len(self.sig_refs) > 0 and not self.sig:
|
if self.sig_refs and not self.sig:
|
||||||
self.sig = self.sig_refs[0].sig
|
self.sig = self.sig_refs[0].sig
|
||||||
|
|
||||||
# Parse "de_grid<prop_mode>dx_grid" structures from the comment, e.g. "JN61ES(ES)JM56XT" or "JO02GQ<>KN17LG".
|
# Parse "de_grid<prop_mode>dx_grid" structures from the comment, e.g. "JN61ES(ES)JM56XT" or "JO02GQ<>KN17LG".
|
||||||
@@ -359,6 +360,18 @@ class Spot:
|
|||||||
self.propagation_mode = mode_tag
|
self.propagation_mode = mode_tag
|
||||||
logger.info(f"Seen a new propagation mode tag not yet in the system: {mode_tag}")
|
logger.info(f"Seen a new propagation mode tag not yet in the system: {mode_tag}")
|
||||||
|
|
||||||
|
# Set SIGs based on propagation mode
|
||||||
|
if self.propagation_mode == "Satellite":
|
||||||
|
if not self.sig:
|
||||||
|
self.sig = "AMSAT"
|
||||||
|
if not any(sig_ref.sig == "AMSAT" for sig_ref in self.sig_refs):
|
||||||
|
self.sig_refs.append(SIGRef(sig="AMSAT"))
|
||||||
|
if self.propagation_mode == "Earth-Moon-Earth":
|
||||||
|
if not self.sig:
|
||||||
|
self.sig = "EME"
|
||||||
|
if not any(sig_ref.sig == "EME" for sig_ref in self.sig_refs):
|
||||||
|
self.sig_refs.append(SIGRef(sig="EME"))
|
||||||
|
|
||||||
# Parse "de_grid -> dx_grid" structures from the comment
|
# Parse "de_grid -> dx_grid" structures from the comment
|
||||||
if self.comment:
|
if self.comment:
|
||||||
grid_mode_grid_match = re.search(
|
grid_mode_grid_match = re.search(
|
||||||
@@ -415,7 +428,7 @@ class Spot:
|
|||||||
|
|
||||||
# Determine a "QTH" string. If we have a SIG ref, pick the first one and turn it into a suitable string,
|
# Determine a "QTH" string. If we have a SIG ref, pick the first one and turn it into a suitable string,
|
||||||
# otherwise see what they have set on an online lookup service.
|
# otherwise see what they have set on an online lookup service.
|
||||||
if self.sig_refs and len(self.sig_refs) > 0:
|
if self.sig_refs:
|
||||||
qth = self.sig_refs[0].id
|
qth = self.sig_refs[0].id
|
||||||
if self.sig_refs[0].name:
|
if self.sig_refs[0].name:
|
||||||
qth += f" {self.sig_refs[0].name}"
|
qth += f" {self.sig_refs[0].name}"
|
||||||
@@ -435,6 +448,15 @@ class Spot:
|
|||||||
elif self.dx_call:
|
elif self.dx_call:
|
||||||
self.dx_itu_zone = dx_call_info.itu_zone
|
self.dx_itu_zone = dx_call_info.itu_zone
|
||||||
|
|
||||||
|
# DXCC lookup from callsign if nothing else has provided it
|
||||||
|
if self.dx_call and not self.dx_dxcc_id:
|
||||||
|
for regex, entity_code in DATA_STORE.dxcc_lookup_by_call_regex:
|
||||||
|
if regex.pattern and regex.match(self.dx_call):
|
||||||
|
self.dx_dxcc_id = entity_code
|
||||||
|
break
|
||||||
|
if self.dx_dxcc_id and not self.dx_flag:
|
||||||
|
self.dx_flag = get_flag_for_dxcc(self.dx_dxcc_id)
|
||||||
|
|
||||||
# DX Location is "good" if it is from a spot, or from QRZ if the callsign doesn't contain a slash, so the operator
|
# DX Location is "good" if it is from a spot, or from QRZ if the callsign doesn't contain a slash, so the operator
|
||||||
# is likely at home.
|
# is likely at home.
|
||||||
self.dx_location_good = bool(
|
self.dx_location_good = bool(
|
||||||
@@ -462,7 +484,7 @@ class Spot:
|
|||||||
|
|
||||||
# Icon for the spot should be the icon of the first SIG ref if present, otherwise a radio tower
|
# Icon for the spot should be the icon of the first SIG ref if present, otherwise a radio tower
|
||||||
self.icon = "fa-tower-cell"
|
self.icon = "fa-tower-cell"
|
||||||
if self.sig_refs and len(self.sig_refs) > 0 and self.sig_refs[0].icon:
|
if self.sig_refs and self.sig_refs[0].icon:
|
||||||
self.icon = self.sig_refs[0].icon
|
self.icon = self.sig_refs[0].icon
|
||||||
|
|
||||||
except Exception:
|
except Exception:
|
||||||
@@ -476,16 +498,14 @@ class Spot:
|
|||||||
def _append_sig_ref_if_missing(self, new_sig_ref):
|
def _append_sig_ref_if_missing(self, new_sig_ref):
|
||||||
"""Append a sig_ref to the list, so long as it's not already there."""
|
"""Append a sig_ref to the list, so long as it's not already there."""
|
||||||
|
|
||||||
sig_refs = self.sig_refs or []
|
|
||||||
self.sig_refs = sig_refs
|
|
||||||
new_sig_ref.id = new_sig_ref.id.strip().upper()
|
new_sig_ref.id = new_sig_ref.id.strip().upper()
|
||||||
new_sig_ref.sig = new_sig_ref.sig.strip().upper()
|
new_sig_ref.sig = new_sig_ref.sig.strip().upper()
|
||||||
if new_sig_ref.id == "":
|
if new_sig_ref.id == "":
|
||||||
return
|
return
|
||||||
for sig_ref in sig_refs:
|
for sig_ref in self.sig_refs:
|
||||||
if sig_ref.id == new_sig_ref.id and sig_ref.sig == new_sig_ref.sig:
|
if sig_ref.id == new_sig_ref.id and sig_ref.sig == new_sig_ref.sig:
|
||||||
return
|
return
|
||||||
sig_refs.append(new_sig_ref)
|
self.sig_refs.append(new_sig_ref)
|
||||||
|
|
||||||
def expired(self):
|
def expired(self):
|
||||||
"""Decide if this spot has expired (in which case it should not be added to the system in the first place, and not
|
"""Decide if this spot has expired (in which case it should not be added to the system in the first place, and not
|
||||||
|
|||||||
@@ -13,6 +13,7 @@ services:
|
|||||||
restart: unless-stopped
|
restart: unless-stopped
|
||||||
ports:
|
ports:
|
||||||
- "8080:8080"
|
- "8080:8080"
|
||||||
|
- "7373:7373" # For telnet if required
|
||||||
volumes:
|
volumes:
|
||||||
- ./config.yml:/app/config.yml
|
- ./config.yml:/app/config.yml
|
||||||
- ./cache:/app/cache
|
- ./cache:/app/cache
|
||||||
|
|||||||
+4
-1
@@ -16,9 +16,12 @@ To navigate your way around the source code, this list may help.
|
|||||||
* `/providers/solarconditions` - Classes providing solar and propagation by accessing the APIs of other services
|
* `/providers/solarconditions` - Classes providing solar and propagation by accessing the APIs of other services
|
||||||
* `/providers/staticdata` - Classes providing static lookup data by accessing bundled data files or the APIs of other
|
* `/providers/staticdata` - Classes providing static lookup data by accessing bundled data files or the APIs of other
|
||||||
services
|
services
|
||||||
|
* `/providers/callsign` - Classes providing callsign lookup data by accessing bundled data files or the APIs of other
|
||||||
|
services
|
||||||
* `/providers/sigrefdata` - Classes providing SIG reference lookup data by accessing bundled data files or the APIs of
|
* `/providers/sigrefdata` - Classes providing SIG reference lookup data by accessing bundled data files or the APIs of
|
||||||
other services
|
other services
|
||||||
* `/server` - Classes for running Spothole's own web server
|
* `/webserver` - Classes for running Spothole's own web server
|
||||||
|
* `/telnetserver` - Classes for running Spothole's telnet server
|
||||||
* `spothole.py` - Main application script
|
* `spothole.py` - Main application script
|
||||||
|
|
||||||
*Templates*
|
*Templates*
|
||||||
|
|||||||
@@ -0,0 +1,56 @@
|
|||||||
|
from datetime import datetime
|
||||||
|
|
||||||
|
import pytz
|
||||||
|
|
||||||
|
from core.enums import AlertType
|
||||||
|
from data.alert import Alert
|
||||||
|
from data.sig_ref import SIGRef
|
||||||
|
from providers.alert.http_alert_provider import HTTPAlertProvider
|
||||||
|
|
||||||
|
|
||||||
|
class Hamsat(HTTPAlertProvider):
|
||||||
|
"""Alert provider for Hamsat (hams.at)"""
|
||||||
|
|
||||||
|
POLL_INTERVAL_SEC = 1800
|
||||||
|
ALERTS_URL = "https://hams.at/api/alerts"
|
||||||
|
|
||||||
|
def __init__(self, provider_config):
|
||||||
|
super().__init__("Hamsat", provider_config, self.ALERTS_URL, self.POLL_INTERVAL_SEC)
|
||||||
|
|
||||||
|
def _http_response_to_alerts(self, http_response):
|
||||||
|
new_alerts = []
|
||||||
|
# Iterate through source data
|
||||||
|
for source_alert in http_response.json()["data"]:
|
||||||
|
# Convert to our alert format
|
||||||
|
freqs_modes = source_alert.get("mode", "")
|
||||||
|
if "mhz" in source_alert:
|
||||||
|
if "mhz_direction" in source_alert:
|
||||||
|
freqs_modes = f"{source_alert['mhz']!s} {source_alert['mhz_direction']}, {freqs_modes}"
|
||||||
|
else:
|
||||||
|
freqs_modes = f"{source_alert['mhz']!s}, {freqs_modes}"
|
||||||
|
|
||||||
|
alert = Alert(
|
||||||
|
source=self.name,
|
||||||
|
source_id=source_alert["id"],
|
||||||
|
dx_calls=[source_alert["callsign"].upper()],
|
||||||
|
freqs_modes=freqs_modes,
|
||||||
|
comment=source_alert["comment"],
|
||||||
|
# Fudge a SIG ref to provide the remaining bits of data we need: the satellite and the operator's grid
|
||||||
|
sig_refs=[
|
||||||
|
SIGRef(
|
||||||
|
sig="AMSAT",
|
||||||
|
id=f"{source_alert['satellite']['name']} from {source_alert['grids'][0]}",
|
||||||
|
)
|
||||||
|
],
|
||||||
|
start_time=datetime.strptime(source_alert["aos_at"], "%Y-%m-%dT%H:%M:%SZ")
|
||||||
|
.replace(tzinfo=pytz.UTC)
|
||||||
|
.timestamp(),
|
||||||
|
end_time=datetime.strptime(source_alert["los_at"], "%Y-%m-%dT%H:%M:%SZ")
|
||||||
|
.replace(tzinfo=pytz.UTC)
|
||||||
|
.timestamp(),
|
||||||
|
alert_type=AlertType.SATELLITE,
|
||||||
|
)
|
||||||
|
|
||||||
|
# Add to our list
|
||||||
|
new_alerts.append(alert)
|
||||||
|
return new_alerts
|
||||||
@@ -27,11 +27,15 @@ class HTTPAlertProvider(AlertProvider):
|
|||||||
# Fire off the polling thread. It will poll immediately on startup, then sleep for poll_interval between
|
# Fire off the polling thread. It will poll immediately on startup, then sleep for poll_interval between
|
||||||
# subsequent polls, so start() returns immediately and the application can continue starting.
|
# subsequent polls, so start() returns immediately and the application can continue starting.
|
||||||
logger.info(f"Set up query of {self.name} alert API every {self._poll_interval!s} seconds.")
|
logger.info(f"Set up query of {self.name} alert API every {self._poll_interval!s} seconds.")
|
||||||
self._thread = Thread(target=self._run, name=f"HTTPAlertProvider-{self.name}")
|
self._thread = Thread(target=self._run, name=f"HTTPAlertProvider-{self.name}", daemon=True)
|
||||||
self._thread.start()
|
self._thread.start()
|
||||||
|
|
||||||
def stop(self):
|
def stop(self):
|
||||||
self._stop_event.set()
|
self._stop_event.set()
|
||||||
|
if self._thread:
|
||||||
|
self._thread.join(timeout=35)
|
||||||
|
if self._thread.is_alive():
|
||||||
|
logger.warning(f"{self.name} alert worker thread did not exit on time and will be killed.")
|
||||||
|
|
||||||
def _run(self):
|
def _run(self):
|
||||||
while True:
|
while True:
|
||||||
|
|||||||
@@ -42,7 +42,13 @@ class CallsignDataProvider:
|
|||||||
|
|
||||||
if self.enabled:
|
if self.enabled:
|
||||||
if callsign in self._storage:
|
if callsign in self._storage:
|
||||||
|
try:
|
||||||
return self._storage[callsign]
|
return self._storage[callsign]
|
||||||
|
except (ValueError, KeyError):
|
||||||
|
# Catch exceptions due to e.g. old versions of objects in the cache that are no longer compatible,
|
||||||
|
# and remove them from the cache.
|
||||||
|
del self._storage[callsign]
|
||||||
|
return None
|
||||||
else:
|
else:
|
||||||
c = self._perform_new_lookup(callsign, lookup_credentials)
|
c = self._perform_new_lookup(callsign, lookup_credentials)
|
||||||
if c:
|
if c:
|
||||||
|
|||||||
@@ -32,11 +32,15 @@ class FileDownloadCallsignDataProvider(CallsignDataProvider):
|
|||||||
# Fire off the polling thread. It will poll immediately on startup, then sleep for poll_interval between
|
# Fire off the polling thread. It will poll immediately on startup, then sleep for poll_interval between
|
||||||
# subsequent polls, so start() returns immediately and the application can continue starting.
|
# subsequent polls, so start() returns immediately and the application can continue starting.
|
||||||
logger.info(f"Set up query of {self.name} callsign reference data every {self._poll_interval!s} days.")
|
logger.info(f"Set up query of {self.name} callsign reference data every {self._poll_interval!s} days.")
|
||||||
self._thread = Thread(target=self._run, name=f"FileDownloadCallsignDataProvider-{self.name}")
|
self._thread = Thread(target=self._run, name=f"FileDownloadCallsignDataProvider-{self.name}", daemon=True)
|
||||||
self._thread.start()
|
self._thread.start()
|
||||||
|
|
||||||
def stop(self):
|
def stop(self):
|
||||||
self._stop_event.set()
|
self._stop_event.set()
|
||||||
|
if self._thread:
|
||||||
|
self._thread.join(timeout=35)
|
||||||
|
if self._thread.is_alive():
|
||||||
|
logger.warning(f"{self.name} callsign data worker thread did not exit on time and will be killed.")
|
||||||
|
|
||||||
def _run(self):
|
def _run(self):
|
||||||
while True:
|
while True:
|
||||||
|
|||||||
@@ -53,7 +53,7 @@ class DME(LocalFileSIGRefDataProvider):
|
|||||||
|
|
||||||
# Bail out if a stop has been requested, i.e. the program is shutting down - no need to parse the rest
|
# Bail out if a stop has been requested, i.e. the program is shutting down - no need to parse the rest
|
||||||
# of the data in this case
|
# of the data in this case
|
||||||
if self._stop:
|
if self._stop_event.is_set():
|
||||||
break
|
break
|
||||||
|
|
||||||
# Very short pause. This will extend the time to handle sig refs by a few seconds but will ensure some time
|
# Very short pause. This will extend the time to handle sig refs by a few seconds but will ensure some time
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
import logging
|
import logging
|
||||||
from datetime import datetime
|
from datetime import datetime
|
||||||
from threading import Event, Thread
|
from threading import Thread
|
||||||
|
|
||||||
import pytz
|
import pytz
|
||||||
from requests.exceptions import ConnectionError, ConnectTimeout, ReadTimeout
|
from requests.exceptions import ConnectionError, ConnectTimeout, ReadTimeout
|
||||||
@@ -21,19 +21,21 @@ class FileDownloadSIGRefDataProvider(SIGRefDataProvider):
|
|||||||
self._url = url
|
self._url = url
|
||||||
self._poll_interval = poll_interval
|
self._poll_interval = poll_interval
|
||||||
self._thread = None
|
self._thread = None
|
||||||
self._stop_event = Event()
|
|
||||||
self._url_data_cache = URLDataCache(f"sigrefdata_{sig_name}")
|
self._url_data_cache = URLDataCache(f"sigrefdata_{sig_name}")
|
||||||
|
|
||||||
def start(self):
|
def start(self):
|
||||||
# Fire off the polling thread. It will poll immediately on startup, then sleep for poll_interval between
|
# Fire off the polling thread. It will poll immediately on startup, then sleep for poll_interval between
|
||||||
# subsequent polls, so start() returns immediately and the application can continue starting.
|
# subsequent polls, so start() returns immediately and the application can continue starting.
|
||||||
logger.info(f"Set up query of {self.sig_name} SIG ref data every {self._poll_interval!s} days.")
|
logger.info(f"Set up query of {self.sig_name} SIG ref data every {self._poll_interval!s} days.")
|
||||||
self._thread = Thread(target=self._run, name=f"FileDownloadSIGRefDataProvider-{self.sig_name}")
|
self._thread = Thread(target=self._run, name=f"FileDownloadSIGRefDataProvider-{self.sig_name}", daemon=True)
|
||||||
self._thread.start()
|
self._thread.start()
|
||||||
|
|
||||||
def stop(self):
|
def stop(self):
|
||||||
super().stop()
|
super().stop()
|
||||||
self._stop_event.set()
|
if self._thread:
|
||||||
|
self._thread.join(timeout=35)
|
||||||
|
if self._thread.is_alive():
|
||||||
|
logger.warning(f"{self.sig_name} SIG ref data worker thread did not exit on time and will be killed.")
|
||||||
|
|
||||||
def _run(self):
|
def _run(self):
|
||||||
while True:
|
while True:
|
||||||
|
|||||||
@@ -1,5 +1,6 @@
|
|||||||
import logging
|
import logging
|
||||||
from datetime import datetime
|
from datetime import datetime
|
||||||
|
from threading import Event
|
||||||
|
|
||||||
import pytz
|
import pytz
|
||||||
|
|
||||||
@@ -19,7 +20,7 @@ class SIGRefDataProvider:
|
|||||||
self.last_update_time = datetime.min.replace(tzinfo=pytz.UTC)
|
self.last_update_time = datetime.min.replace(tzinfo=pytz.UTC)
|
||||||
self.status = "Not Started" if self.enabled else "Disabled"
|
self.status = "Not Started" if self.enabled else "Disabled"
|
||||||
self.reference_count = 0
|
self.reference_count = 0
|
||||||
self._stop = False
|
self._stop_event = Event()
|
||||||
|
|
||||||
def start(self):
|
def start(self):
|
||||||
"""Start the provider. This should return immediately after spawning threads to access the remote resources"""
|
"""Start the provider. This should return immediately after spawning threads to access the remote resources"""
|
||||||
@@ -30,7 +31,7 @@ class SIGRefDataProvider:
|
|||||||
"""Stop any threads and prepare for application shutdown. Subclasses should implement this method and call
|
"""Stop any threads and prepare for application shutdown. Subclasses should implement this method and call
|
||||||
super()."""
|
super()."""
|
||||||
|
|
||||||
self._stop = True
|
self._stop_event.set()
|
||||||
|
|
||||||
def _add_data(self, new_data):
|
def _add_data(self, new_data):
|
||||||
"""Add all the provided reference data objects to the data store."""
|
"""Add all the provided reference data objects to the data store."""
|
||||||
@@ -43,7 +44,7 @@ class SIGRefDataProvider:
|
|||||||
# For the big data sources, loading will take a few minutes. If we want to shut down the software neatly
|
# For the big data sources, loading will take a few minutes. If we want to shut down the software neatly
|
||||||
# within the first few minutes of startup, we need a way to abort this expensive process of filling up the
|
# within the first few minutes of startup, we need a way to abort this expensive process of filling up the
|
||||||
# disk cache.
|
# disk cache.
|
||||||
if self._stop:
|
if self._stop_event.is_set():
|
||||||
break
|
break
|
||||||
|
|
||||||
self.reference_count = len(new_data)
|
self.reference_count = len(new_data)
|
||||||
|
|||||||
@@ -35,7 +35,7 @@ class Toilets(LocalFileSIGRefDataProvider):
|
|||||||
|
|
||||||
# Bail out if a stop has been requested, i.e. the program is shutting down - no need to parse the rest
|
# Bail out if a stop has been requested, i.e. the program is shutting down - no need to parse the rest
|
||||||
# of the data in this case
|
# of the data in this case
|
||||||
if self._stop:
|
if self._stop_event.is_set():
|
||||||
break
|
break
|
||||||
|
|
||||||
return new_data
|
return new_data
|
||||||
|
|||||||
@@ -67,11 +67,15 @@ class GIROIonosonde(SolarConditionsProvider):
|
|||||||
|
|
||||||
def start(self):
|
def start(self):
|
||||||
logger.info(f"Set up query of GIRO ionosonde data API every {POLL_INTERVAL} seconds.")
|
logger.info(f"Set up query of GIRO ionosonde data API every {POLL_INTERVAL} seconds.")
|
||||||
self._thread = Thread(target=self._run, name="GIROIonosondeDataProvider")
|
self._thread = Thread(target=self._run, name="GIROIonosondeDataProvider", daemon=True)
|
||||||
self._thread.start()
|
self._thread.start()
|
||||||
|
|
||||||
def stop(self):
|
def stop(self):
|
||||||
self._stop_event.set()
|
self._stop_event.set()
|
||||||
|
if self._thread:
|
||||||
|
self._thread.join(timeout=35)
|
||||||
|
if self._thread.is_alive():
|
||||||
|
logger.warning("GIRO ionosonde worker thread did not exit on time and will be killed.")
|
||||||
|
|
||||||
def _run(self):
|
def _run(self):
|
||||||
# Real interval at which we poll is the "once per hour" divided by the number of stations, so each one gets
|
# Real interval at which we poll is the "once per hour" divided by the number of stations, so each one gets
|
||||||
|
|||||||
@@ -25,11 +25,15 @@ class HTTPSolarConditionsProvider(SolarConditionsProvider):
|
|||||||
|
|
||||||
def start(self):
|
def start(self):
|
||||||
logger.info(f"Set up query of {self.name} solar conditions API every {self._poll_interval!s} seconds.")
|
logger.info(f"Set up query of {self.name} solar conditions API every {self._poll_interval!s} seconds.")
|
||||||
self._thread = Thread(target=self._run, name=f"HTTPSolarConditionsProvider-{self.name}")
|
self._thread = Thread(target=self._run, name=f"HTTPSolarConditionsProvider-{self.name}", daemon=True)
|
||||||
self._thread.start()
|
self._thread.start()
|
||||||
|
|
||||||
def stop(self):
|
def stop(self):
|
||||||
self._stop_event.set()
|
self._stop_event.set()
|
||||||
|
if self._thread:
|
||||||
|
self._thread.join(timeout=35)
|
||||||
|
if self._thread.is_alive():
|
||||||
|
logger.warning(f"{self.name} solar conditions worker thread did not exit on time and will be killed.")
|
||||||
|
|
||||||
def _run(self):
|
def _run(self):
|
||||||
while True:
|
while True:
|
||||||
|
|||||||
@@ -32,11 +32,15 @@ class KC2GProp(SolarConditionsProvider):
|
|||||||
|
|
||||||
def start(self):
|
def start(self):
|
||||||
logger.info(f"Set up query of KC2G ionosonde data API every {POLL_INTERVAL} seconds.")
|
logger.info(f"Set up query of KC2G ionosonde data API every {POLL_INTERVAL} seconds.")
|
||||||
self._thread = Thread(target=self._run, name="KC2GPropProvider")
|
self._thread = Thread(target=self._run, name="KC2GPropProvider", daemon=True)
|
||||||
self._thread.start()
|
self._thread.start()
|
||||||
|
|
||||||
def stop(self):
|
def stop(self):
|
||||||
self._stop_event.set()
|
self._stop_event.set()
|
||||||
|
if self._thread:
|
||||||
|
self._thread.join(timeout=35)
|
||||||
|
if self._thread.is_alive():
|
||||||
|
logger.warning("KC2G ionosonde worker thread did not exit on time and will be killed.")
|
||||||
|
|
||||||
def _run(self):
|
def _run(self):
|
||||||
while True:
|
while True:
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
import logging
|
import logging
|
||||||
from datetime import datetime
|
from datetime import datetime
|
||||||
from threading import Thread
|
from threading import Event, Thread
|
||||||
|
|
||||||
import aprslib
|
import aprslib
|
||||||
import pytz
|
import pytz
|
||||||
@@ -17,27 +17,44 @@ class APRSIS(SpotProvider):
|
|||||||
|
|
||||||
def __init__(self, provider_config):
|
def __init__(self, provider_config):
|
||||||
super().__init__("APRS-IS", provider_config)
|
super().__init__("APRS-IS", provider_config)
|
||||||
self._thread = Thread(target=self._connect, name="APRSISSpotProvider")
|
self._thread = None
|
||||||
self._thread.daemon = True
|
|
||||||
self._aprsis = None
|
self._aprsis = None
|
||||||
|
self._stop_event = Event()
|
||||||
|
|
||||||
def start(self):
|
def start(self):
|
||||||
|
self._thread = Thread(target=self._run, name="APRSISSpotProvider", daemon=True)
|
||||||
self._thread.start()
|
self._thread.start()
|
||||||
|
|
||||||
def _connect(self):
|
def _run(self):
|
||||||
|
while not self._stop_event.is_set():
|
||||||
|
try:
|
||||||
self._aprsis = aprslib.IS(SERVER_OWNER_CALLSIGN)
|
self._aprsis = aprslib.IS(SERVER_OWNER_CALLSIGN)
|
||||||
self.status = "Connecting"
|
self.status = "Connecting"
|
||||||
logger.info("APRS-IS connecting...")
|
logger.info("APRS-IS connecting...")
|
||||||
self._aprsis.connect()
|
self._aprsis.connect()
|
||||||
self._aprsis.consumer(self._handle)
|
|
||||||
logger.info("APRS-IS connected.")
|
logger.info("APRS-IS connected.")
|
||||||
|
self._aprsis.consumer(self._handle, immortal=True)
|
||||||
|
|
||||||
|
except Exception:
|
||||||
|
if not self._stop_event.is_set():
|
||||||
|
self.status = "Error"
|
||||||
|
logger.exception("Exception in APRS-IS provider")
|
||||||
|
|
||||||
|
if not self._stop_event.is_set():
|
||||||
|
self._stop_event.wait(timeout=5)
|
||||||
|
|
||||||
def stop(self):
|
def stop(self):
|
||||||
self.status = "Shutting down"
|
self.status = "Shutting down"
|
||||||
|
self._stop_event.set()
|
||||||
|
if self._aprsis:
|
||||||
self._aprsis.close()
|
self._aprsis.close()
|
||||||
self._thread.join()
|
if self._thread:
|
||||||
|
self._thread.join(timeout=15)
|
||||||
|
if self._thread.is_alive():
|
||||||
|
logger.warning("APRS-IS worker thread did not exit on time and will be killed.")
|
||||||
|
|
||||||
def _handle(self, data):
|
def _handle(self, data):
|
||||||
|
try:
|
||||||
# Split SSID in "from" call and store separately
|
# Split SSID in "from" call and store separately
|
||||||
from_parts = str(data["from"]).split("-")
|
from_parts = str(data["from"]).split("-")
|
||||||
dx_call = from_parts[0].upper()
|
dx_call = from_parts[0].upper()
|
||||||
@@ -63,3 +80,6 @@ class APRSIS(SpotProvider):
|
|||||||
self.status = "OK"
|
self.status = "OK"
|
||||||
self.last_update_time = datetime.now(pytz.UTC)
|
self.last_update_time = datetime.now(pytz.UTC)
|
||||||
logger.debug("Data received from APRS-IS.")
|
logger.debug("Data received from APRS-IS.")
|
||||||
|
|
||||||
|
except Exception:
|
||||||
|
logger.exception("Exception handling APRS-IS packet")
|
||||||
|
|||||||
+18
-16
@@ -1,8 +1,7 @@
|
|||||||
import logging
|
import logging
|
||||||
import re
|
import re
|
||||||
from datetime import datetime
|
from datetime import datetime
|
||||||
from threading import Thread
|
from threading import Event, Thread
|
||||||
from time import sleep
|
|
||||||
|
|
||||||
import pytz
|
import pytz
|
||||||
import telnetlib3
|
import telnetlib3
|
||||||
@@ -41,23 +40,26 @@ class DXCluster(SpotProvider):
|
|||||||
self._LINE_PATTERN_ALLOW_RBN if self._allow_rbn_spots else self._LINE_PATTERN_EXCLUDE_RBN
|
self._LINE_PATTERN_ALLOW_RBN if self._allow_rbn_spots else self._LINE_PATTERN_EXCLUDE_RBN
|
||||||
)
|
)
|
||||||
self._telnet = None
|
self._telnet = None
|
||||||
self._thread = Thread(target=self._handle, name=f"DXClusterSpotProvider-{self.name}")
|
self._thread = None
|
||||||
self._thread.daemon = True
|
self._stop_event = Event()
|
||||||
self._running = True
|
|
||||||
|
|
||||||
def start(self):
|
def start(self):
|
||||||
|
self._thread = Thread(target=self._handle, name=f"DXClusterSpotProvider-{self.name}", daemon=True)
|
||||||
self._thread.start()
|
self._thread.start()
|
||||||
|
|
||||||
def stop(self):
|
def stop(self):
|
||||||
self._running = False
|
self._stop_event.set()
|
||||||
if self._telnet:
|
if self._telnet:
|
||||||
self._telnet.close()
|
self._telnet.close()
|
||||||
self._thread.join()
|
if self._thread:
|
||||||
|
self._thread.join(timeout=15)
|
||||||
|
if self._thread.is_alive():
|
||||||
|
logger.warning(f"DX Cluster {self._hostname} worker thread did not exit on time and will be killed.")
|
||||||
|
|
||||||
def _handle(self):
|
def _handle(self):
|
||||||
while self._running:
|
while not self._stop_event.is_set():
|
||||||
connected = False
|
connected = False
|
||||||
while not connected and self._running:
|
while not connected and not self._stop_event.is_set():
|
||||||
try:
|
try:
|
||||||
self.status = "Connecting"
|
self.status = "Connecting"
|
||||||
logger.info(f"DX Cluster {self._hostname} connecting...")
|
logger.info(f"DX Cluster {self._hostname} connecting...")
|
||||||
@@ -69,14 +71,14 @@ class DXCluster(SpotProvider):
|
|||||||
except ConnectionRefusedError:
|
except ConnectionRefusedError:
|
||||||
self.status = "Error"
|
self.status = "Error"
|
||||||
logger.warning(f"Connection refused to DX cluster {self._hostname}")
|
logger.warning(f"Connection refused to DX cluster {self._hostname}")
|
||||||
sleep(300)
|
self._stop_event.wait(timeout=300)
|
||||||
except Exception:
|
except Exception:
|
||||||
self.status = "Error"
|
self.status = "Error"
|
||||||
logger.exception(f"Exception while connecting to DX Cluster Provider ({self._hostname}).")
|
logger.exception(f"Exception while connecting to DX Cluster Provider ({self._hostname}).")
|
||||||
sleep(5)
|
self._stop_event.wait(timeout=5)
|
||||||
|
|
||||||
self.status = "Waiting for Data"
|
self.status = "Waiting for Data"
|
||||||
while connected and self._running:
|
while connected and not self._stop_event.is_set():
|
||||||
try:
|
try:
|
||||||
# Check new telnet info against regular expression
|
# Check new telnet info against regular expression
|
||||||
telnet_output = self._telnet.read_until("\n".encode("latin-1"))
|
telnet_output = self._telnet.read_until("\n".encode("latin-1"))
|
||||||
@@ -106,19 +108,19 @@ class DXCluster(SpotProvider):
|
|||||||
|
|
||||||
except EOFError:
|
except EOFError:
|
||||||
connected = False
|
connected = False
|
||||||
if self._running:
|
if not self._stop_event.is_set():
|
||||||
self.status = "Restarting"
|
self.status = "Restarting"
|
||||||
logger.warning(f"Disconnected from DX Cluster {self._hostname}. Reconnecting...")
|
logger.warning(f"Disconnected from DX Cluster {self._hostname}. Reconnecting...")
|
||||||
sleep(5)
|
self._stop_event.wait(timeout=5)
|
||||||
else:
|
else:
|
||||||
logger.info(f"DX Cluster {self._hostname} shutting down...")
|
logger.info(f"DX Cluster {self._hostname} shutting down...")
|
||||||
self.status = "Shutting down"
|
self.status = "Shutting down"
|
||||||
except Exception:
|
except Exception:
|
||||||
connected = False
|
connected = False
|
||||||
if self._running:
|
if not self._stop_event.is_set():
|
||||||
self.status = "Error"
|
self.status = "Error"
|
||||||
logger.exception(f"Exception in DX Cluster Provider ({self._hostname})")
|
logger.exception(f"Exception in DX Cluster Provider ({self._hostname})")
|
||||||
sleep(5)
|
self._stop_event.wait(timeout=5)
|
||||||
else:
|
else:
|
||||||
logger.info(f"DX Cluster {self._hostname} shutting down...")
|
logger.info(f"DX Cluster {self._hostname} shutting down...")
|
||||||
self.status = "Shutting down"
|
self.status = "Shutting down"
|
||||||
|
|||||||
@@ -28,12 +28,16 @@ class HTTPSpotProvider(SpotProvider):
|
|||||||
# Fire off the polling thread. It will poll immediately on startup, then sleep for poll_interval between
|
# Fire off the polling thread. It will poll immediately on startup, then sleep for poll_interval between
|
||||||
# subsequent polls, so start() returns immediately and the application can continue starting.
|
# subsequent polls, so start() returns immediately and the application can continue starting.
|
||||||
logger.info(f"Set up query of {self.name} spot API every {self._poll_interval!s} seconds.")
|
logger.info(f"Set up query of {self.name} spot API every {self._poll_interval!s} seconds.")
|
||||||
self._thread = Thread(target=self._run, name=f"HTTPSpotProvider-{self.name}")
|
self._thread = Thread(target=self._run, name=f"HTTPSpotProvider-{self.name}", daemon=True)
|
||||||
self._thread.start()
|
self._thread.start()
|
||||||
|
|
||||||
def stop(self):
|
def stop(self):
|
||||||
self._stop_event.set()
|
self._stop_event.set()
|
||||||
self._wakeup_event.set()
|
self._wakeup_event.set()
|
||||||
|
if self._thread:
|
||||||
|
self._thread.join(timeout=35)
|
||||||
|
if self._thread.is_alive():
|
||||||
|
logger.warning(f"{self.name} spot worker thread did not exit on time and will be killed.")
|
||||||
|
|
||||||
def force_poll(self):
|
def force_poll(self):
|
||||||
"""Trigger an immediate poll without waiting for the normal interval."""
|
"""Trigger an immediate poll without waiting for the normal interval."""
|
||||||
|
|||||||
+17
-15
@@ -1,8 +1,7 @@
|
|||||||
import logging
|
import logging
|
||||||
import re
|
import re
|
||||||
from datetime import datetime
|
from datetime import datetime
|
||||||
from threading import Thread
|
from threading import Event, Thread
|
||||||
from time import sleep
|
|
||||||
|
|
||||||
import pytz
|
import pytz
|
||||||
import telnetlib3
|
import telnetlib3
|
||||||
@@ -30,23 +29,26 @@ class RBN(SpotProvider):
|
|||||||
super().__init__(name, provider_config)
|
super().__init__(name, provider_config)
|
||||||
self._port = provider_config["port"]
|
self._port = provider_config["port"]
|
||||||
self._telnet = None
|
self._telnet = None
|
||||||
self._thread = Thread(target=self._handle, name=f"RBNSpotProvider-{self.name}")
|
self._thread = None
|
||||||
self._thread.daemon = True
|
self._stop_event = Event()
|
||||||
self._running = True
|
|
||||||
|
|
||||||
def start(self):
|
def start(self):
|
||||||
|
self._thread = Thread(target=self._handle, name=f"RBNSpotProvider-{self.name}", daemon=True)
|
||||||
self._thread.start()
|
self._thread.start()
|
||||||
|
|
||||||
def stop(self):
|
def stop(self):
|
||||||
self._running = False
|
self._stop_event.set()
|
||||||
if self._telnet:
|
if self._telnet:
|
||||||
self._telnet.close()
|
self._telnet.close()
|
||||||
self._thread.join()
|
if self._thread:
|
||||||
|
self._thread.join(timeout=15)
|
||||||
|
if self._thread.is_alive():
|
||||||
|
logger.warning(f"RBN (port {self._port!s}) worker thread did not exit on time and will be killed.")
|
||||||
|
|
||||||
def _handle(self):
|
def _handle(self):
|
||||||
while self._running:
|
while not self._stop_event.is_set():
|
||||||
connected = False
|
connected = False
|
||||||
while not connected and self._running:
|
while not connected and not self._stop_event.is_set():
|
||||||
try:
|
try:
|
||||||
self.status = "Connecting"
|
self.status = "Connecting"
|
||||||
logger.info(f"RBN port {self._port!s} connecting...")
|
logger.info(f"RBN port {self._port!s} connecting...")
|
||||||
@@ -58,10 +60,10 @@ class RBN(SpotProvider):
|
|||||||
except Exception:
|
except Exception:
|
||||||
self.status = "Error"
|
self.status = "Error"
|
||||||
logger.exception(f"Exception while connecting to RBN (port {self._port!s}).")
|
logger.exception(f"Exception while connecting to RBN (port {self._port!s}).")
|
||||||
sleep(5)
|
self._stop_event.wait(timeout=5)
|
||||||
|
|
||||||
self.status = "Waiting for Data"
|
self.status = "Waiting for Data"
|
||||||
while connected and self._running:
|
while connected and not self._stop_event.is_set():
|
||||||
try:
|
try:
|
||||||
# Check new telnet info against regular expression
|
# Check new telnet info against regular expression
|
||||||
telnet_output = self._telnet.read_until("\n".encode("latin-1"))
|
telnet_output = self._telnet.read_until("\n".encode("latin-1"))
|
||||||
@@ -91,19 +93,19 @@ class RBN(SpotProvider):
|
|||||||
|
|
||||||
except EOFError:
|
except EOFError:
|
||||||
connected = False
|
connected = False
|
||||||
if self._running:
|
if not self._stop_event.is_set():
|
||||||
self.status = "Restarting"
|
self.status = "Restarting"
|
||||||
logger.warning(f"Disconnected from RBN provider (port {self._port!s}). Reconnecting...")
|
logger.warning(f"Disconnected from RBN provider (port {self._port!s}). Reconnecting...")
|
||||||
sleep(5)
|
self._stop_event.wait(timeout=5)
|
||||||
else:
|
else:
|
||||||
logger.info(f"RBN provider (port {self._port!s}) shutting down...")
|
logger.info(f"RBN provider (port {self._port!s}) shutting down...")
|
||||||
self.status = "Shutting down"
|
self.status = "Shutting down"
|
||||||
except Exception:
|
except Exception:
|
||||||
connected = False
|
connected = False
|
||||||
if self._running:
|
if not self._stop_event.is_set():
|
||||||
self.status = "Error"
|
self.status = "Error"
|
||||||
logger.exception(f"Exception in RBN provider (port {self._port!s})")
|
logger.exception(f"Exception in RBN provider (port {self._port!s})")
|
||||||
sleep(5)
|
self._stop_event.wait(timeout=5)
|
||||||
else:
|
else:
|
||||||
logger.info(f"RBN provider (port {self._port!s}) shutting down...")
|
logger.info(f"RBN provider (port {self._port!s}) shutting down...")
|
||||||
self.status = "Shutting down"
|
self.status = "Shutting down"
|
||||||
|
|||||||
@@ -1,7 +1,6 @@
|
|||||||
import logging
|
import logging
|
||||||
from datetime import datetime
|
from datetime import datetime
|
||||||
from threading import Thread
|
from threading import Event, Thread
|
||||||
from time import sleep
|
|
||||||
|
|
||||||
import pytz
|
import pytz
|
||||||
from websocket import create_connection
|
from websocket import create_connection
|
||||||
@@ -20,22 +19,24 @@ class WebsocketSpotProvider(SpotProvider):
|
|||||||
self._url = url
|
self._url = url
|
||||||
self._ws = None
|
self._ws = None
|
||||||
self._thread = None
|
self._thread = None
|
||||||
self._stopped = False
|
self._stop_event = Event()
|
||||||
self._last_event_id = None
|
self._last_event_id = None
|
||||||
|
|
||||||
def start(self):
|
def start(self):
|
||||||
logger.info(f"Set up websocket connection to {self.name} spot API.")
|
logger.info(f"Set up websocket connection to {self.name} spot API.")
|
||||||
self._stopped = False
|
self._stop_event.clear()
|
||||||
self._thread = Thread(target=self._run, name=f"WebsocketSpotProvider-{self.name}")
|
self._thread = Thread(target=self._run, name=f"WebsocketSpotProvider-{self.name}")
|
||||||
self._thread.daemon = True
|
self._thread.daemon = True
|
||||||
self._thread.start()
|
self._thread.start()
|
||||||
|
|
||||||
def stop(self):
|
def stop(self):
|
||||||
self._stopped = True
|
self._stop_event.set()
|
||||||
if self._ws:
|
if self._ws:
|
||||||
self._ws.close()
|
self._ws.close()
|
||||||
if self._thread:
|
if self._thread:
|
||||||
self._thread.join()
|
self._thread.join(timeout=15)
|
||||||
|
if self._thread.is_alive():
|
||||||
|
logger.warning(f"{self.name} websocket worker thread did not exit on time and will be killed.")
|
||||||
|
|
||||||
def _on_open(self):
|
def _on_open(self):
|
||||||
self.status = "Waiting for Data"
|
self.status = "Waiting for Data"
|
||||||
@@ -44,14 +45,19 @@ class WebsocketSpotProvider(SpotProvider):
|
|||||||
self.status = "Connecting"
|
self.status = "Connecting"
|
||||||
|
|
||||||
def _run(self):
|
def _run(self):
|
||||||
while not self._stopped:
|
while not self._stop_event.is_set():
|
||||||
try:
|
try:
|
||||||
logger.debug(f"Connecting to {self.name} spot API...")
|
logger.debug(f"Connecting to {self.name} spot API...")
|
||||||
self.status = "Connecting"
|
self.status = "Connecting"
|
||||||
self._ws = create_connection(self._url, header=HTTP_HEADERS)
|
self._ws = create_connection(self._url, header=HTTP_HEADERS)
|
||||||
self.status = "Connected"
|
self.status = "Connected"
|
||||||
|
|
||||||
|
# Keep reading from this same connection until it drops or we're asked to stop, rather than
|
||||||
|
# reconnecting for every message.
|
||||||
|
while not self._stop_event.is_set():
|
||||||
data = self._ws.recv()
|
data = self._ws.recv()
|
||||||
if data:
|
if not data:
|
||||||
|
break
|
||||||
try:
|
try:
|
||||||
new_spot = self._ws_message_to_spot(data)
|
new_spot = self._ws_message_to_spot(data)
|
||||||
if new_spot:
|
if new_spot:
|
||||||
@@ -69,7 +75,16 @@ class WebsocketSpotProvider(SpotProvider):
|
|||||||
logger.exception(f"Exception in Websocket Spot Provider ({self.name})")
|
logger.exception(f"Exception in Websocket Spot Provider ({self.name})")
|
||||||
else:
|
else:
|
||||||
self.status = "Disconnected"
|
self.status = "Disconnected"
|
||||||
sleep(5) # Wait before trying to reconnect
|
finally:
|
||||||
|
if self._ws:
|
||||||
|
try:
|
||||||
|
self._ws.close()
|
||||||
|
except Exception:
|
||||||
|
# No problem, we were getting rid of this object anyway.
|
||||||
|
pass
|
||||||
|
self._ws = None
|
||||||
|
if not self._stop_event.is_set():
|
||||||
|
self._stop_event.wait(timeout=5) # Wait before trying to reconnect
|
||||||
|
|
||||||
def _ws_message_to_spot(self, b):
|
def _ws_message_to_spot(self, b):
|
||||||
"""Convert a WS message received from the API into a spot. The exact message data (in bytes) is provided here so the
|
"""Convert a WS message received from the API into a spot. The exact message data (in bytes) is provided here so the
|
||||||
|
|||||||
@@ -29,11 +29,15 @@ class FileDownloadStaticDataProvider(StaticDataProvider):
|
|||||||
# Fire off the polling thread. It will poll immediately on startup, then sleep for poll_interval between
|
# Fire off the polling thread. It will poll immediately on startup, then sleep for poll_interval between
|
||||||
# subsequent polls, so start() returns immediately and the application can continue starting.
|
# subsequent polls, so start() returns immediately and the application can continue starting.
|
||||||
logger.info(f"Set up query of {self.name} static reference data every {self._poll_interval!s} days.")
|
logger.info(f"Set up query of {self.name} static reference data every {self._poll_interval!s} days.")
|
||||||
self._thread = Thread(target=self._run, name=f"FileDownloadStaticDataProvider-{self.name}")
|
self._thread = Thread(target=self._run, name=f"FileDownloadStaticDataProvider-{self.name}", daemon=True)
|
||||||
self._thread.start()
|
self._thread.start()
|
||||||
|
|
||||||
def stop(self):
|
def stop(self):
|
||||||
self._stop_event.set()
|
self._stop_event.set()
|
||||||
|
if self._thread:
|
||||||
|
self._thread.join(timeout=35)
|
||||||
|
if self._thread.is_alive():
|
||||||
|
logger.warning(f"{self.name} static data worker thread did not exit on time and will be killed.")
|
||||||
|
|
||||||
def _run(self):
|
def _run(self):
|
||||||
while True:
|
while True:
|
||||||
|
|||||||
+1
-1
@@ -1,6 +1,6 @@
|
|||||||
[project]
|
[project]
|
||||||
name = "spothole"
|
name = "spothole"
|
||||||
version = "2.1-pre"
|
version = "2.1"
|
||||||
authors = [
|
authors = [
|
||||||
{ name = "Ian Renton", email = "ian@ianrenton.com" },
|
{ name = "Ian Renton", email = "ian@ianrenton.com" },
|
||||||
]
|
]
|
||||||
|
|||||||
+24
-7
@@ -5,25 +5,35 @@ import signal
|
|||||||
import sys
|
import sys
|
||||||
|
|
||||||
from core.cleanup import CLEANUP_TIMER
|
from core.cleanup import CLEANUP_TIMER
|
||||||
from core.config import LOG_LEVEL, SERVER_OWNER_CALLSIGN
|
from core.config import LOG_LEVEL, SERVER_OWNER_CALLSIGN, TELNET_SERVER_ENABLED, TELNET_SERVER_PORT
|
||||||
from core.constants import SOFTWARE_VERSION
|
from core.constants import SOFTWARE_VERSION
|
||||||
from core.data_providers import DATA_PROVIDERS
|
from core.data_providers import DATA_PROVIDERS
|
||||||
from core.data_store import DATA_STORE
|
from core.data_store import DATA_STORE
|
||||||
from core.status_reporter import StatusReporter
|
from core.status_reporter import StatusReporter
|
||||||
from server.webserver import WEB_SERVER
|
from telnetserver.telnetserver import TELNET_SERVER
|
||||||
|
from webserver.webserver import WEB_SERVER
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
_shutdown_in_progress = False
|
||||||
|
|
||||||
|
|
||||||
def shutdown(_signum=None, _frame=None):
|
def shutdown(_signum=None, _frame=None):
|
||||||
"""Shutdown function"""
|
"""Shutdown function"""
|
||||||
|
|
||||||
|
# Check if this is the second time a shutdown was asked for, if so immediately kill the program.
|
||||||
|
global _shutdown_in_progress
|
||||||
|
if _shutdown_in_progress:
|
||||||
|
os._exit(1)
|
||||||
|
_shutdown_in_progress = True
|
||||||
|
|
||||||
logger.info("Stopping program...")
|
logger.info("Stopping program...")
|
||||||
WEB_SERVER.stop()
|
WEB_SERVER.stop()
|
||||||
|
TELNET_SERVER.stop()
|
||||||
DATA_PROVIDERS.stop()
|
DATA_PROVIDERS.stop()
|
||||||
CLEANUP_TIMER.stop()
|
CLEANUP_TIMER.stop()
|
||||||
DATA_STORE.close()
|
DATA_STORE.close()
|
||||||
os._exit(0)
|
logger.info("Stopped.")
|
||||||
|
|
||||||
|
|
||||||
# Main function
|
# Main function
|
||||||
@@ -41,8 +51,9 @@ if __name__ == "__main__":
|
|||||||
logger.info("Starting...")
|
logger.info("Starting...")
|
||||||
logger.info(f"This is Spothole version {SOFTWARE_VERSION}. This instance is run by {SERVER_OWNER_CALLSIGN}.")
|
logger.info(f"This is Spothole version {SOFTWARE_VERSION}. This instance is run by {SERVER_OWNER_CALLSIGN}.")
|
||||||
|
|
||||||
# Shut down gracefully on SIGINT
|
# Shut down gracefully on SIGINT or SIGTERM
|
||||||
signal.signal(signal.SIGINT, shutdown)
|
signal.signal(signal.SIGINT, shutdown)
|
||||||
|
signal.signal(signal.SIGTERM, shutdown)
|
||||||
|
|
||||||
# Set up data store
|
# Set up data store
|
||||||
DATA_STORE.setup()
|
DATA_STORE.setup()
|
||||||
@@ -57,10 +68,16 @@ if __name__ == "__main__":
|
|||||||
status_reporter = StatusReporter(run_interval=5)
|
status_reporter = StatusReporter(run_interval=5)
|
||||||
status_reporter.start()
|
status_reporter.start()
|
||||||
|
|
||||||
|
# Run the telnet server
|
||||||
|
if TELNET_SERVER_ENABLED:
|
||||||
|
TELNET_SERVER.start(port=TELNET_SERVER_PORT)
|
||||||
|
|
||||||
# Set up the web server
|
# Set up the web server
|
||||||
WEB_SERVER.setup()
|
WEB_SERVER.setup()
|
||||||
|
|
||||||
# Run the web server. This is the blocking call that keeps the application running in the main thread, so this must
|
# Run the web server
|
||||||
# be the last thing we do. web_server.stop() triggers an await condition in the web server which finishes the main
|
|
||||||
# thread.
|
|
||||||
WEB_SERVER.start()
|
WEB_SERVER.start()
|
||||||
|
|
||||||
|
# Block the main thread until a termination signal arrives and shutdown() is running.
|
||||||
|
while not _shutdown_in_progress:
|
||||||
|
signal.pause()
|
||||||
|
|||||||
@@ -17,7 +17,7 @@ info:
|
|||||||
|
|
||||||
### 2.1
|
### 2.1
|
||||||
|
|
||||||
* Added DTMBA, FEA, BIWOTA, COTA & PGA SIGs
|
* Added AMSAT, EME, DTMBA, FEA, BIWOTA, COTA & PGA SIGs
|
||||||
* Removed the distinction between LSB & USB (both will now show as SSB) and between the various digital voice modes, which will now show as DV.
|
* Removed the distinction between LSB & USB (both will now show as SSB) and between the various digital voice modes, which will now show as DV.
|
||||||
* Added `sig_type`, `icon`, `region_flag` and `refs_globally_unique` to SIG data
|
* Added `sig_type`, `icon`, `region_flag` and `refs_globally_unique` to SIG data
|
||||||
* Added `icon` to spot and alert data
|
* Added `icon` to spot and alert data
|
||||||
@@ -25,6 +25,8 @@ info:
|
|||||||
* Added `contests_skip_max_duration_check` to alert query parameters
|
* Added `contests_skip_max_duration_check` to alert query parameters
|
||||||
* SIG reference types (e.g. "Park") are now capitalised to match other enums
|
* SIG reference types (e.g. "Park") are now capitalised to match other enums
|
||||||
* Added the ability to get only certain fields of spots and alerts from the API by using the `fields` query parameter.
|
* Added the ability to get only certain fields of spots and alerts from the API by using the `fields` query parameter.
|
||||||
|
* Replace `last_page_access` with `page_requests_per_hour` and `last_api_access` with `api_requests_per_hour` in the web server stats.
|
||||||
|
* Added `sse_client_count` to the `webserver` stats, and a new `telnet` object with `client_count`.
|
||||||
|
|
||||||
### 2.0
|
### 2.0
|
||||||
|
|
||||||
@@ -899,7 +901,12 @@ components:
|
|||||||
- WAB
|
- WAB
|
||||||
- WAI
|
- WAI
|
||||||
- DME
|
- DME
|
||||||
|
- DMF
|
||||||
- FEA
|
- FEA
|
||||||
|
- DMUE
|
||||||
|
- DMVE
|
||||||
|
- DCE
|
||||||
|
- DEFE
|
||||||
- DTMBA
|
- DTMBA
|
||||||
- BIWOTA
|
- BIWOTA
|
||||||
- COTA
|
- COTA
|
||||||
@@ -2100,14 +2107,25 @@ components:
|
|||||||
type: string
|
type: string
|
||||||
description: The status of the web server
|
description: The status of the web server
|
||||||
example: OK
|
example: OK
|
||||||
last_page_access:
|
page_requests_per_hour:
|
||||||
type: number
|
type: integer
|
||||||
description: The last time a page was accessed on the web server, UTC seconds since UNIX epoch.
|
description: The number of page requests handled by the web server in the last hour
|
||||||
example: 1759579508
|
example: 123
|
||||||
last_api_access:
|
api_requests_per_hour:
|
||||||
type: number
|
type: integer
|
||||||
description: The last time an API endpoint was accessed on the web server, UTC seconds since UNIX epoch.
|
description: The number of API requests handled by the web server in the last hour
|
||||||
example: 1759579508
|
example: 123
|
||||||
|
sse_client_count:
|
||||||
|
type: integer
|
||||||
|
description: The number of clients currently connected to SSE streams
|
||||||
|
example: 5
|
||||||
|
"telnet":
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
client_count:
|
||||||
|
type: integer
|
||||||
|
description: The number of clients currently connected to the telnet server
|
||||||
|
example: 2
|
||||||
spot_providers:
|
spot_providers:
|
||||||
type: array
|
type: array
|
||||||
description: An array of all the spot providers.
|
description: An array of all the spot providers.
|
||||||
|
|||||||
+35
-11
@@ -54,7 +54,7 @@ function updateTable() {
|
|||||||
const showDX = $("#tableShowDX")[0].checked;
|
const showDX = $("#tableShowDX")[0].checked;
|
||||||
const showFreqsModes = $("#tableShowFreqsModes")[0].checked;
|
const showFreqsModes = $("#tableShowFreqsModes")[0].checked;
|
||||||
const showComment = $("#tableShowComment")[0].checked;
|
const showComment = $("#tableShowComment")[0].checked;
|
||||||
const showSource = $("#tableShowSource")[0].checked;
|
const showType = $("#tableShowType")[0].checked;
|
||||||
const showRef = $("#tableShowRef")[0].checked;
|
const showRef = $("#tableShowRef")[0].checked;
|
||||||
|
|
||||||
// Populate table with headers
|
// Populate table with headers
|
||||||
@@ -75,8 +75,8 @@ function updateTable() {
|
|||||||
if (showComment) {
|
if (showComment) {
|
||||||
table.find('thead tr').append(`<th class='bg-primary-subtle hideonmobile'>Comment</th>`);
|
table.find('thead tr').append(`<th class='bg-primary-subtle hideonmobile'>Comment</th>`);
|
||||||
}
|
}
|
||||||
if (showSource) {
|
if (showType) {
|
||||||
table.find('thead tr').append(`<th class='bg-primary-subtle hideonmobile'>Source</th>`);
|
table.find('thead tr').append(`<th class='bg-primary-subtle hideonmobile'>Type</th>`);
|
||||||
}
|
}
|
||||||
if (showRef) {
|
if (showRef) {
|
||||||
table.find('thead tr').append(`<th class='bg-primary-subtle hideonmobile'>Ref.</th>`);
|
table.find('thead tr').append(`<th class='bg-primary-subtle hideonmobile'>Ref.</th>`);
|
||||||
@@ -151,7 +151,7 @@ function addAlertRowsToTable(tbody, alerts) {
|
|||||||
const showDX = $("#tableShowDX")[0].checked;
|
const showDX = $("#tableShowDX")[0].checked;
|
||||||
const showFreqsModes = $("#tableShowFreqsModes")[0].checked;
|
const showFreqsModes = $("#tableShowFreqsModes")[0].checked;
|
||||||
const showComment = $("#tableShowComment")[0].checked;
|
const showComment = $("#tableShowComment")[0].checked;
|
||||||
const showSource = $("#tableShowSource")[0].checked;
|
const showType = $("#tableShowType")[0].checked;
|
||||||
const showRef = $("#tableShowRef")[0].checked;
|
const showRef = $("#tableShowRef")[0].checked;
|
||||||
|
|
||||||
// Get times for the alert, and convert to local time if necessary.
|
// Get times for the alert, and convert to local time if necessary.
|
||||||
@@ -232,14 +232,38 @@ function addAlertRowsToTable(tbody, alerts) {
|
|||||||
if (a["comment"] != null) {
|
if (a["comment"] != null) {
|
||||||
commentText = escapeHtml(a["comment"]);
|
commentText = escapeHtml(a["comment"]);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Format extra text, like URL and attribution
|
||||||
|
let subComment = a["url"] != null || a["source"] === "NG3K" || a["source"] === "WA7BNM Contest Calendar";
|
||||||
|
if (subComment) {
|
||||||
|
let subCommentText = ""
|
||||||
if (a["url"] != null) {
|
if (a["url"] != null) {
|
||||||
commentText += ` <a href="${escapeHtml(a['url'])}" target="_new" style="text-decoration: none">🔗</a>`;
|
subCommentText += `<a href="${escapeHtml(a['url'])}" target="_new" style="text-decoration: none">More info</a>`;
|
||||||
|
}
|
||||||
|
if ((a["source"] === "NG3K" || a["source"] === "WA7BNM Contest Calendar")) {
|
||||||
|
if (subCommentText !== "") {
|
||||||
|
subCommentText += " | ";
|
||||||
|
}
|
||||||
|
subCommentText += `From ${a["source"]}`;
|
||||||
|
}
|
||||||
|
commentText += `<div class="mt-2 small text-secondary">${subCommentText}</div>`;
|
||||||
}
|
}
|
||||||
|
|
||||||
// Sig or fallback to source
|
|
||||||
let sigSourceText = a["source"];
|
// Type, SIG or fallback to source
|
||||||
|
let sigTypeText = a["source"];
|
||||||
|
if (a["alert_type"] === "CONTEST") {
|
||||||
|
sigTypeText = "Contest";
|
||||||
|
} else if (a["alert_type"] === "DXPEDITION") {
|
||||||
|
sigTypeText = "DXpedition";
|
||||||
|
} else if (a["alert_type"] === "SATELLITE") {
|
||||||
|
sigTypeText = "Satellite";
|
||||||
|
} else if (a["alert_type"] === "XOTA") {
|
||||||
if (a["sig"]) {
|
if (a["sig"]) {
|
||||||
sigSourceText = a["sig"];
|
sigTypeText = a["sig"];
|
||||||
|
} else {
|
||||||
|
sigTypeText = "xOTA";
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Format sig_refs
|
// Format sig_refs
|
||||||
@@ -272,8 +296,8 @@ function addAlertRowsToTable(tbody, alerts) {
|
|||||||
if (showComment) {
|
if (showComment) {
|
||||||
$tr.append(`<td class='hideonmobile'>${commentText}</td>`);
|
$tr.append(`<td class='hideonmobile'>${commentText}</td>`);
|
||||||
}
|
}
|
||||||
if (showSource) {
|
if (showType) {
|
||||||
$tr.append(`<td class='nowrap hideonmobile'><span class='icon-wrapper'><i class='fa-solid ${a["icon"]}'></i></span> ${sigSourceText}</td>`);
|
$tr.append(`<td class='nowrap hideonmobile'><span class='icon-wrapper'><i class='fa-solid ${a["icon"]}'></i></span> ${sigTypeText}</td>`);
|
||||||
}
|
}
|
||||||
if (showRef) {
|
if (showRef) {
|
||||||
$tr.append(`<td class='hideonmobile'>${sig_refs}</td>`);
|
$tr.append(`<td class='hideonmobile'>${sig_refs}</td>`);
|
||||||
@@ -290,7 +314,7 @@ function addAlertRowsToTable(tbody, alerts) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
const $td2 = $("<td colspan='100'>");
|
const $td2 = $("<td colspan='100'>");
|
||||||
if (showSource) {
|
if (showType) {
|
||||||
$td2.append(`<span class='icon-wrapper'><i class='fa-solid ${a["icon"]}'></i></span> `);
|
$td2.append(`<span class='icon-wrapper'><i class='fa-solid ${a["icon"]}'></i></span> `);
|
||||||
}
|
}
|
||||||
if (showRef) {
|
if (showRef) {
|
||||||
|
|||||||
@@ -538,6 +538,15 @@ function displayIntroBox() {
|
|||||||
$("#intro-box-dismiss").click(function () {
|
$("#intro-box-dismiss").click(function () {
|
||||||
localStorage.setItem("intro-box-dismissed", true);
|
localStorage.setItem("intro-box-dismissed", true);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
// Do the same with the "telnet" intro box, but only show it if the user has dismissed the normal intro box once,
|
||||||
|
// to avoid two boxes on first page load.
|
||||||
|
if (localStorage.getItem("intro-box-telnet-dismissed") == null && localStorage.getItem("intro-box-dismissed") != null) {
|
||||||
|
$("#intro-box-telnet").show();
|
||||||
|
}
|
||||||
|
$("#intro-box-telnet-dismiss").click(function () {
|
||||||
|
localStorage.setItem("intro-box-telnet-dismissed", true);
|
||||||
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
// Mark a callsign-band-mode combination as worked (or unmark it). Persist this to localStorage.
|
// Mark a callsign-band-mode combination as worked (or unmark it). Persist this to localStorage.
|
||||||
|
|||||||
+4
-2
@@ -9,8 +9,10 @@ function loadStatus() {
|
|||||||
$("#total-alerts").text(jsonData["num_alerts"]);
|
$("#total-alerts").text(jsonData["num_alerts"]);
|
||||||
|
|
||||||
$("#web-server-status").text(jsonData["webserver"]["status"]);
|
$("#web-server-status").text(jsonData["webserver"]["status"]);
|
||||||
$("#web-server-last-api").text(moment.unix(jsonData["webserver"]["last_api_access"]).utc().fromNow());
|
$("#web-server-api-rate").text(jsonData["webserver"]["api_requests_per_hour"] + " / hour");
|
||||||
$("#web-server-last-page").text(moment.unix(jsonData["webserver"]["last_page_access"]).utc().fromNow());
|
$("#web-server-page-rate").text(jsonData["webserver"]["page_requests_per_hour"] + " / hour");
|
||||||
|
$("#web-server-sse-clients").text(jsonData["webserver"]["sse_client_count"]);
|
||||||
|
$("#telnet-server-clients").text(jsonData["telnet"]["client_count"]);
|
||||||
|
|
||||||
$("#cleanup-status").text(jsonData["cleanup"]["status"]);
|
$("#cleanup-status").text(jsonData["cleanup"]["status"]);
|
||||||
$("#cleanup-last-ran").text((jsonData["cleanup"]["last_ran"] > 0) ? moment.unix(jsonData["cleanup"]["last_ran"]).utc().fromNow() : "N/A");
|
$("#cleanup-last-ran").text((jsonData["cleanup"]["last_ran"] > 0) ? moment.unix(jsonData["cleanup"]["last_ran"]).utc().fromNow() : "N/A");
|
||||||
|
|||||||
@@ -0,0 +1,227 @@
|
|||||||
|
import asyncio
|
||||||
|
import logging
|
||||||
|
import threading
|
||||||
|
from datetime import datetime
|
||||||
|
|
||||||
|
import pytz
|
||||||
|
from pyhamtools import callinfo
|
||||||
|
|
||||||
|
from core.config import SERVER_OWNER_CALLSIGN
|
||||||
|
from core.constants import SOFTWARE_VERSION
|
||||||
|
from core.data_store import DATA_STORE
|
||||||
|
from data.spot import Spot
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
BANNER = (
|
||||||
|
"""
|
||||||
|
==
|
||||||
|
==== ##### ##### ####
|
||||||
|
== == ..### ..### ..###
|
||||||
|
== ###==######## ###### ####### .####### ###### .### ######
|
||||||
|
==###.. ..###..### ###..###...###. .###..### ###..### .### ###..###
|
||||||
|
==###.### .### .###.### .### .### .### .### .### .### .### .#######
|
||||||
|
== .###.###.### .###.### .### .### ### .### .### .### .### .### .###...
|
||||||
|
== ...### .####### ..###### ..##### #### #####..###### #####..######
|
||||||
|
== .###. .###=.. ...... ..... .... ..... ...... ..... ......
|
||||||
|
== %% ... %%%%###==
|
||||||
|
== %%%%%%%%%%%#####== \r\n"""
|
||||||
|
+ "== ..... =="
|
||||||
|
+ f"Welcome to Spothole v{SOFTWARE_VERSION}".rjust(56)
|
||||||
|
+ "\r\n"
|
||||||
|
+ "========================"
|
||||||
|
+ f"This server is run by {SERVER_OWNER_CALLSIGN}".rjust(56)
|
||||||
|
)
|
||||||
|
|
||||||
|
MOTD = (
|
||||||
|
"Spothole's telnet server is a new feature and may not work properly in all\r\n"
|
||||||
|
+ "loggers. Please give it a try in your logger of choice and let me know if it\r\n"
|
||||||
|
+ "(or doesn't!) Please note that DXSpider-like commands are not yet supported\r\n"
|
||||||
|
+ "so you are not yet able to filter spots server-side or log in at all."
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class TelnetServer:
|
||||||
|
"""A telnet server designed to provide spots in the same format as DXSpider, for compatibility with desktop loggers."""
|
||||||
|
|
||||||
|
def __init__(self):
|
||||||
|
self._port = None
|
||||||
|
self._running = False
|
||||||
|
self._clients = set()
|
||||||
|
self._loop = None
|
||||||
|
self._thread = None
|
||||||
|
self._shutdown_event = asyncio.Event()
|
||||||
|
|
||||||
|
def start(self, port=7373):
|
||||||
|
"""Starts the telnet server"""
|
||||||
|
|
||||||
|
self._port = port
|
||||||
|
|
||||||
|
# Start the telnet server. asyncio.run() needs a coroutine, and threading.Thread needs a plain callable, so
|
||||||
|
# hand Thread the bridge between the two directly rather than writing a one-line wrapper method for it.
|
||||||
|
self._thread = threading.Thread(
|
||||||
|
target=asyncio.run, args=(self._start_internal(),), name="TelnetServer", daemon=True
|
||||||
|
)
|
||||||
|
self._thread.start()
|
||||||
|
logger.debug("Telnet server background thread spawned")
|
||||||
|
|
||||||
|
# Listen for new spots and alerts being added to the cache, so we can notify SSE clients immediately
|
||||||
|
DATA_STORE.spots.add_listener(self.publish)
|
||||||
|
self._running = True
|
||||||
|
|
||||||
|
async def _start_internal(self):
|
||||||
|
"""Start method (async). Sets up the telnet server and waits for shutdown."""
|
||||||
|
|
||||||
|
self._loop = asyncio.get_running_loop()
|
||||||
|
|
||||||
|
server = await asyncio.start_server(self._handle_client, "0.0.0.0", self._port)
|
||||||
|
logger.info(f"Telnet server listening on port {self._port}")
|
||||||
|
async with server:
|
||||||
|
await self._shutdown_event.wait()
|
||||||
|
|
||||||
|
await self._stop_internal()
|
||||||
|
|
||||||
|
async def _handle_client(self, reader, writer):
|
||||||
|
"""Handles a new client connection"""
|
||||||
|
|
||||||
|
logger.debug("Telnet client connected")
|
||||||
|
self._clients.add(writer)
|
||||||
|
|
||||||
|
# Print banner and MOTD
|
||||||
|
try:
|
||||||
|
text = (
|
||||||
|
BANNER
|
||||||
|
+ "\r\n\r\n"
|
||||||
|
+ "================================================================================"
|
||||||
|
+ "\r\n"
|
||||||
|
+ MOTD
|
||||||
|
+ "\r\n"
|
||||||
|
+ "================================================================================"
|
||||||
|
+ "\r\n\r\n"
|
||||||
|
)
|
||||||
|
writer.write(text.encode("ascii"))
|
||||||
|
await writer.drain()
|
||||||
|
except Exception:
|
||||||
|
logger.exception("Exception printing telnet motd")
|
||||||
|
|
||||||
|
# Set up buffer for user input
|
||||||
|
input_buffer = ""
|
||||||
|
|
||||||
|
try:
|
||||||
|
# Read forever, picking out any commands. Currently we just support "exit"
|
||||||
|
while True:
|
||||||
|
data = await reader.read(1024)
|
||||||
|
if not data:
|
||||||
|
break
|
||||||
|
|
||||||
|
input_buffer, command = self._consume_input(input_buffer, data)
|
||||||
|
if command == "exit":
|
||||||
|
writer.write(b"Goodbye!\r\n")
|
||||||
|
await writer.drain()
|
||||||
|
# Exit the while read loop, this will disconnect the client.
|
||||||
|
return
|
||||||
|
|
||||||
|
except asyncio.CancelledError:
|
||||||
|
pass
|
||||||
|
except Exception:
|
||||||
|
logger.exception("Exception handling telnet client")
|
||||||
|
finally:
|
||||||
|
logger.debug("Telnet client disconnected")
|
||||||
|
self._clients.remove(writer)
|
||||||
|
writer.close()
|
||||||
|
await writer.wait_closed()
|
||||||
|
|
||||||
|
def stop(self):
|
||||||
|
"""Stops the telnet server"""
|
||||||
|
|
||||||
|
self._running = False
|
||||||
|
if self._loop and self._loop.is_running():
|
||||||
|
logger.debug("Stopping telnet server...")
|
||||||
|
self._loop.call_soon_threadsafe(self._shutdown_event.set)
|
||||||
|
if self._thread:
|
||||||
|
self._thread.join(timeout=15)
|
||||||
|
if self._thread.is_alive():
|
||||||
|
logger.warning("Telnet server background thread did not exit on time and will be killed.")
|
||||||
|
|
||||||
|
@property
|
||||||
|
def client_count(self) -> int:
|
||||||
|
return len(self._clients)
|
||||||
|
|
||||||
|
async def _stop_internal(self):
|
||||||
|
"""Stops the telnet server"""
|
||||||
|
|
||||||
|
for writer in list(self._clients):
|
||||||
|
try:
|
||||||
|
writer.close()
|
||||||
|
await writer.wait_closed()
|
||||||
|
except Exception:
|
||||||
|
pass
|
||||||
|
self._clients.clear()
|
||||||
|
|
||||||
|
def publish(self, spot: Spot):
|
||||||
|
"""Callback from the data store when a spot is added"""
|
||||||
|
|
||||||
|
if self._running and self._clients and self._loop and self._loop.is_running():
|
||||||
|
asyncio.run_coroutine_threadsafe(self._broadcast_spot_internal(spot), self._loop)
|
||||||
|
|
||||||
|
async def _broadcast_spot_internal(self, spot: Spot):
|
||||||
|
"""Internal version, run on async loop for thread safety?"""
|
||||||
|
|
||||||
|
# Ensure ASCII formatting for telnet clients
|
||||||
|
encoded_line = self._format_dxspider_spot(spot).encode("ascii", errors="ignore")
|
||||||
|
|
||||||
|
# Try to write to all clients, and in the process find the ones that are disconnected. Iterate over a copy
|
||||||
|
# since a new client can connect (mutating self._clients) while we're awaiting a write below.
|
||||||
|
disconnected_clients = set()
|
||||||
|
for writer in list(self._clients):
|
||||||
|
try:
|
||||||
|
writer.write(encoded_line)
|
||||||
|
await writer.drain()
|
||||||
|
except Exception:
|
||||||
|
disconnected_clients.add(writer)
|
||||||
|
|
||||||
|
# Clean up any disconnected connections caught during writing
|
||||||
|
for writer in disconnected_clients:
|
||||||
|
self._clients.discard(writer)
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def _consume_input(input_buffer: str, data: bytes) -> tuple[str, str | None]:
|
||||||
|
"""Handle any input the user gives us, keeping a rolling buffer that we keep passing back through and
|
||||||
|
adding to. Once we get a command, return that as well, so the caller can deal with it."""
|
||||||
|
|
||||||
|
command = None
|
||||||
|
for char in data.decode("ascii", errors="ignore"):
|
||||||
|
if char in ("\r", "\n"):
|
||||||
|
stripped = input_buffer.strip().lower()
|
||||||
|
if stripped:
|
||||||
|
command = stripped
|
||||||
|
input_buffer = ""
|
||||||
|
elif char in ("\b", "\x7f"):
|
||||||
|
# Handle backspaces
|
||||||
|
input_buffer = input_buffer[:-1]
|
||||||
|
else:
|
||||||
|
input_buffer += char
|
||||||
|
return input_buffer, command
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def _format_dxspider_spot(spot: Spot) -> str:
|
||||||
|
"""Formats a spot into the format DXspider uses:
|
||||||
|
DX de CALLSIGN: FREQUENCY DX_CALLSIGN COMMENTS TIME_UTC.
|
||||||
|
Always use the base call for the spotter to save space. Everything must align properly to parse in clients,
|
||||||
|
and everything must be renderable in ASCII."""
|
||||||
|
|
||||||
|
de_call = f"{callinfo.Callinfo.get_homecall(spot.de_call)[:6] + ':' if spot.de_call else '???:'!s:<7}"
|
||||||
|
frequency = f"{(spot.freq / 1000.0):10.1f}"
|
||||||
|
dx_call = f"{spot.dx_call!s:<12}"
|
||||||
|
comment = f"{spot.comment.encode('ascii', errors='ignore').decode()[:29]:<30}"
|
||||||
|
if spot.time:
|
||||||
|
timestamp = datetime.fromtimestamp(spot.time, tz=pytz.utc).strftime("%H%M") + "Z"
|
||||||
|
else:
|
||||||
|
timestamp = datetime.now(tz=pytz.utc).strftime("%H%M") + "Z"
|
||||||
|
|
||||||
|
# Combine into classic DXSpider output string followed by network line breaks
|
||||||
|
return f"DX de {de_call} {frequency} {dx_call} {comment} {timestamp}\r\n"
|
||||||
|
|
||||||
|
|
||||||
|
# Global object
|
||||||
|
TELNET_SERVER = TelnetServer()
|
||||||
+14
-2
@@ -34,6 +34,13 @@
|
|||||||
like. The usage is explained in more detail in the <a
|
like. The usage is explained in more detail in the <a
|
||||||
href="https://git.ianrenton.com/ian/spothole/src/branch/main/README.md">README file</a>.
|
href="https://git.ianrenton.com/ian/spothole/src/branch/main/README.md">README file</a>.
|
||||||
</li>
|
</li>
|
||||||
|
{% if telnet_server_enabled %}
|
||||||
|
<li>You can use it as a traditional telnet-based source of spots, similar to DXSpider and other software, <b>in
|
||||||
|
your desktop logging application</b>. To do this, set up your logger with the server address
|
||||||
|
<code>{{ telnet_server_address }}</code> and port <code>{{ telnet_server_port }}</code>. You can also access
|
||||||
|
it from a terminal with <code>telnet {{ telnet_server_address }} {{ telnet_server_port }}</code>.
|
||||||
|
</li>
|
||||||
|
{% end %}
|
||||||
<li>You can <b>write your own client using the Spothole API</b>, using the main Spothole instance to provide
|
<li>You can <b>write your own client using the Spothole API</b>, using the main Spothole instance to provide
|
||||||
data, and do whatever you like with it. The README contains guidance on how to do this, and the full API
|
data, and do whatever you like with it. The README contains guidance on how to do this, and the full API
|
||||||
docs are linked above. You can also find reference implementations in the form of Spothole's own web-based
|
docs are linked above. You can also find reference implementations in the form of Spothole's own web-based
|
||||||
@@ -85,7 +92,8 @@
|
|||||||
<p>Spothole can retrieve alerts from: <a href="https://www.ng3k.com/">NG3K</a>, <a href="https://pota.app">POTA</a>,
|
<p>Spothole can retrieve alerts from: <a href="https://www.ng3k.com/">NG3K</a>, <a href="https://pota.app">POTA</a>,
|
||||||
<a href="https://www.sota.org.uk/">SOTA</a>, <a href="https://wwff.co/">WWFF</a>, <a
|
<a href="https://www.sota.org.uk/">SOTA</a>, <a href="https://wwff.co/">WWFF</a>, <a
|
||||||
href="https://www.parksnpeaks.org/">Parks 'n' Peaks</a>, <a href="https://www.wota.org.uk/">WOTA</a> and
|
href="https://www.parksnpeaks.org/">Parks 'n' Peaks</a>, <a href="https://www.wota.org.uk/">WOTA</a> and
|
||||||
<a href="https://www.beachesontheair.com/">BOTA</a>.</p>
|
<a href="https://www.beachesontheair.com/">BOTA</a>. It also fetches contest dates from
|
||||||
|
<a href="https://contestcalendar.com/">WA7BNM Contest Calendar</a> and RSGB contest calendars.</p>
|
||||||
<p>Spothole can retrieve solar and propagation condition data from <a href="https://www.hamqsl.com">HamQSL</a>, the
|
<p>Spothole can retrieve solar and propagation condition data from <a href="https://www.hamqsl.com">HamQSL</a>, the
|
||||||
<a href="https://www.swpc.noaa.gov/">NOAA Space Weather Prediction Center</a>, the <a
|
<a href="https://www.swpc.noaa.gov/">NOAA Space Weather Prediction Center</a>, the <a
|
||||||
href="https://giro.uml.edu/">Lowell GIRO Data Center</a> and <a href="https://prop.kc2g.com/">prop.kc2g.com</a>
|
href="https://giro.uml.edu/">Lowell GIRO Data Center</a> and <a href="https://prop.kc2g.com/">prop.kc2g.com</a>
|
||||||
@@ -106,7 +114,7 @@
|
|||||||
Faros de España (FEA), Diploma Muesos de España (DMUE), Diploma Castillos de España (DCE), Diploma Monumentos y
|
Faros de España (FEA), Diploma Muesos de España (DMUE), Diploma Castillos de España (DCE), Diploma Monumentos y
|
||||||
Vestigios de España (DMVE), Diploma Estaciones de Ferrocarril de España (DEFE), Diploma Teatri Musei e Belle
|
Vestigios de España (DMVE), Diploma Estaciones de Ferrocarril de España (DEFE), Diploma Teatri Musei e Belle
|
||||||
Arti (DTMBA), British Inland Waterways on the Air (BIWOTA), Castles on the Air (COTA), Polish Gmina Award (PGA),
|
Arti (DTMBA), British Inland Waterways on the Air (BIWOTA), Castles on the Air (COTA), Polish Gmina Award (PGA),
|
||||||
and Toilets on the Air.</p>
|
Diplôme des Moulins de France (DMF), EME/Moonbounce, Amateur Satellite (AMSAT), and Toilets on the Air.</p>
|
||||||
<p>As of the time of writing in August 2026, I think Spothole captures most outdoor radio programmes that have a
|
<p>As of the time of writing in August 2026, I think Spothole captures most outdoor radio programmes that have a
|
||||||
defined, downloadable reference list, and almost certainly those that have a spotting/alerting API. If you know
|
defined, downloadable reference list, and almost certainly those that have a spotting/alerting API. If you know
|
||||||
of one I've missed, please let me know!</p>
|
of one I've missed, please let me know!</p>
|
||||||
@@ -162,6 +170,10 @@
|
|||||||
modify it however you like, you can claim you wrote it and charge people £1000 for a copy, I don't really mind.
|
modify it however you like, you can claim you wrote it and charge people £1000 for a copy, I don't really mind.
|
||||||
(Please don't do the last one. But if you're using my code for something cool, it would be nice to hear from
|
(Please don't do the last one. But if you're using my code for something cool, it would be nice to hear from
|
||||||
you!)</p>
|
you!)</p>
|
||||||
|
<h4 class="mt-4">What commands are supported in the telnet server?</h4>
|
||||||
|
<p>Currently, <code>exit</code>, and nothing else. Support for some DXSpider-like commands may be added to Spothole
|
||||||
|
in due course, but at the moment if you want to add Spothole as a telnet cluster data source to your desktop
|
||||||
|
logging application, that application must handle filtering itself.</p>
|
||||||
<h2 id="accuracy" class="mt-4">Data Accuracy</h2>
|
<h2 id="accuracy" class="mt-4">Data Accuracy</h2>
|
||||||
<p>Please note that the data coming out of Spothole is only as good as the data going in. People mis-hear and make
|
<p>Please note that the data coming out of Spothole is only as good as the data going in. People mis-hear and make
|
||||||
typos when spotting callsigns all the time. There are also plenty of cases where Spothole's data, particularly
|
typos when spotting callsigns all the time. There are also plenty of cases where Spothole's data, particularly
|
||||||
|
|||||||
@@ -77,7 +77,7 @@
|
|||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<script src="/static/js/add-spot.js?v=1789059482"></script>
|
<script src="/static/js/add-spot.js?v=1789731849"></script>
|
||||||
<script>$(document).ready(function () {
|
<script>$(document).ready(function () {
|
||||||
$("#nav-link-add-spot").addClass("active");
|
$("#nav-link-add-spot").addClass("active");
|
||||||
}); <!-- highlight active page in nav --></script>
|
}); <!-- highlight active page in nav --></script>
|
||||||
|
|||||||
@@ -83,7 +83,7 @@
|
|||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<script src="/static/js/alerts.js?v=1789059482"></script>
|
<script src="/static/js/alerts.js?v=1789731849"></script>
|
||||||
<script>$(document).ready(function () {
|
<script>$(document).ready(function () {
|
||||||
$("#nav-link-alerts").addClass("active");
|
$("#nav-link-alerts").addClass("active");
|
||||||
}); <!-- highlight active page in nav --></script>
|
}); <!-- highlight active page in nav --></script>
|
||||||
|
|||||||
@@ -76,8 +76,8 @@
|
|||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<script src="/static/js/spotsbandsandmap.js?v=1789059482"></script>
|
<script src="/static/js/spotsbandsandmap.js?v=1789731849"></script>
|
||||||
<script src="/static/js/bands.js?v=1789059482"></script>
|
<script src="/static/js/bands.js?v=1789731849"></script>
|
||||||
<script>$(document).ready(function () {
|
<script>$(document).ready(function () {
|
||||||
$("#nav-link-bands").addClass("active");
|
$("#nav-link-bands").addClass("active");
|
||||||
}); <!-- highlight active page in nav --></script>
|
}); <!-- highlight active page in nav --></script>
|
||||||
|
|||||||
+5
-5
@@ -1,6 +1,6 @@
|
|||||||
{% extends "skeleton.html" %}
|
{% extends "skeleton.html" %}
|
||||||
{% block head_extra %}
|
{% block head_extra %}
|
||||||
<link rel="stylesheet" href="/static/css/style.css?v=1789059482" type="text/css">
|
<link rel="stylesheet" href="/static/css/style.css?v=1789731849" type="text/css">
|
||||||
<link href="/static/vendor/css/bootstrap-5.3.8.min.css" rel="stylesheet">
|
<link href="/static/vendor/css/bootstrap-5.3.8.min.css" rel="stylesheet">
|
||||||
<link href="/static/vendor/css/fontawesome-6.7.2.min.css" rel="stylesheet">
|
<link href="/static/vendor/css/fontawesome-6.7.2.min.css" rel="stylesheet">
|
||||||
<link href="/static/vendor/css/solid-6.7.2.min.css" rel="stylesheet">
|
<link href="/static/vendor/css/solid-6.7.2.min.css" rel="stylesheet">
|
||||||
@@ -16,10 +16,10 @@
|
|||||||
window.fetchEventSource = fetchEventSource;
|
window.fetchEventSource = fetchEventSource;
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
<script src="/static/js/utils.js?v=1789059482"></script>
|
<script src="/static/js/utils.js?v=1789731849"></script>
|
||||||
<script src="/static/js/ui-ham.js?v=1789059482"></script>
|
<script src="/static/js/ui-ham.js?v=1789731849"></script>
|
||||||
<script src="/static/js/geo.js?v=1789059482"></script>
|
<script src="/static/js/geo.js?v=1789731849"></script>
|
||||||
<script src="/static/js/common.js?v=1789059482"></script>
|
<script src="/static/js/common.js?v=1789731849"></script>
|
||||||
{% end %}
|
{% end %}
|
||||||
{% block body %}
|
{% block body %}
|
||||||
<div class="container">
|
<div class="container">
|
||||||
|
|||||||
@@ -39,9 +39,9 @@
|
|||||||
</div>
|
</div>
|
||||||
<div class="col">
|
<div class="col">
|
||||||
<div class="form-check">
|
<div class="form-check">
|
||||||
<input class="form-check-input storeable-checkbox" type="checkbox" id="tableShowSource"
|
<input class="form-check-input storeable-checkbox" type="checkbox" id="tableShowType"
|
||||||
value="tableShowSource" oninput="columnsUpdated();" checked>
|
value="tableShowType" oninput="columnsUpdated();" checked>
|
||||||
<label class="form-check-label" for="tableShowSource">Source</label>
|
<label class="form-check-label" for="tableShowType">Source</label>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
<div class="col">
|
<div class="col">
|
||||||
|
|||||||
@@ -284,7 +284,7 @@
|
|||||||
</div>
|
</div>
|
||||||
|
|
||||||
<script src="/static/vendor/js/chart-4.4.9.umd.min.js"></script>
|
<script src="/static/vendor/js/chart-4.4.9.umd.min.js"></script>
|
||||||
<script src="/static/js/conditions.js?v=1789059482"></script>
|
<script src="/static/js/conditions.js?v=1789731849"></script>
|
||||||
<script>$(document).ready(function () {
|
<script>$(document).ready(function () {
|
||||||
$("#nav-link-conditions").addClass("active");
|
$("#nav-link-conditions").addClass("active");
|
||||||
}); <!-- highlight active page in nav --></script>
|
}); <!-- highlight active page in nav --></script>
|
||||||
|
|||||||
+2
-2
@@ -113,8 +113,8 @@
|
|||||||
const CARTODB_API_KEY = "{{ web_ui_options.get('cartodb_api_key', '') }}";
|
const CARTODB_API_KEY = "{{ web_ui_options.get('cartodb_api_key', '') }}";
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
<script src="/static/js/spotsbandsandmap.js?v=1789059482"></script>
|
<script src="/static/js/spotsbandsandmap.js?v=1789731849"></script>
|
||||||
<script src="/static/js/map.js?v=1789059482"></script>
|
<script src="/static/js/map.js?v=1789731849"></script>
|
||||||
<script>$(document).ready(function () {
|
<script>$(document).ready(function () {
|
||||||
$("#nav-link-map").addClass("active");
|
$("#nav-link-map").addClass("active");
|
||||||
}); <!-- highlight active page in nav --></script>
|
}); <!-- highlight active page in nav --></script>
|
||||||
|
|||||||
+14
-2
@@ -14,6 +14,18 @@
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
{% if telnet_server_enabled %}
|
||||||
|
<div id="intro-box-telnet" class="permanently-dismissible-box mt-3">
|
||||||
|
<div class="alert alert-primary alert-dismissible fade show" role="alert">
|
||||||
|
<i class="fa-solid fa-circle-info"></i> <strong>Spothole now has a telnet server!</strong><br/>If you'd like to
|
||||||
|
add Spothole as a source of data to your desktop logging application, now you can. Use server address
|
||||||
|
<code>{{ telnet_server_address }}</code> and port <code>{{ telnet_server_port }}</code>.
|
||||||
|
<button type="button" id="intro-box-telnet-dismiss" class="btn-close" data-bs-dismiss="alert"
|
||||||
|
aria-label="Close"></button>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
{% end %}
|
||||||
|
|
||||||
<div class="mt-3">
|
<div class="mt-3">
|
||||||
<div id="settingsButtonRow" class="row mb-3">
|
<div id="settingsButtonRow" class="row mb-3">
|
||||||
<div class="col-md-4 mb-3 mb-md-0">
|
<div class="col-md-4 mb-3 mb-md-0">
|
||||||
@@ -113,8 +125,8 @@
|
|||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<script src="/static/js/spotsbandsandmap.js?v=1789059482"></script>
|
<script src="/static/js/spotsbandsandmap.js?v=1789731849"></script>
|
||||||
<script src="/static/js/spots.js?v=1789059482"></script>
|
<script src="/static/js/spots.js?v=1789731849"></script>
|
||||||
<script>$(document).ready(function () {
|
<script>$(document).ready(function () {
|
||||||
$("#nav-link-spots").addClass("active");
|
$("#nav-link-spots").addClass("active");
|
||||||
}); <!-- highlight active page in nav --></script>
|
}); <!-- highlight active page in nav --></script>
|
||||||
|
|||||||
+13
-3
@@ -21,9 +21,19 @@
|
|||||||
<div class="row row-cols-1 row-cols-md-4 g-4 mb-4 mb-md-2">
|
<div class="row row-cols-1 row-cols-md-4 g-4 mb-4 mb-md-2">
|
||||||
<div class="col"><strong>Web Server</strong></div>
|
<div class="col"><strong>Web Server</strong></div>
|
||||||
<div class="col">Status: <span id="web-server-status"></span></div>
|
<div class="col">Status: <span id="web-server-status"></span></div>
|
||||||
<div class="col">Last API call: <span id="web-server-last-api"></span></div>
|
<div class="col">SSE clients connected: <span id="web-server-sse-clients"></span></div>
|
||||||
<div class="col">Last page req: <span id="web-server-last-page"></span></div>
|
|
||||||
</div>
|
</div>
|
||||||
|
<div class="row row-cols-1 row-cols-md-4 g-4 mb-4 mb-md-2">
|
||||||
|
<div class="col"></div>
|
||||||
|
<div class="col">API request rate: <span id="web-server-api-rate"></span></div>
|
||||||
|
<div class="col">Page request rate: <span id="web-server-page-rate"></span></div>
|
||||||
|
</div>
|
||||||
|
{% if telnet_server_enabled %}
|
||||||
|
<div class="row row-cols-1 row-cols-md-4 g-4 mb-4 mb-md-2">
|
||||||
|
<div class="col"><strong>Telnet Server</strong></div>
|
||||||
|
<div class="col">Clients connected: <span id="telnet-server-clients"></span></div>
|
||||||
|
</div>
|
||||||
|
{% end %}
|
||||||
<div class="row row-cols-1 row-cols-md-4 g-4 mb-2">
|
<div class="row row-cols-1 row-cols-md-4 g-4 mb-2">
|
||||||
<div class="col"><strong>Cleanup Service</strong></div>
|
<div class="col"><strong>Cleanup Service</strong></div>
|
||||||
<div class="col">Status: <span id="cleanup-status"></span></div>
|
<div class="col">Status: <span id="cleanup-status"></span></div>
|
||||||
@@ -86,7 +96,7 @@
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<script src="/static/js/status.js?v=1789059482"></script>
|
<script src="/static/js/status.js?v=1789731849"></script>
|
||||||
<script>
|
<script>
|
||||||
$(document).ready(function () {
|
$(document).ready(function () {
|
||||||
$("#nav-link-status").addClass("active");
|
$("#nav-link-status").addClass("active");
|
||||||
|
|||||||
@@ -1,10 +1,8 @@
|
|||||||
import logging
|
import logging
|
||||||
import re
|
import re
|
||||||
import threading
|
import threading
|
||||||
from datetime import datetime
|
|
||||||
from typing import Any
|
from typing import Any
|
||||||
|
|
||||||
import pytz
|
|
||||||
import requests
|
import requests
|
||||||
import tornado
|
import tornado
|
||||||
from tornado import httputil
|
from tornado import httputil
|
||||||
@@ -12,7 +10,6 @@ from tornado.web import Application
|
|||||||
|
|
||||||
from core.config import ALLOW_SPOTTING, ALLOW_UPSTREAM_SPOTTING, RECAPTCHA_SECRET_KEY
|
from core.config import ALLOW_SPOTTING, ALLOW_UPSTREAM_SPOTTING, RECAPTCHA_SECRET_KEY
|
||||||
from core.constants import UNKNOWN_BAND
|
from core.constants import UNKNOWN_BAND
|
||||||
from core.prometheus_metrics_handler import api_requests_counter
|
|
||||||
from core.sig_utils import get_ref_regex_for_sig
|
from core.sig_utils import get_ref_regex_for_sig
|
||||||
from core.utils import infer_band_from_freq, safe_json_dumps
|
from core.utils import infer_band_from_freq, safe_json_dumps
|
||||||
from data.spot import Spot
|
from data.spot import Spot
|
||||||
@@ -33,23 +30,15 @@ class APISpotHandler(tornado.web.RequestHandler):
|
|||||||
**kwargs: Any,
|
**kwargs: Any,
|
||||||
):
|
):
|
||||||
self._spots = None
|
self._spots = None
|
||||||
self._web_server_metrics = None
|
|
||||||
self._spot_providers = None
|
self._spot_providers = None
|
||||||
super().__init__(application, request, **kwargs)
|
super().__init__(application, request, **kwargs)
|
||||||
|
|
||||||
def initialize(self, spots, web_server_metrics, spot_providers=None):
|
def initialize(self, spots, spot_providers=None):
|
||||||
self._spots = spots
|
self._spots = spots
|
||||||
self._web_server_metrics = web_server_metrics
|
|
||||||
self._spot_providers = spot_providers or []
|
self._spot_providers = spot_providers or []
|
||||||
|
|
||||||
def post(self):
|
def post(self):
|
||||||
try:
|
try:
|
||||||
# Metrics
|
|
||||||
self._web_server_metrics["last_api_access_time"] = datetime.now(pytz.UTC)
|
|
||||||
self._web_server_metrics["api_access_counter"] += 1
|
|
||||||
self._web_server_metrics["status"] = "OK"
|
|
||||||
api_requests_counter.inc()
|
|
||||||
|
|
||||||
# Reject if not allowed
|
# Reject if not allowed
|
||||||
if not ALLOW_SPOTTING:
|
if not ALLOW_SPOTTING:
|
||||||
self.set_status(401)
|
self.set_status(401)
|
||||||
@@ -10,7 +10,6 @@ from tornado import httputil
|
|||||||
from tornado.web import Application
|
from tornado.web import Application
|
||||||
|
|
||||||
from core.enums import AlertType
|
from core.enums import AlertType
|
||||||
from core.prometheus_metrics_handler import api_requests_counter
|
|
||||||
from core.utils import safe_json_dumps
|
from core.utils import safe_json_dumps
|
||||||
from data.lookup_credentials import extract_credentials
|
from data.lookup_credentials import extract_credentials
|
||||||
|
|
||||||
@@ -27,12 +26,10 @@ class APIAlertsHandler(tornado.web.RequestHandler):
|
|||||||
**kwargs: Any,
|
**kwargs: Any,
|
||||||
):
|
):
|
||||||
self._alerts = None
|
self._alerts = None
|
||||||
self._web_server_metrics = None
|
|
||||||
super().__init__(application, request, **kwargs)
|
super().__init__(application, request, **kwargs)
|
||||||
|
|
||||||
def initialize(self, alerts, web_server_metrics):
|
def initialize(self, alerts):
|
||||||
self._alerts = alerts
|
self._alerts = alerts
|
||||||
self._web_server_metrics = web_server_metrics
|
|
||||||
|
|
||||||
@staticmethod
|
@staticmethod
|
||||||
def _enrich(alerts, credentials):
|
def _enrich(alerts, credentials):
|
||||||
@@ -45,12 +42,6 @@ class APIAlertsHandler(tornado.web.RequestHandler):
|
|||||||
|
|
||||||
def get(self):
|
def get(self):
|
||||||
try:
|
try:
|
||||||
# Metrics
|
|
||||||
self._web_server_metrics["last_api_access_time"] = datetime.now(pytz.UTC)
|
|
||||||
self._web_server_metrics["api_access_counter"] += 1
|
|
||||||
self._web_server_metrics["status"] = "OK"
|
|
||||||
api_requests_counter.inc()
|
|
||||||
|
|
||||||
# request.arguments contains lists for each param key because technically the client can supply multiple,
|
# request.arguments contains lists for each param key because technically the client can supply multiple,
|
||||||
# reduce that to just the first entry, and convert bytes to string
|
# reduce that to just the first entry, and convert bytes to string
|
||||||
query_params = {k: v[0].decode("utf-8") for k, v in self.request.arguments.items()}
|
query_params = {k: v[0].decode("utf-8") for k, v in self.request.arguments.items()}
|
||||||
@@ -82,15 +73,13 @@ class APIAlertsStreamHandler(tornado_eventsource.handler.EventSourceHandler):
|
|||||||
|
|
||||||
def __init__(self, application, request, **kwargs: Any):
|
def __init__(self, application, request, **kwargs: Any):
|
||||||
self._sse_alert_broadcaster = None
|
self._sse_alert_broadcaster = None
|
||||||
self._web_server_metrics = None
|
|
||||||
self._query_params = None
|
self._query_params = None
|
||||||
self._credentials = None
|
self._credentials = None
|
||||||
self._fields = None
|
self._fields = None
|
||||||
super().__init__(application, request, **kwargs)
|
super().__init__(application, request, **kwargs)
|
||||||
|
|
||||||
def initialize(self, sse_alert_broadcaster, web_server_metrics):
|
def initialize(self, sse_alert_broadcaster):
|
||||||
self._sse_alert_broadcaster = sse_alert_broadcaster
|
self._sse_alert_broadcaster = sse_alert_broadcaster
|
||||||
self._web_server_metrics = web_server_metrics
|
|
||||||
|
|
||||||
def custom_headers(self):
|
def custom_headers(self):
|
||||||
"""Custom headers to avoid e.g. nginx reverse proxy from buffering SSE data"""
|
"""Custom headers to avoid e.g. nginx reverse proxy from buffering SSE data"""
|
||||||
@@ -99,12 +88,6 @@ class APIAlertsStreamHandler(tornado_eventsource.handler.EventSourceHandler):
|
|||||||
|
|
||||||
def open(self):
|
def open(self):
|
||||||
try:
|
try:
|
||||||
# Metrics
|
|
||||||
self._web_server_metrics["last_api_access_time"] = datetime.now(pytz.UTC)
|
|
||||||
self._web_server_metrics["api_access_counter"] += 1
|
|
||||||
self._web_server_metrics["status"] = "OK"
|
|
||||||
api_requests_counter.inc()
|
|
||||||
|
|
||||||
# request.arguments contains lists for each param key because technically the client can supply multiple,
|
# request.arguments contains lists for each param key because technically the client can supply multiple,
|
||||||
# reduce that to just the first entry, and convert bytes to string
|
# reduce that to just the first entry, and convert bytes to string
|
||||||
self._query_params = {k: v[0].decode("utf-8") for k, v in self.request.arguments.items()}
|
self._query_params = {k: v[0].decode("utf-8") for k, v in self.request.arguments.items()}
|
||||||
@@ -11,7 +11,6 @@ from tornado.web import Application
|
|||||||
|
|
||||||
from core.constants import BANDS
|
from core.constants import BANDS
|
||||||
from core.enums import Continent
|
from core.enums import Continent
|
||||||
from core.prometheus_metrics_handler import api_requests_counter
|
|
||||||
from core.utils import safe_json_dumps
|
from core.utils import safe_json_dumps
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
@@ -30,20 +29,13 @@ class APIDxStatsHandler(tornado.web.RequestHandler):
|
|||||||
**kwargs: Any,
|
**kwargs: Any,
|
||||||
):
|
):
|
||||||
self._spots = None
|
self._spots = None
|
||||||
self._web_server_metrics = None
|
|
||||||
super().__init__(application, request, **kwargs)
|
super().__init__(application, request, **kwargs)
|
||||||
|
|
||||||
def initialize(self, spots, web_server_metrics):
|
def initialize(self, spots):
|
||||||
self._spots = spots
|
self._spots = spots
|
||||||
self._web_server_metrics = web_server_metrics
|
|
||||||
|
|
||||||
def get(self):
|
def get(self):
|
||||||
try:
|
try:
|
||||||
self._web_server_metrics["last_api_access_time"] = datetime.now(pytz.UTC)
|
|
||||||
self._web_server_metrics["api_access_counter"] += 1
|
|
||||||
self._web_server_metrics["status"] = "OK"
|
|
||||||
api_requests_counter.inc()
|
|
||||||
|
|
||||||
one_hour_ago = (datetime.now(pytz.UTC) - timedelta(hours=1)).timestamp()
|
one_hour_ago = (datetime.now(pytz.UTC) - timedelta(hours=1)).timestamp()
|
||||||
counts = Counter()
|
counts = Counter()
|
||||||
|
|
||||||
@@ -1,9 +1,7 @@
|
|||||||
import logging
|
import logging
|
||||||
import re
|
import re
|
||||||
from datetime import datetime
|
|
||||||
from typing import Any
|
from typing import Any
|
||||||
|
|
||||||
import pytz
|
|
||||||
import tornado
|
import tornado
|
||||||
from tornado import httputil
|
from tornado import httputil
|
||||||
from tornado.web import Application
|
from tornado.web import Application
|
||||||
@@ -15,7 +13,6 @@ from core.geo_utils import (
|
|||||||
lat_lon_to_cq_zone,
|
lat_lon_to_cq_zone,
|
||||||
lat_lon_to_itu_zone,
|
lat_lon_to_itu_zone,
|
||||||
)
|
)
|
||||||
from core.prometheus_metrics_handler import api_requests_counter
|
|
||||||
from core.sig_lookup_helper import populate_missing_sig_ref_info
|
from core.sig_lookup_helper import populate_missing_sig_ref_info
|
||||||
from core.sig_utils import get_ref_regex_for_sig
|
from core.sig_utils import get_ref_regex_for_sig
|
||||||
from core.utils import safe_json_dumps
|
from core.utils import safe_json_dumps
|
||||||
@@ -34,20 +31,10 @@ class APILookupCallHandler(tornado.web.RequestHandler):
|
|||||||
request: httputil.HTTPServerRequest,
|
request: httputil.HTTPServerRequest,
|
||||||
**kwargs: Any,
|
**kwargs: Any,
|
||||||
):
|
):
|
||||||
self._web_server_metrics = None
|
|
||||||
super().__init__(application, request, **kwargs)
|
super().__init__(application, request, **kwargs)
|
||||||
|
|
||||||
def initialize(self, web_server_metrics):
|
|
||||||
self._web_server_metrics = web_server_metrics
|
|
||||||
|
|
||||||
def get(self):
|
def get(self):
|
||||||
try:
|
try:
|
||||||
# Metrics
|
|
||||||
self._web_server_metrics["last_api_access_time"] = datetime.now(pytz.UTC)
|
|
||||||
self._web_server_metrics["api_access_counter"] += 1
|
|
||||||
self._web_server_metrics["status"] = "OK"
|
|
||||||
api_requests_counter.inc()
|
|
||||||
|
|
||||||
# request.arguments contains lists for each param key because technically the client can supply multiple,
|
# request.arguments contains lists for each param key because technically the client can supply multiple,
|
||||||
# reduce that to just the first entry, and convert bytes to string
|
# reduce that to just the first entry, and convert bytes to string
|
||||||
query_params = {k: v[0].decode("utf-8") for k, v in self.request.arguments.items()}
|
query_params = {k: v[0].decode("utf-8") for k, v in self.request.arguments.items()}
|
||||||
@@ -85,20 +72,10 @@ class APILookupSIGRefHandler(tornado.web.RequestHandler):
|
|||||||
request: httputil.HTTPServerRequest,
|
request: httputil.HTTPServerRequest,
|
||||||
**kwargs: Any,
|
**kwargs: Any,
|
||||||
):
|
):
|
||||||
self._web_server_metrics = None
|
|
||||||
super().__init__(application, request, **kwargs)
|
super().__init__(application, request, **kwargs)
|
||||||
|
|
||||||
def initialize(self, web_server_metrics):
|
|
||||||
self._web_server_metrics = web_server_metrics
|
|
||||||
|
|
||||||
def get(self):
|
def get(self):
|
||||||
try:
|
try:
|
||||||
# Metrics
|
|
||||||
self._web_server_metrics["last_api_access_time"] = datetime.now(pytz.UTC)
|
|
||||||
self._web_server_metrics["api_access_counter"] += 1
|
|
||||||
self._web_server_metrics["status"] = "OK"
|
|
||||||
api_requests_counter.inc()
|
|
||||||
|
|
||||||
# request.arguments contains lists for each param key because technically the client can supply multiple,
|
# request.arguments contains lists for each param key because technically the client can supply multiple,
|
||||||
# reduce that to just the first entry, and convert bytes to string
|
# reduce that to just the first entry, and convert bytes to string
|
||||||
query_params = {k: v[0].decode("utf-8") for k, v in self.request.arguments.items()}
|
query_params = {k: v[0].decode("utf-8") for k, v in self.request.arguments.items()}
|
||||||
@@ -143,20 +120,10 @@ class APILookupGridHandler(tornado.web.RequestHandler):
|
|||||||
request: httputil.HTTPServerRequest,
|
request: httputil.HTTPServerRequest,
|
||||||
**kwargs: Any,
|
**kwargs: Any,
|
||||||
):
|
):
|
||||||
self._web_server_metrics = None
|
|
||||||
super().__init__(application, request, **kwargs)
|
super().__init__(application, request, **kwargs)
|
||||||
|
|
||||||
def initialize(self, web_server_metrics):
|
|
||||||
self._web_server_metrics = web_server_metrics
|
|
||||||
|
|
||||||
def get(self):
|
def get(self):
|
||||||
try:
|
try:
|
||||||
# Metrics
|
|
||||||
self._web_server_metrics["last_api_access_time"] = datetime.now(pytz.UTC)
|
|
||||||
self._web_server_metrics["api_access_counter"] += 1
|
|
||||||
self._web_server_metrics["status"] = "OK"
|
|
||||||
api_requests_counter.inc()
|
|
||||||
|
|
||||||
# request.arguments contains lists for each param key because technically the client can supply multiple,
|
# request.arguments contains lists for each param key because technically the client can supply multiple,
|
||||||
# reduce that to just the first entry, and convert bytes to string
|
# reduce that to just the first entry, and convert bytes to string
|
||||||
query_params = {k: v[0].decode("utf-8") for k, v in self.request.arguments.items()}
|
query_params = {k: v[0].decode("utf-8") for k, v in self.request.arguments.items()}
|
||||||
@@ -1,8 +1,6 @@
|
|||||||
import logging
|
import logging
|
||||||
from datetime import datetime
|
|
||||||
from typing import Any
|
from typing import Any
|
||||||
|
|
||||||
import pytz
|
|
||||||
import tornado
|
import tornado
|
||||||
from tornado import httputil
|
from tornado import httputil
|
||||||
from tornado.web import Application
|
from tornado.web import Application
|
||||||
@@ -10,7 +8,6 @@ from tornado.web import Application
|
|||||||
from core.config import ALLOW_SPOTTING, MAX_SPOT_AGE
|
from core.config import ALLOW_SPOTTING, MAX_SPOT_AGE
|
||||||
from core.constants import BANDS, PROPAGATION_MODES, SIGS
|
from core.constants import BANDS, PROPAGATION_MODES, SIGS
|
||||||
from core.enums import Continent, Mode, ModeType
|
from core.enums import Continent, Mode, ModeType
|
||||||
from core.prometheus_metrics_handler import api_requests_counter
|
|
||||||
from core.utils import safe_json_dumps
|
from core.utils import safe_json_dumps
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
@@ -26,23 +23,15 @@ class APIOptionsHandler(tornado.web.RequestHandler):
|
|||||||
**kwargs: Any,
|
**kwargs: Any,
|
||||||
):
|
):
|
||||||
self._status_data = None
|
self._status_data = None
|
||||||
self._web_server_metrics = None
|
|
||||||
self._spot_providers = None
|
self._spot_providers = None
|
||||||
super().__init__(application, request, **kwargs)
|
super().__init__(application, request, **kwargs)
|
||||||
|
|
||||||
def initialize(self, status_data, web_server_metrics, spot_providers=None):
|
def initialize(self, status_data, spot_providers=None):
|
||||||
self._status_data = status_data
|
self._status_data = status_data
|
||||||
self._web_server_metrics = web_server_metrics
|
|
||||||
self._spot_providers = spot_providers or []
|
self._spot_providers = spot_providers or []
|
||||||
|
|
||||||
def get(self):
|
def get(self):
|
||||||
try:
|
try:
|
||||||
# Metrics
|
|
||||||
self._web_server_metrics["last_api_access_time"] = datetime.now(pytz.UTC)
|
|
||||||
self._web_server_metrics["api_access_counter"] += 1
|
|
||||||
self._web_server_metrics["status"] = "OK"
|
|
||||||
api_requests_counter.inc()
|
|
||||||
|
|
||||||
# Build a map of SIG name -> list of provider names that can submit spots for that SIG
|
# Build a map of SIG name -> list of provider names that can submit spots for that SIG
|
||||||
spot_submit_providers = {}
|
spot_submit_providers = {}
|
||||||
|
|
||||||
+1
-12
@@ -1,13 +1,10 @@
|
|||||||
import logging
|
import logging
|
||||||
from datetime import datetime
|
|
||||||
from typing import Any
|
from typing import Any
|
||||||
|
|
||||||
import pytz
|
|
||||||
import tornado
|
import tornado
|
||||||
from tornado import httputil
|
from tornado import httputil
|
||||||
from tornado.web import Application
|
from tornado.web import Application
|
||||||
|
|
||||||
from core.prometheus_metrics_handler import api_requests_counter
|
|
||||||
from core.utils import safe_json_dumps
|
from core.utils import safe_json_dumps
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
@@ -23,21 +20,13 @@ class APISolarConditionsHandler(tornado.web.RequestHandler):
|
|||||||
**kwargs: Any,
|
**kwargs: Any,
|
||||||
):
|
):
|
||||||
self._solar_conditions = None
|
self._solar_conditions = None
|
||||||
self._web_server_metrics = None
|
|
||||||
super().__init__(application, request, **kwargs)
|
super().__init__(application, request, **kwargs)
|
||||||
|
|
||||||
def initialize(self, solar_conditions, web_server_metrics):
|
def initialize(self, solar_conditions):
|
||||||
self._solar_conditions = solar_conditions
|
self._solar_conditions = solar_conditions
|
||||||
self._web_server_metrics = web_server_metrics
|
|
||||||
|
|
||||||
def get(self):
|
def get(self):
|
||||||
try:
|
try:
|
||||||
# Metrics
|
|
||||||
self._web_server_metrics["last_api_access_time"] = datetime.now(pytz.UTC)
|
|
||||||
self._web_server_metrics["api_access_counter"] += 1
|
|
||||||
self._web_server_metrics["status"] = "OK"
|
|
||||||
api_requests_counter.inc()
|
|
||||||
|
|
||||||
self.write(self._solar_conditions.to_json())
|
self.write(self._solar_conditions.to_json())
|
||||||
self.set_status(200)
|
self.set_status(200)
|
||||||
self.set_header("Cache-Control", "no-store")
|
self.set_header("Cache-Control", "no-store")
|
||||||
@@ -9,7 +9,6 @@ import tornado_eventsource.handler
|
|||||||
from tornado import httputil
|
from tornado import httputil
|
||||||
from tornado.web import Application
|
from tornado.web import Application
|
||||||
|
|
||||||
from core.prometheus_metrics_handler import api_requests_counter
|
|
||||||
from core.utils import safe_json_dumps
|
from core.utils import safe_json_dumps
|
||||||
from data.lookup_credentials import extract_credentials
|
from data.lookup_credentials import extract_credentials
|
||||||
|
|
||||||
@@ -26,12 +25,10 @@ class APISpotsHandler(tornado.web.RequestHandler):
|
|||||||
**kwargs: Any,
|
**kwargs: Any,
|
||||||
):
|
):
|
||||||
self._spots = None
|
self._spots = None
|
||||||
self._web_server_metrics = None
|
|
||||||
super().__init__(application, request, **kwargs)
|
super().__init__(application, request, **kwargs)
|
||||||
|
|
||||||
def initialize(self, spots, web_server_metrics):
|
def initialize(self, spots):
|
||||||
self._spots = spots
|
self._spots = spots
|
||||||
self._web_server_metrics = web_server_metrics
|
|
||||||
|
|
||||||
@staticmethod
|
@staticmethod
|
||||||
def _enrich(spots, credentials):
|
def _enrich(spots, credentials):
|
||||||
@@ -44,12 +41,6 @@ class APISpotsHandler(tornado.web.RequestHandler):
|
|||||||
|
|
||||||
def get(self):
|
def get(self):
|
||||||
try:
|
try:
|
||||||
# Metrics
|
|
||||||
self._web_server_metrics["last_api_access_time"] = datetime.now(pytz.UTC)
|
|
||||||
self._web_server_metrics["api_access_counter"] += 1
|
|
||||||
self._web_server_metrics["status"] = "OK"
|
|
||||||
api_requests_counter.inc()
|
|
||||||
|
|
||||||
# request.arguments contains lists for each param key because technically the client can supply multiple,
|
# request.arguments contains lists for each param key because technically the client can supply multiple,
|
||||||
# reduce that to just the first entry, and convert bytes to string
|
# reduce that to just the first entry, and convert bytes to string
|
||||||
query_params = {k: v[0].decode("utf-8") for k, v in self.request.arguments.items()}
|
query_params = {k: v[0].decode("utf-8") for k, v in self.request.arguments.items()}
|
||||||
@@ -81,15 +72,13 @@ class APISpotsStreamHandler(tornado_eventsource.handler.EventSourceHandler):
|
|||||||
|
|
||||||
def __init__(self, application, request, **kwargs: Any):
|
def __init__(self, application, request, **kwargs: Any):
|
||||||
self._sse_spot_broadcaster = None
|
self._sse_spot_broadcaster = None
|
||||||
self._web_server_metrics = None
|
|
||||||
self._query_params = None
|
self._query_params = None
|
||||||
self._credentials = None
|
self._credentials = None
|
||||||
self._fields = None
|
self._fields = None
|
||||||
super().__init__(application, request, **kwargs)
|
super().__init__(application, request, **kwargs)
|
||||||
|
|
||||||
def initialize(self, sse_spot_broadcaster, web_server_metrics):
|
def initialize(self, sse_spot_broadcaster):
|
||||||
self._sse_spot_broadcaster = sse_spot_broadcaster
|
self._sse_spot_broadcaster = sse_spot_broadcaster
|
||||||
self._web_server_metrics = web_server_metrics
|
|
||||||
|
|
||||||
def custom_headers(self):
|
def custom_headers(self):
|
||||||
"""Custom headers to avoid e.g. nginx reverse proxy from buffering SSE data"""
|
"""Custom headers to avoid e.g. nginx reverse proxy from buffering SSE data"""
|
||||||
@@ -100,12 +89,6 @@ class APISpotsStreamHandler(tornado_eventsource.handler.EventSourceHandler):
|
|||||||
"""Called once on the client opening a connection, set things up"""
|
"""Called once on the client opening a connection, set things up"""
|
||||||
|
|
||||||
try:
|
try:
|
||||||
# Metrics
|
|
||||||
self._web_server_metrics["last_api_access_time"] = datetime.now(pytz.UTC)
|
|
||||||
self._web_server_metrics["api_access_counter"] += 1
|
|
||||||
self._web_server_metrics["status"] = "OK"
|
|
||||||
api_requests_counter.inc()
|
|
||||||
|
|
||||||
# request.arguments contains lists for each param key because technically the client can supply multiple,
|
# request.arguments contains lists for each param key because technically the client can supply multiple,
|
||||||
# reduce that to just the first entry, and convert bytes to string
|
# reduce that to just the first entry, and convert bytes to string
|
||||||
self._query_params = {k: v[0].decode("utf-8") for k, v in self.request.arguments.items()}
|
self._query_params = {k: v[0].decode("utf-8") for k, v in self.request.arguments.items()}
|
||||||
@@ -1,13 +1,10 @@
|
|||||||
import logging
|
import logging
|
||||||
from datetime import datetime
|
|
||||||
from typing import Any
|
from typing import Any
|
||||||
|
|
||||||
import pytz
|
|
||||||
import tornado
|
import tornado
|
||||||
from tornado import httputil
|
from tornado import httputil
|
||||||
from tornado.web import Application
|
from tornado.web import Application
|
||||||
|
|
||||||
from core.prometheus_metrics_handler import api_requests_counter
|
|
||||||
from core.utils import safe_json_dumps
|
from core.utils import safe_json_dumps
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
@@ -23,21 +20,13 @@ class APIStatusHandler(tornado.web.RequestHandler):
|
|||||||
**kwargs: Any,
|
**kwargs: Any,
|
||||||
):
|
):
|
||||||
self._status_data = None
|
self._status_data = None
|
||||||
self._web_server_metrics = None
|
|
||||||
super().__init__(application, request, **kwargs)
|
super().__init__(application, request, **kwargs)
|
||||||
|
|
||||||
def initialize(self, status_data, web_server_metrics):
|
def initialize(self, status_data):
|
||||||
self._status_data = status_data
|
self._status_data = status_data
|
||||||
self._web_server_metrics = web_server_metrics
|
|
||||||
|
|
||||||
def get(self):
|
def get(self):
|
||||||
try:
|
try:
|
||||||
# Metrics
|
|
||||||
self._web_server_metrics["last_api_access_time"] = datetime.now(pytz.UTC)
|
|
||||||
self._web_server_metrics["api_access_counter"] += 1
|
|
||||||
self._web_server_metrics["status"] = "OK"
|
|
||||||
api_requests_counter.inc()
|
|
||||||
|
|
||||||
self.write(safe_json_dumps(self._status_data))
|
self.write(safe_json_dumps(self._status_data))
|
||||||
self.set_status(200)
|
self.set_status(200)
|
||||||
self.set_header("Cache-Control", "no-store")
|
self.set_header("Cache-Control", "no-store")
|
||||||
@@ -1,16 +1,13 @@
|
|||||||
import logging
|
import logging
|
||||||
import re
|
import re
|
||||||
from datetime import datetime
|
|
||||||
from typing import Any
|
from typing import Any
|
||||||
|
|
||||||
import pytz
|
|
||||||
import tornado
|
import tornado
|
||||||
from tornado import httputil
|
from tornado import httputil
|
||||||
from tornado.web import Application
|
from tornado.web import Application
|
||||||
|
|
||||||
from core.config import ALLOW_SPOTTING
|
from core.config import ALLOW_SPOTTING
|
||||||
from core.constants import UNKNOWN_BAND
|
from core.constants import UNKNOWN_BAND
|
||||||
from core.prometheus_metrics_handler import api_requests_counter
|
|
||||||
from core.sig_utils import get_ref_regex_for_sig
|
from core.sig_utils import get_ref_regex_for_sig
|
||||||
from core.utils import infer_band_from_freq, safe_json_dumps
|
from core.utils import infer_band_from_freq, safe_json_dumps
|
||||||
from data.spot import Spot
|
from data.spot import Spot
|
||||||
@@ -28,21 +25,13 @@ class V1APISpotHandler(tornado.web.RequestHandler):
|
|||||||
**kwargs: Any,
|
**kwargs: Any,
|
||||||
):
|
):
|
||||||
self._spots = None
|
self._spots = None
|
||||||
self._web_server_metrics = None
|
|
||||||
super().__init__(application, request, **kwargs)
|
super().__init__(application, request, **kwargs)
|
||||||
|
|
||||||
def initialize(self, spots, web_server_metrics):
|
def initialize(self, spots):
|
||||||
self._spots = spots
|
self._spots = spots
|
||||||
self._web_server_metrics = web_server_metrics
|
|
||||||
|
|
||||||
def post(self):
|
def post(self):
|
||||||
try:
|
try:
|
||||||
# Metrics
|
|
||||||
self._web_server_metrics["last_api_access_time"] = datetime.now(pytz.UTC)
|
|
||||||
self._web_server_metrics["api_access_counter"] += 1
|
|
||||||
self._web_server_metrics["status"] = "OK"
|
|
||||||
api_requests_counter.inc()
|
|
||||||
|
|
||||||
# Reject if not allowed
|
# Reject if not allowed
|
||||||
if not ALLOW_SPOTTING:
|
if not ALLOW_SPOTTING:
|
||||||
self.set_status(401)
|
self.set_status(401)
|
||||||
+1
-1
@@ -34,7 +34,7 @@ class V1RedirectHandler(tornado.web.RequestHandler):
|
|||||||
response = await client.fetch(
|
response = await client.fetch(
|
||||||
new_url,
|
new_url,
|
||||||
method=self.request.method,
|
method=self.request.method,
|
||||||
headers=self.request.headers,
|
headers=headers,
|
||||||
body=None if self.request.method == "GET" else (self.request.body or b""),
|
body=None if self.request.method == "GET" else (self.request.body or b""),
|
||||||
raise_error=False,
|
raise_error=False,
|
||||||
follow_redirects=False,
|
follow_redirects=False,
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
import re
|
import re
|
||||||
|
|
||||||
from server.handlers.api.spots import APISpotsHandler, APISpotsStreamHandler
|
from webserver.handlers.api.spots import APISpotsHandler, APISpotsStreamHandler
|
||||||
|
|
||||||
_GRID_SOURCE_RE = re.compile(r'"dx_location_source":\s*"GRID"')
|
_GRID_SOURCE_RE = re.compile(r'"dx_location_source":\s*"GRID"')
|
||||||
_LEGACY_PARAM_TO_HEADER_MAP = {
|
_LEGACY_PARAM_TO_HEADER_MAP = {
|
||||||
@@ -1,14 +1,19 @@
|
|||||||
from datetime import datetime
|
|
||||||
from typing import Any
|
from typing import Any
|
||||||
|
|
||||||
import pytz
|
|
||||||
import tornado
|
import tornado
|
||||||
from tornado import httputil
|
from tornado import httputil
|
||||||
from tornado.web import Application
|
from tornado.web import Application
|
||||||
|
|
||||||
from core.config import ALLOW_SPOTTING, BASE_URL, SERVER_OWNER_CALLSIGN, WEB_UI_OPTIONS
|
from core.config import (
|
||||||
|
ALLOW_SPOTTING,
|
||||||
|
BASE_URL,
|
||||||
|
SERVER_OWNER_CALLSIGN,
|
||||||
|
TELNET_SERVER_ADDRESS,
|
||||||
|
TELNET_SERVER_ENABLED,
|
||||||
|
TELNET_SERVER_PORT,
|
||||||
|
WEB_UI_OPTIONS,
|
||||||
|
)
|
||||||
from core.constants import SOFTWARE_VERSION
|
from core.constants import SOFTWARE_VERSION
|
||||||
from core.prometheus_metrics_handler import page_requests_counter
|
|
||||||
|
|
||||||
|
|
||||||
class PageTemplateHandler(tornado.web.RequestHandler):
|
class PageTemplateHandler(tornado.web.RequestHandler):
|
||||||
@@ -21,20 +26,12 @@ class PageTemplateHandler(tornado.web.RequestHandler):
|
|||||||
**kwargs: Any,
|
**kwargs: Any,
|
||||||
):
|
):
|
||||||
self._template_name = None
|
self._template_name = None
|
||||||
self._web_server_metrics = None
|
|
||||||
super().__init__(application, request, **kwargs)
|
super().__init__(application, request, **kwargs)
|
||||||
|
|
||||||
def initialize(self, template_name, web_server_metrics):
|
def initialize(self, template_name):
|
||||||
self._template_name = template_name
|
self._template_name = template_name
|
||||||
self._web_server_metrics = web_server_metrics
|
|
||||||
|
|
||||||
def get(self):
|
def get(self):
|
||||||
# Metrics
|
|
||||||
self._web_server_metrics["last_page_access_time"] = datetime.now(pytz.UTC)
|
|
||||||
self._web_server_metrics["page_access_counter"] += 1
|
|
||||||
self._web_server_metrics["status"] = "OK"
|
|
||||||
page_requests_counter.inc()
|
|
||||||
|
|
||||||
# Load named template, and provide variables used in templates
|
# Load named template, and provide variables used in templates
|
||||||
self.render(
|
self.render(
|
||||||
f"{self._template_name}.html",
|
f"{self._template_name}.html",
|
||||||
@@ -43,5 +40,8 @@ class PageTemplateHandler(tornado.web.RequestHandler):
|
|||||||
allow_spotting=ALLOW_SPOTTING,
|
allow_spotting=ALLOW_SPOTTING,
|
||||||
web_ui_options=WEB_UI_OPTIONS,
|
web_ui_options=WEB_UI_OPTIONS,
|
||||||
baseurl=BASE_URL,
|
baseurl=BASE_URL,
|
||||||
|
telnet_server_enabled=TELNET_SERVER_ENABLED,
|
||||||
|
telnet_server_address=TELNET_SERVER_ADDRESS,
|
||||||
|
telnet_server_port=TELNET_SERVER_PORT,
|
||||||
current_path=self.request.path,
|
current_path=self.request.path,
|
||||||
)
|
)
|
||||||
@@ -26,6 +26,11 @@ class SSEBroadcaster:
|
|||||||
with self._lock:
|
with self._lock:
|
||||||
self._handlers.discard(handler)
|
self._handlers.discard(handler)
|
||||||
|
|
||||||
|
@property
|
||||||
|
def client_count(self) -> int:
|
||||||
|
with self._lock:
|
||||||
|
return len(self._handlers)
|
||||||
|
|
||||||
def publish(self, value):
|
def publish(self, value):
|
||||||
self._loop.add_callback(self._broadcast, value)
|
self._loop.add_callback(self._broadcast, value)
|
||||||
|
|
||||||
@@ -1,6 +1,7 @@
|
|||||||
import asyncio
|
import asyncio
|
||||||
import logging
|
import logging
|
||||||
import os
|
import os
|
||||||
|
import threading
|
||||||
|
|
||||||
import tornado
|
import tornado
|
||||||
from tornado.web import StaticFileHandler
|
from tornado.web import StaticFileHandler
|
||||||
@@ -14,25 +15,26 @@ from core.config import (
|
|||||||
)
|
)
|
||||||
from core.data_providers import DATA_PROVIDERS
|
from core.data_providers import DATA_PROVIDERS
|
||||||
from core.data_store import DATA_STORE
|
from core.data_store import DATA_STORE
|
||||||
from server.handlers.api.addspot import APISpotHandler
|
from webserver.handlers.api.addspot import APISpotHandler
|
||||||
from server.handlers.api.alerts import APIAlertsHandler, APIAlertsStreamHandler
|
from webserver.handlers.api.alerts import APIAlertsHandler, APIAlertsStreamHandler
|
||||||
from server.handlers.api.dxstats import APIDxStatsHandler
|
from webserver.handlers.api.dxstats import APIDxStatsHandler
|
||||||
from server.handlers.api.lookups import (
|
from webserver.handlers.api.lookups import (
|
||||||
APILookupCallHandler,
|
APILookupCallHandler,
|
||||||
APILookupGridHandler,
|
APILookupGridHandler,
|
||||||
APILookupSIGRefHandler,
|
APILookupSIGRefHandler,
|
||||||
)
|
)
|
||||||
from server.handlers.api.options import APIOptionsHandler
|
from webserver.handlers.api.options import APIOptionsHandler
|
||||||
from server.handlers.api.solar_conditions import APISolarConditionsHandler
|
from webserver.handlers.api.solar_conditions import APISolarConditionsHandler
|
||||||
from server.handlers.api.spots import APISpotsHandler, APISpotsStreamHandler
|
from webserver.handlers.api.spots import APISpotsHandler, APISpotsStreamHandler
|
||||||
from server.handlers.api.status import APIStatusHandler
|
from webserver.handlers.api.status import APIStatusHandler
|
||||||
from server.handlers.api.v1_addspot import V1APISpotHandler
|
from webserver.handlers.api.v1_addspot import V1APISpotHandler
|
||||||
from server.handlers.api.v1_compatability import V1RedirectHandler
|
from webserver.handlers.api.v1_compatability import V1RedirectHandler
|
||||||
from server.handlers.api.v1_spots import V1APISpotsHandler, V1APISpotsStreamHandler
|
from webserver.handlers.api.v1_spots import V1APISpotsHandler, V1APISpotsStreamHandler
|
||||||
from server.handlers.manifesthandler import ManifestHandler
|
from webserver.handlers.manifesthandler import ManifestHandler
|
||||||
from server.handlers.metrics import PrometheusMetricsHandler
|
from webserver.handlers.metrics import PrometheusMetricsHandler
|
||||||
from server.handlers.pagetemplate import PageTemplateHandler
|
from webserver.handlers.pagetemplate import PageTemplateHandler
|
||||||
from server.sse_broadcaster import SSEBroadcaster
|
from webserver.sse_broadcaster import SSEBroadcaster
|
||||||
|
from webserver.webserver_metrics import WebServerMetrics
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
@@ -52,92 +54,107 @@ class WebServer:
|
|||||||
self._port = WEB_SERVER_PORT
|
self._port = WEB_SERVER_PORT
|
||||||
self._api_only_mode = API_ONLY_MODE
|
self._api_only_mode = API_ONLY_MODE
|
||||||
self._shutdown_event = asyncio.Event()
|
self._shutdown_event = asyncio.Event()
|
||||||
self.web_server_metrics = {
|
self._loop = None
|
||||||
"last_page_access_time": None,
|
self._thread = None
|
||||||
"last_api_access_time": None,
|
self.web_server_metrics = WebServerMetrics()
|
||||||
"page_access_counter": 0,
|
|
||||||
"api_access_counter": 0,
|
|
||||||
"status": "Starting",
|
|
||||||
}
|
|
||||||
|
|
||||||
def setup(self):
|
def setup(self):
|
||||||
# Listen for new spots and alerts being added to the cache, so we can notify SSE clients immediately
|
# Listen for new spots and alerts being added to the cache, so we can notify SSE clients immediately
|
||||||
DATA_STORE.spots.add_listener(self._spot_broadcaster.publish)
|
DATA_STORE.spots.add_listener(self._spot_broadcaster.publish)
|
||||||
DATA_STORE.alerts.add_listener(self._alert_broadcaster.publish)
|
DATA_STORE.alerts.add_listener(self._alert_broadcaster.publish)
|
||||||
|
|
||||||
|
@property
|
||||||
|
def sse_client_count(self) -> int:
|
||||||
|
"""Number of connected SSE clients, across both the spots and alerts streams."""
|
||||||
|
|
||||||
|
return self._spot_broadcaster.client_count + self._alert_broadcaster.client_count
|
||||||
|
|
||||||
def start(self):
|
def start(self):
|
||||||
"""Start the web server"""
|
"""Start the web server"""
|
||||||
|
|
||||||
asyncio.run(self._start_inner())
|
self._thread = threading.Thread(target=asyncio.run, args=(self._start_inner(),), name="WebServer", daemon=True)
|
||||||
|
self._thread.start()
|
||||||
|
|
||||||
def stop(self):
|
def stop(self):
|
||||||
"""Stop the web server"""
|
"""Stop the web server"""
|
||||||
|
|
||||||
self._shutdown_event.set()
|
if self._loop and self._loop.is_running():
|
||||||
|
self._loop.call_soon_threadsafe(self._shutdown_event.set)
|
||||||
|
if self._thread:
|
||||||
|
self._thread.join(timeout=15)
|
||||||
|
if self._thread.is_alive():
|
||||||
|
logger.warning("Web server background thread did not exit on time and will be killed.")
|
||||||
|
|
||||||
|
def _handle_loop_exception(self, loop, context):
|
||||||
|
"""Ignore "cancelled" exceptions from the asyncio loop to avoid printing exceptions to the log on shutdown when
|
||||||
|
we cancel the SSE handler threads"""
|
||||||
|
|
||||||
|
exception = context.get("exception")
|
||||||
|
if isinstance(exception, asyncio.CancelledError):
|
||||||
|
return
|
||||||
|
loop.default_exception_handler(context)
|
||||||
|
|
||||||
async def _start_inner(self):
|
async def _start_inner(self):
|
||||||
"""Start method (async). Sets up the Tornado application."""
|
"""Start method (async). Sets up the Tornado application."""
|
||||||
|
|
||||||
|
self._loop = asyncio.get_running_loop()
|
||||||
|
self._loop.set_exception_handler(self._handle_loop_exception)
|
||||||
|
|
||||||
# Bind the SSE broadcasters to the web server's loop, so they fire correctly
|
# Bind the SSE broadcasters to the web server's loop, so they fire correctly
|
||||||
self._spot_broadcaster.bind_to_web_server_loop()
|
self._spot_broadcaster.bind_to_web_server_loop()
|
||||||
self._alert_broadcaster.bind_to_web_server_loop()
|
self._alert_broadcaster.bind_to_web_server_loop()
|
||||||
|
|
||||||
# Prepare a list of common arguments that are passed in to every API & page handler. This is just a basic thing
|
|
||||||
# to avoid copy-pasting the same thing to every route declaration below.
|
|
||||||
handler_opts = {"web_server_metrics": self.web_server_metrics}
|
|
||||||
|
|
||||||
# API endpoints are always enabled
|
# API endpoints are always enabled
|
||||||
api_routes = [
|
api_routes = [
|
||||||
(
|
(
|
||||||
r"/api/v2/spots",
|
r"/api/v2/spots",
|
||||||
APISpotsHandler,
|
APISpotsHandler,
|
||||||
{"spots": self._data_store.spots, **handler_opts},
|
{"spots": self._data_store.spots},
|
||||||
),
|
),
|
||||||
(
|
(
|
||||||
r"/api/v2/alerts",
|
r"/api/v2/alerts",
|
||||||
APIAlertsHandler,
|
APIAlertsHandler,
|
||||||
{"alerts": self._data_store.alerts, **handler_opts},
|
{"alerts": self._data_store.alerts},
|
||||||
),
|
),
|
||||||
(
|
(
|
||||||
r"/api/v2/spots/stream",
|
r"/api/v2/spots/stream",
|
||||||
APISpotsStreamHandler,
|
APISpotsStreamHandler,
|
||||||
{"sse_spot_broadcaster": self._spot_broadcaster, **handler_opts},
|
{"sse_spot_broadcaster": self._spot_broadcaster},
|
||||||
),
|
),
|
||||||
(
|
(
|
||||||
r"/api/v2/alerts/stream",
|
r"/api/v2/alerts/stream",
|
||||||
APIAlertsStreamHandler,
|
APIAlertsStreamHandler,
|
||||||
{"sse_alert_broadcaster": self._alert_broadcaster, **handler_opts},
|
{"sse_alert_broadcaster": self._alert_broadcaster},
|
||||||
),
|
),
|
||||||
(
|
(
|
||||||
r"/api/v2/solar",
|
r"/api/v2/solar",
|
||||||
APISolarConditionsHandler,
|
APISolarConditionsHandler,
|
||||||
{"solar_conditions": self._data_store.solar_conditions.get(), **handler_opts},
|
{"solar_conditions": self._data_store.solar_conditions.get()},
|
||||||
),
|
),
|
||||||
(
|
(
|
||||||
r"/api/v2/dxstats",
|
r"/api/v2/dxstats",
|
||||||
APIDxStatsHandler,
|
APIDxStatsHandler,
|
||||||
{"spots": self._data_store.spots, **handler_opts},
|
{"spots": self._data_store.spots},
|
||||||
),
|
),
|
||||||
(
|
(
|
||||||
r"/api/v2/options",
|
r"/api/v2/options",
|
||||||
APIOptionsHandler,
|
APIOptionsHandler,
|
||||||
{"status_data": self._data_store.status.get(), **handler_opts},
|
{"status_data": self._data_store.status.get()},
|
||||||
),
|
),
|
||||||
(
|
(
|
||||||
r"/api/v2/status",
|
r"/api/v2/status",
|
||||||
APIStatusHandler,
|
APIStatusHandler,
|
||||||
{"status_data": self._data_store.status.get(), **handler_opts},
|
{"status_data": self._data_store.status.get()},
|
||||||
),
|
),
|
||||||
(r"/api/v2/lookup/call", APILookupCallHandler, {**handler_opts}),
|
(r"/api/v2/lookup/call", APILookupCallHandler),
|
||||||
(r"/api/v2/lookup/sigref", APILookupSIGRefHandler, {**handler_opts}),
|
(r"/api/v2/lookup/sigref", APILookupSIGRefHandler),
|
||||||
(r"/api/v2/lookup/grid", APILookupGridHandler, {**handler_opts}),
|
(r"/api/v2/lookup/grid", APILookupGridHandler),
|
||||||
(
|
(
|
||||||
r"/api/v2/spot",
|
r"/api/v2/spot",
|
||||||
APISpotHandler,
|
APISpotHandler,
|
||||||
{
|
{
|
||||||
"spots": self._data_store.spots,
|
"spots": self._data_store.spots,
|
||||||
"spot_providers": self._data_providers,
|
"spot_providers": self._data_providers,
|
||||||
**handler_opts,
|
|
||||||
},
|
},
|
||||||
),
|
),
|
||||||
]
|
]
|
||||||
@@ -148,19 +165,18 @@ class WebServer:
|
|||||||
(
|
(
|
||||||
r"/api/v1/spots",
|
r"/api/v1/spots",
|
||||||
V1APISpotsHandler,
|
V1APISpotsHandler,
|
||||||
{"spots": self._data_store.spots, **handler_opts},
|
{"spots": self._data_store.spots},
|
||||||
),
|
),
|
||||||
(
|
(
|
||||||
r"/api/v1/spots/stream",
|
r"/api/v1/spots/stream",
|
||||||
V1APISpotsStreamHandler,
|
V1APISpotsStreamHandler,
|
||||||
{"sse_spot_broadcaster": self._spot_broadcaster, **handler_opts},
|
{"sse_spot_broadcaster": self._spot_broadcaster},
|
||||||
),
|
),
|
||||||
(
|
(
|
||||||
r"/api/v1/spot",
|
r"/api/v1/spot",
|
||||||
V1APISpotHandler,
|
V1APISpotHandler,
|
||||||
{
|
{
|
||||||
"spots": self._data_store.spots,
|
"spots": self._data_store.spots,
|
||||||
**handler_opts,
|
|
||||||
},
|
},
|
||||||
),
|
),
|
||||||
(r"/api/v1/(.*)", V1RedirectHandler),
|
(r"/api/v1/(.*)", V1RedirectHandler),
|
||||||
@@ -173,41 +189,41 @@ class WebServer:
|
|||||||
(
|
(
|
||||||
r"/",
|
r"/",
|
||||||
PageTemplateHandler,
|
PageTemplateHandler,
|
||||||
{"template_name": "api_only_home", **handler_opts},
|
{"template_name": "api_only_home"},
|
||||||
)
|
)
|
||||||
]
|
]
|
||||||
else:
|
else:
|
||||||
ui_routes = [
|
ui_routes = [
|
||||||
(r"/", PageTemplateHandler, {"template_name": "spots", **handler_opts}),
|
(r"/", PageTemplateHandler, {"template_name": "spots"}),
|
||||||
(
|
(
|
||||||
r"/map",
|
r"/map",
|
||||||
PageTemplateHandler,
|
PageTemplateHandler,
|
||||||
{"template_name": "map", **handler_opts},
|
{"template_name": "map"},
|
||||||
),
|
),
|
||||||
(
|
(
|
||||||
r"/bands",
|
r"/bands",
|
||||||
PageTemplateHandler,
|
PageTemplateHandler,
|
||||||
{"template_name": "bands", **handler_opts},
|
{"template_name": "bands"},
|
||||||
),
|
),
|
||||||
(
|
(
|
||||||
r"/alerts",
|
r"/alerts",
|
||||||
PageTemplateHandler,
|
PageTemplateHandler,
|
||||||
{"template_name": "alerts", **handler_opts},
|
{"template_name": "alerts"},
|
||||||
),
|
),
|
||||||
(
|
(
|
||||||
r"/conditions",
|
r"/conditions",
|
||||||
PageTemplateHandler,
|
PageTemplateHandler,
|
||||||
{"template_name": "conditions", **handler_opts},
|
{"template_name": "conditions"},
|
||||||
),
|
),
|
||||||
(
|
(
|
||||||
r"/status",
|
r"/status",
|
||||||
PageTemplateHandler,
|
PageTemplateHandler,
|
||||||
{"template_name": "status", **handler_opts},
|
{"template_name": "status"},
|
||||||
),
|
),
|
||||||
(
|
(
|
||||||
r"/about",
|
r"/about",
|
||||||
PageTemplateHandler,
|
PageTemplateHandler,
|
||||||
{"template_name": "about", **handler_opts},
|
{"template_name": "about"},
|
||||||
),
|
),
|
||||||
]
|
]
|
||||||
# Only allow the Add Spot page if spotting is allowed
|
# Only allow the Add Spot page if spotting is allowed
|
||||||
@@ -216,7 +232,7 @@ class WebServer:
|
|||||||
(
|
(
|
||||||
r"/add-spot",
|
r"/add-spot",
|
||||||
PageTemplateHandler,
|
PageTemplateHandler,
|
||||||
{"template_name": "add_spot", **handler_opts},
|
{"template_name": "add_spot"},
|
||||||
)
|
)
|
||||||
]
|
]
|
||||||
|
|
||||||
@@ -226,7 +242,7 @@ class WebServer:
|
|||||||
(
|
(
|
||||||
r"/apidocs",
|
r"/apidocs",
|
||||||
PageTemplateHandler,
|
PageTemplateHandler,
|
||||||
{"template_name": "apidocs", **handler_opts},
|
{"template_name": "apidocs"},
|
||||||
),
|
),
|
||||||
(r"/metrics", PrometheusMetricsHandler),
|
(r"/metrics", PrometheusMetricsHandler),
|
||||||
(r"/manifest.webmanifest", ManifestHandler),
|
(r"/manifest.webmanifest", ManifestHandler),
|
||||||
@@ -254,7 +270,11 @@ class WebServer:
|
|||||||
|
|
||||||
def request_log(handler):
|
def request_log(handler):
|
||||||
"""Custom log function to provide more data about requests when enabled, and to provide the ability to turn off
|
"""Custom log function to provide more data about requests when enabled, and to provide the ability to turn off
|
||||||
web request logging altogetether."""
|
web request logging altogetether. Also records the time of the request and status in the webserver metrics. Probably
|
||||||
|
not what this method is supposed to be used for but it's a convenient thing that gets called on every request, so
|
||||||
|
saves having to pass the metrics around each handler individually."""
|
||||||
|
|
||||||
|
WEB_SERVER.web_server_metrics.record(handler.request.path, handler.get_status())
|
||||||
|
|
||||||
if LOG_WEB_REQUESTS:
|
if LOG_WEB_REQUESTS:
|
||||||
if handler.get_status() < 500:
|
if handler.get_status() < 500:
|
||||||
@@ -0,0 +1,44 @@
|
|||||||
|
from collections import deque
|
||||||
|
from datetime import datetime, timedelta
|
||||||
|
|
||||||
|
import pytz
|
||||||
|
|
||||||
|
from core.prometheus_metrics_handler import api_requests_counter, page_requests_counter
|
||||||
|
|
||||||
|
|
||||||
|
class WebServerMetrics:
|
||||||
|
"""Tracker for web server metrics. Stores the times pages and API endpoints were accessed for an hour, so we
|
||||||
|
can display the rate of requests per hour, and also updates the equivalent Prometheus counters."""
|
||||||
|
|
||||||
|
def __init__(self):
|
||||||
|
self.status = "Starting"
|
||||||
|
self._page_access_times = deque()
|
||||||
|
self._api_access_times = deque()
|
||||||
|
|
||||||
|
def record(self, path: str, status_code: int):
|
||||||
|
"""Records data for a request, depending on whether it's a page, API, or other request, and making sure
|
||||||
|
the response code isn't 404. Also sets the status of the web server."""
|
||||||
|
|
||||||
|
if status_code == 404 or path.startswith(("/static/", "/metrics", "/manifest.webmanifest")):
|
||||||
|
return
|
||||||
|
|
||||||
|
self.status = "OK" if status_code < 500 else "Error"
|
||||||
|
if path.startswith("/api/"):
|
||||||
|
api_requests_counter.inc()
|
||||||
|
self._api_access_times.append(datetime.now(pytz.UTC))
|
||||||
|
else:
|
||||||
|
page_requests_counter.inc()
|
||||||
|
self._page_access_times.append(datetime.now(pytz.UTC))
|
||||||
|
|
||||||
|
def page_requests_per_hour(self) -> int:
|
||||||
|
return self._count_and_prune_last_hour(self._page_access_times)
|
||||||
|
|
||||||
|
def api_requests_per_hour(self) -> int:
|
||||||
|
return self._count_and_prune_last_hour(self._api_access_times)
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def _count_and_prune_last_hour(access_times: deque) -> int:
|
||||||
|
cutoff = datetime.now(pytz.UTC) - timedelta(hours=1)
|
||||||
|
while access_times and access_times[0] < cutoff:
|
||||||
|
access_times.popleft()
|
||||||
|
return len(access_times)
|
||||||
Reference in New Issue
Block a user