Project version bump

README.md

@@ -30,7 +30,7 @@ URL parameters can be used to trigger an "embedded" mode which hides the headers
 
 Setting `embedded` to true is important for the rest of the settings to be applied; otherwise, the user's defaults will be used in preference to the URL params.
 
-These are supplied with the URL to the page you want to embed, for example for an embedded version of the band map in dark mode, use `https://spothole.com/bands?embedded=true&dark-mode=true`. For an embedded version of the main spots/home page in the system light/dark mode, use `https://spothole.com/?embedded=true`. For dark mode showing 70cm TOTA spots only, use `https://spothole.com/?embedded=true&dark-mode=true&filter-sigs=TOTA&filter-bands=70cm`. Providing no URL params causes the page to be loaded in the normal way it would when accessed directly in the user's browser.
+These are supplied with the URL to the page you want to embed, for example for an embedded version of the band map in dark mode, use `https://spothole.app/bands?embedded=true&dark-mode=true`. For an embedded version of the main spots/home page in the system light/dark mode, use `https://spothole.app/?embedded=true`. For dark mode showing 70cm TOTA spots only, use `https://spothole.app/?embedded=true&dark-mode=true&sig=TOTA&band=70cm`. Providing no URL params causes the page to be loaded in the normal way it would when accessed directly in the user's browser.
 
 The supported parameters are as follows. Generally these match the equivalent parameters in the real Spothole API, where a mapping exists.
 
@@ -157,6 +157,8 @@ server {
     
     location / {
         add_header Access-Control-Allow-Origin $xssorigin;
+        proxy_http_version 1.1;
+        proxy_set_header Connection "";
         proxy_pass http://127.0.0.1:8080;
     }
 }
@@ -204,7 +206,7 @@ To navigate your way around the source code, this list may help.
 
 *Templates*
 
-* `/views` - Templates used for constructing Spothole's user-targeted HTML pages
+* `/templates` - Templates used for constructing Spothole's user-targeted HTML pages
 
 *HTML/JS/CSS front-end code*
 
@@ -219,6 +221,7 @@ To navigate your way around the source code, this list may help.
 
 * `/` - Main script (`spothole.py`), pip `requirements.txt`, config, README, etc.
 * `/images` - Image sources
+* `/datafiles` - Local data sources (differentiated from the majority of data files which are loaded from URLs and cached in `/cache`)
 * `/cache` - Directory where static-ish data downloaded from the internet is cached to avoid rapid re-requests, and where spot/alert data is cached so that it survives a software restart. Created on first run.
 
 ### Extending the server

alertproviders/alert_provider.py

@@ -30,6 +30,9 @@ class AlertProvider:
     # because alerts could be created at any point for any time in the future. Rely on hashcode-based id matching
     # to deal with duplicates.
     def submit_batch(self, alerts):
+        # Sort the batch so that earliest ones go in first. This helps keep the ordering correct when alerts are fired
+        # off to SSE listeners.
+        alerts = sorted(alerts, key=lambda alert: (alert.start_time if alert and alert.start_time else 0))
         for alert in alerts:
             # Fill in any blanks and add to the list
             alert.infer_missing()

alertproviders/ng3k.py

@@ -76,7 +76,6 @@ class NG3K(HTTPAlertProvider):
                           dx_country=dx_country,
                           freqs_modes=bands + (("; " + modes) if modes != "" else ""),
                           comment=by + "; " + comment + "; " + qsl_info,
-                          icon="globe-africa",
                           start_time=start_timestamp,
                           end_time=end_timestamp,
                           is_dxpedition=True)

alertproviders/sota.py

@@ -20,13 +20,18 @@ class SOTA(HTTPAlertProvider):
         # Iterate through source data
         for source_alert in http_response.json():
             # Convert to our alert format
+            details = source_alert["summitDetails"].split(", ")
+            summit_name = details[0]
+            summit_points = None
+            if len(details) > 2:
+                summit_points = int(details[-1].split(" ")[0])
             alert = Alert(source=self.name,
                           source_id=source_alert["id"],
                           dx_calls=[source_alert["activatingCallsign"].upper()],
                           dx_names=[source_alert["activatorName"].upper()],
                           freqs_modes=source_alert["frequency"],
                           comment=source_alert["comments"],
-                          sig_refs=[SIGRef(id=source_alert["associationCode"] + "/" + source_alert["summitCode"], sig="SOTA", name=source_alert["summitDetails"])],
+                          sig_refs=[SIGRef(id=source_alert["associationCode"] + "/" + source_alert["summitCode"], sig="SOTA", name=summit_name, activation_score=summit_points)],
                           start_time=datetime.strptime(source_alert["dateActivated"],
                                                        "%Y-%m-%dT%H:%M:%SZ").replace(tzinfo=pytz.UTC).timestamp(),
                           is_dxpedition=False)

config-example.yml

@@ -59,39 +59,63 @@ spot-providers:
     enabled: true
     host: "hrd.wa9pie.net"
     port: 8000
+    # Prompt the cluster node gives when asking for a callsign to log in. Varies between cluster node software.
     login_prompt: "login:"
+    # Callsign Spothole will use to log into this cluster. Ensure the SSID (e.g. -99) is different to any personal
+    # connection you might make to this cluster node.
+    login_callsign: "N0CALL-99"
+    # Whether to allow RBN spots that come via this cluster. If you don't want RBN spots or you are making a separate
+    # connection to RBN directly, leave this as False. If you want RBN spots from this cluster, set this to True. (Make
+    # sure you aren't also separately connecting to RBN directly, otherwise you may get duplicate spots.) Note that not
+    # all clusters sent RBN spots anyway.
+    allow_rbn_spots: false
   -
     class: "DXCluster"
     name: "W3LPL Cluster"
     enabled: false
     host: "w3lpl.net"
     port: 7373
+    # Prompt the cluster node gives when asking for a callsign to log in. Varies between cluster node software.
     login_prompt: "Please enter your call:"
+    # Callsign Spothole will use to log into this cluster. Ensure the SSID (e.g. -99) is different to any personal
+    # connection you might make to this cluster node.
+    login_callsign: "N0CALL-99"
+    # Whether to allow RBN spots that come via this cluster. If you don't want RBN spots or you are making a separate
+    # connection to RBN directly, leave this as False. If you want RBN spots from this cluster, set this to True. (Make
+    # sure you aren't also separately connecting to RBN directly, otherwise you may get duplicate spots.) Note that not
+    # all clusters sent RBN spots anyway.
+    allow_rbn_spots: false
   -
     class: "RBN"
     name: "RBN CW/RTTY"
     enabled: false
     port: 7000
+    # This setting doesn't affect the spot provider itself, or anything in the back-end of Spothole, just the web UI.
+    # By default spots from all enabled providers will be shown in the web UI. However, you might want RBN data to be
+    # received by Spothole but not shown on the web UI unless the user explicitly turns it on. For that behaviour,
+    # set enabled to true, but enabled-by-default-in-web-ui to false.
+    enabled-by-default-in-web-ui: false
   -
     class: "RBN"
     name: "RBN FT8"
     enabled: false
     port: 7001
+    enabled-by-default-in-web-ui: false
   -
     class: "UKPacketNet"
     name: "UK Packet Radio Net"
     enabled: false
+    enabled-by-default-in-web-ui: false
   -
     class: "XOTA"
     name: "39C3 TOTA"
     enabled: false
     url: "wss://dev.39c3.totawatch.de/api/spot/live"
-    # Fixed SIG/latitude/longitude for all spots from a provider is currently only a feature for the "XOTA" provider,
+    # Fixed SIG for all spots from a provider & location CSV are currently only a feature for the "XOTA" provider,
     # the software found at https://github.com/nischu/xOTA/. This is because this is a generic backend for xOTA
     # programmes and so different URLs provide different programmes.
     sig: "TOTA"
-    latitude: 53.5622678
-    longitude: 9.9855205
+    locations-csv: "datafiles/39c3-tota.csv"
 
 
 # Alert providers to use. Same setup as the spot providers list above.

core/config.py

@@ -5,7 +5,8 @@ import yaml
 
 # Check you have a config file
 if not os.path.isfile("config.yml"):
-    logging.error("Your config file is missing. Ensure you have copied config-example.yml to config.yml and updated it according to your needs.")
+    logging.error(
+        "Your config file is missing. Ensure you have copied config-example.yml to config.yml and updated it according to your needs.")
     exit()
 
 # Load config
@@ -18,3 +19,8 @@ SERVER_OWNER_CALLSIGN = config["server-owner-callsign"]
 WEB_SERVER_PORT = config["web-server-port"]
 ALLOW_SPOTTING = config["allow-spotting"]
 WEB_UI_OPTIONS = config["web-ui-options"]
+
+# For ease of config, each spot provider owns its own config about whether it should be enabled by default in the web UI
+# but for consistency we provide this to the front-end in web-ui-options because it has no impact outside of the web UI.
+WEB_UI_OPTIONS["spot-providers-enabled-by-default"] = [p["name"] for p in config["spot-providers"] if p["enabled"] and (
+            "enabled-by-default-in-web-ui" not in p or p["enabled-by-default-in-web-ui"] == True)]

core/constants.py

@@ -4,7 +4,7 @@ from data.sig import SIG
 
 # General software
 SOFTWARE_NAME = "Spothole by M0TRT"
-SOFTWARE_VERSION = "1.1-pre"
+SOFTWARE_VERSION = "1.1"
 
 # HTTP headers used for spot providers that use HTTP
 HTTP_HEADERS = {"User-Agent": SOFTWARE_NAME + ", v" + SOFTWARE_VERSION + " (operated by " + SERVER_OWNER_CALLSIGN + ")"}
@@ -12,25 +12,25 @@ HAMQTH_PRG = (SOFTWARE_NAME + " v" + SOFTWARE_VERSION + " operated by " + SERVER
 
 # Special Interest Groups
 SIGS = [
-   SIG(name="POTA", description="Parks on the Air", icon="tree", ref_regex=r"[A-Z]{2}\-\d{4,5}"),
-   SIG(name="SOTA", description="Summits on the Air", icon="mountain-sun", ref_regex=r"[A-Z0-9]{1,3}\/[A-Z]{2}\-\d{3}"),
-   SIG(name="WWFF", description="World Wide Flora & Fauna", icon="seedling", ref_regex=r"[A-Z0-9]{1,3}FF\-\d{4}"),
-   SIG(name="GMA", description="Global Mountain Activity", icon="person-hiking", ref_regex=r"[A-Z0-9]{1,3}\/[A-Z]{2}\-\d{3}"),
-   SIG(name="WWBOTA", description="Worldwide Bunkers on the Air", icon="radiation", ref_regex=r"B\/[A-Z0-9]{1,3}\-\d{3,4}"),
-   SIG(name="HEMA", description="HuMPs Excluding Marilyns Award", icon="mound", ref_regex=r"[A-Z0-9]{1,3}\/[A-Z]{3}\-\d{3}"),
-   SIG(name="IOTA", description="Islands on the Air", icon="umbrella-beach", ref_regex=r"[A-Z]{2}\-\d{3}"),
-   SIG(name="MOTA", description="Mills on the Air", icon="fan", ref_regex=r"X\d{4-6}"),
-   SIG(name="ARLHS", description="Amateur Radio Lighthouse Society", icon="tower-observation", ref_regex=r"[A-Z]{3}\-\d{3,4}"),
-   SIG(name="ILLW", description="International Lighthouse & Lightship Weekend", icon="tower-observation", ref_regex=r"[A-Z]{2}\d{4}"),
-   SIG(name="SIOTA", description="Silos on the Air", icon="wheat-awn", ref_regex=r"[A-Z]{2}\-[A-Z]{3}\d"),
-   SIG(name="WCA", description="World Castles Award", icon="chess-rook", ref_regex=r"[A-Z0-9]{1,3}\-\d{5}"),
-   SIG(name="ZLOTA", description="New Zealand on the Air", icon="kiwi-bird", ref_regex=r"ZL[A-Z]/[A-Z]{2}\-\d{3,4}"),
-   SIG(name="WOTA", description="Wainwrights on the Air", icon="w", ref_regex=r"[A-Z]{3}-[0-9]{2}"),
-   SIG(name="BOTA", description="Beaches on the Air", icon="water"),
-   SIG(name="KRMNPA", description="Keith Roget Memorial National Parks Award", icon="earth-oceania"),
-   SIG(name="WAB", description="Worked All Britain", icon="table-cells-large", ref_regex=r"[A-Z]{1,2}[0-9]{2}"),
-   SIG(name="WAI", description="Worked All Ireland", icon="table-cells-large", ref_regex=r"[A-Z][0-9]{2}"),
-   SIG(name="TOTA", description="Toilets on the Air", icon="toilet", ref_regex=r"T\-[0-9]{2}")
+   SIG(name="POTA", description="Parks on the Air", ref_regex=r"[A-Z]{2}\-\d{4,5}"),
+   SIG(name="SOTA", description="Summits on the Air", ref_regex=r"[A-Z0-9]{1,3}\/[A-Z]{2}\-\d{3}"),
+   SIG(name="WWFF", description="World Wide Flora & Fauna", ref_regex=r"[A-Z0-9]{1,3}FF\-\d{4}"),
+   SIG(name="GMA", description="Global Mountain Activity", ref_regex=r"[A-Z0-9]{1,3}\/[A-Z]{2}\-\d{3}"),
+   SIG(name="WWBOTA", description="Worldwide Bunkers on the Air", ref_regex=r"B\/[A-Z0-9]{1,3}\-\d{3,4}"),
+   SIG(name="HEMA", description="HuMPs Excluding Marilyns Award", ref_regex=r"[A-Z0-9]{1,3}\/[A-Z]{3}\-\d{3}"),
+   SIG(name="IOTA", description="Islands on the Air", ref_regex=r"[A-Z]{2}\-\d{3}"),
+   SIG(name="MOTA", description="Mills on the Air", ref_regex=r"X\d{4-6}"),
+   SIG(name="ARLHS", description="Amateur Radio Lighthouse Society", ref_regex=r"[A-Z]{3}\-\d{3,4}"),
+   SIG(name="ILLW", description="International Lighthouse & Lightship Weekend", ref_regex=r"[A-Z]{2}\d{4}"),
+   SIG(name="SIOTA", description="Silos on the Air", ref_regex=r"[A-Z]{2}\-[A-Z]{3}\d"),
+   SIG(name="WCA", description="World Castles Award", ref_regex=r"[A-Z0-9]{1,3}\-\d{5}"),
+   SIG(name="ZLOTA", description="New Zealand on the Air", ref_regex=r"ZL[A-Z]/[A-Z]{2}\-\d{3,4}"),
+   SIG(name="WOTA", description="Wainwrights on the Air", ref_regex=r"[A-Z]{3}-[0-9]{2}"),
+   SIG(name="BOTA", description="Beaches on the Air"),
+   SIG(name="KRMNPA", description="Keith Roget Memorial National Parks Award"),
+   SIG(name="WAB", description="Worked All Britain", ref_regex=r"[A-Z]{1,2}[0-9]{2}"),
+   SIG(name="WAI", description="Worked All Ireland", ref_regex=r"[A-Z][0-9]{2}"),
+   SIG(name="TOTA", description="Toilets on the Air", ref_regex=r"T\-[0-9]{2}")
 ]
 
 # Modes. Note "DIGI" and "DIGITAL" are also supported but are normalised into "DATA".
@@ -42,33 +42,33 @@ MODE_TYPES = ["CW", "PHONE", "DATA"]
 
 # Band definitions
 BANDS = [
-    Band(name="2200m", start_freq=135700, end_freq=137800, color="#ff4500", contrast_color="white"),
-    Band(name="600m", start_freq=472000, end_freq=479000, color="#1e90ff", contrast_color="white"),
-    Band(name="160m", start_freq=1800000, end_freq=2000000, color="#7cfc00", contrast_color="black"),
-    Band(name="80m", start_freq=3500000, end_freq=4000000, color="#e550e5", contrast_color="black"),
-    Band(name="60m", start_freq=5250000, end_freq=5410000, color="#00008b", contrast_color="white"),
-    Band(name="40m", start_freq=7000000, end_freq=7300000, color="#5959ff", contrast_color="white"),
-    Band(name="30m", start_freq=10100000, end_freq=10150000, color="#62d962", contrast_color="black"),
-    Band(name="20m", start_freq=14000000, end_freq=14350000, color="#f2c40c", contrast_color="black"),
-    Band(name="17m", start_freq=18068000, end_freq=18168000, color="#f2f261", contrast_color="black"),
-    Band(name="15m", start_freq=21000000, end_freq=21450000, color="#cca166", contrast_color="black"),
-    Band(name="12m", start_freq=24890000, end_freq=24990000, color="#b22222", contrast_color="white"),
-    Band(name="11m", start_freq=26965000, end_freq=27405000, color="#00ff00", contrast_color="black"),
-    Band(name="10m", start_freq=28000000, end_freq=29700000, color="#ff69b4", contrast_color="black"),
-    Band(name="6m", start_freq=50000000, end_freq=54000000, color="#FF0000", contrast_color="white"),
-    Band(name="5m", start_freq=56000000, end_freq=60500000, color="#e0e0e0", contrast_color="black"),
-    Band(name="4m", start_freq=70000000, end_freq=70500000, color="#cc0044", contrast_color="white"),
-    Band(name="2m", start_freq=144000000, end_freq=148000000, color="#FF1493", contrast_color="black"),
-    Band(name="1.25m", start_freq=219000000, end_freq=225000000, color="#CCFF00", contrast_color="black"),
-    Band(name="70cm", start_freq=420000000, end_freq=450000000, color="#999900", contrast_color="white"),
-    Band(name="23cm", start_freq=1240000000, end_freq=1325000000, color="#5AB8C7", contrast_color="black"),
-    Band(name="2.4GHz", start_freq=2300000000, end_freq=2450000000, color="#FF7F50", contrast_color="black"),
-    Band(name="5.8GHz", start_freq=5725000000, end_freq=5850000000, color="#cc0099", contrast_color="white"),
-    Band(name="10GHz", start_freq=10000000000, end_freq=10500000000, color="#696969", contrast_color="white"),
-    Band(name="24GHz", start_freq=24000000000, end_freq=24050000000, color="#f3edc6", contrast_color="black"),
-    Band(name="47GHz", start_freq=47000000000, end_freq=47200000000, color="#ffe786", contrast_color="black"),
-    Band(name="76GHz", start_freq=75500000000, end_freq=81500000000, color="#baf9d8", contrast_color="black")]
-UNKNOWN_BAND = Band(name="Unknown", start_freq=0, end_freq=0, color="black", contrast_color="white")
+    Band(name="2200m", start_freq=135700, end_freq=137800),
+    Band(name="600m", start_freq=472000, end_freq=479000),
+    Band(name="160m", start_freq=1800000, end_freq=2000000),
+    Band(name="80m", start_freq=3500000, end_freq=4000000),
+    Band(name="60m", start_freq=5250000, end_freq=5410000),
+    Band(name="40m", start_freq=7000000, end_freq=7300000),
+    Band(name="30m", start_freq=10100000, end_freq=10150000),
+    Band(name="20m", start_freq=14000000, end_freq=14350000),
+    Band(name="17m", start_freq=18068000, end_freq=18168000),
+    Band(name="15m", start_freq=21000000, end_freq=21450000),
+    Band(name="12m", start_freq=24890000, end_freq=24990000),
+    Band(name="11m", start_freq=26965000, end_freq=27405000),
+    Band(name="10m", start_freq=28000000, end_freq=29700000),
+    Band(name="6m", start_freq=50000000, end_freq=54000000),
+    Band(name="5m", start_freq=56000000, end_freq=60500000),
+    Band(name="4m", start_freq=70000000, end_freq=70500000),
+    Band(name="2m", start_freq=144000000, end_freq=148000000),
+    Band(name="1.25m", start_freq=219000000, end_freq=225000000),
+    Band(name="70cm", start_freq=420000000, end_freq=450000000),
+    Band(name="23cm", start_freq=1240000000, end_freq=1325000000),
+    Band(name="13cm", start_freq=2300000000, end_freq=2450000000),
+    Band(name="5.8GHz", start_freq=5725000000, end_freq=5850000000),
+    Band(name="10GHz", start_freq=10000000000, end_freq=10500000000),
+    Band(name="24GHz", start_freq=24000000000, end_freq=24050000000),
+    Band(name="47GHz", start_freq=47000000000, end_freq=47200000000),
+    Band(name="76GHz", start_freq=75500000000, end_freq=81500000000)]
+UNKNOWN_BAND = Band(name="Unknown", start_freq=0, end_freq=0)
 
 # Continents
 CONTINENTS = ["EU", "NA", "SA", "AS", "AF", "OC", "AN"]

core/prometheus_metrics_handler.py

@@ -1,6 +1,4 @@
-from bottle import response
-from prometheus_client import CollectorRegistry, generate_latest, CONTENT_TYPE_LATEST, Counter, disable_created_metrics, \
-    Gauge
+from prometheus_client import CollectorRegistry, generate_latest, Counter, disable_created_metrics, Gauge
 
 disable_created_metrics()
 # Prometheus metrics registry
@@ -33,8 +31,6 @@ memory_use_gauge = Gauge(
 )
 
 
-# Get a Prometheus metrics response for Bottle
+# Get a Prometheus metrics response for the web server
 def get_metrics():
-    response.content_type = CONTENT_TYPE_LATEST
-    response.status = 200
     return generate_latest(registry)

core/sig_utils.py

@@ -8,14 +8,6 @@ from core.constants import SIGS, HTTP_HEADERS
 from core.geo_utils import wab_wai_square_to_lat_lon
 
 
-# Utility function to get the icon for a named SIG. If no match is found, the "circle-question" icon will be returned.
-def get_icon_for_sig(sig):
-    for s in SIGS:
-        if s.name == sig:
-            return s.icon
-    return "circle-question"
-
-
 # Utility function to get the regex string for a SIG reference for a named SIG. If no match is found, None will be returned.
 def get_ref_regex_for_sig(sig):
     for s in SIGS:
@@ -54,6 +46,7 @@ def populate_sig_ref_info(sig_ref):
                 sig_ref.grid = data["locator"] if "locator" in data else None
                 sig_ref.latitude = data["latitude"] if "latitude" in data else None
                 sig_ref.longitude = data["longitude"] if "longitude" in data else None
+                sig_ref.activation_score = data["points"] if "points" in data else None
         elif sig.upper() == "WWBOTA":
             data = SEMI_STATIC_URL_DATA_CACHE.get("https://api.wwbota.org/bunkers/" + ref_id,
                                                   headers=HTTP_HEADERS).json()

core/status_reporter.py

@@ -58,13 +58,17 @@ class StatusReporter:
         self.status_data["cleanup"] = {"status": self.cleanup_timer.status,
                                        "last_ran": self.cleanup_timer.last_cleanup_time.replace(
                                            tzinfo=pytz.UTC).timestamp() if self.cleanup_timer.last_cleanup_time else 0}
-        self.status_data["webserver"] = {"status": self.web_server.status,
-                                         "last_api_access": self.web_server.last_api_access_time.replace(
-                                             tzinfo=pytz.UTC).timestamp() if self.web_server.last_api_access_time else 0,
-                                         "api_access_count": self.web_server.api_access_counter,
-                                         "last_page_access": self.web_server.last_page_access_time.replace(
-                                             tzinfo=pytz.UTC).timestamp() if self.web_server.last_page_access_time else 0,
-                                         "page_access_count": self.web_server.page_access_counter}
+        self.status_data["webserver"] = {"status": self.web_server.web_server_metrics["status"],
+                                         "last_api_access": self.web_server.web_server_metrics[
+                                             "last_api_access_time"].replace(
+                                             tzinfo=pytz.UTC).timestamp() if self.web_server.web_server_metrics[
+                                             "last_api_access_time"] else 0,
+                                         "api_access_count": self.web_server.web_server_metrics["api_access_counter"],
+                                         "last_page_access": self.web_server.web_server_metrics[
+                                             "last_page_access_time"].replace(
+                                             tzinfo=pytz.UTC).timestamp() if self.web_server.web_server_metrics[
+                                             "last_page_access_time"] else 0,
+                                         "page_access_count": self.web_server.web_server_metrics["page_access_counter"]}
 
         # Update Prometheus metrics
         memory_use_gauge.set(psutil.Process(os.getpid()).memory_info().rss * 1024)

core/utils.py

@@ -0,0 +1,5 @@
+# Convert objects to serialisable things. Used by JSON serialiser as a default when it encounters unserializable things.
+# Just converts objects to dict. Try to avoid doing anything clever here when serialising spots, because we also need
+# to receive spots without complex handling.
+def serialize_everything(obj):
+    return obj.__dict__

data/alert.py

@@ -7,7 +7,7 @@ from datetime import datetime, timedelta
 import pytz
 
 from core.lookup_helper import lookup_helper
-from core.sig_utils import get_icon_for_sig, populate_sig_ref_info
+from core.sig_utils import populate_sig_ref_info
 
 
 # Data class that defines an alert.
@@ -53,10 +53,6 @@ class Alert:
     sig: str = None
     # SIG references. We allow multiple here for e.g. n-fer activations, unlike ADIF SIG_INFO
     sig_refs: list = None
-    # Activation score. SOTA only
-    activation_score: int = None
-    # Icon, from the Font Awesome set. This is fairly opinionated but is here to help the alerthole web UI and Field alertter. Does not include the "fa-" prefix.
-    icon: str = None
     # Whether this alert is for a DXpedition, as opposed to e.g. an xOTA programme.
     is_dxpedition: bool = False
     # Where we got the alert from, e.g. "POTA", "SOTA"...
@@ -109,10 +105,6 @@ class Alert:
         if self.sig_refs and len(self.sig_refs) > 0 and not self.sig:
             self.sig = self.sig_refs[0].sig
 
-        # Icon from SIG
-        if self.sig and not self.icon:
-            self.icon = get_icon_for_sig(self.sig)
-
         # DX operator details lookup, using QRZ.com. This should be the last resort compared to taking the data from
         # the actual alertting service, e.g. we don't want to accidentally use a user's QRZ.com home lat/lon instead of
         # the one from the park reference they're at.

data/band.py

@@ -9,7 +9,3 @@ class Band:
     start_freq: float
     # Stop frequency, in Hz
     end_freq: float
-    # Colour to use for this band, as per PSK Reporter
-    color: str
-    # Contrast colour to use for text against a background of the band colour
-    contrast_color: str

data/sig.py

@@ -7,8 +7,5 @@ class SIG:
     name: str
     # Description, e.g. "Parks on the Air"
     description: str
-    # Icon to use for it, from the Font Awesome set. This is fairly opinionated but is here to help the Spothole web UI
-    # and Field Spotter. Does not include the "fa-" prefix.
-    icon: str
     # Regex matcher for references, e.g. for POTA r"[A-Z]{2}\-\d+".
     ref_regex: str = None

data/sig_ref.py

@@ -18,3 +18,5 @@ class SIGRef:
     longitude: float = None
     # Maidenhead grid reference of the reference, if known.
     grid: str = None
+    # Activation score. SOTA only
+    activation_score: int = None

data/spot.py

@@ -11,7 +11,7 @@ from pyhamtools.locator import locator_to_latlong, latlong_to_locator
 
 from core.config import MAX_SPOT_AGE
 from core.lookup_helper import lookup_helper
-from core.sig_utils import get_icon_for_sig, populate_sig_ref_info, ANY_SIG_REGEX, get_ref_regex_for_sig
+from core.sig_utils import populate_sig_ref_info, ANY_SIG_REGEX, get_ref_regex_for_sig
 from data.sig_ref import SIGRef
 
 
@@ -106,18 +106,6 @@ class Spot:
     sig: str = None
     # SIG references. We allow multiple here for e.g. n-fer activations, unlike ADIF SIG_INFO
     sig_refs: list = None
-    # Activation score. SOTA only
-    activation_score: int = None
-
-    # Display guidance (optional)
-
-    # Icon, from the Font Awesome set. This is fairly opinionated but is here to help the Spothole web UI and Field
-    # Spotter. Does not include the "fa-" prefix.
-    icon: str = None
-    # Colour to represent this spot, if a client chooses to colour spots based on their frequency band, using PSK
-    # Reporter's default colours. HTML colour e.g. hex. A contrast colour is also provided which will be black or white.
-    band_color: str = None
-    band_contrast_color: str = None
 
     # Timing info
 
@@ -214,8 +202,6 @@ class Spot:
         if self.freq and not self.band:
             band = lookup_helper.infer_band_from_freq(self.freq)
             self.band = band.name
-            self.band_color = band.color
-            self.band_contrast_color = band.contrast_color
 
         # Mode from comments or bandplan
         if self.mode:
@@ -236,8 +222,8 @@ class Spot:
         if self.mode and not self.mode_type:
             self.mode_type = lookup_helper.infer_mode_type_from_mode(self.mode)
 
-        # If we have a latitude at this point, it can only have been provided by the spot itself
-        if self.dx_latitude:
+        # If we have a latitude or grid at this point, it can only have been provided by the spot itself
+        if self.dx_latitude or self.dx_grid:
             self.dx_location_source = "SPOT"
 
         # Set the top-level "SIG" if it is missing but we have at least one SIG ref.
@@ -296,14 +282,6 @@ class Spot:
         if self.sig_refs and len(self.sig_refs) > 0 and not self.sig:
             self.sig = self.sig_refs[0].sig
 
-        # Icon from SIG if we have one
-        if self.sig:
-            self.icon = get_icon_for_sig(self.sig)
-
-        # Default "radio" icon if nothing else has set it
-        if not self.icon:
-            self.icon = "tower-cell"
-
         # DX Grid to lat/lon and vice versa in case one is missing
         if self.dx_grid and not self.dx_latitude:
             ll = locator_to_latlong(self.dx_grid)

datafiles/39c3-tota.csv

@@ -0,0 +1,18 @@
+ref,lat,lon
+T-01,53.56278090617755,9.984341869295505
+T-02,53.562383404176416,9.98551893027115
+T-03,53.56170184391514,9.985416035619778
+T-04,53.562026534393176,9.986372919078974
+T-11,53.56284641242506,9.98475590239655
+T-12,53.562431705517035,9.98551675702443
+T-13,53.56223704898424,9.985774520335664
+T-14,53.5617893512591,9.986344302837976
+T-21,53.56284641242506,9.98475590239655
+T-22,53.56245816412497,9.985456089490567
+T-23,53.56199560857136,9.985636761412673
+T-24,53.5617893512591,9.986344302837976
+T-31,53.56247470064887,9.985611427551902
+T-32,53.5617893512591,9.986344302837976
+T-41,53.56245039134992,9.985486136112701
+T-91,53.56147934973529,9.984626806439744
+T-92,53.561396810300735,9.987553052152899

requirements.txt

@@ -1,5 +1,4 @@
 pyyaml~=6.0.3
-bottle~=0.13.4
 requests-cache~=1.2.1
 pyhamtools~=0.12.0
 telnetlib3~=2.0.8
@@ -14,4 +13,5 @@ pyproj~=3.7.2
 prometheus_client~=0.23.1
 beautifulsoup4~=4.14.2
 websocket-client~=1.9.0
-gevent~=25.9.1
+tornado~=6.5.4
+tornado_eventsource~=3.0.0

server/handlers/api/addspot.py

@@ -0,0 +1,142 @@
+import json
+import logging
+import re
+from datetime import datetime
+
+import pytz
+import tornado
+
+from core.config import ALLOW_SPOTTING, MAX_SPOT_AGE
+from core.constants import UNKNOWN_BAND
+from core.lookup_helper import lookup_helper
+from core.prometheus_metrics_handler import api_requests_counter
+from core.sig_utils import get_ref_regex_for_sig
+from core.utils import serialize_everything
+from data.sig_ref import SIGRef
+from data.spot import Spot
+
+
+# API request handler for /api/v1/spot (POST)
+class APISpotHandler(tornado.web.RequestHandler):
+    def initialize(self, spots, web_server_metrics):
+        self.spots = spots
+        self.web_server_metrics = web_server_metrics
+
+    def post(self):
+        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
+            if not ALLOW_SPOTTING:
+                self.set_status(401)
+                self.write(json.dumps("Error - this server does not allow new spots to be added via the API.",
+                                  default=serialize_everything))
+                self.set_header("Cache-Control", "no-store")
+                self.set_header("Content-Type", "application/json")
+                return
+
+            # Reject if format not json
+            if 'Content-Type' not in self.request.headers or self.request.headers.get('Content-Type') != "application/json":
+                self.set_status(415)
+                self.write(json.dumps("Error - request Content-Type must be application/json", default=serialize_everything))
+                self.set_header("Cache-Control", "no-store")
+                self.set_header("Content-Type", "application/json")
+                return
+
+            # Reject if request body is empty
+            post_data = self.request.body
+            if not post_data:
+                self.set_status(422)
+                self.write(json.dumps("Error - request body is empty", default=serialize_everything))
+                self.set_header("Cache-Control", "no-store")
+                self.set_header("Content-Type", "application/json")
+                return
+
+            # Read in the request body as JSON then convert to a Spot object
+            json_spot = tornado.escape.json_decode(post_data)
+            spot = Spot(**json_spot)
+
+            # Converting to a spot object this way won't have coped with sig_ref objects, so fix that. (Would be nice to
+            # redo this in a functional style)
+            if spot.sig_refs:
+                real_sig_refs = []
+                for dict_obj in spot.sig_refs:
+                    real_sig_refs.append(json.loads(json.dumps(dict_obj), object_hook=lambda d: SIGRef(**d)))
+                spot.sig_refs = real_sig_refs
+
+            # Reject if no timestamp, frequency, dx_call or de_call
+            if not spot.time or not spot.dx_call or not spot.freq or not spot.de_call:
+                self.set_status(422)
+                self.write(json.dumps("Error - 'time', 'dx_call', 'freq' and 'de_call' must be provided as a minimum.",
+                                  default=serialize_everything))
+                self.set_header("Cache-Control", "no-store")
+                self.set_header("Content-Type", "application/json")
+                return
+
+            # Reject invalid-looking callsigns
+            if not re.match(r"^[A-Za-z0-9/\-]*$", spot.dx_call):
+                self.set_status(422)
+                self.write(json.dumps("Error - '" + spot.dx_call + "' does not look like a valid callsign.",
+                                  default=serialize_everything))
+                self.set_header("Cache-Control", "no-store")
+                self.set_header("Content-Type", "application/json")
+                return
+            if not re.match(r"^[A-Za-z0-9/\-]*$", spot.de_call):
+                self.set_status(422)
+                self.write(json.dumps("Error - '" + spot.de_call + "' does not look like a valid callsign.",
+                                  default=serialize_everything))
+                self.set_header("Cache-Control", "no-store")
+                self.set_header("Content-Type", "application/json")
+                return
+
+            # Reject if frequency not in a known band
+            if lookup_helper.infer_band_from_freq(spot.freq) == UNKNOWN_BAND:
+                self.set_status(422)
+                self.write(json.dumps("Error - Frequency of " + str(spot.freq / 1000.0) + "kHz is not in a known band.",
+                                  default=serialize_everything))
+                self.set_header("Cache-Control", "no-store")
+                self.set_header("Content-Type", "application/json")
+                return
+
+            # Reject if grid formatting incorrect
+            if spot.dx_grid and not re.match(
+                    r"^([A-R]{2}[0-9]{2}[A-X]{2}[0-9]{2}[A-X]{2}|[A-R]{2}[0-9]{2}[A-X]{2}[0-9]{2}|[A-R]{2}[0-9]{2}[A-X]{2}|[A-R]{2}[0-9]{2})$",
+                    spot.dx_grid.upper()):
+                self.set_status(422)
+                self.write(json.dumps("Error - '" + spot.dx_grid + "' does not look like a valid Maidenhead grid.",
+                                  default=serialize_everything))
+                self.set_header("Cache-Control", "no-store")
+                self.set_header("Content-Type", "application/json")
+                return
+
+            # Reject if sig_ref format incorrect for sig
+            if spot.sig and spot.sig_refs and len(spot.sig_refs) > 0 and spot.sig_refs[0].id and get_ref_regex_for_sig(
+                    spot.sig) and not re.match(get_ref_regex_for_sig(spot.sig), spot.sig_refs[0].id):
+                self.set_status(422)
+                self.write(json.dumps(
+                    "Error - '" + spot.sig_refs[0].id + "' does not look like a valid reference for " + spot.sig + ".",
+                    default=serialize_everything))
+                self.set_header("Cache-Control", "no-store")
+                self.set_header("Content-Type", "application/json")
+                return
+
+            # infer missing data, and add it to our database.
+            spot.source = "API"
+            spot.infer_missing()
+            self.spots.add(spot.id, spot, expire=MAX_SPOT_AGE)
+
+            self.write(json.dumps("OK", default=serialize_everything))
+            self.set_status(201)
+            self.set_header("Cache-Control", "no-store")
+            self.set_header("Content-Type", "application/json")
+
+        except Exception as e:
+            logging.error(e)
+            self.write(json.dumps("Error - " + str(e), default=serialize_everything))
+            self.set_status(500)
+            self.set_header("Cache-Control", "no-store")
+            self.set_header("Content-Type", "application/json")

server/handlers/api/alerts.py

@@ -0,0 +1,179 @@
+import json
+import logging
+from datetime import datetime
+from queue import Queue
+
+import pytz
+import tornado
+import tornado_eventsource.handler
+
+from core.prometheus_metrics_handler import api_requests_counter
+from core.utils import serialize_everything
+
+SSE_HANDLER_MAX_QUEUE_SIZE = 100
+SSE_HANDLER_QUEUE_CHECK_INTERVAL = 5000
+
+
+# API request handler for /api/v1/alerts
+class APIAlertsHandler(tornado.web.RequestHandler):
+    def initialize(self, alerts, web_server_metrics):
+        self.alerts = alerts
+        self.web_server_metrics = web_server_metrics
+
+    def get(self):
+        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,
+            # 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()}
+
+            # Fetch all alerts matching the query
+            data = get_alert_list_with_filters(self.alerts, query_params)
+            self.write(json.dumps(data, default=serialize_everything))
+            self.set_status(200)
+        except ValueError as e:
+            logging.error(e)
+            self.write(json.dumps("Bad request - " + str(e), default=serialize_everything))
+            self.set_status(400)
+        except Exception as e:
+            logging.error(e)
+            self.write(json.dumps("Error - " + str(e), default=serialize_everything))
+            self.set_status(500)
+        self.set_header("Cache-Control", "no-store")
+        self.set_header("Content-Type", "application/json")
+
+# API request handler for /api/v1/alerts/stream
+class APIAlertsStreamHandler(tornado_eventsource.handler.EventSourceHandler):
+    def initialize(self, sse_alert_queues, web_server_metrics):
+        self.sse_alert_queues = sse_alert_queues
+        self.web_server_metrics = web_server_metrics
+
+    # Custom headers to avoid e.g. nginx reverse proxy from buffering SSE data
+    def custom_headers(self):
+        return {"Cache-Control": "no-store",
+                "X-Accel-Buffering": "no"}
+
+    def open(self):
+        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,
+            # 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()}
+
+            # Create a alert queue and add it to the web server's list. The web server will fill this when alerts arrive
+            self.alert_queue = Queue(maxsize=SSE_HANDLER_MAX_QUEUE_SIZE)
+            self.sse_alert_queues.append(self.alert_queue)
+
+            # Set up a timed callback to check if anything is in the queue
+            self.heartbeat = tornado.ioloop.PeriodicCallback(self._callback, SSE_HANDLER_QUEUE_CHECK_INTERVAL)
+            self.heartbeat.start()
+
+        except Exception as e:
+            logging.warn("Exception when serving SSE socket", e)
+
+    # When the user closes the socket, empty our queue and remove it from the list so the server no longer fills it
+    def close(self):
+        try:
+            if self.alert_queue in self.sse_alert_queues:
+                self.sse_alert_queues.remove(self.alert_queue)
+            self.alert_queue.empty()
+        except:
+            pass
+        self.alert_queue = None
+        super().close()
+
+    # Callback to check if anything has arrived in the queue, and if so send it to the client
+    def _callback(self):
+        try:
+            if self.alert_queue:
+                while not self.alert_queue.empty():
+                    alert = self.alert_queue.get()
+                    # If the new alert matches our param filters, send it to the client. If not, ignore it.
+                    if alert_allowed_by_query(alert, self.query_params):
+                        self.write_message(msg=json.dumps(alert, default=serialize_everything))
+
+                if self.alert_queue not in self.sse_alert_queues:
+                    logging.error("Web server cleared up a queue of an active connection!")
+                    self.close()
+        except:
+            logging.warn("Exception in SSE callback, connection will be closed.")
+            self.close()
+
+
+
+
+# Utility method to apply filters to the overall alert list and return only a subset. Enables query parameters in
+# the main "alerts" GET call.
+def get_alert_list_with_filters(all_alerts, query):
+    # Create a shallow copy of the alert list ordered by start time, then filter the list to reduce it only to alerts
+    # that match the filter parameters in the query string. Finally, apply a limit to the number of alerts returned.
+    # The list of query string filters is defined in the API docs.
+    alert_ids = list(all_alerts.iterkeys())
+    alerts = []
+    for k in alert_ids:
+        a = all_alerts.get(k)
+        if a is not None:
+            alerts.append(a)
+    alerts = sorted(alerts, key=lambda alert: (alert.start_time if alert and alert.start_time else 0))
+    alerts = list(filter(lambda alert: alert_allowed_by_query(alert, query), alerts))
+    if "limit" in query.keys():
+        alerts = alerts[:int(query.get("limit"))]
+    return alerts
+
+# Given URL query params and an alert, figure out if the alert "passes" the requested filters or is rejected. The list
+# of query parameters and their function is defined in the API docs.
+def alert_allowed_by_query(alert, query):
+    for k in query.keys():
+        match k:
+            case "received_since":
+                since = datetime.fromtimestamp(int(query.get(k)), pytz.UTC)
+                if not alert.received_time or alert.received_time <= since:
+                    return False
+            case "max_duration":
+                max_duration = int(query.get(k))
+                # Check the duration if end_time is provided. If end_time is not provided, assume the activation is
+                # "short", i.e. it always passes this check. If dxpeditions_skip_max_duration_check is true and
+                # the alert is a dxpedition, it also always passes the check.
+                if alert.is_dxpedition and (bool(query.get(
+                        "dxpeditions_skip_max_duration_check")) if "dxpeditions_skip_max_duration_check" in query.keys() else False):
+                    continue
+                if alert.end_time and alert.start_time and alert.end_time - alert.start_time > max_duration:
+                    return False
+            case "source":
+                sources = query.get(k).split(",")
+                if not alert.source or alert.source not in sources:
+                    return False
+            case "sig":
+                # If a list of sigs is provided, the alert must have a sig and it must match one of them.
+                # The special "sig" "NO_SIG", when supplied in the list, mathches alerts with no sig.
+                sigs = query.get(k).split(",")
+                include_no_sig = "NO_SIG" in sigs
+                if not alert.sig and not include_no_sig:
+                    return False
+                if alert.sig and alert.sig not in sigs:
+                    return False
+            case "dx_continent":
+                dxconts = query.get(k).split(",")
+                if not alert.dx_continent or alert.dx_continent not in dxconts:
+                    return False
+            case "dx_call_includes":
+                dx_call_includes = query.get(k).strip()
+                if not alert.dx_call or dx_call_includes.upper() not in alert.dx_call.upper():
+                    return False
+            case "text_includes":
+                text_includes = query.get(k).strip()
+                if (not alert.dx_call or text_includes.upper() not in alert.dx_call.upper()) \
+                        and (not alert.comment or text_includes.upper() not in alert.comment.upper()) \
+                        and (not alert.freqs_modes or text_includes.upper() not in alert.freqs_modes.upper()):
+                    return False
+    return True

server/handlers/api/lookups.py

@@ -0,0 +1,121 @@
+import json
+import logging
+import re
+from datetime import datetime
+
+import pytz
+import tornado
+
+from core.constants import SIGS
+from core.prometheus_metrics_handler import api_requests_counter
+from core.sig_utils import get_ref_regex_for_sig, populate_sig_ref_info
+from core.utils import serialize_everything
+from data.sig_ref import SIGRef
+from data.spot import Spot
+
+
+# API request handler for /api/v1/lookup/call
+class APILookupCallHandler(tornado.web.RequestHandler):
+    def initialize(self, web_server_metrics):
+        self.web_server_metrics = web_server_metrics
+
+    def get(self):
+        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,
+            # 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()}
+
+            # The "call" query param must exist and look like a callsign
+            if "call" in query_params.keys():
+                call = query_params.get("call").upper()
+                if re.match(r"^[A-Z0-9/\-]*$", call):
+                    # Take the callsign, make a "fake spot" so we can run infer_missing() on it, then repack the
+                    # resulting data in the correct way for the API response.
+                    fake_spot = Spot(dx_call=call)
+                    fake_spot.infer_missing()
+                    data = {
+                        "call": call,
+                        "name": fake_spot.dx_name,
+                        "qth": fake_spot.dx_qth,
+                        "country": fake_spot.dx_country,
+                        "flag": fake_spot.dx_flag,
+                        "continent": fake_spot.dx_continent,
+                        "dxcc_id": fake_spot.dx_dxcc_id,
+                        "cq_zone": fake_spot.dx_cq_zone,
+                        "itu_zone": fake_spot.dx_itu_zone,
+                        "grid": fake_spot.dx_grid,
+                        "latitude": fake_spot.dx_latitude,
+                        "longitude": fake_spot.dx_longitude,
+                        "location_source": fake_spot.dx_location_source
+                    }
+                    self.write(json.dumps(data, default=serialize_everything))
+
+                else:
+                    self.write(json.dumps("Error - '" + call + "' does not look like a valid callsign.",
+                                          default=serialize_everything))
+                    self.set_status(422)
+            else:
+                self.write(json.dumps("Error - call must be provided", default=serialize_everything))
+                self.set_status(422)
+
+        except Exception as e:
+            logging.error(e)
+            self.write(json.dumps("Error - " + str(e), default=serialize_everything))
+            self.set_status(500)
+
+        self.set_header("Cache-Control", "no-store")
+        self.set_header("Content-Type", "application/json")
+
+
+# API request handler for /api/v1/lookup/sigref
+class APILookupSIGRefHandler(tornado.web.RequestHandler):
+    def initialize(self, web_server_metrics):
+        self.web_server_metrics = web_server_metrics
+
+    def get(self):
+        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,
+            # 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()}
+
+            # "sig" and "id" query params must exist, SIG must be known, and if we have a reference regex for that SIG,
+            # the provided id must match it.
+            if "sig" in query_params.keys() and "id" in query_params.keys():
+                sig = query_params.get("sig").upper()
+                id = query_params.get("id").upper()
+                if sig in list(map(lambda p: p.name, SIGS)):
+                    if not get_ref_regex_for_sig(sig) or re.match(get_ref_regex_for_sig(sig), id):
+                        data = populate_sig_ref_info(SIGRef(id=id, sig=sig))
+                        self.write(json.dumps(data, default=serialize_everything))
+
+                    else:
+                        self.write(
+                            json.dumps("Error - '" + id + "' does not look like a valid reference ID for " + sig + ".",
+                                       default=serialize_everything))
+                        self.set_status(422)
+                else:
+                    self.write(json.dumps("Error - sig '" + sig + "' is not known.", default=serialize_everything))
+                    self.set_status(422)
+            else:
+                self.write(json.dumps("Error - sig and id must be provided", default=serialize_everything))
+                self.set_status(422)
+
+        except Exception as e:
+            logging.error(e)
+            self.write(json.dumps("Error - " + str(e), default=serialize_everything))
+            self.set_status(500)
+
+        self.set_header("Cache-Control", "no-store")
+        self.set_header("Content-Type", "application/json")

server/handlers/api/options.py

@@ -0,0 +1,48 @@
+import json
+from datetime import datetime
+
+import pytz
+import tornado
+
+from core.config import MAX_SPOT_AGE, ALLOW_SPOTTING, WEB_UI_OPTIONS
+from core.constants import BANDS, ALL_MODES, MODE_TYPES, SIGS, CONTINENTS
+from core.prometheus_metrics_handler import api_requests_counter
+from core.utils import serialize_everything
+
+
+# API request handler for /api/v1/options
+class APIOptionsHandler(tornado.web.RequestHandler):
+    def initialize(self, status_data, web_server_metrics):
+        self.status_data = status_data
+        self.web_server_metrics = web_server_metrics
+
+    def get(self):
+        # 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()
+
+        options = {"bands": BANDS,
+                   "modes": ALL_MODES,
+                   "mode_types": MODE_TYPES,
+                   "sigs": SIGS,
+                   # Spot/alert sources are filtered for only ones that are enabled in config, no point letting the user toggle things that aren't even available.
+                   "spot_sources": list(
+                       map(lambda p: p["name"], filter(lambda p: p["enabled"], self.status_data["spot_providers"]))),
+                   "alert_sources": list(
+                       map(lambda p: p["name"], filter(lambda p: p["enabled"], self.status_data["alert_providers"]))),
+                   "continents": CONTINENTS,
+                   "max_spot_age": MAX_SPOT_AGE,
+                   "spot_allowed": ALLOW_SPOTTING,
+                   "web-ui-options": WEB_UI_OPTIONS}
+        # If spotting to this server is enabled, "API" is another valid spot source even though it does not come from
+        # one of our proviers.
+        if ALLOW_SPOTTING:
+            options["spot_sources"].append("API")
+            options["web-ui-options"]["spot-providers-enabled-by-default"].append("API")
+
+        self.write(json.dumps(options, default=serialize_everything))
+        self.set_status(200)
+        self.set_header("Cache-Control", "no-store")
+        self.set_header("Content-Type", "application/json")

server/handlers/api/spots.py

@@ -0,0 +1,239 @@
+import json
+import logging
+from datetime import datetime, timedelta
+from queue import Queue
+
+import pytz
+import tornado
+import tornado_eventsource.handler
+
+from core.prometheus_metrics_handler import api_requests_counter
+from core.utils import serialize_everything
+
+SSE_HANDLER_MAX_QUEUE_SIZE = 1000
+SSE_HANDLER_QUEUE_CHECK_INTERVAL = 5000
+
+
+# API request handler for /api/v1/spots
+class APISpotsHandler(tornado.web.RequestHandler):
+    def initialize(self, spots, web_server_metrics):
+        self.spots = spots
+        self.web_server_metrics = web_server_metrics
+
+    def get(self):
+        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,
+            # 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()}
+
+            # Fetch all spots matching the query
+            data = get_spot_list_with_filters(self.spots, query_params)
+            self.write(json.dumps(data, default=serialize_everything))
+            self.set_status(200)
+        except ValueError as e:
+            logging.error(e)
+            self.write(json.dumps("Bad request - " + str(e), default=serialize_everything))
+            self.set_status(400)
+        except Exception as e:
+            logging.error(e)
+            self.write(json.dumps("Error - " + str(e), default=serialize_everything))
+            self.set_status(500)
+        self.set_header("Cache-Control", "no-store")
+        self.set_header("Content-Type", "application/json")
+
+
+# API request handler for /api/v1/spots/stream
+class APISpotsStreamHandler(tornado_eventsource.handler.EventSourceHandler):
+    def initialize(self, sse_spot_queues, web_server_metrics):
+        self.sse_spot_queues = sse_spot_queues
+        self.web_server_metrics = web_server_metrics
+
+    # Custom headers to avoid e.g. nginx reverse proxy from buffering SSE data
+    def custom_headers(self):
+        return {"Cache-Control": "no-store",
+                "X-Accel-Buffering": "no"}
+
+    # Called once on the client opening a connection, set things up
+    def open(self):
+        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,
+            # 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()}
+
+            # Create a spot queue and add it to the web server's list. The web server will fill this when spots arrive
+            self.spot_queue = Queue(maxsize=SSE_HANDLER_MAX_QUEUE_SIZE)
+            self.sse_spot_queues.append(self.spot_queue)
+
+            # Set up a timed callback to check if anything is in the queue
+            self.heartbeat = tornado.ioloop.PeriodicCallback(self._callback, SSE_HANDLER_QUEUE_CHECK_INTERVAL)
+            self.heartbeat.start()
+
+        except Exception as e:
+            logging.warn("Exception when serving SSE socket", e)
+
+    # When the user closes the socket, empty our queue and remove it from the list so the server no longer fills it
+    def close(self):
+        try:
+            if self.spot_queue in self.sse_spot_queues:
+                self.sse_spot_queues.remove(self.spot_queue)
+            self.spot_queue.empty()
+        except:
+            pass
+        self.spot_queue = None
+        super().close()
+
+    # Callback to check if anything has arrived in the queue, and if so send it to the client
+    def _callback(self):
+        try:
+            if self.spot_queue:
+                while not self.spot_queue.empty():
+                    spot = self.spot_queue.get()
+                    # If the new spot matches our param filters, send it to the client. If not, ignore it.
+                    if spot_allowed_by_query(spot, self.query_params):
+                        self.write_message(msg=json.dumps(spot, default=serialize_everything))
+
+                if self.spot_queue not in self.sse_spot_queues:
+                    logging.error("Web server cleared up a queue of an active connection!")
+                    self.close()
+        except:
+            logging.warn("Exception in SSE callback, connection will be closed.")
+            self.close()
+
+
+
+# Utility method to apply filters to the overall spot list and return only a subset. Enables query parameters in
+# the main "spots" GET call.
+def get_spot_list_with_filters(all_spots, query):
+    # Create a shallow copy of the spot list, ordered by spot time, then filter the list to reduce it only to spots
+    # that match the filter parameters in the query string. Finally, apply a limit to the number of spots returned.
+    # The list of query string filters is defined in the API docs.
+    spot_ids = list(all_spots.iterkeys())
+    spots = []
+    for k in spot_ids:
+        s = all_spots.get(k)
+        if s is not None:
+            spots.append(s)
+    spots = sorted(spots, key=lambda spot: (spot.time if spot and spot.time else 0), reverse=True)
+    spots = list(filter(lambda spot: spot_allowed_by_query(spot, query), spots))
+    if "limit" in query.keys():
+        spots = spots[:int(query.get("limit"))]
+
+    # Ensure only the latest spot of each callsign-SSID combo is present in the list. This relies on the
+    # list being in reverse time order, so if any future change allows re-ordering the list, that should
+    # be done *after* this. SSIDs are deliberately included here (see issue #68) because e.g. M0TRT-7
+    # and M0TRT-9 APRS transponders could well be in different locations, on different frequencies etc.
+    # This is a special consideration for the geo map and band map views (and Field Spotter) because while
+    # duplicates are fine in the main spot list (e.g. different cluster spots of the same DX) this doesn't
+    # work well for the other views.
+    if "dedupe" in query.keys():
+            dedupe = query.get("dedupe").upper() == "TRUE"
+            if dedupe:
+                spots_temp = []
+                already_seen = []
+                for s in spots:
+                    call_plus_ssid = s.dx_call + (s.dx_ssid if s.dx_ssid else "")
+                    if call_plus_ssid not in already_seen:
+                        spots_temp.append(s)
+                        already_seen.append(call_plus_ssid)
+                spots = spots_temp
+
+    return spots
+
+# Given URL query params and a spot, figure out if the spot "passes" the requested filters or is rejected. The list
+# of query parameters and their function is defined in the API docs.
+def spot_allowed_by_query(spot, query):
+    for k in query.keys():
+        match k:
+            case "since":
+                since = datetime.fromtimestamp(int(query.get(k)), pytz.UTC).timestamp()
+                if not spot.time or spot.time <= since:
+                    return False
+            case "max_age":
+                max_age = int(query.get(k))
+                since = (datetime.now(pytz.UTC) - timedelta(seconds=max_age)).timestamp()
+                if not spot.time or spot.time <= since:
+                    return False
+            case "received_since":
+                since = datetime.fromtimestamp(int(query.get(k)), pytz.UTC).timestamp()
+                if not spot.received_time or spot.received_time <= since:
+                    return False
+            case "source":
+                sources = query.get(k).split(",")
+                if not spot.source or spot.source not in sources:
+                    return False
+            case "sig":
+                # If a list of sigs is provided, the spot must have a sig and it must match one of them.
+                # The special "sig" "NO_SIG", when supplied in the list, mathches spots with no sig.
+                sigs = query.get(k).split(",")
+                include_no_sig = "NO_SIG" in sigs
+                if not spot.sig and not include_no_sig:
+                    return False
+                if spot.sig and spot.sig not in sigs:
+                    return False
+            case "needs_sig":
+                # If true, a sig is required, regardless of what it is, it just can't be missing. Mutually
+                # exclusive with supplying the special "NO_SIG" parameter to the "sig" query param.
+                needs_sig = query.get(k).upper() == "TRUE"
+                if needs_sig and not spot.sig:
+                    return False
+            case "needs_sig_ref":
+                # If true, at least one sig ref is required, regardless of what it is, it just can't be missing.
+                needs_sig_ref = query.get(k).upper() == "TRUE"
+                if needs_sig_ref and (not spot.sig_refs or len(spot.sig_refs) == 0):
+                    return False
+            case "band":
+                bands = query.get(k).split(",")
+                if not spot.band or spot.band not in bands:
+                    return False
+            case "mode":
+                modes = query.get(k).split(",")
+                if not spot.mode or spot.mode not in modes:
+                    return False
+            case "mode_type":
+                mode_types = query.get(k).split(",")
+                if not spot.mode_type or spot.mode_type not in mode_types:
+                    return False
+            case "dx_continent":
+                dxconts = query.get(k).split(",")
+                if not spot.dx_continent or spot.dx_continent not in dxconts:
+                    return False
+            case "de_continent":
+                deconts = query.get(k).split(",")
+                if not spot.de_continent or spot.de_continent not in deconts:
+                    return False
+            case "comment_includes":
+                comment_includes = query.get(k).strip()
+                if not spot.comment or comment_includes.upper() not in spot.comment.upper():
+                    return False
+            case "dx_call_includes":
+                dx_call_includes = query.get(k).strip()
+                if not spot.dx_call or dx_call_includes.upper() not in spot.dx_call.upper():
+                    return False
+            case "text_includes":
+                text_includes = query.get(k).strip()
+                if (not spot.dx_call or text_includes.upper() not in spot.dx_call.upper()) \
+                        and (not spot.comment or text_includes.upper() not in spot.comment.upper()):
+                    return False
+            case "allow_qrt":
+                # If false, spots that are flagged as QRT are not returned.
+                prevent_qrt = query.get(k).upper() == "FALSE"
+                if prevent_qrt and spot.qrt and spot.qrt == True:
+                    return False
+            case "needs_good_location":
+                # If true, spots require a "good" location to be returned
+                needs_good_location = query.get(k).upper() == "TRUE"
+                if needs_good_location and not spot.dx_location_good:
+                    return False
+    return True

server/handlers/api/status.py

@@ -0,0 +1,27 @@
+import json
+from datetime import datetime
+
+import pytz
+import tornado
+
+from core.prometheus_metrics_handler import api_requests_counter
+from core.utils import serialize_everything
+
+
+# API request handler for /api/v1/status
+class APIStatusHandler(tornado.web.RequestHandler):
+    def initialize(self, status_data, web_server_metrics):
+        self.status_data = status_data
+        self.web_server_metrics = web_server_metrics
+
+    def get(self):
+        # 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(json.dumps(self.status_data, default=serialize_everything))
+        self.set_status(200)
+        self.set_header("Cache-Control", "no-store")
+        self.set_header("Content-Type", "application/json")

server/handlers/metrics.py

@@ -0,0 +1,12 @@
+import tornado
+from prometheus_client import CONTENT_TYPE_LATEST
+
+from core.prometheus_metrics_handler import get_metrics
+
+
+# Handler for Prometheus metrics endpoint
+class PrometheusMetricsHandler(tornado.web.RequestHandler):
+    def get(self):
+        self.write(get_metrics())
+        self.set_status(200)
+        self.set_header('Content-Type', CONTENT_TYPE_LATEST)

server/handlers/pagetemplate.py

@@ -0,0 +1,26 @@
+from datetime import datetime
+
+import pytz
+import tornado
+
+from core.config import ALLOW_SPOTTING
+from core.constants import SOFTWARE_VERSION
+from core.prometheus_metrics_handler import page_requests_counter
+
+
+# Handler for all HTML pages generated from templates
+class PageTemplateHandler(tornado.web.RequestHandler):
+    def initialize(self, template_name, web_server_metrics):
+        self.template_name = template_name
+        self.web_server_metrics = web_server_metrics
+
+    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
+        self.render(self.template_name + ".html", software_version=SOFTWARE_VERSION, allow_spotting=ALLOW_SPOTTING)
+

server/webserver.py

@@ -1,430 +1,78 @@
-import json
+import asyncio
 import logging
-import re
-from datetime import datetime, timedelta
-from queue import Queue
-from threading import Thread
+import os
 
-import bottle
-import gevent
-import pytz
-from bottle import run, request, response, template
+import tornado
+from tornado.web import StaticFileHandler
 
-from core.config import MAX_SPOT_AGE, ALLOW_SPOTTING, WEB_UI_OPTIONS
-from core.constants import BANDS, ALL_MODES, MODE_TYPES, SIGS, CONTINENTS, SOFTWARE_VERSION, UNKNOWN_BAND
-from core.lookup_helper import lookup_helper
-from core.prometheus_metrics_handler import page_requests_counter, get_metrics, api_requests_counter
-from core.sig_utils import get_ref_regex_for_sig, populate_sig_ref_info
-from data.sig_ref import SIGRef
-from data.spot import Spot
+from server.handlers.api.addspot import APISpotHandler
+from server.handlers.api.alerts import APIAlertsHandler, APIAlertsStreamHandler
+from server.handlers.api.lookups import APILookupCallHandler, APILookupSIGRefHandler
+from server.handlers.api.options import APIOptionsHandler
+from server.handlers.api.spots import APISpotsHandler, APISpotsStreamHandler
+from server.handlers.api.status import APIStatusHandler
+from server.handlers.metrics import PrometheusMetricsHandler
+from server.handlers.pagetemplate import PageTemplateHandler
 
 
 # Provides the public-facing web server.
 class WebServer:
-
     # Constructor
     def __init__(self, spots, alerts, status_data, port):
-        self.last_page_access_time = None
-        self.last_api_access_time = None
-        self.page_access_counter = 0
-        self.api_access_counter = 0
         self.spots = spots
         self.alerts = alerts
         self.sse_spot_queues = []
         self.sse_alert_queues = []
         self.status_data = status_data
         self.port = port
-        self.thread = Thread(target=self.run)
-        self.thread.daemon = True
-        self.status = "Starting"
-
-        # Base template data
-        bottle.BaseTemplate.defaults['software_version'] = SOFTWARE_VERSION
-        bottle.BaseTemplate.defaults['allow_spotting'] = ALLOW_SPOTTING
-
-        # Routes for API calls
-        bottle.get("/api/v1/spots")(lambda: self.serve_spots_api())
-        bottle.get("/api/v1/alerts")(lambda: self.serve_alerts_api())
-        bottle.get("/api/v1/spots/stream")(lambda: self.serve_sse_spots_api())
-        bottle.get("/api/v1/alerts/stream")(lambda: self.serve_sse_alerts_api())
-        bottle.get("/api/v1/options")(lambda: self.serve_api(self.get_options()))
-        bottle.get("/api/v1/status")(lambda: self.serve_api(self.status_data))
-        bottle.get("/api/v1/lookup/call")(lambda: self.serve_call_lookup_api())
-        bottle.get("/api/v1/lookup/sigref")(lambda: self.serve_sig_ref_lookup_api())
-        bottle.post("/api/v1/spot")(lambda: self.accept_spot())
-        # Routes for templated pages
-        bottle.get("/")(lambda: self.serve_template('webpage_spots'))
-        bottle.get("/map")(lambda: self.serve_template('webpage_map'))
-        bottle.get("/bands")(lambda: self.serve_template('webpage_bands'))
-        bottle.get("/alerts")(lambda: self.serve_template('webpage_alerts'))
-        bottle.get("/add-spot")(lambda: self.serve_template('webpage_add_spot'))
-        bottle.get("/status")(lambda: self.serve_template('webpage_status'))
-        bottle.get("/about")(lambda: self.serve_template('webpage_about'))
-        bottle.get("/apidocs")(lambda: self.serve_template('webpage_apidocs'))
-        # Route for Prometheus metrics
-        bottle.get("/metrics")(lambda: self.serve_prometheus_metrics())
-        # Default route to serve from "webassets"
-        bottle.get("/<filepath:path>")(self.serve_static_file)
+        self.shutdown_event = asyncio.Event()
+        self.web_server_metrics = {
+            "last_page_access_time": None,
+            "last_api_access_time": None,
+            "page_access_counter": 0,
+            "api_access_counter": 0,
+            "status": "Starting"
+        }
 
     # Start the web server
     def start(self):
-        self.thread.start()
+        asyncio.run(self.start_inner())
 
-    # Run the web server itself. This blocks until the server is shut down, so it runs in a separate thread.
-    def run(self):
-        logging.info("Starting web server on port " + str(self.port) + "...")
-        self.status = "Waiting"
-        run(host='localhost', port=self.port, server="gevent")
+    # Stop the web server
+    def stop(self):
+        self.shutdown_event.set()
 
-    # Serve the JSON API /spots endpoint
-    def serve_spots_api(self):
-        try:
-            data = self.get_spot_list_with_filters()
-            return self.serve_api(data)
-        except ValueError as e:
-            logging.error(e)
-            response.content_type = 'application/json'
-            response.status = 400
-            return json.dumps("Bad request - " + str(e), default=serialize_everything)
-        except Exception as e:
-            logging.error(e)
-            response.content_type = 'application/json'
-            response.status = 500
-            return json.dumps("Error - " + str(e), default=serialize_everything)
-
-    # Serve the JSON API /alerts endpoint
-    def serve_alerts_api(self):
-        try:
-            data = self.get_alert_list_with_filters()
-            return self.serve_api(data)
-        except ValueError as e:
-            logging.error(e)
-            response.content_type = 'application/json'
-            response.status = 400
-            return json.dumps("Bad request - " + str(e), default=serialize_everything)
-        except Exception as e:
-            logging.error(e)
-            response.content_type = 'application/json'
-            response.status = 500
-            return json.dumps("Error - " + str(e), default=serialize_everything)
-
-    # Serve the SSE JSON API /spots/stream endpoint
-    def serve_sse_spots_api(self):
-        try:
-            response.content_type  = 'text/event-stream'
-            response.cache_control = 'no-cache'
-            yield 'retry: 1000\n\n'
-
-            spot_queue = Queue(maxsize=100)
-            self.sse_spot_queues.append(spot_queue)
-            while True:
-                if spot_queue.empty():
-                    gevent.sleep(1)
-                else:
-                    spot = spot_queue.get()
-                    yield 'data: ' + json.dumps(spot, default=serialize_everything) + '\n\n'
-        except Exception as e:
-            logging.warn("Exception when serving SSE socket", e)
-
-
-    # Serve the SSE JSON API /alerts/stream endpoint
-    def serve_sse_alerts_api(self):
-        try:
-            response.content_type  = 'text/event-stream'
-            response.cache_control = 'no-cache'
-            yield 'retry: 1000\n\n'
-
-            alert_queue = Queue(maxsize=100)
-            self.sse_alert_queues.append(alert_queue)
-            while True:
-                if alert_queue.empty():
-                    gevent.sleep(1)
-                else:
-                    alert = alert_queue.get()
-                    yield 'data: ' + json.dumps(alert, default=serialize_everything) + '\n\n'
-        except Exception as e:
-            logging.warn("Exception when serving SSE socket", e)
-
-    # Look up data for a callsign
-    def serve_call_lookup_api(self):
-        try:
-            # Reject if no callsign
-            query = bottle.request.query
-            if not "call" in query.keys():
-                response.content_type = 'application/json'
-                response.status = 422
-                return json.dumps("Error - call must be provided", default=serialize_everything)
-            call = query.get("call").upper()
-
-            # Reject badly formatted callsigns
-            if not re.match(r"^[A-Za-z0-9/\-]*$", call):
-                response.content_type = 'application/json'
-                response.status = 422
-                return json.dumps("Error - '" + call + "' does not look like a valid callsign.",
-                                  default=serialize_everything)
-
-            # Take the callsign, make a "fake spot" so we can run infer_missing() on it, then repack the resulting data
-            # in the correct way for the API response.
-            fake_spot = Spot(dx_call=call)
-            fake_spot.infer_missing()
-            return self.serve_api({
-                "call": call,
-                "name": fake_spot.dx_name,
-                "qth": fake_spot.dx_qth,
-                "country": fake_spot.dx_country,
-                "flag": fake_spot.dx_flag,
-                "continent": fake_spot.dx_continent,
-                "dxcc_id": fake_spot.dx_dxcc_id,
-                "cq_zone": fake_spot.dx_cq_zone,
-                "itu_zone": fake_spot.dx_itu_zone,
-                "grid": fake_spot.dx_grid,
-                "latitude": fake_spot.dx_latitude,
-                "longitude": fake_spot.dx_longitude,
-                "location_source": fake_spot.dx_location_source
-            })
-
-        except Exception as e:
-            logging.error(e)
-            response.content_type = 'application/json'
-            response.status = 500
-            return json.dumps("Error -  " + str(e), default=serialize_everything)
-
-    # Look up data for a SIG reference
-    def serve_sig_ref_lookup_api(self):
-        try:
-            # Reject if no sig or sig_ref
-            query = bottle.request.query
-            if not "sig" in query.keys() or not "id" in query.keys():
-                response.content_type = 'application/json'
-                response.status = 422
-                return json.dumps("Error - sig and id must be provided", default=serialize_everything)
-            sig = query.get("sig").upper()
-            id = query.get("id").upper()
-
-            # Reject if sig unknown
-            if not sig in list(map(lambda p: p.name, SIGS)):
-                response.content_type = 'application/json'
-                response.status = 422
-                return json.dumps("Error - sig '" + sig + "' is not known.", default=serialize_everything)
-
-            # Reject if sig_ref format incorrect for sig
-            if get_ref_regex_for_sig(sig) and not re.match(get_ref_regex_for_sig(sig), id):
-                response.content_type = 'application/json'
-                response.status = 422
-                return json.dumps("Error - '" + id + "' does not look like a valid reference ID for " + sig + ".", default=serialize_everything)
-
-            data = populate_sig_ref_info(SIGRef(id=id, sig=sig))
-            return self.serve_api(data)
-
-        except Exception as e:
-            logging.error(e)
-            response.content_type = 'application/json'
-            response.status = 500
-            return json.dumps("Error -  " + str(e), default=serialize_everything)
-
-    # Serve a JSON API endpoint
-    def serve_api(self, data):
-        self.last_api_access_time = datetime.now(pytz.UTC)
-        self.api_access_counter += 1
-        api_requests_counter.inc()
-        self.status = "OK"
-        response.content_type = 'application/json'
-        response.set_header('Cache-Control', 'no-store')
-        return json.dumps(data, default=serialize_everything)
-
-    # Accept a spot
-    def accept_spot(self):
-        self.last_api_access_time = datetime.now(pytz.UTC)
-        self.api_access_counter += 1
-        api_requests_counter.inc()
-        self.status = "OK"
-
-        try:
-            # Reject if not allowed
-            if not ALLOW_SPOTTING:
-                response.content_type = 'application/json'
-                response.status = 401
-                return json.dumps("Error - this server does not allow new spots to be added via the API.",
-                                  default=serialize_everything)
-
-            # Reject if format not json
-            if not request.get_header('Content-Type') or request.get_header('Content-Type') != "application/json":
-                response.content_type = 'application/json'
-                response.status = 415
-                return json.dumps("Error - request Content-Type must be application/json", default=serialize_everything)
-
-            # Reject if request body is empty
-            post_data = request.body.read()
-            if not post_data:
-                response.content_type = 'application/json'
-                response.status = 422
-                return json.dumps("Error - request body is empty", default=serialize_everything)
-
-            # Read in the request body as JSON then convert to a Spot object
-            json_spot = json.loads(post_data)
-            spot = Spot(**json_spot)
-
-            # Converting to a spot object this way won't have coped with sig_ref objects, so fix that. (Would be nice to
-            # redo this in a functional style)
-            if spot.sig_refs:
-                real_sig_refs = []
-                for dict_obj in spot.sig_refs:
-                    real_sig_refs.append(json.loads(json.dumps(dict_obj), object_hook=lambda d: SIGRef(**d)))
-                spot.sig_refs = real_sig_refs
-
-            # Reject if no timestamp, frequency, dx_call or de_call
-            if not spot.time or not spot.dx_call or not spot.freq or not spot.de_call:
-                response.content_type = 'application/json'
-                response.status = 422
-                return json.dumps("Error - 'time', 'dx_call', 'freq' and 'de_call' must be provided as a minimum.",
-                                  default=serialize_everything)
-
-            # Reject invalid-looking callsigns
-            if not re.match(r"^[A-Za-z0-9/\-]*$", spot.dx_call):
-                response.content_type = 'application/json'
-                response.status = 422
-                return json.dumps("Error - '" + spot.dx_call + "' does not look like a valid callsign.",
-                                  default=serialize_everything)
-            if not re.match(r"^[A-Za-z0-9/\-]*$", spot.de_call):
-                response.content_type = 'application/json'
-                response.status = 422
-                return json.dumps("Error - '" + spot.de_call + "' does not look like a valid callsign.",
-                                  default=serialize_everything)
-
-            # Reject if frequency not in a known band
-            if lookup_helper.infer_band_from_freq(spot.freq) == UNKNOWN_BAND:
-                response.content_type = 'application/json'
-                response.status = 422
-                return json.dumps("Error - Frequency of " + str(spot.freq / 1000.0) + "kHz is not in a known band.", default=serialize_everything)
-
-            # Reject if grid formatting incorrect
-            if spot.dx_grid and not re.match(r"^([A-R]{2}[0-9]{2}[A-X]{2}[0-9]{2}[A-X]{2}|[A-R]{2}[0-9]{2}[A-X]{2}[0-9]{2}|[A-R]{2}[0-9]{2}[A-X]{2}|[A-R]{2}[0-9]{2})$", spot.dx_grid.upper()):
-                response.content_type = 'application/json'
-                response.status = 422
-                return json.dumps("Error - '" + spot.dx_grid + "' does not look like a valid Maidenhead grid.", default=serialize_everything)
-
-            # Reject if sig_ref format incorrect for sig
-            if spot.sig and spot.sig_refs and len(spot.sig_refs) > 0 and spot.sig_refs[0].id and get_ref_regex_for_sig(spot.sig) and not re.match(get_ref_regex_for_sig(spot.sig), spot.sig_refs[0].id):
-                response.content_type = 'application/json'
-                response.status = 422
-                return json.dumps("Error - '" + spot.sig_refs[0].id + "' does not look like a valid reference for " + spot.sig + ".", default=serialize_everything)
-
-            # infer missing data, and add it to our database.
-            spot.source = "API"
-            spot.infer_missing()
-            self.spots.add(spot.id, spot, expire=MAX_SPOT_AGE)
-
-            response.content_type = 'application/json'
-            response.set_header('Cache-Control', 'no-store')
-            response.status = 201
-            return json.dumps("OK", default=serialize_everything)
-        except Exception as e:
-            logging.error(e)
-            response.content_type = 'application/json'
-            response.status = 500
-            return json.dumps("Error -  " + str(e), default=serialize_everything)
-
-    # Serve a templated page
-    def serve_template(self, template_name):
-        self.last_page_access_time = datetime.now(pytz.UTC)
-        self.page_access_counter += 1
-        page_requests_counter.inc()
-        self.status = "OK"
-        return template(template_name)
-
-    # Serve general static files from "webassets" directory.
-    def serve_static_file(self, filepath):
-        return bottle.static_file(filepath, root="webassets")
-
-    # Serve Prometheus metrics
-    def serve_prometheus_metrics(self):
-        return get_metrics()
-
-    # Utility method to apply filters to the overall spot list and return only a subset. Enables query parameters in
-    # the main "spots" GET call.
-    def get_spot_list_with_filters(self):
-        # Get the query (and the right one, with Bottle magic. This is a MultiDict object)
-        query = bottle.request.query
-
-        # Create a shallow copy of the spot list, ordered by spot time, then filter the list to reduce it only to spots
-        # that match the filter parameters in the query string. Finally, apply a limit to the number of spots returned.
-        # The list of query string filters is defined in the API docs.
-        spot_ids = list(self.spots.iterkeys())
-        spots = []
-        for k in spot_ids:
-            s = self.spots.get(k)
-            if s is not None:
-                spots.append(s)
-        spots = sorted(spots, key=lambda spot: (spot.time if spot and spot.time else 0), reverse=True)
-        spots = list(filter(lambda spot: spot_allowed_by_query(spot, query), spots))
-        if "limit" in query.keys():
-            spots = spots[:int(query.get("limit"))]
-
-        # Ensure only the latest spot of each callsign-SSID combo is present in the list. This relies on the
-        # list being in reverse time order, so if any future change allows re-ordering the list, that should
-        # be done *after* this. SSIDs are deliberately included here (see issue #68) because e.g. M0TRT-7
-        # and M0TRT-9 APRS transponders could well be in different locations, on different frequencies etc.
-        # This is a special consideration for the geo map and band map views (and Field Spotter) because while
-        # duplicates are fine in the main spot list (e.g. different cluster spots of the same DX) this doesn't
-        # work well for the other views.
-        if "dedupe" in query.keys():
-                dedupe = query.get("dedupe").upper() == "TRUE"
-                if dedupe:
-                    spots_temp = []
-                    already_seen = []
-                    for s in spots:
-                        call_plus_ssid = s.dx_call + (s.dx_ssid if s.dx_ssid else "")
-                        if call_plus_ssid not in already_seen:
-                            spots_temp.append(s)
-                            already_seen.append(call_plus_ssid)
-                    spots = spots_temp
-
-        return spots
-
-    # Utility method to apply filters to the overall alert list and return only a subset. Enables query parameters in
-    # the main "alerts" GET call.
-    def get_alert_list_with_filters(self):
-        # Get the query (and the right one, with Bottle magic. This is a MultiDict object)
-        query = bottle.request.query
-
-        # Create a shallow copy of the alert list ordered by start time, then filter the list to reduce it only to alerts
-        # that match the filter parameters in the query string. Finally, apply a limit to the number of alerts returned.
-        # The list of query string filters is defined in the API docs.
-        alert_ids = list(self.alerts.iterkeys())
-        alerts = []
-        for k in alert_ids:
-            a = self.alerts.get(k)
-            if a is not None:
-                alerts.append(a)
-        alerts = sorted(alerts, key=lambda alert: (alert.start_time if alert and alert.start_time else 0))
-        alerts = list(filter(lambda alert: alert_allowed_by_query(alert, query), alerts))
-        if "limit" in query.keys():
-            alerts = alerts[:int(query.get("limit"))]
-        return alerts
-
-    # Return all the "options" for various things that the server is aware of. This can be fetched with an API call.
-    # The idea is that this will include most of the things that can be provided as queries to the main spots call,
-    # and thus a client can use this data to configure its filter controls.
-    def get_options(self):
-        options = {"bands": BANDS,
-                "modes": ALL_MODES,
-                "mode_types": MODE_TYPES,
-                "sigs": SIGS,
-                # Spot/alert sources are filtered for only ones that are enabled in config, no point letting the user toggle things that aren't even available.
-                "spot_sources": list(
-                    map(lambda p: p["name"], filter(lambda p: p["enabled"], self.status_data["spot_providers"]))),
-                "alert_sources": list(
-                    map(lambda p: p["name"], filter(lambda p: p["enabled"], self.status_data["alert_providers"]))),
-                "continents": CONTINENTS,
-                "max_spot_age": MAX_SPOT_AGE,
-                "spot_allowed": ALLOW_SPOTTING,
-                "web-ui-options": WEB_UI_OPTIONS}
-        # If spotting to this server is enabled, "API" is another valid spot source even though it does not come from
-        # one of our proviers.
-        if ALLOW_SPOTTING:
-            options["spot_sources"].append("API")
-
-        return options
+    # Start method (async). Sets up the Tornado application.
+    async def start_inner(self):
+        app = tornado.web.Application([
+            # Routes for API calls
+            (r"/api/v1/spots", APISpotsHandler, {"spots": self.spots, "web_server_metrics": self.web_server_metrics}),
+            (r"/api/v1/alerts", APIAlertsHandler, {"alerts": self.alerts, "web_server_metrics": self.web_server_metrics}),
+            (r"/api/v1/spots/stream", APISpotsStreamHandler, {"sse_spot_queues": self.sse_spot_queues, "web_server_metrics": self.web_server_metrics}),
+            (r"/api/v1/alerts/stream", APIAlertsStreamHandler, {"sse_alert_queues": self.sse_alert_queues, "web_server_metrics": self.web_server_metrics}),
+            (r"/api/v1/options", APIOptionsHandler, {"status_data": self.status_data, "web_server_metrics": self.web_server_metrics}),
+            (r"/api/v1/status", APIStatusHandler, {"status_data": self.status_data, "web_server_metrics": self.web_server_metrics}),
+            (r"/api/v1/lookup/call", APILookupCallHandler, {"web_server_metrics": self.web_server_metrics}),
+            (r"/api/v1/lookup/sigref", APILookupSIGRefHandler, {"web_server_metrics": self.web_server_metrics}),
+            (r"/api/v1/spot", APISpotHandler, {"spots": self.spots, "web_server_metrics": self.web_server_metrics}),
+            # Routes for templated pages
+            (r"/", PageTemplateHandler, {"template_name": "spots", "web_server_metrics": self.web_server_metrics}),
+            (r"/map", PageTemplateHandler, {"template_name": "map", "web_server_metrics": self.web_server_metrics}),
+            (r"/bands", PageTemplateHandler, {"template_name": "bands", "web_server_metrics": self.web_server_metrics}),
+            (r"/alerts", PageTemplateHandler, {"template_name": "alerts", "web_server_metrics": self.web_server_metrics}),
+            (r"/add-spot", PageTemplateHandler, {"template_name": "add_spot", "web_server_metrics": self.web_server_metrics}),
+            (r"/status", PageTemplateHandler, {"template_name": "status", "web_server_metrics": self.web_server_metrics}),
+            (r"/about", PageTemplateHandler, {"template_name": "about", "web_server_metrics": self.web_server_metrics}),
+            (r"/apidocs", PageTemplateHandler, {"template_name": "apidocs", "web_server_metrics": self.web_server_metrics}),
+            # Route for Prometheus metrics
+            (r"/metrics", PrometheusMetricsHandler),
+            # Default route to serve from "webassets"
+            (r"/(.*)", StaticFileHandler, {"path": os.path.join(os.path.dirname(__file__), "../webassets")}),
+        ],
+            template_path=os.path.join(os.path.dirname(__file__), "../templates"),
+            debug=False)
+        app.listen(self.port)
+        await self.shutdown_event.wait()
 
     # Internal method called when a new spot is added to the system. This is used to ping any SSE clients that are
     # awaiting a server-sent message with new spots.
@@ -435,6 +83,7 @@ class WebServer:
             except:
                 # Cleanup thread was probably deleting the queue, that's fine
                 pass
+        pass
 
     # Internal method called when a new alert is added to the system. This is used to ping any SSE clients that are
     # awaiting a server-sent message with new spots.
@@ -445,139 +94,27 @@ class WebServer:
             except:
                 # Cleanup thread was probably deleting the queue, that's fine
                 pass
+        pass
 
-    # Clean up any SSE queues that are growing too large; probably their client disconnected.
+    # Clean up any SSE queues that are growing too large; probably their client disconnected and we didn't catch it
+    # properly for some reason.
     def clean_up_sse_queues(self):
-        self.sse_spot_queues = [q for q in self.sse_spot_queues if not q.full()]
-        self.sse_alert_queues = [q for q in self.sse_alert_queues if not q.full()]
-
-
-# Given URL query params and a spot, figure out if the spot "passes" the requested filters or is rejected. The list
-# of query parameters and their function is defined in the API docs.
-def spot_allowed_by_query(spot, query):
-    for k in query.keys():
-        match k:
-            case "since":
-                since = datetime.fromtimestamp(int(query.get(k)), pytz.UTC).timestamp()
-                if not spot.time or spot.time <= since:
-                    return False
-            case "max_age":
-                max_age = int(query.get(k))
-                since = (datetime.now(pytz.UTC) - timedelta(seconds=max_age)).timestamp()
-                if not spot.time or spot.time <= since:
-                    return False
-            case "received_since":
-                since = datetime.fromtimestamp(int(query.get(k)), pytz.UTC).timestamp()
-                if not spot.received_time or spot.received_time <= since:
-                    return False
-            case "source":
-                sources = query.get(k).split(",")
-                if not spot.source or spot.source not in sources:
-                    return False
-            case "sig":
-                # If a list of sigs is provided, the spot must have a sig and it must match one of them.
-                # The special "sig" "NO_SIG", when supplied in the list, mathches spots with no sig.
-                sigs = query.get(k).split(",")
-                include_no_sig = "NO_SIG" in sigs
-                if not spot.sig and not include_no_sig:
-                    return False
-                if spot.sig and spot.sig not in sigs:
-                    return False
-            case "needs_sig":
-                # If true, a sig is required, regardless of what it is, it just can't be missing. Mutually
-                # exclusive with supplying the special "NO_SIG" parameter to the "sig" query param.
-                needs_sig = query.get(k).upper() == "TRUE"
-                if needs_sig and not spot.sig:
-                    return False
-            case "needs_sig_ref":
-                # If true, at least one sig ref is required, regardless of what it is, it just can't be missing.
-                needs_sig_ref = query.get(k).upper() == "TRUE"
-                if needs_sig_ref and (not spot.sig_refs or len(spot.sig_refs) == 0):
-                    return False
-            case "band":
-                bands = query.get(k).split(",")
-                if not spot.band or spot.band not in bands:
-                    return False
-            case "mode":
-                modes = query.get(k).split(",")
-                if not spot.mode or spot.mode not in modes:
-                    return False
-            case "mode_type":
-                mode_types = query.get(k).split(",")
-                if not spot.mode_type or spot.mode_type not in mode_types:
-                    return False
-            case "dx_continent":
-                dxconts = query.get(k).split(",")
-                if not spot.dx_continent or spot.dx_continent not in dxconts:
-                    return False
-            case "de_continent":
-                deconts = query.get(k).split(",")
-                if not spot.de_continent or spot.de_continent not in deconts:
-                    return False
-            case "comment_includes":
-                comment_includes = query.get(k).strip()
-                if not spot.comment or comment_includes.upper() not in spot.comment.upper():
-                    return False
-            case "dx_call_includes":
-                dx_call_includes = query.get(k).strip()
-                if not spot.dx_call or dx_call_includes.upper() not in spot.dx_call.upper():
-                    return False
-            case "allow_qrt":
-                # If false, spots that are flagged as QRT are not returned.
-                prevent_qrt = query.get(k).upper() == "FALSE"
-                if prevent_qrt and spot.qrt and spot.qrt == True:
-                    return False
-            case "needs_good_location":
-                # If true, spots require a "good" location to be returned
-                needs_good_location = query.get(k).upper() == "TRUE"
-                if needs_good_location and not spot.dx_location_good:
-                    return False
-    return True
-
-# Given URL query params and an alert, figure out if the alert "passes" the requested filters or is rejected. The list
-# of query parameters and their function is defined in the API docs.
-def alert_allowed_by_query(alert, query):
-    for k in query.keys():
-        match k:
-            case "received_since":
-                since = datetime.fromtimestamp(int(query.get(k)), pytz.UTC)
-                if not alert.received_time or alert.received_time <= since:
-                    return False
-            case "max_duration":
-                max_duration = int(query.get(k))
-                # Check the duration if end_time is provided. If end_time is not provided, assume the activation is
-                # "short", i.e. it always passes this check. If dxpeditions_skip_max_duration_check is true and
-                # the alert is a dxpedition, it also always passes the check.
-                if alert.is_dxpedition and (bool(query.get(
-                        "dxpeditions_skip_max_duration_check")) if "dxpeditions_skip_max_duration_check" in query.keys() else False):
-                    continue
-                if alert.end_time and alert.start_time and alert.end_time - alert.start_time > max_duration:
-                    return False
-            case "source":
-                sources = query.get(k).split(",")
-                if not alert.source or alert.source not in sources:
-                    return False
-            case "sig":
-                # If a list of sigs is provided, the alert must have a sig and it must match one of them.
-                # The special "sig" "NO_SIG", when supplied in the list, mathches alerts with no sig.
-                sigs = query.get(k).split(",")
-                include_no_sig = "NO_SIG" in sigs
-                if not alert.sig and not include_no_sig:
-                    return False
-                if alert.sig and alert.sig not in sigs:
-                    return False
-            case "dx_continent":
-                dxconts = query.get(k).split(",")
-                if not alert.dx_continent or alert.dx_continent not in dxconts:
-                    return False
-            case "dx_call_includes":
-                dx_call_includes = query.get(k).strip()
-                if not alert.dx_call or dx_call_includes.upper() not in alert.dx_call.upper():
-                    return False
-    return True
-
-# Convert objects to serialisable things. Used by JSON serialiser as a default when it encounters unserializable things.
-# Just converts objects to dict. Try to avoid doing anything clever here when serialising spots, because we also need
-# to receive spots without complex handling.
-def serialize_everything(obj):
-    return obj.__dict__
+        for q in self.sse_spot_queues:
+            try:
+                if q.full():
+                    logging.warn("A full SSE spot queue was found, presumably because the client disconnected strangely. It has been removed.")
+                    self.sse_spot_queues.remove(q)
+                    q.empty()
+            except:
+                # Probably got deleted already on another thread
+                pass
+        for q in self.sse_alert_queues:
+            try:
+                if q.full():
+                    logging.warn("A full SSE alert queue was found, presumably because the client disconnected strangely. It has been removed.")
+                    self.sse_alert_queues.remove(q)
+                    q.empty()
+            except:
+                # Probably got deleted already on another thread
+                pass
+        pass

spothole.py

@@ -1,11 +1,7 @@
 # Main script
-from time import sleep
-
-import gevent
-from gevent import monkey; monkey.patch_all()
-
 import importlib
 import logging
+import os
 import signal
 import sys
 
@@ -33,7 +29,8 @@ run = True
 def shutdown(sig, frame):
     global run
 
-    logging.info("Stopping program, this may take a few seconds...")
+    logging.info("Stopping program...")
+    web_server.stop()
     for p in spot_providers:
         if p.enabled:
             p.stop()
@@ -44,7 +41,7 @@ def shutdown(sig, frame):
     lookup_helper.stop()
     spots.close()
     alerts.close()
-    run = False
+    os._exit(0)
 
 
 # Utility method to get a spot provider based on the class specified in its config entry.
@@ -84,7 +81,6 @@ if __name__ == '__main__':
 
     # Set up web server
     web_server = WebServer(spots=spots, alerts=alerts, status_data=status_data, port=WEB_SERVER_PORT)
-    web_server.start()
 
     # Fetch, set up and start spot providers
     for entry in config["spot-providers"]:
@@ -114,6 +110,7 @@ if __name__ == '__main__':
 
     logging.info("Startup complete.")
 
-    while run:
-        gevent.sleep(1)
-    exit(0)
+    # Run the web server. This is the blocking call that keeps the application running in the main thread, so this must
+    # 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()

spotproviders/aprsis.py

@@ -51,7 +51,6 @@ class APRSIS(SpotProvider):
                     comment=data["comment"] if "comment" in data else None,
                     dx_latitude=data["latitude"] if "latitude" in data else None,
                     dx_longitude=data["longitude"] if "longitude" in data else None,
-                    icon="tower-cell",
                     time=datetime.now(pytz.UTC).timestamp()) # APRS-IS spots are live so we can assume spot time is "now"
 
         # Add to our list

spotproviders/dxcluster.py

@@ -12,22 +12,27 @@ from data.spot import Spot
 from spotproviders.spot_provider import SpotProvider
 
 
-# Spot provider for a DX Cluster. Hostname port and login_prompt provided as parameters.
+# Spot provider for a DX Cluster. Hostname, port, login_prompt, login_callsign and allow_rbn_spots are provided in config.
+# See config-example.yml for examples.
 class DXCluster(SpotProvider):
-    # Note the callsign pattern deliberately excludes calls ending in "-#", which are from RBN and can be enabled by
-    # default on some clusters. If you want RBN spots, there is a separate provider for that.
     CALLSIGN_PATTERN = "([a-z|0-9|/]+)"
     FREQUENCY_PATTERN = "([0-9|.]+)"
-    LINE_PATTERN = re.compile(
+    LINE_PATTERN_EXCLUDE_RBN = re.compile(
         "^DX de " + CALLSIGN_PATTERN + ":\\s+" + FREQUENCY_PATTERN + "\\s+" + CALLSIGN_PATTERN + "\\s+(.*)\\s+(\\d{4}Z)",
         re.IGNORECASE)
+    LINE_PATTERN_ALLOW_RBN = re.compile(
+        "^DX de " + CALLSIGN_PATTERN + "-?#?:\\s+" + FREQUENCY_PATTERN + "\\s+" + CALLSIGN_PATTERN + "\\s+(.*)\\s+(\\d{4}Z)",
+        re.IGNORECASE)
 
     # Constructor requires hostname and port
     def __init__(self, provider_config):
         super().__init__(provider_config)
         self.hostname = provider_config["host"]
         self.port = provider_config["port"]
-        self.login_prompt = provider_config["login_prompt"]
+        self.login_prompt = provider_config["login_prompt"] if "login_prompt" in provider_config else "login:"
+        self.login_callsign = provider_config["login_callsign"] if "login_callsign" in provider_config else SERVER_OWNER_CALLSIGN
+        self.allow_rbn_spots = provider_config["allow_rbn_spots"] if "allow_rbn_spots" in provider_config else False
+        self.spot_line_pattern = self.LINE_PATTERN_ALLOW_RBN if self.allow_rbn_spots else self.LINE_PATTERN_EXCLUDE_RBN
         self.telnet = None
         self.thread = Thread(target=self.handle)
         self.thread.daemon = True
@@ -50,7 +55,7 @@ class DXCluster(SpotProvider):
                     logging.info("DX Cluster " + self.hostname + " connecting...")
                     self.telnet = telnetlib3.Telnet(self.hostname, self.port)
                     self.telnet.read_until(self.login_prompt.encode("latin-1"))
-                    self.telnet.write((SERVER_OWNER_CALLSIGN + "\n").encode("latin-1"))
+                    self.telnet.write((self.login_callsign + "\n").encode("latin-1"))
                     connected = True
                     logging.info("DX Cluster " + self.hostname + " connected.")
                 except Exception as e:
@@ -63,7 +68,7 @@ class DXCluster(SpotProvider):
                 try:
                     # Check new telnet info against regular expression
                     telnet_output = self.telnet.read_until("\n".encode("latin-1"))
-                    match = self.LINE_PATTERN.match(telnet_output.decode("latin-1"))
+                    match = self.spot_line_pattern.match(telnet_output.decode("latin-1"))
                     if match:
                         spot_time = datetime.strptime(match.group(5), "%H%MZ")
                         spot_datetime = datetime.combine(datetime.today(), spot_time.time()).replace(tzinfo=pytz.UTC)
@@ -72,7 +77,6 @@ class DXCluster(SpotProvider):
                                     de_call=match.group(1),
                                     freq=float(match.group(2)) * 1000,
                                     comment=match.group(4).strip(),
-                                    icon="tower-cell",
                                     time=spot_datetime.timestamp())
 
                         # Add to our list

spotproviders/rbn.py

@@ -70,7 +70,6 @@ class RBN(SpotProvider):
                                     de_call=match.group(1),
                                     freq=float(match.group(2)) * 1000,
                                     comment=match.group(4).strip(),
-                                    icon="tower-cell",
                                     time=spot_datetime.timestamp())
 
                         # Add to our list

spotproviders/sota.py

@@ -45,9 +45,8 @@ class SOTA(HTTPSpotProvider):
                             mode=source_spot["mode"].upper(),
                             comment=source_spot["comments"],
                             sig="SOTA",
-                            sig_refs=[SIGRef(id=source_spot["summitCode"], sig="SOTA", name=source_spot["summitName"])],
-                            time=datetime.fromisoformat(source_spot["timeStamp"]).timestamp(),
-                            activation_score=source_spot["points"])
+                            sig_refs=[SIGRef(id=source_spot["summitCode"], sig="SOTA", name=source_spot["summitName"], activation_score=source_spot["points"])],
+                            time=datetime.fromisoformat(source_spot["timeStamp"]).timestamp())
 
                 # Add to our list. Don't worry about de-duping, removing old spots etc. at this point; other code will do
                 # that for us.

spotproviders/spot_provider.py

@@ -32,6 +32,9 @@ class SpotProvider:
     # their infer_missing() method called to complete their data set. This is called by the API-querying
     # subclasses on receiving spots.
     def submit_batch(self, spots):
+        # Sort the batch so that earliest ones go in first. This helps keep the ordering correct when spots are fired
+        # off to SSE listeners.
+        spots = sorted(spots, key=lambda spot: (spot.time if spot and spot.time else 0))
         for spot in spots:
             if datetime.fromtimestamp(spot.time, pytz.UTC) > self.last_spot_time:
                 # Fill in any blanks and add to the list

spotproviders/ukpacketnet.py

@@ -61,7 +61,6 @@ class UKPacketNet(HTTPSpotProvider):
                                             freq=freq,
                                             mode="PKT",
                                             comment=comment,
-                                            icon="tower-cell",
                                             time=datetime.strptime(heard["lastHeard"], "%Y-%m-%d %H:%M:%S").replace(tzinfo=pytz.UTC).timestamp(),
                                             de_grid=node["location"]["locator"] if "locator" in node["location"] else None,
                                             de_latitude=node["location"]["coords"]["lat"],

spotproviders/websocket_spot_provider.py

@@ -47,6 +47,7 @@ class WebsocketSpotProvider(SpotProvider):
                 logging.debug("Connecting to " + self.name + " spot API...")
                 self.status = "Connecting"
                 self.ws = create_connection(self.url, header=HTTP_HEADERS)
+                self.status = "Connected"
                 data = self.ws.recv()
                 if data:
                     try:

spotproviders/xota.py

@@ -1,4 +1,6 @@
+import csv
 import json
+import logging
 from datetime import datetime
 
 import pytz
@@ -9,31 +11,45 @@ from spotproviders.websocket_spot_provider import WebsocketSpotProvider
 
 
 # Spot provider for servers based on the "xOTA" software at https://github.com/nischu/xOTA/
-# The provider typically doesn't give us a lat/lon or SIG explicitly, so our own config provides this information. This
-# functionality is implemented for TOTA events.
+# The provider typically doesn't give us a lat/lon or SIG explicitly, so our own config provides a SIG and a reference
+# to a local CSV file with location information. This functionality is implemented for TOTA events, of which there are
+# several - so a plain lookup of a "TOTA reference" doesn't make sense, it depends on which TOTA and hence which server
+# supplied the data, which is why the CSV location lookup is here and not in sig_utils.
 class XOTA(WebsocketSpotProvider):
-    FIXED_LATITUDE = None
-    FIXED_LONGITUDE = None
+    LOCATION_DATA = {}
     SIG = None
 
     def __init__(self, provider_config):
         super().__init__(provider_config, provider_config["url"])
-        self.FIXED_LATITUDE = provider_config["latitude"] if "latitude" in provider_config else None
-        self.FIXED_LONGITUDE = provider_config["longitude"] if "longitude" in provider_config else None
+        locations_csv = provider_config["locations-csv"] if "locations-csv" in provider_config else None
         self.SIG = provider_config["sig"] if "sig" in provider_config else None
 
+        # Load location data
+        if locations_csv:
+            try:
+                f = open(locations_csv)
+                csv_data = f.read()
+                dr = csv.DictReader(csv_data.splitlines())
+                for row in dr:
+                    self.LOCATION_DATA[row["ref"]] = {"lat": row["lat"], "lon": row["lon"]}
+            except:
+                logging.exception("Could not look up location data for XOTA source.")
+
     def ws_message_to_spot(self, bytes):
         string = bytes.decode("utf-8")
         source_spot = json.loads(string)
+        ref_id = source_spot["reference"]["title"]
+        lat = float(self.LOCATION_DATA[ref_id]["lat"]) if ref_id in self.LOCATION_DATA else None
+        lon = float(self.LOCATION_DATA[ref_id]["lon"]) if ref_id in self.LOCATION_DATA else None
         spot = Spot(source=self.name,
                     source_id=source_spot["id"],
                     dx_call=source_spot["stationCallSign"].upper(),
                     freq=float(source_spot["freq"]) * 1000,
                     mode=source_spot["mode"].upper(),
                     sig=self.SIG,
-                    sig_refs=[SIGRef(id=source_spot["reference"]["title"], sig=self.SIG, url=source_spot["reference"]["website"])],
+                    sig_refs=[SIGRef(id=ref_id, sig=self.SIG, url=source_spot["reference"]["website"], latitude=lat, longitude=lon)],
                     time=datetime.now(pytz.UTC).timestamp(),
-                    dx_latitude=self.FIXED_LATITUDE,
-                    dx_longitude=self.FIXED_LONGITUDE,
+                    dx_latitude=lat,
+                    dx_longitude=lon,
                     qrt=source_spot["state"] != "active")
         return spot

templates/about.html

@@ -1,4 +1,5 @@
-% rebase('webpage_base.tpl')
+{% extends "base.html" %}
+{% block content %}
 
 <div id="info-container" class="mt-4">
     <h2 class="mt-4 mb-4">About Spothole</h2>
@@ -62,5 +63,7 @@
     <p>This software is dedicated to the memory of Tom G1PJB, SK, a friend and colleague who sadly passed away around the time I started writing it in Autumn 2025. I was looking forward to showing it to you when it was done.</p>
 </div>
 
-<script src="/js/common.js?v=1"></script>
+<script src="/js/common.js?v=6"></script>
 <script>$(document).ready(function() { $("#nav-link-about").addClass("active"); }); <!-- highlight active page in nav --></script>
+
+{% end %}

templates/add_spot.html

@@ -1,4 +1,5 @@
-% rebase('webpage_base.tpl')
+{% extends "base.html" %}
+{% block content %}
 
 <div id="add-spot-intro-box" class="permanently-dismissible-box mt-3">
 <div class="alert alert-primary alert-dismissible fade show" role="alert">
@@ -68,6 +69,8 @@
 
 </div>
 
-<script src="/js/common.js?v=1"></script>
-<script src="/js/add-spot.js?v=1"></script>
+<script src="/js/common.js?v=6"></script>
+<script src="/js/add-spot.js?v=6"></script>
 <script>$(document).ready(function() { $("#nav-link-add-spot").addClass("active"); }); <!-- highlight active page in nav --></script>
+
+{% end %}

templates/alerts.html

@@ -1,4 +1,5 @@
-% rebase('webpage_base.tpl')
+{% extends "base.html" %}
+{% block content %}
 
 <div class="mt-3">
     <div id="settingsButtonRow" class="row">
@@ -167,6 +168,8 @@
 
 </div>
 
-<script src="/js/common.js?v=1"></script>
-<script src="/js/alerts.js?v=1"></script>
+<script src="/js/common.js?v=6"></script>
+<script src="/js/alerts.js?v=6"></script>
 <script>$(document).ready(function() { $("#nav-link-alerts").addClass("active"); }); <!-- highlight active page in nav --></script>
+
+{% end %}

templates/apidocs.html

@@ -1,5 +1,8 @@
-% rebase('webpage_base.tpl')
+{% extends "base.html" %}
+{% block content %}
 
 <redoc spec-url="/apidocs/openapi.yml"></redoc>
 <script src="https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js"> </script>
 <script>$(document).ready(function() { $("#nav-link-api").addClass("active"); }); <!-- highlight active page in nav --></script>
+
+{% end %}

templates/bands.html

@@ -1,4 +1,5 @@
-% rebase('webpage_base.tpl')
+{% extends "base.html" %}
+{% block content %}
 
 <div class="mt-3">
     <div id="settingsButtonRow" class="row">
@@ -116,6 +117,11 @@
                                         <input class="form-check-input storeable-checkbox" type="checkbox" id="darkMode" value="darkMode" oninput="toggleDarkMode();">
                                         <label class="form-check-label" for="darkMode">Dark mode</label>
                                     </div>
+                                    <p class="card-text spothole-card-text">
+                                        Band color scheme<br/>
+                                        <select id="band-color-scheme" class="storeable-select form-select d-inline-block" oninput="setBandColorSchemeFromUI();" style="display: inline-block;">
+                                        </select>
+                                    </p>
                                 </div>
                         </div>
                     </div>
@@ -128,7 +134,9 @@
 
 </div>
 
-<script src="/js/common.js?v=1"></script>
-<script src="/js/spotsbandsandmap.js?v=1"></script>
-<script src="/js/bands.js?v=1"></script>
+<script src="/js/common.js?v=6"></script>
+<script src="/js/spotsbandsandmap.js?v=6"></script>
+<script src="/js/bands.js?v=6"></script>
 <script>$(document).ready(function() { $("#nav-link-bands").addClass("active"); }); <!-- highlight active page in nav --></script>
+
+{% end %}

templates/base.html

@@ -35,7 +35,7 @@
     <link rel="alternate icon" type="image/png" href="/img/icon-192.png">
     <link rel="alternate icon" type="image/png" href="/img/icon-32.png">
     <link rel="alternate icon" type="image/png" href="/img/icon-16.png">
-    <link rel="alternate icon" type="image/x-icon" href="/img/favicon.ico">
+    <link rel="alternate icon" type="image/x-icon" href="/favicon.ico">
 
     <link rel="manifest" href="manifest.webmanifest">
 
@@ -44,6 +44,12 @@
     <script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.8/dist/js/bootstrap.bundle.min.js"
             integrity="sha384-FKyoEForCGlyvwx9Hj09JcYn3nv7wiPVlz7YYwJrWVcXK/BmnVDxM+D2scQbITxI"
             crossorigin="anonymous"></script>
+    <script src="https://cdn.jsdelivr.net/npm/tinycolor2@1.6.0/cjs/tinycolor.min.js"></script>
+
+    <script src="https://misc.ianrenton.com/jsutils/utils.js?v=6"></script>
+    <script src="https://misc.ianrenton.com/jsutils/storage.js?v=6"></script>
+    <script src="https://misc.ianrenton.com/jsutils/ui-ham.js?v=6"></script>
+    <script src="https://misc.ianrenton.com/jsutils/geo.js?v=6"></script>
 
 </head>
 <body>
@@ -62,9 +68,9 @@
                     <li class="nav-item ms-4"><a href="/map" class="nav-link" id="nav-link-map"><i class="fa-solid fa-map"></i> Map</a></li>
                     <li class="nav-item ms-4"><a href="/bands" class="nav-link" id="nav-link-bands"><i class="fa-solid fa-ruler-vertical"></i> Bands</a></li>
                     <li class="nav-item ms-4"><a href="/alerts" class="nav-link" id="nav-link-alerts"><i class="fa-solid fa-bell"></i> Alerts</a></li>
-                  % if allow_spotting:
-                    <li class="nav-item ms-4"><a href="/add-spot" class="nav-link" id="nav-link-add-spot"><i class="fa-solid fa-comment"></i> Add Spot</a></li>
-                  % end
+                  {% if allow_spotting %}
+                    <li class="nav-item ms-4"><a href="/add-spot" class="nav-link" id="nav-link-add-spot"><i class="fa-solid fa-comment"></i> Add&nbsp;Spot</a></li>
+                  {% end %}
                     <li class="nav-item ms-4"><a href="/status" class="nav-link" id="nav-link-status"><i class="fa-solid fa-chart-simple"></i> Status</a></li>
                     <li class="nav-item ms-4"><a href="/about" class="nav-link" id="nav-link-about"><i class="fa-solid fa-circle-info"></i> About</a></li>
                     <li class="nav-item ms-4"><a href="/apidocs" class="nav-link" id="nav-link-api"><i class="fa-solid fa-gear"></i> API</a></li>
@@ -75,7 +81,7 @@
 
     <main>
 
-{{!base}}
+{% block content %}{% end %}
 
     </main>
 

templates/map.html

@@ -1,4 +1,5 @@
-% rebase('webpage_base.tpl')
+{% extends "base.html" %}
+{% block content %}
 
 <div id="map">
     <div id="settingsButtonRowMap" class="mt-3 px-3" style="z-index: 1002; position: relative;">
@@ -128,6 +129,11 @@
                                             <input class="form-check-input storeable-checkbox" type="checkbox" id="darkMode" value="darkMode" oninput="toggleDarkMode();">
                                             <label class="form-check-label" for="darkMode">Dark mode</label>
                                         </div>
+                                        <p class="card-text spothole-card-text">
+                                            Band color scheme<br/>
+                                            <select id="band-color-scheme" class="storeable-select form-select d-inline-block" oninput="setBandColorSchemeFromUI();" style="display: inline-block;">
+                                            </select>
+                                        </p>
                                     </div>
                             </div>
                         </div>
@@ -146,7 +152,9 @@
 <script src="https://cdn.jsdelivr.net/npm/leaflet.geodesic"></script>
 <script src="https://cdn.jsdelivr.net/npm/@joergdietrich/leaflet.terminator@1.1.0/L.Terminator.min.js"></script>
 
-<script src="/js/common.js?v=1"></script>
-<script src="/js/spotsbandsandmap.js?v=1"></script>
-<script src="/js/map.js?v=1"></script>
+<script src="/js/common.js?v=6"></script>
+<script src="/js/spotsbandsandmap.js?v=6"></script>
+<script src="/js/map.js?v=6"></script>
 <script>$(document).ready(function() { $("#nav-link-map").addClass("active"); }); <!-- highlight active page in nav --></script>
+
+{% end %}

templates/spots.html

@@ -1,4 +1,5 @@
-% rebase('webpage_base.tpl')
+{% extends "base.html" %}
+{% block content %}
 
 <div id="intro-box" class="permanently-dismissible-box mt-3">
 <div class="alert alert-primary alert-dismissible fade show" role="alert">
@@ -9,14 +10,21 @@
 
 <div class="mt-3">
     <div id="settingsButtonRow" class="row">
-        <div class="col-auto me-auto pt-3">
+        <div class="col-lg-6 me-auto pt-3 hideonmobile">
             <p id="timing-container">Loading...</p>
         </div>
-        <div class="col-auto">
+        <div class="col-lg-6 text-end">
             <p class="d-inline-flex gap-1">
-                <span style="position: relative;">
-                    <i class="fa-solid fa-magnifying-glass" style="position: absolute; left: 0px; top: 2px; padding: 10px; pointer-events: none;"></i>
-                    <input id="filter-dx-call" type="search" class="form-control" oninput="filtersUpdated();" placeholder="Callsign">
+                <span class="btn-group" role="group">
+                  <input type="radio" class="btn-check" name="runPause" id="runButton" autocomplete="off" checked>
+                  <label class="btn btn-outline-primary" for="runButton"><i class="fa-solid fa-play"></i> Run</label>
+
+                  <input type="radio" class="btn-check" name="runPause" id="pauseButton" autocomplete="off">
+                  <label class="btn btn-outline-primary" for="pauseButton"><i class="fa-solid fa-pause"></i> Pause</label>
+                </span>
+                <span class="hideonmobile" style="position: relative;">
+                    <i id="searchicon" class="fa-solid fa-magnifying-glass"></i>
+                    <input id="search" type="search" class="form-control" oninput="filtersUpdated();" placeholder="Search">
                 </span>
                 <button id="filters-button" type="button" class="btn btn-outline-primary" data-bs-toggle="button" onclick="toggleFiltersPanel();"><i class="fa-solid fa-filter"></i> Filters</button>
                 <button id="display-button" type="button" class="btn btn-outline-primary" data-bs-toggle="button" onclick="toggleDisplayPanel();"><i class="fa-solid fa-desktop"></i> Display</button>
@@ -152,6 +160,11 @@
                                     <label class="form-check-label" for="darkMode">Dark mode</label>
                                 </div>
                             </div>
+                            <p class="card-text spothole-card-text">
+                                Band color scheme<br/>
+                                <select id="band-color-scheme" class="storeable-select form-select d-inline-block" oninput="setBandColorSchemeFromUI();" style="display: inline-block;">
+                                </select>
+                            </p>
                         </div>
                     </div>
                 </div>
@@ -210,7 +223,9 @@
 
 </div>
 
-<script src="/js/common.js?v=1"></script>
-<script src="/js/spotsbandsandmap.js?v=1"></script>
-<script src="/js/spots.js?v=1"></script>
+<script src="/js/common.js?v=6"></script>
+<script src="/js/spotsbandsandmap.js?v=6"></script>
+<script src="/js/spots.js?v=6"></script>
 <script>$(document).ready(function() { $("#nav-link-spots").addClass("active"); }); <!-- highlight active page in nav --></script>
+
+{% end %}

templates/status.html

@@ -1,7 +1,10 @@
-% rebase('webpage_base.tpl')
+{% extends "base.html" %}
+{% block content %}
 
 <div id="status-container" class="row row-cols-1 row-cols-md-4 g-4 mt-4"></div>
 
-<script src="/js/common.js?v=1"></script>
-<script src="/js/status.js?v=1"></script>
+<script src="/js/common.js?v=6"></script>
+<script src="/js/status.js?v=6"></script>
 <script>$(document).ready(function() { $("#nav-link-status").addClass("active"); }); <!-- highlight active page in nav --></script>
+
+{% end %}

webassets/.idea/.gitignore

@@ -0,0 +1,10 @@
+# Default ignored files
+/shelf/
+/workspace.xml
+# Ignored default folder with query files
+/queries/
+# Datasource local storage ignored files
+/dataSources/
+/dataSources.local.xml
+# Editor-based HTTP Client requests
+/httpRequests/

webassets/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="$PROJECT_DIR$/.." vcs="Git" />
+  </component>
+</project>

webassets/apidocs/openapi.yml

@@ -1,4 +1,4 @@
-openapi: 3.0.4
+openapi: 3.1.0
 info:
   title: Spothole API
   description: |-
@@ -9,12 +9,20 @@ info:
     The API calls described below allow third-party software to access data from Spothole, and receive data on spots and alerts in a consistent format regardless of the data sources used by Spothole itself. Utility calls are also provided for general data lookups.
     
     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, and there are plenty of areas where Spothole's location data may be inaccurate. If you are doing something where accuracy is important, such as contesting, you should not rely on Spothole's data to fill in any gaps in your log.
+    
+    ## Changelog
+    
+    ### 1.1
+    
+    * Added Server-Sent Event API endpoints for spots and alerts.
+    * Removed band colour and icon information from spots.
+    * Moved activation_score from top-level in Spot and Alert to be part of the SIGRef
   contact:
     email: ian@ianrenton.com
   license:
     name: The Unlicense
     url: https://unlicense.org/#the-unlicense
-  version: v1
+  version: v1.1
 servers:
   - url: https://spothole.app/api/v1
 paths:
@@ -115,7 +123,7 @@ paths:
             default: false
         - name: dx_call_includes
           in: query
-          description: "Limit the alerts to only ones where the DX callsign includes the supplied string (case-insensitive). Generally a complete callsign, but you can supply a shorter string for partial matches."
+          description: "Limit the spots to only ones where the DX callsign includes the supplied string (case-insensitive). Generally a complete callsign, but you can supply a shorter string for partial matches."
           required: false
           schema:
             type: string
@@ -125,6 +133,12 @@ paths:
           required: false
           schema:
             type: string
+        - name: text_includes
+          in: query
+          description: "Limit the spots to only ones where some significant text (DX callsign or comment) includes the supplied string (case-insensitive)."
+          required: false
+          schema:
+            type: string
         - name: needs_good_location
           in: query
           description: "Return only spots with a 'good' location. (See the spot `dx_location_good` parameter for details. Useful for map-based clients, to avoid spots with 'bad' locations e.g. loads of cluster spots ending up in the centre of the DXCC entitity.)"
@@ -215,7 +229,7 @@ paths:
             $ref: "#/components/schemas/Continent"
         - name: dx_call_includes
           in: query
-          description: "Limit the alerts to only ones where the DX callsign includes the supplied string (case-insensitive). Generally a complete callsign, but you can supply a shorter string for partial matches."
+          description: "Limit the spots to only ones where the DX callsign includes the supplied string (case-insensitive). Generally a complete callsign, but you can supply a shorter string for partial matches."
           required: false
           schema:
             type: string
@@ -225,6 +239,12 @@ paths:
           required: false
           schema:
             type: string
+        - name: text_includes
+          in: query
+          description: "Limit the spots to only ones where some significant text (DX callsign or comment) includes the supplied string (case-insensitive)."
+          required: false
+          schema:
+            type: string
         - name: needs_good_location
           in: query
           description: "Return only spots with a 'good' location. (See the spot `dx_location_good` parameter for details. Useful for map-based clients, to avoid spots with 'bad' locations e.g. loads of cluster spots ending up in the centre of the DXCC entitity.)"
@@ -304,6 +324,12 @@ paths:
           required: false
           schema:
             type: string
+        - name: text_includes
+          in: query
+          description: "Limit the alerts to only ones where some significant text (DX callsign, freqs/modes, or comment) includes the supplied string (case-insensitive)."
+          required: false
+          schema:
+            type: string
       responses:
         '200':
           description: Success
@@ -359,6 +385,12 @@ paths:
           required: false
           schema:
             type: string
+        - name: text_includes
+          in: query
+          description: "Limit the alerts to only ones where some significant text (DX callsign, freqs/modes, or comment) includes the supplied string (case-insensitive)."
+          required: false
+          schema:
+            type: string
       responses:
         '200':
           description: Success
@@ -525,6 +557,12 @@ paths:
                         type: integer
                         example: 30
                         description: The suggested default "maximum spot age" that the web UI should retrieve from the API
+                      spot-providers-enabled-by-default:
+                        type: array
+                        description: A list of the spot providers that should be enabled in the web UI on first load, if the user hasn't already got a localStorage setting that sets their preference. This is to allow some high-volume providers like RBN to be enabled in Spothole's back-end and displayable in the web UI if the user wants, but by default the experience will not include them.
+                        items:
+                          type: string
+                          example: "POTA"
                       alert-count:
                         type: array
                         description: An array of suggested "alert counts" that the web UI can retrieve from the API
@@ -910,6 +948,10 @@ components:
           type: number
           description: Longitude of the reference, in degrees, if known.
           example: -1.2345
+        activation_score:
+          type: integer
+          description: Activation score. SOTA only
+          example: 0
 
     Spot:
       type: object
@@ -1056,22 +1098,6 @@ components:
           items:
             $ref: '#/components/schemas/SIGRef'
           description: SIG references. We allow multiple here for e.g. n-fer activations, unlike ADIF SIG_INFO
-        activation_score:
-          type: integer
-          description: Activation score. SOTA only
-          example: 0
-        icon:
-          type: string
-          descripton: Icon, from the Font Awesome set. This is fairly opinionated but is here to help the Spothole web UI and Field Spotter. Does not include the "fa-" prefix.
-          example: tree
-        band_color:
-          type: string
-          descripton: Colour to represent this spot, if a client chooses to colour spots based on their frequency band, using PSK Reporter's default colours. HTML colour e.g. hex.
-          example: "#ff0000"
-        band_contrast_color:
-          type: string
-          descripton: Black or white, whichever best contrasts with "band_color".
-          example: "white"
         qrt:
           type: boolean
           description: QRT state. Some APIs return spots marked as QRT. Otherwise we can check the comments.
@@ -1176,14 +1202,6 @@ components:
           items:
             $ref: '#/components/schemas/SIGRef'
           description: SIG references. We allow multiple here for e.g. n-fer activations, unlike ADIF SIG_INFO
-        activation_score:
-          type: integer
-          description: Activation score. SOTA only
-          example: 0
-        icon:
-          type: string
-          descripton: Icon, from the Font Awesome set. This is fairly opinionated but is here to help the Spothole web UI and Field Spotter. Does not include the "fa-" prefix.
-          example: tree
         source:
           type: string
           description: Where we got the alert from.
@@ -1259,14 +1277,6 @@ components:
           type: int
           description: The end frequency of this band, in Hz.
           example: 7200000
-        color:
-          type: string
-          description: The color associated with this mode, as used on PSK Reporter.
-          example: "#5959ff"
-        contrast_color:
-          type: string
-          description: Black or white, whichever provides the best contrast against the band colour.
-          example: white
 
     SIG:
       type: object
@@ -1278,10 +1288,6 @@ components:
           type: string
           description: The full name of the SIG
           example: Parks on the Air
-        icon:
-          type: string
-          description: Icon, from the Font Awesome set. This is fairly opinionated but is here to help the Spothole web UI and Field Spotter. Does not include the "fa-" prefix.
-          example: tree
         ref_regex:
           type: string
           description: Regex that matches this SIG's reference IDs. Generally for Spothole's own internal use, clients probably won't need this.

webassets/css/style.css

@@ -80,17 +80,22 @@ div.container {
 
 /* SPOTS/ALERTS PAGES, SETTINGS/STATUS AREAS */
 
-input#filter-dx-call {
+input#search {
     max-width: 12em;
+    margin-left: 1rem;
     margin-right: 1rem;
     padding-left: 2em;
 }
 
-div.appearing-panel {
-    display: none;
+i#searchicon {
+    position: absolute;
+    left: 1rem;
+    top: 2px;
+    padding: 10px;
+    pointer-events: none;
 }
 
-button#add-spot-button {
+div.appearing-panel {
     display: none;
 }
 
@@ -219,6 +224,10 @@ div#map {
   filter: invert(100%) hue-rotate(180deg) brightness(95%) contrast(90%);
 }
 
+/* Make buttons overlaid on the map have a non-transparent fill so you can see the text better */
+.btn-outline-primary {
+    --bs-btn-bg: var(--bs-body-bg) !important;
+}
 
 
 /* BANDS PANEL */
@@ -340,11 +349,6 @@ div.band-spot:hover span.band-spot-info {
         max-height: 26em;
         overflow: scroll;
     }
-    /* Filter/search DX Call field should be smaller on mobile */
-    input#filter-dx-call {
-        max-width: 9em;
-        margin-right: 0;
-    }
 }
 
 @media (min-width: 992px) {

webassets/js/alerts.js

@@ -243,7 +243,7 @@ function addAlertRowsToTable(tbody, alerts) {
             $tr.append(`<td class='hideonmobile'>${commentText}</td>`);
         }
         if (showSource) {
-            $tr.append(`<td class='nowrap hideonmobile'><span class='icon-wrapper'><i class='fa-solid fa-${a["icon"]}'></i></span> ${sigSourceText}</td>`);
+            $tr.append(`<td class='nowrap hideonmobile'><span class='icon-wrapper'><i class='fa-solid ${sigToIcon(a["sig"], "fa-globe-africa")}'></i></span> ${sigSourceText}</td>`);
         }
         if (showRef) {
             $tr.append(`<td class='hideonmobile'>${sig_refs}</td>`);
@@ -257,7 +257,7 @@ function addAlertRowsToTable(tbody, alerts) {
         }
         $td2 = $("<td colspan='100'>");
         if (showSource) {
-            $td2.append(`<span class='icon-wrapper'><i class='fa-solid fa-${a["icon"]}'></i></span> `);
+            $td2.append(`<span class='icon-wrapper'><i class='fa-solid ${sigToIcon(a["sig"], "fa-globe-africa")}'></i></span> `);
         }
         if (showRef) {
             $td2.append(`${sig_refs} `);
@@ -352,3 +352,11 @@ $(document).ready(function() {
     // Update the refresh timing display every second
     setInterval(updateRefreshDisplay, 1000);
 });
+
+// Reload alerts on becoming visible. This forces a refresh when used as a PWA and the user switches back to the PWA
+// after some time has passed with it in the background.
+addEventListener("visibilitychange", (event) => {
+    if (!document.hidden) {
+        loadAlerts();
+    }
+});

webassets/js/bands.js

@@ -70,7 +70,7 @@ function updateBands() {
     var table = $('<table id="bands-table">').append('<thead><tr></tr></thead><tbody><tr></tr></tbody>');
     bandToSpots.forEach(function (spotList, bandName) {
         // Get the colours for the band from the first spot, and prepare the header
-        table.find('thead tr').append(`<th style='background-color:${spotList[0].band_color}; color:${spotList[0].band_contrast_color}'>${spotList[0].band}</th>`);
+        table.find('thead tr').append(`<th style='background-color:${bandToColor(spotList[0].band)}; color:${bandToContrastColor(spotList[0].band)}'>${spotList[0].band}</th>`);
 
         // Get the band data to fetch start and end frequencies
         let band = options["bands"].filter(function (b) {
@@ -145,7 +145,7 @@ function updateBands() {
 
         // Now each spot is tagged with how far down the div it should go, add them to the DOM.
         spotList.forEach(s => {
-            bandSpotsDiv.append(`<div class="band-spot" style="top: ${s['pxDownBandLabel']}px; border-top: 1px solid ${s.band_color}; border-left: 5px solid ${s.band_color}; border-bottom: 1px solid ${s.band_color}; border-right: 1px solid ${s.band_color};"><span class="band-spot-call">${s.dx_call}${s.dx_ssid != null ? "-" + s.dx_ssid : ""}</span><span class="band-spot-info">${s.dx_call}${s.dx_ssid != null ? "-" + s.dx_ssid : ""} ${(s.freq/1000000).toFixed(3)} ${s.mode}</span></div>`);
+            bandSpotsDiv.append(`<div class="band-spot" style="top: ${s['pxDownBandLabel']}px; border-top: 1px solid ${bandToColor(s['band'])}; border-left: 5px solid ${bandToColor(s['band'])}; border-bottom: 1px solid ${bandToColor(s['band'])}; border-right: 1px solid ${bandToColor(s['band'])};"><span class="band-spot-call">${s.dx_call}${s.dx_ssid != null ? "-" + s.dx_ssid : ""}</span><span class="band-spot-info">${s.dx_call}${s.dx_ssid != null ? "-" + s.dx_ssid : ""} ${(s.freq/1000000).toFixed(3)} ${s.mode}</span></div>`);
         });
 
         // Work out how tall the canvas should be. Normally this is matching the normal band column height, but if some
@@ -167,7 +167,7 @@ function updateBands() {
             ctx.beginPath();
             ctx.lineWidth = 2;
             ctx.lineCap = "round";
-            ctx.strokeStyle = s.band_color;
+            ctx.strokeStyle = bandToColor(s['band']);
             ctx.moveTo(0, pxDownBandFreq);
             ctx.lineTo(BAND_COLUMN_CANVAS_WIDTH_PX, pxDownBandLabel);
             ctx.stroke();
@@ -228,6 +228,21 @@ function loadOptions() {
         // Store options
         options = jsonData;
 
+        // Populate the Display panel
+        options["web-ui-options"]["max-spot-age"].forEach(sc => $("#max-spot-age").append($('<option>', {
+            value: sc * 60,
+            text: sc
+        })));
+        $("#max-spot-age").val(options["web-ui-options"]["max-spot-age-default"] * 60);
+        getAvailableBandColorSchemes().forEach(sc => $("#band-color-scheme").append($('<option>', {
+            value: sc,
+            text: sc
+        })));
+
+        // First pass loading settings, so we can load the band colour scheme before the filters that need to use it
+        loadSettings();
+        setBandColorScheme($("#band-color-scheme option:selected").val());
+
         // Add CSS for band toggle buttons
         addBandToggleColourCSS(options["bands"]);
 
@@ -237,14 +252,7 @@ function loadOptions() {
         generateMultiToggleFilterCard("#dx-continent-options", "dx_continent", options["continents"]);
         generateMultiToggleFilterCard("#de-continent-options", "de_continent", options["continents"]);
         generateMultiToggleFilterCard("#mode-options", "mode_type", options["mode_types"]);
-        generateMultiToggleFilterCard("#source-options", "source", options["spot_sources"]);
-
-        // Populate the Display panel
-        options["web-ui-options"]["max-spot-age"].forEach(sc => $("#max-spot-age").append($('<option>', {
-            value: sc * 60,
-            text: sc
-        })));
-        $("#max-spot-age").val(options["web-ui-options"]["max-spot-age-default"] * 60);
+        generateSourcesMultiToggleFilterCard(options["spot_sources"], options["web-ui-options"]["spot-providers-enabled-by-default"]);
 
         // Load URL params. These may select things from the various filter & display options, so the function needs
         // to be called after these are set up, but if the URL params ask for "embedded mode", this will suppress

webassets/js/common.js

@@ -2,9 +2,6 @@
 var options = {};
 // Last time we updated the spots/alerts list on display.
 var lastUpdateTime;
-// Whether "embedded mode" is being used. This removes headers and footers, maximises the remaining content, and
-// uses URL params to configure the interface options rather than using the user's localstorage.
-var embeddedMode = false;
 
 // Load and apply any URL params. This is used for "embedded mode" where another site can embed a version of
 // Spothole and provide its own interface options rather than using the user's saved ones. These may select things
@@ -18,7 +15,7 @@ function loadURLParams() {
     // top-level html element to use CSS selectors to remove bits of UI.
     let embedded = params.get("embedded");
     if (embedded != null && embedded === "true") {
-        embeddedMode = true;
+        useLocalStorage = false;
         $("html").attr("embedded-mode", "true");
     }
 
@@ -117,7 +114,6 @@ function toggleFilterButtons(filterQuery, state) {
 function updateRefreshDisplay() {
     if (lastUpdateTime != null) {
         let secSinceUpdate = moment.duration(moment().diff(lastUpdateTime)).asSeconds();
-        if (typeof REFRESH_INTERVAL_SEC !== 'undefined' && REFRESH_INTERVAL_SEC != null) {
         let count = REFRESH_INTERVAL_SEC;
         let updatingString = "Updating..."
         if (secSinceUpdate < REFRESH_INTERVAL_SEC) {
@@ -131,32 +127,8 @@ function updateRefreshDisplay() {
             }
         }
         $("#timing-container").html("Last updated at " + lastUpdateTime.format('HH:mm') + " UTC. " + updatingString);
-        } else {
-            $("#timing-container").html("Connected to live spot server. Last spot at " + lastUpdateTime.format('HH:mm') + " UTC.");
     }
 }
-}
-
-// Utility function to escape HTML characters from a string.
-function escapeHtml(str) {
-    if (typeof str !== 'string') {
-        return '';
-    }
-
-    const escapeCharacter = (match) => {
-        switch (match) {
-            case '&': return '&amp;';
-            case '<': return '&lt;';
-            case '>': return '&gt;';
-            case '"': return '&quot;';
-            case '\'': return '&#039;';
-            case '`': return '&#096;';
-            default: return match;
-        }
-    };
-
-    return str.replace(/[&<>"'`]/g, escapeCharacter);
-}
 
 // When the "use local time" field is changed, reload the table and save settings
 function timeZoneUpdated() {
@@ -170,106 +142,6 @@ function columnsUpdated() {
     saveSettings();
 }
 
-// Calculate great circle bearing between two lat/lon points.
-function calcBearing(lat1, lon1, lat2, lon2) {
-    lat1 *= Math.PI / 180;
-    lon1 *= Math.PI / 180;
-    lat2 *= Math.PI / 180;
-    lon2 *= Math.PI / 180;
-    var lonDelta = lon2 - lon1;
-    var y = Math.sin(lonDelta) * Math.cos(lat2);
-    var x = Math.cos(lat1) * Math.sin(lat2) - Math.sin(lat1) * Math.cos(lat2) * Math.cos(lonDelta);
-    var bearing = Math.atan2(y, x);
-    bearing = bearing * (180 / Math.PI);
-    if ( bearing < 0 ) { bearing += 360; }
-    return bearing;
-}
-
-// Convert a Maidenhead grid reference of arbitrary precision to the lat/long of the centre point of the square.
-// Returns null if the grid format is invalid.
-function latLonForGridCentre(grid) {
-    let [lat, lon, latCellSize, lonCellSize] = latLonForGridSWCornerPlusSize(grid);
-    if (lat != null && lon != null && latCellSize != null && lonCellSize != null) {
-        return [lat + latCellSize / 2.0, lon + lonCellSize / 2.0];
-    } else {
-        return null;
-    }
-}
-
-// Convert a Maidenhead grid reference of arbitrary precision to lat/long, including in the result the size of the
-// lowest grid square. This is a utility method used by the main methods that return the centre, southwest, and
-// northeast coordinates of a grid square.
-// The return type is always an array of size 4. The elements in it are null if the grid format is invalid.
-function latLonForGridSWCornerPlusSize(grid) {
-    // Make sure we are in upper case so our maths works. Case is arbitrary for Maidenhead references
-    grid = grid.toUpperCase();
-
-    // Return null if our Maidenhead string is invalid or too short
-    let len = grid.length;
-    if (len <= 0 || (len % 2) !== 0) {
-        return [null, null, null, null];
-    }
-
-    let lat = 0.0; // aggregated latitude
-    let lon = 0.0; // aggregated longitude
-    let latCellSize = 10; // Size in degrees latitude of the current cell. Starts at 20 and gets smaller as the calculation progresses
-    let lonCellSize = 20; // Size in degrees longitude of the current cell. Starts at 20 and gets smaller as the calculation progresses
-    let latCellNo; // grid latitude cell number this time
-    let lonCellNo; // grid longitude cell number this time
-
-    // Iterate through blocks (two-character sections)
-    for (let block = 0; block * 2 < len; block += 1) {
-        if (block % 2 === 0) {
-            // Letters in this block
-            lonCellNo = grid.charCodeAt(block * 2) - 'A'.charCodeAt(0);
-            latCellNo = grid.charCodeAt(block * 2 + 1) - 'A'.charCodeAt(0);
-            // Bail if the values aren't in range. Allowed values are A-R (0-17) for the first letter block, or
-            // A-X (0-23) thereafter.
-            let maxCellNo = (block === 0) ? 17 : 23;
-            if (latCellNo < 0 || latCellNo > maxCellNo || lonCellNo < 0 || lonCellNo > maxCellNo) {
-                return [null, null, null, null];
-            }
-        } else {
-            // Numbers in this block
-            lonCellNo = parseInt(grid.charAt(block * 2));
-            latCellNo = parseInt(grid.charAt(block * 2 + 1));
-            // Bail if the values aren't in range 0-9..
-            if (latCellNo < 0 || latCellNo > 9 || lonCellNo < 0 || lonCellNo > 9) {
-                return [null, null, null, null];
-            }
-        }
-
-        // Aggregate the angles
-        lat += latCellNo * latCellSize;
-        lon += lonCellNo * lonCellSize;
-
-        // Reduce the cell size for the next block, unless we are on the last cell.
-        if (block * 2 < len - 2) {
-            // Still have more work to do, so reduce the cell size
-            if (block % 2 === 0) {
-                // Just dealt with letters, next block will be numbers so cells will be 1/10 the current size
-                latCellSize = latCellSize / 10.0;
-                lonCellSize = lonCellSize / 10.0;
-            } else {
-                // Just dealt with numbers, next block will be letters so cells will be 1/24 the current size
-                latCellSize = latCellSize / 24.0;
-                lonCellSize = lonCellSize / 24.0;
-            }
-        }
-    }
-
-    // Offset back to (-180, -90) where the grid starts
-    lon -= 180.0;
-    lat -= 90.0;
-
-    // Return nulls on maths errors
-    if (isNaN(lat) || isNaN(lon) || isNaN(latCellSize) ||  isNaN(lonCellSize)) {
-        return [null, null, null, null];
-    }
-
-    return [lat, lon, latCellSize, lonCellSize];
-}
-
 // Function to set dark mode on or off
 function enableDarkMode(dark) {
     $("html").attr("data-bs-theme", dark ? "dark" : "light");
@@ -293,37 +165,6 @@ function usePreferredTheme() {
     }
 }
 
-// Save settings to local storage. Suppressed if "embedded mode" is in use.
-function saveSettings() {
-    if (!embeddedMode) {
-        // Find all storeable UI elements, store a key of "element id:property name" mapped to the value of that
-        // property. For a checkbox, that's the "checked" property.
-        $(".storeable-checkbox").each(function() {
-            localStorage.setItem("#" + $(this)[0].id + ":checked", JSON.stringify($(this)[0].checked));
-        });
-        $(".storeable-select").each(function() {
-            localStorage.setItem("#" + $(this)[0].id + ":value", JSON.stringify($(this)[0].value));
-        });
-        $(".storeable-text").each(function() {
-            localStorage.setItem("#" + $(this)[0].id + ":value", JSON.stringify($(this)[0].value));
-        });
-    }
-}
-
-// Load settings from local storage and set up the filter selectors. Suppressed if "embedded mode" is in use.
-function loadSettings() {
-    if (!embeddedMode) {
-        // Find all local storage entries and push their data to the corresponding UI element
-        Object.keys(localStorage).forEach(function(key) {
-            if (key.startsWith("#") && key.includes(":")) {
-                // Split the key back into an element ID and a property
-                var split = key.split(":");
-                $(split[0]).prop(split[1], JSON.parse(localStorage.getItem(key)));
-            }
-        });
-    }
-}
-
 // Startup
 $(document).ready(function() {
     usePreferredTheme();

webassets/js/map.js

@@ -45,12 +45,16 @@ function updateMap() {
 
         // Create geodesics if required
         if ($("#mapShowGeodesics")[0].checked && s["de_latitude"] != null && s["de_longitude"] != null) {
+            try {
                 var geodesic = L.geodesic([[s["de_latitude"], s["de_longitude"]], m.getLatLng()], {
-                color: s["band_color"],
+                    color: bandToColor(s['band']),
                     wrap: false,
                     steps: 5
                 });
                 geodesicsLayer.addLayer(geodesic);
+            } catch (e) {
+                // Not sure what causes these but better to continue than to crash out
+            }
         }
     });
 }
@@ -58,9 +62,9 @@ function updateMap() {
 // Get an icon for a spot, based on its band, using PSK Reporter colours, its program etc.
 function getIcon(s) {
     return L.ExtraMarkers.icon({
-        icon: "fa-" + s["icon"],
-        iconColor: s["band_contrast_color"],
-        markerColor: s["band_color"],
+        icon: sigToIcon(s["sig"], "fa-tower-cell"),
+        iconColor: bandToContrastColor(s["band"]),
+        markerColor: bandToColor(s["band"]),
         shape: 'circle',
         prefix: 'fa',
         svg: true
@@ -136,7 +140,7 @@ function getTooltipText(s) {
     ttt += "<br/>";
 
     // Source / SIG / Ref
-    ttt += `<span class='nowrap'><span class='icon-wrapper'><i class='fa-solid fa-${s["icon"]}'></i></span>&nbsp;${sigSourceText} ${sig_refs}</span><br/>`;
+    ttt += `<span class='nowrap'><span class='icon-wrapper'><i class='fa-solid ${sigToIcon(s["sig"], "fa-tower-cell")}'></i></span>&nbsp;${sigSourceText} ${sig_refs}</span><br/>`;
 
     // Time
     ttt += `<span class='icon-wrapper'><i class='fa-solid fa-clock markerPopupIcon'></i></span>&nbsp;${moment.unix(s["time"]).fromNow()}`;
@@ -156,6 +160,21 @@ function loadOptions() {
         // Store options
         options = jsonData;
 
+        // Populate the Display panel
+        options["web-ui-options"]["max-spot-age"].forEach(sc => $("#max-spot-age").append($('<option>', {
+            value: sc * 60,
+            text: sc
+        })));
+        $("#max-spot-age").val(options["web-ui-options"]["max-spot-age-default"] * 60);
+        getAvailableBandColorSchemes().forEach(sc => $("#band-color-scheme").append($('<option>', {
+            value: sc,
+            text: sc
+        })));
+
+        // First pass loading settings, so we can load the band colour scheme before the filters that need to use it
+        loadSettings();
+        setBandColorScheme($("#band-color-scheme option:selected").val());
+
         // Add CSS for band toggle buttons
         addBandToggleColourCSS(options["bands"]);
 
@@ -165,14 +184,7 @@ function loadOptions() {
         generateMultiToggleFilterCard("#dx-continent-options", "dx_continent", options["continents"]);
         generateMultiToggleFilterCard("#de-continent-options", "de_continent", options["continents"]);
         generateMultiToggleFilterCard("#mode-options", "mode_type", options["mode_types"]);
-        generateMultiToggleFilterCard("#source-options", "source", options["spot_sources"]);
-
-        // Populate the Display panel
-        options["web-ui-options"]["max-spot-age"].forEach(sc => $("#max-spot-age").append($('<option>', {
-            value: sc * 60,
-            text: sc
-        })));
-        $("#max-spot-age").val(options["web-ui-options"]["max-spot-age-default"] * 60);
+        generateSourcesMultiToggleFilterCard(options["spot_sources"], options["web-ui-options"]["spot-providers-enabled-by-default"]);
 
         // Load URL params. These may select things from the various filter & display options, so the function needs
         // to be called after these are set up, but if the URL params ask for "embedded mode", this will suppress

webassets/js/spots.js

@@ -1,35 +1,45 @@
 // SSE event source
 let evtSource;
+let restartSSEOnErrorTimeoutId;
 // Table row count, to alternate shading
 let rowCount = 0;
 
 // Load spots and populate the table.
 function loadSpots() {
+    // If we have an ongoing SSE connection, stop it so it doesn't interfere with our reload
+    if (evtSource != null) {
+        evtSource.close();
+    }
+
+    // Make the new query
     $.getJSON('/api/v1/spots' + buildQueryString(), function(jsonData) {
         // Store last updated time
         lastUpdateTime = moment.utc();
-        updateRefreshDisplay();
+        updateTimingDisplayRunPause();
         // Store data
         spots = jsonData;
         // Update table
         updateTable();
-        // Start SSE connection to fetch updates in the background
-        restartSSEConnection();
+        // Start SSE connection to fetch updates in the background, if we are in "run" mode
+        let run = $('#runButton:checked').val();
+        if (run) {
+            startSSEConnection();
+        }
     });
 }
 
 // Start an SSE connection (closing an existing one if it exists). This will then be used to add to the table on the
 // fly.
-function restartSSEConnection() {
+function startSSEConnection() {
     if (evtSource != null) {
         evtSource.close();
     }
-    evtSource = new EventSource('/api/v1/spots/stream');
+    evtSource = new EventSource('/api/v1/spots/stream' + buildQueryString());
 
     evtSource.onmessage = function(event) {
         // Store last updated time
         lastUpdateTime = moment.utc();
-        updateRefreshDisplay();
+        updateTimingDisplayRunPause();
         // Get the new spot
         newSpot = JSON.parse(event.data);
         // Awful fudge to ensure new incoming spots at the top of the list don't have timestamps that make them look
@@ -42,16 +52,38 @@ function restartSSEConnection() {
 
         // Add spot to internal data store
         spots.unshift(newSpot);
+        // Work out if we need to remove an old spot
+        if (spots.length > $("#spots-to-fetch option:selected").val()) {
             spots = spots.slice(0, -1);
-        // Add spot to table
+            // Drop oldest spot off the end of the table. This is two rows because of the mobile view extra rows
+            $("#table tbody tr").last().remove();
+            $("#table tbody tr").last().remove();
+        }
+        // If we had zero spots before (i.e. one now), the table will have a "No spots" row that we need to remove now
+        // that we have one.
+        if (spots.length == 1) {
+            $("#table tbody tr").last().remove();
+        }
+
+        // Add the new spot to table
         addSpotToTopOfTable(newSpot, true);
     };
 
     evtSource.onerror = function(err) {
-        setTimeout(restartSSEConnection(), 1000);
+        if (evtSource != null) {
+            evtSource.close();
+        }
+        clearTimeout(restartSSEOnErrorTimeoutId)
+        restartSSEOnErrorTimeoutId = setTimeout(startSSEConnection, 1000);
     };
 }
 
+// Update the special timing display for the live spots page, which varies depending on run/pause selection.
+function updateTimingDisplayRunPause() {
+    let run = $('#runButton:checked').val();
+    $("#timing-container").html((run ? "Connected to server. Last update at " : "Paused at ") + lastUpdateTime.format('HH:mm') + " UTC.");
+}
+
 // Build a query string for the API, based on the filters that the user has selected.
 function buildQueryString() {
     var str =  "?";
@@ -61,8 +93,8 @@ function buildQueryString() {
         }
     });
     str = str + "limit=" + $("#spots-to-fetch option:selected").val();
-    if ($("#filter-dx-call").val() != "") {
-        str = str + "&dx_call_includes=" + encodeURIComponent($("#filter-dx-call").val());
+    if ($("#search").val() != "") {
+        str = str + "&text_includes=" + encodeURIComponent($("#search").val());
     }
     return str;
 }
@@ -122,8 +154,8 @@ function updateTable() {
         table.find('tbody').append('<tr class="table-danger"><td colspan="100" style="text-align:center;">No spots match your filters.</td></tr>');
     }
 
-    spots.reverse();
-    spots.forEach(s => addSpotToTopOfTable(s, false));
+    let spotsNewestFirst = spots.toReversed();
+    spotsNewestFirst.forEach(s => addSpotToTopOfTable(s, false));
 }
 
 // Add rows corresponding to a new spot to the top of the table
@@ -157,9 +189,6 @@ function createNewTableRowsForSpot(s, highlightNew) {
 
     // Create row
     let $tr = $('<tr>');
-    if (highlightNew) {
-        $tr.addClass("new");
-    }
 
     // Apply striping to the table. We can't just use Bootstrap's table-striped class because we have all sorts of
     // extra faff to deal with, like the mobile view having extra rows, and the On Now / Next 24h / Later banners
@@ -173,6 +202,12 @@ function createNewTableRowsForSpot(s, highlightNew) {
         $tr.addClass("table-faded");
     }
 
+    // If we are asked to highlight new rows (i.e. this row is being added "live" via the SSE client and not as a bulk
+    // reload of the whole table)
+    if (highlightNew) {
+        $tr.addClass("new");
+    }
+
     // Format a UTC or local time for display
     var time = moment.unix(s["time"]).utc();
     if (useLocalTime) {
@@ -215,9 +250,8 @@ function createNewTableRowsForSpot(s, highlightNew) {
     // Format the mode
     mode_string = s["mode"];
     if (s["mode"] == null) {
-        mode_string = "???";
-    }
-    if (s["mode_source"] == "BANDPLAN") {
+        mode_string = "";
+    } else if (s["mode_source"] == "BANDPLAN") {
         mode_string = mode_string + "<span class='mode-q hideonmobile'><i class='fa-solid fa-circle-question' title='The mode was not reported via the spotting service. This is a guess based on the frequency.'></i></span>";
     }
 
@@ -253,9 +287,9 @@ function createNewTableRowsForSpot(s, highlightNew) {
         var items = []
         for (var i = 0; i < s["sig_refs"].length; i++) {
             if (s["sig_refs"][i]["url"] != null) {
-                items[i] = `<a href='${s["sig_refs"][i]["url"]}' title='${s["sig_refs"][i]["name"]}' target='_new' class='sig-ref-link'>${s["sig_refs"][i]["id"]}</a>`
+                items[i] = `<span style="white-space: nowrap;"><a href='${s["sig_refs"][i]["url"]}' title='${s["sig_refs"][i]["name"]}' target='_new' class='sig-ref-link'>${s["sig_refs"][i]["id"]}</a></span>`
             } else {
-                items[i] = `${s["sig_refs"][i]["id"]}`
+                items[i] = `<span style="white-space: nowrap;">${s["sig_refs"][i]["id"]}</span>`
             }
         }
         sig_refs = items.join(", ");
@@ -291,10 +325,10 @@ function createNewTableRowsForSpot(s, highlightNew) {
         $tr.append(`<td class='nowrap'>${time_formatted}</td>`);
     }
     if (showDX) {
-        $tr.append(`<td class='nowrap'><span class='flag-wrapper hideonmobile' title='${dx_country}'>${dx_flag}</span><a class='dx-link' href='https://qrz.com/db/${s["dx_call"]}' target='_new' title='${s["dx_name"] != null ? s["dx_name"] : ""}'>${dx_call}</a></td>`);
+        $tr.append(`<td class='nowrap'><span class='flag-wrapper' title='${dx_country}'>${dx_flag}</span><a class='dx-link' href='https://qrz.com/db/${s["dx_call"]}' target='_new' title='${s["dx_name"] != null ? s["dx_name"] : ""}'>${dx_call}</a></td>`);
     }
     if (showFreq) {
-        $tr.append(`<td class='nowrap'><span class='band-bullet' title='${bandFullName}' style='${(s["freq"] != null) ? "color: " + s["band_color"] : "display: none;"}'>&#9632;</span>${freq_string}</td>`);
+        $tr.append(`<td class='nowrap'><span class='band-bullet' title='${bandFullName}' style='${(s["freq"] != null) ? "color: " + bandToColor(s["band"]) : "display: none;"}'>&#9632;</span>${freq_string}</td>`);
     }
     if (showMode) {
         $tr.append(`<td class='nowrap'>${mode_string}</td>`);
@@ -306,10 +340,10 @@ function createNewTableRowsForSpot(s, highlightNew) {
         $tr.append(`<td class='nowrap hideonmobile'>${bearingText}</td>`);
     }
     if (showType) {
-        $tr.append(`<td class='nowrap hideonmobile'><span class='icon-wrapper'><i class='fa-solid fa-${s["icon"]}'></i></span> ${typeText}</td>`);
+        $tr.append(`<td class='nowrap hideonmobile'><span class='icon-wrapper'><i class='fa-solid ${sigToIcon(s["sig"], "fa-tower-cell")}'></i></span> ${typeText}</td>`);
     }
     if (showRef) {
-        $tr.append(`<td class='hideonmobile'>${sig_refs}</td>`);
+        $tr.append(`<td class='hideonmobile' style='max-width: 11em;'>${sig_refs}</td>`);
     }
     if (showDE) {
         $tr.append(`<td class='nowrap hideonmobile'><span class='flag-wrapper' title='${de_country}'>${de_flag}</span>${de_call}</td>`);
@@ -317,24 +351,38 @@ function createNewTableRowsForSpot(s, highlightNew) {
 
     // Second row for mobile view only, containing type, ref & comment
     $tr2 = $("<tr class='hidenotonmobile'>");
+
+    // Apply styles as per the first row
     if (rowCount % 2 == 1) {
         $tr2.addClass("table-active");
     }
     if (s["qrt"] == true) {
         $tr2.addClass("table-faded");
     }
+    if (highlightNew) {
+        $tr2.addClass("new");
+    }
+
     $td2 = $("<td colspan='100'>");
+    $td2floatleft = $(`<div style="float: left;">`);
     if (showType) {
-        $td2.append(`<span class='icon-wrapper'><i class='fa-solid fa-${s["icon"]}'></i></span> ${typeText} `);
+        $td2floatleft.append(`<span class='icon-wrapper'><i class='fa-solid ${sigToIcon(s["sig"], "fa-tower-cell")}'></i></span> ${typeText} `);
     }
     if (showRef) {
-        $td2.append(`${sig_refs} `);
+        $td2floatleft.append(`${sig_refs} `);
     }
+    $td2.append($td2floatleft);
+    $td2floatright = $(`<div style="float: right;">`);
     if (showBearing) {
-        $td2.append(` &nbsp; Bearing: ${bearingText} `);
+        $td2floatright.append(`${bearingText} &nbsp;`);
     }
+    if (showDE) {
+        $td2floatright.append(` de ${de_call} &nbsp;`);
+    }
+    $td2.append($td2floatright);
+    $td2.append(`</div><div style="clear: both;"></div>`);
     if (showComment) {
-        $td2.append(`<br/>${commentText}`);
+        $td2.append(`${commentText}`);
     }
     $tr2.append($td2);
 
@@ -350,6 +398,21 @@ function loadOptions() {
         // Store options
         options = jsonData;
 
+        // Populate the Display panel
+        options["web-ui-options"]["spot-count"].forEach(sc => $("#spots-to-fetch").append($('<option>', {
+            value: sc,
+            text: sc
+        })));
+        $("#spots-to-fetch").val(options["web-ui-options"]["spot-count-default"]);
+        getAvailableBandColorSchemes().forEach(sc => $("#band-color-scheme").append($('<option>', {
+            value: sc,
+            text: sc
+        })));
+
+        // First pass loading settings, so we can load the band colour scheme before the filters that need to use it
+        loadSettings();
+        setBandColorScheme($("#band-color-scheme option:selected").val());
+
         // Add CSS for band toggle buttons
         addBandToggleColourCSS(options["bands"]);
 
@@ -359,14 +422,7 @@ function loadOptions() {
         generateMultiToggleFilterCard("#dx-continent-options", "dx_continent", options["continents"]);
         generateMultiToggleFilterCard("#de-continent-options", "de_continent", options["continents"]);
         generateMultiToggleFilterCard("#mode-options", "mode_type", options["mode_types"]);
-        generateMultiToggleFilterCard("#source-options", "source", options["spot_sources"]);
-
-        // Populate the Display panel
-        options["web-ui-options"]["spot-count"].forEach(sc => $("#spots-to-fetch").append($('<option>', {
-            value: sc,
-            text: sc
-        })));
-        $("#spots-to-fetch").val(options["web-ui-options"]["spot-count-default"]);
+        generateSourcesMultiToggleFilterCard(options["spot_sources"], options["web-ui-options"]["spot-providers-enabled-by-default"]);
 
         // Load URL params. These may select things from the various filter & display options, so the function needs
         // to be called after these are set up, but if the URL params ask for "embedded mode", this will suppress
@@ -384,11 +440,6 @@ function loadOptions() {
             $("#tableShowBearing").prop('checked', false);
         }
 
-        // Show the Add Spot button if spotting is allowed
-        if (options["spot_allowed"]) {
-            $("#add-spot-button").show();
-        }
-
         // Load spots (this will also set up the SSE connection to update them too)
         loadSpots();
     });
@@ -458,4 +509,19 @@ $(document).ready(function() {
     loadOptions();
     // Display intro box
     displayIntroBox();
+
+    // Set up run/pause toggles
+    $("#runButton").change(function() {
+        // Need to start the SSE connection but also do a full re-query to catch up anything that we missed, so we
+        // might as well just call loadSpots again which will trigger it all
+        loadSpots();
+        updateTimingDisplayRunPause();
+    });
+    $("#pauseButton").change(function() {
+        // If we are pausing and have an open SSE connection, stop it
+        if (evtSource != null) {
+            evtSource.close();
+        }
+        updateTimingDisplayRunPause();
+    });
 });

webassets/js/spotsbandsandmap.js

@@ -6,10 +6,9 @@ var spots = []
 function addBandToggleColourCSS(band_options) {
     var $style = $('<style>');
     band_options.forEach(o => {
-        // CSS doesn't like IDs with decimal points in, so we need to replace that
-        var cssFormattedBandName = o['name'] ? o['name'].replace('.', 'p') : "unknown";
-        $style.append(`#filter-button-label-band-${cssFormattedBandName} { border-color: ${o['color']}; color: var(--bs-primary);}`);
-        $style.append(`.btn-check:checked + #filter-button-label-band-${cssFormattedBandName} { background-color: ${o['color']}; color: ${o['contrast_color']};}`);
+        var domSafeName = o["name"].replace(/^[^A-Za-z0-9]+|[^\w]+/gi, "");
+        $style.append(`#filter-button-label-band-${domSafeName} { border-color: ${bandToColor(o['name'])}; color: var(--bs-primary);}`);
+        $style.append(`.btn-check:checked + #filter-button-label-band-${domSafeName} { background-color: ${bandToColor(o['name'])}; color: ${bandToContrastColor(o['name'])};}`);
     });
     $('html > head').append($style);
 }
@@ -18,20 +17,29 @@ function addBandToggleColourCSS(band_options) {
 function generateBandsMultiToggleFilterCard(band_options) {
     // Create a button for each option
     band_options.forEach(o => {
-        // CSS doesn't like IDs with decimal points in, so we need to replace that in the same way as when we originally
-        // queried the options endpoint and set our CSS.
-        var cssFormattedBandName = o['name'] ? o['name'].replace('.', 'p') : "unknown";
-        $("#band-options").append(`<input type="checkbox" class="btn-check filter-button-band storeable-checkbox" name="options" id="filter-button-band-${cssFormattedBandName}" value="${o['name']}" autocomplete="off" onClick="filtersUpdated()" checked><label class="btn btn-outline" id="filter-button-label-band-${cssFormattedBandName}" for="filter-button-band-${cssFormattedBandName}">${o['name']}</label> `);
+        var domSafeName = o["name"].replace(/^[^A-Za-z0-9]+|[^\w]+/gi, "");
+        $("#band-options").append(`<input type="checkbox" class="btn-check filter-button-band storeable-checkbox" name="options" id="filter-button-band-${domSafeName}" value="${o['name']}" autocomplete="off" onClick="filtersUpdated()" checked><label class="btn btn-outline" id="filter-button-label-band-${domSafeName}" for="filter-button-band-${domSafeName}">${o['name']}</label> `);
     });
-    // Create All/None buttons
-    $("#band-options").append(` <span style="display: inline-block"><button id="filter-button-band-all" type="button" class="btn btn-outline-secondary" onclick="toggleFilterButtons('band', true);">All</button>&nbsp;<button id="filter-button-band-none" type="button" class="btn btn-outline-secondary" onclick="toggleFilterButtons('band', false);">None</button></span>`);
+    // Create All/None/Ham HF buttons
+    $("#band-options").append(` <span style="display: inline-block"><button id="filter-button-band-all" type="button" class="btn btn-outline-secondary" onclick="toggleFilterButtons('band', true);">All</button> <button id="filter-button-band-none" type="button" class="btn btn-outline-secondary" onclick="toggleFilterButtons('band', false);">None</button> <button id="filter-button-band-none" type="button" class="btn btn-outline-secondary" onclick="setHamHFBandToggles();">Ham HF</button></span>`);
+}
+
+// Set the band toggles so that only the amateur radio HF bands are selected. This includes 160m and 6m because that's
+// widely expected by hams to be included. Special case of toggleFilterButtons().
+function setHamHFBandToggles() {
+    const hamHFBands = ["160m", "80m", "60m", "40m", "30m", "20m", "17m", "15m", "12m", "10m", "6m"];
+    $(".filter-button-band").each(function() {
+        $(this).prop('checked', hamHFBands.includes($(this).val().replace("filter-button-band-", "")));
+    });
+    filtersUpdated();
 }
 
 // Generate SIGs filter card. This one is also a special case.
 function generateSIGsMultiToggleFilterCard(sig_options) {
     // Create a button for each option
     sig_options.forEach(o => {
-        $("#sig-options").append(`<input type="checkbox" class="btn-check filter-button-sig storeable-checkbox" name="options" id="filter-button-sig-${o['name']}" value="${o['name']}" autocomplete="off" onClick="filtersUpdated()" checked><label class="btn btn-outline-primary" id="filter-button-label-sig-${o['name']}" for="filter-button-sig-${o['name']}" title="${o['description']}"><i class="fa-solid fa-${o['icon']}"></i> ${o['name']}</label> `);
+        var domSafeName = o["name"].replace(/^[^A-Za-z0-9]+|[^\w]+/gi, "");
+        $("#sig-options").append(`<input type="checkbox" class="btn-check filter-button-sig storeable-checkbox" name="options" id="filter-button-sig-${domSafeName}" value="${o['name']}" autocomplete="off" onClick="filtersUpdated()" checked><label class="btn btn-outline-primary" id="filter-button-label-sig-${domSafeName}" for="filter-button-sig-${domSafeName}" title="${o['description']}"><i class="fa-solid ${sigToIcon(o['name'], 'fa-tower-cell')}"></i> ${o['name']}</label> `);
     });
     // Create a bonus "NO_SIG" / "General DX" option
     $("#sig-options").append(`<input type="checkbox" class="btn-check filter-button-sig storeable-checkbox" name="options" id="filter-button-sig-NO_SIG" value="NO_SIG" autocomplete="off" onClick="filtersUpdated()" checked><label class="btn btn-outline-primary" id="filter-button-label-sig-NO_SIG" for="filter-button-sig-NO_SIG"><i class="fa-solid fa-tower-cell"></i> General DX</label> `);
@@ -39,6 +47,20 @@ function generateSIGsMultiToggleFilterCard(sig_options) {
     $("#sig-options").append(` <span style="display: inline-block"><button id="filter-button-sig-all" type="button" class="btn btn-outline-secondary" onclick="toggleFilterButtons('sig', true);">All</button>&nbsp;<button id="filter-button-sig-none" type="button" class="btn btn-outline-secondary" onclick="toggleFilterButtons('sig', false);">None</button></span>`);
 }
 
+// Generate Sources filter card. This one is a minor special case as we create the buttons in the normal way, but then
+// set which ones are enabled by default based on config rather than having them all enabled by default. We also sanitise
+// names here for HTML elements.
+function generateSourcesMultiToggleFilterCard(source_options, sources_enabled_by_default) {
+    // Create a button for each option
+    source_options.forEach(o => {
+        var enable = sources_enabled_by_default.includes(o);
+        var domSafeName = o.replace(/^[^A-Za-z0-9]+|[^\w]+/gi, "");
+        $("#source-options").append(`<input type="checkbox" class="btn-check filter-button-source storeable-checkbox" name="options" id="filter-button-source-${domSafeName}" value="${o}" autocomplete="off" onClick="filtersUpdated()" ${enable ? "checked" : ""}><label class="btn btn-outline-primary" for="filter-button-source-${domSafeName}">${o}</label> `);
+    });
+    // Create All/None buttons
+    $("#source-options").append(` <span style="display: inline-block"><button id="filter-button-source-all" type="button" class="btn btn-outline-secondary" onclick="toggleFilterButtons('source', true);">All</button>&nbsp;<button id="filter-button-source-none" type="button" class="btn btn-outline-secondary" onclick="toggleFilterButtons('source', false);">None</button></span>`);
+}
+
 // Method called when any filter is changed to reload the spots and persist the filter settings.
 function filtersUpdated() {
     loadSpots();
@@ -50,3 +72,19 @@ function toggleDarkMode() {
     enableDarkMode($("#darkMode")[0].checked);
     saveSettings();
 }
+
+// Function to update the band colour scheme in spots, bands and map pages
+function setBandColorSchemeFromUI() {
+    setBandColorScheme($("#band-color-scheme option:selected").val());
+    saveSettings();
+    // Fudge a full reload because we need to update not just colours in the list/map/bands but also the filters
+    window.location.reload();
+}
+
+// Reload spots on becoming visible. This forces a refresh when used as a PWA and the user switches back to the PWA
+// after some time has passed with it in the background.
+addEventListener("visibilitychange", (event) => {
+    if (!document.hidden) {
+        loadSpots();
+    }
+});