Fix static analysis issues

# Conflicts:
#	webassets/apidocs/openapi.yml

README.md

@@ -10,17 +10,64 @@ The API is deliberately well-defined with an OpenAPI specification and auto-gene
 
 Spothole itself is also open source, Public Domain licenced code that anyone can take and modify.
 
-Supported data sources include DX Clusters, the Reverse Beacon Network (RBN), the APRS Internet Service (APRS-IS), POTA, SOTA, WWFF, GMA, WWBOTA, HEMA, Parks 'n' Peaks, ZLOTA, WOTA, BOTA, the UK Packet Repeater Network, and NG3K.
+Supported data sources include DX Clusters, the Reverse Beacon Network (RBN), the APRS Internet Service (APRS-IS), POTA, SOTA, WWFF, GMA, WWBOTA, HEMA, Parks 'n' Peaks, ZLOTA, WOTA, BOTA, LLOTA, WWTOTA, the UK Packet Repeater Network, NG3K, and any site based on the xOTA software by nischu.
 
 ![Screenshot](/images/screenshot2.png)
 
 ![Screenshot](/images/screenshot3.png)
 
-### Accessing the public version
+## Accessing the public version
 
 You can access the public version's web interface at [https://spothole.app](https://spothole.app), and see [https://spothole.app/apidocs](https://spothole.app/apidocs) for the API details.
 
-### Running your own copy
+This is a Progressive Web App, so you can also "install" it to your Android or iOS device by accessing it in Chrome or Safari respectively, and following the menu-driven process for installing PWAs.
+
+## Embedding Spothole in another website
+
+You can embed Spothole in another website, e.g. for use as part of a ham radio custom dashboard.
+
+URL parameters can be used to trigger an "embedded" mode which hides the headers, footers and settings. In this mode, you provide configuration for the various filter and display options via additional URL parameters. Any settings that the user has set for Spothole are ignored. This is so that the embedding site can select, for example, their choice of dark mode or SIG filters, which will not impact how Spothole appears when the user accesses it directly. Effectively, it becomes separate to their normal Spothole settings.
+
+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.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.
+
+| Name           | Allowed Values          | Default | Example                 | Description                                                                                                                                                           |
+|----------------|-------------------------|---------|-------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `embedded`     | `true`, `false`         | `false` | `?embedded=true`        | Enables embedded mode.                                                                                                                                                |
+| `color-scheme` | `light`, `dark`, `auto` | `auto`  | `?color-scheme=dark`    | Forces light or dark mode in preference to the operating system default.                                                                                              |
+| `time-zone`    | `UTC`, `local`          | `UTC`   | `?time-zone=local`      | Sets times to be in UTC or local time.                                                                                                                                |
+| `limit`        | 10, 25, 50, 100         | 50      | `?limit=50`             | Sets the number of spots that will be displayed on the main spots page                                                                                                |
+| `limit`        | 25, 50, 100, 200, 500   | 100     | `?limit=100`            | Sets the number of alerts that will be displayed on the alerts page                                                                                                   |
+| `max_age`      | 300, 600, 1800, 3600    | 1800    | `?max_age=1800`         | Sets the maximum age of spots displayed on the map and bands pages, in seconds.                                                                                       |
+| `band`         | Comma-separated list    | (all)   | `?band=20m,40m`         | Sets the list of bands that will be shown on the spots, bands and map pages. Available options match the labels of the buttons in the standard web interface.         |
+| `sig`          | Comma-separated list    | (all)   | `?sig=POTA,SOTA,NO_SIG` | Sets the list of SIGs that will be shown on the spots, bands and map pages. Available options match the labels of the buttons in the standard web interface.          |
+| `source`       | Comma-separated list    | (all)   | `?source=Cluster`       | Sets the list of sources that will be shown on any spot or alert pages. Available options match the labels of the buttons in the standard web interface.              |
+| `mode_type`    | Comma-separated list    | (all)   | `?mode_type=PHONE,CW`   | Sets the list of mode types that will be shown on the spots, bands and map pages. Available options match the labels of the buttons in the standard web interface.    |
+| `dx_continent` | Comma-separated list    | (all)   | `?dx_continent=NA,SA`   | Sets the list of DX Continents that will be shown on any spot or alert pages. Available options match the labels of the buttons in the standard web interface.        |
+| `de_continent` | Comma-separated list    | (all)   | `?de_continent=EU`      | Sets the list of DE Continents that will be shown on the spots, bands and map pages. Available options match the labels of the buttons in the standard web interface. |
+
+More will be added soon to allow customisation of filters and other display properties.
+
+## Writing your own client
+
+One of the key strengths of Spothole is that the API is well-defined and open to anyone to use. This means you can build your own software that uses data from Spothole.
+
+As well as the main API endpoints to fetch spots and alerts, with various possible query parameters, there are also Server-Sent Events (SSE) API endpoints to receive a live feed, plus various utility lookup endpoints for things like callsign and park data.
+
+Various approaches exist to writing your own client, but in general:
+
+* Refer to the API docs. These are built on an OpenAPI definition file (`/webassets/apidocs/openapi.yml`), which you can automatically use to generate a client skeleton using various software.
+* Call the main "spots" or "alerts" API endpoints to get the data you want. Apply filters if necessary.
+* Call the "options" API to get an idea of which bands, modes etc. the server knows about. You might want to do that first before calling the spots/alerts APIs, to allow you to populate your filters correctly.
+* Refer to the provided HTML/JS interface for a reference on different approaches. For example, the "map" and "bands" pages simply query the main spot API on a timer, whereas the main/spots page combines this approach with using the Server-Sent Events (SSE) endpoint to update live.
+* Let me know if you get stuck, I'm happy to help!
+
+## Running your own copy
+
+If you want to run a copy of Spothole with different configuration settings than the main instance, you can download it and run it on your own local machine or server.
 
 To download and set up Spothole on a Debian server, run the following commands. Other operating systems will likely be similar.
 
@@ -34,7 +81,9 @@ deactivate
 cp config-example.yml config.yml
 ```
 
-Then edit `config.yml` in your text editor of choice to set up the software as you like it.
+Then edit `config.yml` in your text editor of choice to set up the software as you like it. Mostly, this will involve enabling or disabling the various providers of spot and alert data.
+
+By default, all outdoor programme providers are enabled, as is one cluster node and the NG3K DXpedition data. The RBN spot providers are turned off by default due to the volume of traffic from CW/RTTY/FT8 skimmers, and the APRS and Packet spot providers are off by default on the assumption that Spothole users want a spot with a human at the other end of it, but all can be easily re-enabled.
 
 `config.yml` has some entries for QRZ.com username & password, and Clublog API keys. If provided, these allow Spothole to retrieve more information about DX spots, such as the country their callsign corresponds to. The software will work just fine without them, but you may find a few country flags etc. are less accurate or missing.
 
@@ -55,8 +104,106 @@ The software can take a few seconds to start up, mostly because it is downloadin
 
 If you see some errors on startup, check your configuration, e.g. in case you have specified a port for the web server that is already in use by something else.
 
+### Multiple cluster nodes with different settings
+
+Dan, S50U has written in with his Spothole cluster settings. He is using a cluster node which provides RBN spots, and uses different SSIDs on his callsign to get different settings when logged into the same cluster node. For example:
+
+```
+  -
+    class: "DXCluster"
+    name: "S50CLX"
+    enabled: true
+    host: "s50clx.si"
+    port: 41112
+    login_prompt: "login: "
+    login_callsign: "callsign-10"
+```
+
+Telnet to DXSpider and log in with "callsign-10" and execute the following commands:
+
+`CLEAR/SPOTS ALL` (delete all previous filters)<br/>
+`UNSET/ANN` (stop announce messages)<br/>
+`UNSET/WCY` (stop wcy messages)<br/>
+`UNSET/WWV` (stop wwv messages)<br/>
+`SET/DX` (enable human DX spots)
+
+```
+  -
+    class: "DXCluster"
+    name: "RBN CW"
+    enabled: true
+    host: "s50clx.si"
+    port: 41112
+    login_prompt: "login: "
+    login_callsign: "callsign-11"
+    allow_rbn_spots: true
+    enabled-by-default-in-web-ui: false
+```
+
+Telnet to DXSpider and log in with "callsign-11" and execute the following commands:
+
+`CLEAR/SPOTS ALL` (delete all previous filters)<br/>
+`UNSET/ANN` (stop announce messages)<br/>
+`UNSET/WCY` (stop wcy messages)<br/>
+`UNSET/WWV` (stop wwv messages)<br/>
+`UNSET/DX` (stop human DX spots)<br/>
+`SET/SKIMMER CW` (enable CW RBN spots)
+
+```
+  -
+    class: "DXCluster"
+    name: "RBN RTTY"
+    enabled: true
+    host: "s50clx.si"
+    port: 41112
+    login_prompt: "login: "
+    login_callsign: "callsign-12"
+    allow_rbn_spots: true
+    enabled-by-default-in-web-ui: false
+```
+
+Telnet to DXSpider and log in with "callsign-12" and execute the following commands:
+
+`CLEAR/SPOTS ALL` (delete all previous filters)<br/>
+`UNSET/ANN` (stop announce messages)<br/>
+`UNSET/WCY` (stop wcy messages)<br/>
+`UNSET/WWV` (stop wwv messages)<br/>
+`UNSET/DX` (stop human DX spots)<br/>
+`SET/SKIMMER RTTY` (enable RTTY RBN spots)
+
+```
+  -
+    class: "DXCluster"
+    name: "RBN FT4/8"
+    enabled: true
+    host: "s50clx.si"
+    port: 41112
+    login_prompt: "login: "
+    login_callsign: "callsign-13"
+    allow_rbn_spots: true
+    enabled-by-default-in-web-ui: false
+```
+
+Telnet to DXSpider and log in with "callsign-13" and execute the following commands:
+
+`CLEAR/SPOTS ALL` (delete all previous filters)<br/>
+`UNSET/ANN` (stop announce messages)<br/>
+`UNSET/WCY` (stop wcy messages)<br/>
+`UNSET/WWV` (stop wwv messages)<br/>
+`UNSET/DX` (stop human DX spots)<br/>
+`SET/SKIMMER FT` (enable FT RBN spots)
+
+For each callsign-SSID, we also specify our basic information with commands:
+
+`SET/NAME Spothole10`, Spothole11... etc.<br/>
+`SET/QTH Cerkno`<br/>
+`SET/QRA JN66XD`<br/>
+`SET/HOME S50CLX`
+
 ### systemd configuration
 
+If you want Spothole to run automatically on startup on a Linux distribution that uses `systemd`, follow the instructions here. For distros that don't use `systemd`, or Windows/OSX/etc., you can find generic instructions for your OS online.
+
 Create a file at `/etc/systemd/system/spothole.service`. Give it the following content, adjusting for the user you want to run it as and the directory in which you have installed it:
 
 ```
@@ -87,7 +234,9 @@ Check the service has started up correctly with `sudo journalctl -u spothole -f`
 
 ### nginx Reverse Proxy configuration
 
-It's best not to serve Spothole directly on port 80, as that requires root privileges and prevents us using HTTPS, amongst other reasons. To set up nginx as a reverse proxy that sits in front of Spothole, first ensure it's installed e.g. `sudo apt install nginx`, and enabled e.g. `sudo systemd enable nginx`.
+Web servers generally serve their pages from port 80. However, it's best not to serve Spothole's web interface directly on port 80, as that requires root privileges on a Linux system. It also and prevents us using HTTPS to serve a secure site, since Spothole itself doesn't directly support acting as an HTTPS server. The normal solution to this is to use a "reverse proxy" setup, where a general web server handles HTTP and HTTP requests (to port 80 & 443 respectively), then passes on the request to the back-end application (in this case Spothole). nginx is a common choice for this general web server.
+
+To set up nginx as a reverse proxy that sits in front of Spothole, first ensure it's installed e.g. `sudo apt install nginx`, and enabled e.g. `sudo systemd enable nginx`.
 
 Create a file at `/etc/nginx/sites-available/` called `spothole`. Give it the following contents, replacing `spothole.app` with the domain name on which you want to run Spothole. If you changed the port on which Spothole runs, update that on the "proxy_pass" line too.
 
@@ -106,6 +255,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;
     }
 }
@@ -135,17 +286,11 @@ You should now be able to access the web interface by going to the domain from y
 
 Once that's working, [install certbot](https://certbot.eff.org/instructions?ws=nginx&os=snap) onto your server. Run it as root, and when prompted pick your domain name from the list. After a few seconds, it should successfully provision a certificate and modify your nginx config files automatically. You should then be able to access the site via HTTPS.
 
-### Writing your own client
+## Modifying the source code
 
-Various approaches exist to writing your own client, but in general:
+Spothole is Public Domain licenced, so you can grab the source code and start modifying it for your own needs. Contributions of code back to the main repository are encouraged, but completely optional.
 
-* Refer to the API docs. These are built on an OpenAPI definition file (`/webassets/apidocs/openapi.yml`), which you can automatically use to generate a client skeleton using various software.
+### Code structure
-* Call the main "spots" API to get the data you want. Apply filters if necessary.
-* Call the "options" API to get an idea of which bands, modes etc. the server knows about. You might want to do that first before calling the spots API.
-* Refer to the provided HTML/JS interface for a reference
-* Let me know if you get stuck, I'm happy to help!
-
-### Structure of the source code
 
 To navigate your way around the source code, this list may help.
 
@@ -159,7 +304,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*
 
@@ -174,32 +319,39 @@ 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
 
-Spothole is designed to be easily extensible. If you want to write your own provider, simply add a module to the `providers` package containing your class. (Currently, in order to be loaded correctly, the module (file) name should be the same as the class name, but lower case.)
+Spothole is designed to be easily extensible. If you want to write your own spot provider, for example, simply add a module to the `spotproviders` package containing your class. (Currently, in order to be loaded correctly, the module (file) name should be the same as the class name, but lower case.)
 
-Your class should extend "Provider"; if it operates by polling an HTTP Server on a timer, it can instead extend "HTTPProvider" where some of the work is done for you.
+Your class should extend "SpotProvider"; if it operates by polling an HTTP Server on a timer, it can instead extend "HTTPSpotProvider" where some of the work is done for you.
 
 The class will need to implement a constructor that takes in the `provider_config` and provides it to the superclass constructor, while also taking any other config parameters it needs.
 
-If you're extending the base `Provider` class, you will need to implement `start()` and `stop()` methods that start and stop a separate thread which handles the provider's processing needs. The thread should call `submit()` or `submit_batch()` when it has one or more spots to report.
+If you're extending the base `SpotProvider` class, you will need to implement `start()` and `stop()` methods that start and stop a separate thread which handles the provider's processing needs. The thread should call `submit()` or `submit_batch()` when it has one or more spots to report.
 
-If you're extending the `HTTPProvider` class, you will need to provide a URI to query and an interval to the superclass constructor. You'll then need to implement the `http_response_to_spots()` method which is called when new data is retrieved. Your implementation should then call `submit()` or `submit_batch()` when it has one or more spots to report.
+If you're extending the `HTTPSpotProvider` class, you will need to provide a URI to query and an interval to the superclass constructor. You'll then need to implement the `http_response_to_spots()` method which is called when new data is retrieved. Your implementation should then call `submit()` or `submit_batch()` when it has one or more spots to report.
 
 When constructing spots, use the comments in the Spot class and the existing implementations as an example. All parameters are optional, but you will at least want to provide a `time` (which must be timezone-aware) and a `dx_call`.
 
-Finally, simply add the appropriate config to the `providers` section of `config.yml`, and your provider should be instantiated on startup.
+Finally, simply add the appropriate config to the `spot_providers` section of `config.yml`, and your provider should be instantiated on startup.
 
-### Thanks
+The same approach as above is also used for alert providers.
+
+## Thanks
 
 As well as being my work, I have also gratefully received feature patches from Steven, M1SDH.
 
-The project contains a self-hosted copy of Font Awesome's free library, in the `/webasset/fa/` directory. This is subject to Font Awesome's licence and is not covered by the overall licence declared in the `LICENSE` file. This approach was taken in preference to using their hosted kits due to the popularity of this project exceeding the page view limit for their free hosted offering.
+The project contains GeoJSON files for CQ and ITU zones, in the `/datafiles/` directory. These are MIT-licenced and, to my knowledge, created by HA8TKS for his CQ and ITU zone layers for Leaflet.
+
+The project contains a self-hosted copy of Font Awesome's free library, in the `/webassets/fa/` directory. This is subject to Font Awesome's licence and is not covered by the overall licence declared in the `LICENSE` file. This approach was taken in preference to using their hosted kits due to the popularity of this project exceeding the page view limit for their free hosted offering.
+
+The project contains a set of flag icons generated using the "Noto Color Emoji" font on a Debian system, in the `/webassets/img/flags/` directory.
 
 The software uses a number of Python libraries as listed in `requirements.txt`, and a number of JavaScript libraries such as jQuery, Leaflet and Bootstrap. This project would not have been possible without these libraries, so many thanks to their developers.
 
-Particular thanks go to QRZCQ country-files.com for providing country lookup data for amateur radio, and to the developers of `pyhamtools` for making it easy to use this data as well as QRZ.com and Clublog lookup.
+Particular thanks go to country-files.com for providing country lookup data for amateur radio, to K0SWE for [this JSON-formatted DXCC data](https://github.com/k0swe/dxcc-json/), and to the developers of `pyhamtools` for making it easy to use country-files.com data as well as QRZ.com and Clublog lookup.
 
 The project's name was suggested by Harm, DK4HAA. Thanks!

alertproviders/alert_provider.py

@@ -1,41 +1,55 @@
-from datetime import datetime, timedelta
+from datetime import datetime
 
 import pytz
 
-from core.config import SERVER_OWNER_CALLSIGN, MAX_ALERT_AGE
+from core.config import MAX_ALERT_AGE
-from core.constants import SOFTWARE_NAME, SOFTWARE_VERSION
 
 
-# Generic alert provider class. Subclasses of this query the individual APIs for alerts.
 class AlertProvider:
+    """Generic alert provider class. Subclasses of this query the individual APIs for alerts."""
 
-    # Constructor
     def __init__(self, provider_config):
+        """Constructor"""
+
         self.name = provider_config["name"]
         self.enabled = provider_config["enabled"]
         self.last_update_time = datetime.min.replace(tzinfo=pytz.UTC)
         self.status = "Not Started" if self.enabled else "Disabled"
-        self.alerts = None
+        self._alerts = None
+        self._web_server = None
 
-    # Set up the provider, e.g. giving it the alert list to work from
+    def setup(self, alerts, web_server):
-    def setup(self, alerts):
+        """Set up the provider, e.g. giving it the alert list to work from"""
-        self.alerts = alerts
+
+        self._alerts = alerts
+        self._web_server = web_server
 
-    # Start the provider. This should return immediately after spawning threads to access the remote resources
     def start(self):
+        """Start the provider. This should return immediately after spawning threads to access the remote resources"""
+
         raise NotImplementedError("Subclasses must implement this method")
 
-    # Submit a batch of alerts retrieved from the provider. There is no timestamp checking like there is for spots,
+    def _submit_batch(self, alerts):
-    # because alerts could be created at any point for any time in the future. Rely on hashcode-based id matching
+        """Submit a batch of alerts retrieved from the provider. There is no timestamp checking like there is for spots,
-    # to deal with duplicates.
+        because alerts could be created at any point for any time in the future. Rely on hashcode-based id matching
-    def submit_batch(self, alerts):
+        to deal with duplicates."""
+
+        # 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 a: (a.start_time if a and a.start_time else 0))
         for alert in alerts:
-            # Fill in any blanks
+            # Fill in any blanks and add to the list
             alert.infer_missing()
-            # Add to the list, provided it heas not already expired.
+            self._add_alert(alert)
-            if not alert.expired():
+
-                self.alerts.add(alert.id, alert, expire=MAX_ALERT_AGE)
+    def _add_alert(self, alert):
+        if not alert.expired():
+            self._alerts.add(alert.id, alert, expire=MAX_ALERT_AGE)
+            # Ping the web server in case we have any SSE connections that need to see this immediately
+            if self._web_server:
+                self._web_server.notify_new_alert(alert)
 
-    # Stop any threads and prepare for application shutdown
     def stop(self):
+        """Stop any threads and prepare for application shutdown"""
+
         raise NotImplementedError("Subclasses must implement this method")

alertproviders/bota.py

@@ -2,25 +2,30 @@ from datetime import datetime, timedelta
 
 import pytz
 from bs4 import BeautifulSoup
+
 from alertproviders.http_alert_provider import HTTPAlertProvider
-from core.sig_utils import get_icon_for_sig
 from data.alert import Alert
 from data.sig_ref import SIGRef
 
 
-# Alert provider for Beaches on the Air
 class BOTA(HTTPAlertProvider):
-    POLL_INTERVAL_SEC = 3600
+    """Alert provider for Beaches on the Air"""
+
+    POLL_INTERVAL_SEC = 1800
     ALERTS_URL = "https://www.beachesontheair.com/"
 
     def __init__(self, provider_config):
         super().__init__(provider_config, self.ALERTS_URL, self.POLL_INTERVAL_SEC)
 
-    def http_response_to_alerts(self, http_response):
+    def _http_response_to_alerts(self, http_response):
         new_alerts = []
         # Find the table of upcoming alerts
         bs = BeautifulSoup(http_response.content.decode(), features="lxml")
-        tbody = bs.body.find('div', attrs={'class': 'view-activations-public'}).find('table', attrs={'class': 'views-table'}).find('tbody')
+        div = bs.body.find('div', attrs={'class': 'view-activations-public'})
+        if div:
+            table = div.find('table', attrs={'class': 'views-table'})
+            if table:
+                tbody = table.find('tbody')
                 for row in tbody.find_all('tr'):
                     cells = row.find_all('td')
                     first_cell_text = str(cells[0].find('a').contents[0]).strip()
@@ -29,7 +34,7 @@ class BOTA(HTTPAlertProvider):
 
                     # Get the date, dealing with the fact we get no year so have to figure out if it's last year or next year
                     date_text = str(cells[2].find('span').contents[0]).strip()
-            date_time = datetime.strptime(date_text,"%d %b - %H:%M UTC").replace(tzinfo=pytz.UTC)
+                    date_time = datetime.strptime(date_text, "%d %b - %H:%M UTC").replace(tzinfo=pytz.UTC)
                     date_time = date_time.replace(year=datetime.now(pytz.UTC).year)
                     # If this was more than a day ago, activation is actually next year
                     if date_time < datetime.now(pytz.UTC) - timedelta(days=1):

alertproviders/http_alert_provider.py

@@ -1,7 +1,6 @@
 import logging
 from datetime import datetime
-from threading import Timer, Thread
+from threading import Thread, Event
-from time import sleep
 
 import pytz
 import requests
@@ -10,54 +9,57 @@ from alertproviders.alert_provider import AlertProvider
 from core.constants import HTTP_HEADERS
 
 
-# Generic alert provider class for providers that request data via HTTP(S). Just for convenience to avoid code
-# duplication. Subclasses of this query the individual APIs for data.
 class HTTPAlertProvider(AlertProvider):
+    """Generic alert provider class for providers that request data via HTTP(S). Just for convenience to avoid code
+    duplication. Subclasses of this query the individual APIs for data."""
 
     def __init__(self, provider_config, url, poll_interval):
         super().__init__(provider_config)
-        self.url = url
+        self._url = url
-        self.poll_interval = poll_interval
+        self._poll_interval = poll_interval
-        self.poll_timer = None
+        self._thread = None
+        self._stop_event = Event()
 
     def start(self):
-        # Fire off a one-shot thread to run poll() for the first time, just to ensure start() returns immediately and
+        # Fire off the polling thread. It will poll immediately on startup, then sleep for poll_interval between
-        # the application can continue starting. The thread itself will then die, and the timer will kick in on its own
+        # subsequent polls, so start() returns immediately and the application can continue starting.
-        # thread.
+        logging.info("Set up query of " + self.name + " alert API every " + str(self._poll_interval) + " seconds.")
-        logging.info("Set up query of " + self.name + " alert API every " + str(self.poll_interval) + " seconds.")
+        self._thread = Thread(target=self._run, daemon=True)
-        thread = Thread(target=self.poll)
+        self._thread.start()
-        thread.daemon = True
-        thread.start()
 
     def stop(self):
-        if self.poll_timer:
+        self._stop_event.set()
-            self.poll_timer.cancel()
 
-    def poll(self):
+    def _run(self):
+        while True:
+            self._poll()
+            if self._stop_event.wait(timeout=self._poll_interval):
+                break
+
+    def _poll(self):
         try:
             # Request data from API
             logging.debug("Polling " + self.name + " alert API...")
-            http_response = requests.get(self.url, headers=HTTP_HEADERS)
+            http_response = requests.get(self._url, headers=HTTP_HEADERS)
             # Pass off to the subclass for processing
-            new_alerts = self.http_response_to_alerts(http_response)
+            new_alerts = self._http_response_to_alerts(http_response)
             # Submit the new alerts for processing. There might not be any alerts for the less popular programs.
             if new_alerts:
-                self.submit_batch(new_alerts)
+                self._submit_batch(new_alerts)
 
             self.status = "OK"
             self.last_update_time = datetime.now(pytz.UTC)
             logging.debug("Received data from " + self.name + " alert API.")
 
-        except Exception as e:
+        except Exception:
             self.status = "Error"
             logging.exception("Exception in HTTP JSON Alert Provider (" + self.name + ")")
-            sleep(1)
+            # Brief pause on error before the next poll, but still respond promptly to stop()
+            self._stop_event.wait(timeout=1)
 
-        self.poll_timer = Timer(self.poll_interval, self.poll)
+    def _http_response_to_alerts(self, http_response):
-        self.poll_timer.start()
+        """Convert an HTTP response returned by the API into alert data. The whole response is provided here so the subclass
+        implementations can check for HTTP status codes if necessary, and handle the response as JSON, XML, text, whatever
+        the API actually provides."""
 
-    # Convert an HTTP response returned by the API into alert data. The whole response is provided here so the subclass
-    # implementations can check for HTTP status codes if necessary, and handle the response as JSON, XML, text, whatever
-    # the API actually provides.
-    def http_response_to_alerts(self, http_response):
         raise NotImplementedError("Subclasses must implement this method")

alertproviders/ng3k.py

@@ -8,16 +8,17 @@ from alertproviders.http_alert_provider import HTTPAlertProvider
 from data.alert import Alert
 
 
-# Alert provider NG3K DXpedition list
 class NG3K(HTTPAlertProvider):
-    POLL_INTERVAL_SEC = 3600
+    """Alert provider NG3K DXpedition list"""
+
+    POLL_INTERVAL_SEC = 1800
     ALERTS_URL = "https://www.ng3k.com/adxo.xml"
     AS_CALL_PATTERN = re.compile("as ([a-z0-9/]+)", re.IGNORECASE)
 
     def __init__(self, provider_config):
         super().__init__(provider_config, self.ALERTS_URL, self.POLL_INTERVAL_SEC)
 
-    def http_response_to_alerts(self, http_response):
+    def _http_response_to_alerts(self, http_response):
         new_alerts = []
         rss = RSSParser.parse(http_response.content.decode())
         # Iterate through source data
@@ -48,7 +49,8 @@ class NG3K(HTTPAlertProvider):
 
             start_timestamp = datetime.strptime(start_year + " " + start_mon + " " + start_day, "%Y %b %d").replace(
                 tzinfo=pytz.UTC).timestamp()
-            end_timestamp = datetime.strptime(end_year + " " + end_mon + " " + end_day + " 23:59", "%Y %b %d %H:%M").replace(
+            end_timestamp = datetime.strptime(end_year + " " + end_mon + " " + end_day + " 23:59",
+                                              "%Y %b %d %H:%M").replace(
                 tzinfo=pytz.UTC).timestamp()
 
             # Sometimes the DX callsign is "real", sometimes you just get a prefix with the real working callsigns being
@@ -62,7 +64,7 @@ class NG3K(HTTPAlertProvider):
                 dx_calls = [parts[2].upper()]
 
             # "Calls" of TBA, TBC or TBD are not real attempts at Turkish callsigns
-            dx_calls = list(filter(lambda a: a != "TBA" and a != "TBC" and a != "TBD" , dx_calls))
+            dx_calls = list(filter(lambda a: a != "TBA" and a != "TBC" and a != "TBD", dx_calls))
 
             dx_country = parts[1]
             qsl_info = parts[3]
@@ -76,7 +78,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/parksnpeaks.py

@@ -4,20 +4,20 @@ from datetime import datetime
 import pytz
 
 from alertproviders.http_alert_provider import HTTPAlertProvider
-from core.sig_utils import get_icon_for_sig
 from data.alert import Alert
 from data.sig_ref import SIGRef
 
 
-# Alert provider for Parks n Peaks
 class ParksNPeaks(HTTPAlertProvider):
-    POLL_INTERVAL_SEC = 3600
+    """Alert provider for Parks n Peaks"""
+
+    POLL_INTERVAL_SEC = 1800
     ALERTS_URL = "http://parksnpeaks.org/api/ALERTS/"
 
     def __init__(self, provider_config):
         super().__init__(provider_config, self.ALERTS_URL, self.POLL_INTERVAL_SEC)
 
-    def http_response_to_alerts(self, http_response):
+    def _http_response_to_alerts(self, http_response):
         new_alerts = []
         # Iterate through source data
         for source_alert in http_response.json():
@@ -45,7 +45,7 @@ class ParksNPeaks(HTTPAlertProvider):
 
             # Log a warning for the developer if PnP gives us an unknown programme we've never seen before
             if sig and sig not in ["POTA", "SOTA", "WWFF", "SiOTA", "ZLOTA", "KRMNPA"]:
-                logging.warn("PNP alert found with sig " + sig + ", developer needs to add support for this!")
+                logging.warning("PNP alert found with sig " + sig + ", developer needs to add support for this!")
 
             # If this is POTA, SOTA or WWFF data we already have it through other means, so ignore. Otherwise, add to
             # the alert list. Note that while ZLOTA has its own spots API, it doesn't have its own alerts API. So that

alertproviders/pota.py

@@ -3,20 +3,20 @@ from datetime import datetime
 import pytz
 
 from alertproviders.http_alert_provider import HTTPAlertProvider
-from core.sig_utils import get_icon_for_sig
 from data.alert import Alert
 from data.sig_ref import SIGRef
 
 
-# Alert provider for Parks on the Air
 class POTA(HTTPAlertProvider):
-    POLL_INTERVAL_SEC = 3600
+    """Alert provider for Parks on the Air"""
+
+    POLL_INTERVAL_SEC = 1800
     ALERTS_URL = "https://api.pota.app/activation"
 
     def __init__(self, provider_config):
         super().__init__(provider_config, self.ALERTS_URL, self.POLL_INTERVAL_SEC)
 
-    def http_response_to_alerts(self, http_response):
+    def _http_response_to_alerts(self, http_response):
         new_alerts = []
         # Iterate through source data
         for source_alert in http_response.json():
@@ -26,7 +26,8 @@ class POTA(HTTPAlertProvider):
                           dx_calls=[source_alert["activator"].upper()],
                           freqs_modes=source_alert["frequencies"],
                           comment=source_alert["comments"],
-                          sig_refs=[SIGRef(id=source_alert["reference"], sig="POTA", name=source_alert["name"], url="https://pota.app/#/park/" + source_alert["reference"])],
+                          sig_refs=[SIGRef(id=source_alert["reference"], sig="POTA", name=source_alert["name"],
+                                           url="https://pota.app/#/park/" + source_alert["reference"])],
                           start_time=datetime.strptime(source_alert["startDate"] + source_alert["startTime"],
                                                        "%Y-%m-%d%H:%M").replace(tzinfo=pytz.UTC).timestamp(),
                           end_time=datetime.strptime(source_alert["endDate"] + source_alert["endTime"],

alertproviders/sota.py

@@ -3,31 +3,38 @@ from datetime import datetime
 import pytz
 
 from alertproviders.http_alert_provider import HTTPAlertProvider
-from core.sig_utils import get_icon_for_sig
 from data.alert import Alert
 from data.sig_ref import SIGRef
 
 
-# Alert provider for Summits on the Air
 class SOTA(HTTPAlertProvider):
-    POLL_INTERVAL_SEC = 3600
+    """Alert provider for Summits on the Air"""
+
+    POLL_INTERVAL_SEC = 1800
     ALERTS_URL = "https://api-db2.sota.org.uk/api/alerts/365/all/all"
 
     def __init__(self, provider_config):
         super().__init__(provider_config, self.ALERTS_URL, self.POLL_INTERVAL_SEC)
 
-    def http_response_to_alerts(self, http_response):
+    def _http_response_to_alerts(self, http_response):
         new_alerts = []
         # 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)

alertproviders/wota.py

@@ -4,21 +4,21 @@ import pytz
 from rss_parser import RSSParser
 
 from alertproviders.http_alert_provider import HTTPAlertProvider
-from core.sig_utils import get_icon_for_sig
 from data.alert import Alert
 from data.sig_ref import SIGRef
 
 
-# Alert provider for Wainwrights on the Air
 class WOTA(HTTPAlertProvider):
-    POLL_INTERVAL_SEC = 3600
+    """Alert provider for Wainwrights on the Air"""
+
+    POLL_INTERVAL_SEC = 1800
     ALERTS_URL = "https://www.wota.org.uk/alerts_rss.php"
     RSS_DATE_TIME_FORMAT = "%a, %d %b %Y %H:%M:%S %z"
 
     def __init__(self, provider_config):
         super().__init__(provider_config, self.ALERTS_URL, self.POLL_INTERVAL_SEC)
 
-    def http_response_to_alerts(self, http_response):
+    def _http_response_to_alerts(self, http_response):
         new_alerts = []
         rss = RSSParser.parse(http_response.content.decode())
         # Iterate through source data

alertproviders/wwff.py

@@ -3,20 +3,20 @@ from datetime import datetime
 import pytz
 
 from alertproviders.http_alert_provider import HTTPAlertProvider
-from core.sig_utils import get_icon_for_sig
 from data.alert import Alert
 from data.sig_ref import SIGRef
 
 
-# Alert provider for Worldwide Flora and Fauna
 class WWFF(HTTPAlertProvider):
-    POLL_INTERVAL_SEC = 3600
+    """Alert provider for Worldwide Flora and Fauna"""
+
+    POLL_INTERVAL_SEC = 1800
     ALERTS_URL = "https://spots.wwff.co/static/agendas.json"
 
     def __init__(self, provider_config):
         super().__init__(provider_config, self.ALERTS_URL, self.POLL_INTERVAL_SEC)
 
-    def http_response_to_alerts(self, http_response):
+    def _http_response_to_alerts(self, http_response):
         new_alerts = []
         # Iterate through source data
         for source_alert in http_response.json():

config-example.yml

@@ -49,6 +49,14 @@ spot-providers:
     class: "WOTA"
     name: "WOTA"
     enabled: true
+  -
+    class: "LLOTA"
+    name: "LLOTA"
+    enabled: true
+  -
+    class: "WWTOTA"
+    name: "WWTOTA"
+    enabled: true
   -
     class: "APRSIS"
     name: "APRS-IS"
@@ -59,28 +67,64 @@ spot-providers:
     enabled: true
     host: "hrd.wa9pie.net"
     port: 8000
-    login_prompt: "login: "
+    # 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
-    login_prompt: "Please enter your call: "
+    # 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 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"
+    locations-csv: "datafiles/39c3-tota.csv"
+
 
 # Alert providers to use. Same setup as the spot providers list above.
 alert-providers:
@@ -136,3 +180,23 @@ clublog-api-key: ""
 
 # Allow submitting spots to the Spothole API?
 allow-spotting: true
+
+# Options for the web UI.
+web-ui-options:
+  spot-count: [10, 25, 50, 100]
+  spot-count-default: 50
+  max-spot-age: [5, 10, 30, 60]
+  max-spot-age-default: 30
+  alert-count: [25, 50, 100, 200, 500]
+  alert-count-default: 100
+  # Default UI colour scheme. Supported values are "light", "dark" and "auto" (i.e. use the browser/OS colour scheme).
+  # Users can still override this in the UI to their own preference.
+  color-scheme-default: "auto"
+  # Default band colour scheme. Supported values are the full names of any band colour scheme shown in the UI.
+  # Users can still override this in the UI to their own preference.
+  band-color-scheme-default: "PSK Reporter (Adjusted)"
+  # Custom HTML insert. This can be any arbitrary HTML. It will be inserted next to the start/stop buttons on the spots
+  # (home) page, although being arbitrary HTML you can also use a div with absolute, relative, float placement etc. This
+  # is designed for a "donate/support the server" type button, though you are free to do whatever you want with it.
+  # As the server owner you are responsible for the safe usage of this option!
+  support-button-html: ""

core/cleanup.py

@@ -1,52 +1,73 @@
 import logging
-from datetime import datetime, timedelta
+from datetime import datetime
-from threading import Timer
+from threading import Event, Thread
-from time import sleep
 
 import pytz
 
 
-# Provides a timed cleanup of the spot list.
 class CleanupTimer:
+    """Provides a timed cleanup of the spot list."""
 
-    # Constructor
+    def __init__(self, spots, alerts, web_server, cleanup_interval):
-    def __init__(self, spots, alerts, cleanup_interval):
+        """Constructor"""
-        self.spots = spots
+
-        self.alerts = alerts
+        self._spots = spots
-        self.cleanup_interval = cleanup_interval
+        self._alerts = alerts
-        self.cleanup_timer = None
+        self._web_server = web_server
+        self._cleanup_interval = cleanup_interval
         self.last_cleanup_time = datetime.min.replace(tzinfo=pytz.UTC)
         self.status = "Starting"
+        self._thread = None
+        self._stop_event = Event()
 
-    # Start the cleanup timer
     def start(self):
-        self.cleanup()
+        """Start the cleanup timer"""
+
+        self._thread = Thread(target=self._run, daemon=True)
+        self._thread.start()
 
-    # Stop any threads and prepare for application shutdown
     def stop(self):
-        self.cleanup_timer.cancel()
+        """Stop any threads and prepare for application shutdown"""
+
+        self._stop_event.set()
+
+    def _run(self):
+        while not self._stop_event.wait(timeout=self._cleanup_interval):
+            self._cleanup()
+
+    def _cleanup(self):
+        """Perform cleanup and reschedule next timer"""
 
-    # Perform cleanup and reschedule next timer
-    def cleanup(self):
         try:
-            # Perform cleanup
+            # Perform cleanup via letting the data expire
-            self.spots.expire()
+            self._spots.expire()
-            self.alerts.expire()
+            self._alerts.expire()
 
-            # Alerts can persist in the system for a while, so we want to explicitly clean up any alerts that have
+            # Explicitly clean up any spots and alerts that have expired
-            # expired
+            for i in list(self._spots.iterkeys()):
-            for id in list(self.alerts.iterkeys()):
+                try:
-                alert = self.alerts[id]
+                    spot = self._spots[i]
+                    if spot.expired():
+                        self._spots.delete(i)
+                except KeyError:
+                    # Must have already been deleted, OK with that
+                    pass
+            for i in list(self._alerts.iterkeys()):
+                try:
+                    alert = self._alerts[i]
                     if alert.expired():
-                    self.alerts.delete(id)
+                        self._alerts.delete(i)
+                except KeyError:
+                    # Must have already been deleted, OK with that
+                    pass
+
+            # Clean up web server SSE spot/alert queues
+            self._web_server.clean_up_sse_queues()
 
             self.status = "OK"
             self.last_cleanup_time = datetime.now(pytz.UTC)
 
-        except Exception as e:
+        except Exception:
             self.status = "Error"
             logging.exception("Exception in Cleanup thread")
-            sleep(1)
+            self._stop_event.wait(timeout=1)
-
-        self.cleanup_timer = Timer(self.cleanup_interval, self.cleanup)
-        self.cleanup_timer.start()

core/config.py

@@ -5,11 +5,13 @@ 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
-config = yaml.safe_load(open("config.yml"))
+with open("config.yml") as f:
+    config = yaml.safe_load(f)
 logging.info("Loaded config.")
 
 MAX_SPOT_AGE = config["max-spot-age-sec"]
@@ -17,3 +19,13 @@ MAX_ALERT_AGE = config["max-alert-age-sec"]
 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"])]
+# If spotting to this server is enabled, "API" is another valid spot source even though it does not come from
+# one of our proviers. We set that to also be enabled by default.
+if ALLOW_SPOTTING:
+    WEB_UI_OPTIONS["spot-providers-enabled-by-default"].append("API")

core/geo_utils.py

@@ -2,15 +2,172 @@ import logging
 import re
 from math import floor
 
+import geopandas
 from pyproj import Transformer
+from shapely import prepare
+from shapely.geometry import Point, Polygon
 
 TRANSFORMER_OS_GRID_TO_WGS84 = Transformer.from_crs("EPSG:27700", "EPSG:4326")
 TRANSFORMER_IRISH_GRID_TO_WGS84 = Transformer.from_crs("EPSG:29903", "EPSG:4326")
 TRANSFORMER_CI_UTM_GRID_TO_WGS84 = Transformer.from_crs("+proj=utm +zone=30 +ellps=WGS84", "EPSG:4326")
 
+cq_zone_data = geopandas.GeoDataFrame.from_features(geopandas.read_file("datafiles/cqzones.geojson"))
+itu_zone_data = geopandas.GeoDataFrame.from_features(geopandas.read_file("datafiles/ituzones.geojson"))
+for idx in cq_zone_data.index:
+    prepare(cq_zone_data.at[idx, 'geometry'])
+for idx in itu_zone_data.index:
+    prepare(itu_zone_data.at[idx, 'geometry'])
+
+
+def lat_lon_to_cq_zone(lat, lon):
+    """Finds out which CQ zone a lat/lon point is in."""
+
+    lon = ((lon + 180) % 360) - 180
+    for index, row in cq_zone_data.iterrows():
+        polygon = Polygon(row["geometry"])
+        test_point = Point(lon, lat)
+        if polygon.contains(test_point):
+            return int(row["name"])
+
+        # Might have problems around the antemeridian, so if we didn't find a match, try offsetting the point by + or -
+        # 360 degrees longitude to try the other side of the Earth
+        if lon < 0:
+            test_point = Point(lon + 360, lat)
+        else:
+            test_point = Point(lon - 360, lat)
+        if polygon.contains(test_point):
+            return int(row["name"])
+    return None
+
+
+def lat_lon_to_itu_zone(lat, lon):
+    """Finds out which ITU zone a lat/lon point is in."""
+
+    lon = ((lon + 180) % 360) - 180
+    for index, row in itu_zone_data.iterrows():
+        polygon = Polygon(row["geometry"])
+        test_point = Point(lon, lat)
+        if polygon.contains(test_point):
+            return int(row["name"])
+
+        # Might have problems around the antemeridian, so if we didn't find a match, try offsetting the point by + or -
+        # 360 degrees longitude to try the other side of the Earth
+        if lon < 0:
+            test_point = Point(lon + 360, lat)
+        else:
+            test_point = Point(lon - 360, lat)
+        if polygon.contains(test_point):
+            return int(row["name"])
+    return None
+
+
+def lat_lon_for_grid_centre(grid):
+    """Convert a Maidenhead grid reference of arbitrary precision to the lat/long of the centre point of the square.
+    Returns None if the grid format is invalid."""
+
+    lat, lon, lat_cell_size, lon_cell_size = lat_lon_for_grid_sw_corner_plus_size(grid)
+    if lat is not None and lon is not None and lat_cell_size is not None and lon_cell_size is not None:
+        return [lat + lat_cell_size / 2.0, lon + lon_cell_size / 2.0]
+    else:
+        return None
+
+
+def lat_lon_for_grid_sw_corner(grid):
+    """Convert a Maidenhead grid reference of arbitrary precision to the lat/long of the southwest corner of the square.
+    Returns None if the grid format is invalid."""
+
+    lat, lon, lat_cell_size, lon_cell_size = lat_lon_for_grid_sw_corner_plus_size(grid)
+    if lat is not None and lon is not None:
+        return [lat, lon]
+    else:
+        return None
+
+
+def lat_lon_for_grid_ne_corner(grid):
+    """Convert a Maidenhead grid reference of arbitrary precision to the lat/long of the northeast corner of the square.
+    Returns None if the grid format is invalid."""
+
+    lat, lon, lat_cell_size, lon_cell_size = lat_lon_for_grid_sw_corner_plus_size(grid)
+    if lat is not None and lon is not None and lat_cell_size is not None and lon_cell_size is not None:
+        return [lat + lat_cell_size, lon + lon_cell_size]
+    else:
+        return None
+
+
+def lat_lon_for_grid_sw_corner_plus_size(grid):
+    """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 a tuple of size 4. The elements in it are None if the grid format is invalid."""
+
+    # Make sure we are in upper case so our maths works. Case is arbitrary for Maidenhead references
+    grid = grid.upper()
+
+    # Return None if our Maidenhead string is invalid or too short
+    length = len(grid)
+    if length <= 0 or (length % 2) != 0:
+        return None, None, None, None
+
+    lat = 0.0  # aggregated latitude
+    lon = 0.0  # aggregated longitude
+    lat_cell_size = 10.0  # Size in degrees latitude of the current cell. Starts at 10 and gets smaller as the calculation progresses
+    lon_cell_size = 20.0  # Size in degrees longitude of the current cell. Starts at 20 and gets smaller as the calculation progresses
+
+    # Iterate through blocks (two-character sections)
+    block = 0
+    while block * 2 < length:
+        if block % 2 == 0:
+            # Letters in this block
+            lon_cell_no = ord(grid[block * 2]) - ord('A')
+            lat_cell_no = ord(grid[block * 2 + 1]) - ord('A')
+            # 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.
+            max_cell_no = 17 if block == 0 else 23
+            if lat_cell_no < 0 or lat_cell_no > max_cell_no or lon_cell_no < 0 or lon_cell_no > max_cell_no:
+                return None, None, None, None
+        else:
+            # Numbers in this block
+            try:
+                lon_cell_no = int(grid[block * 2])
+                lat_cell_no = int(grid[block * 2 + 1])
+            except ValueError:
+                return None, None, None, None
+            # Bail if the values aren't in range 0-9
+            if lat_cell_no < 0 or lat_cell_no > 9 or lon_cell_no < 0 or lon_cell_no > 9:
+                return None, None, None, None
+
+        # Aggregate the angles
+        lat += lat_cell_no * lat_cell_size
+        lon += lon_cell_no * lon_cell_size
+
+        # Reduce the cell size for the next block, unless we are on the last cell.
+        if block * 2 < length - 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
+                lat_cell_size = lat_cell_size / 10.0
+                lon_cell_size = lon_cell_size / 10.0
+            else:
+                # Just dealt with numbers, next block will be letters so cells will be 1/24 the current size
+                lat_cell_size = lat_cell_size / 24.0
+                lon_cell_size = lon_cell_size / 24.0
+
+        block += 1
+
+    # Offset back to (-180, -90) where the grid starts
+    lon -= 180.0
+    lat -= 90.0
+
+    # Return None values on maths errors
+    if any(x != x for x in [lat, lon, lat_cell_size, lon_cell_size]):  # NaN check
+        return None, None, None, None
+
+    return lat, lon, lat_cell_size, lon_cell_size
+
 
-# Convert a Worked All Britain or Worked All Ireland reference to a lat/lon point.
 def wab_wai_square_to_lat_lon(ref):
+    """Convert a Worked All Britain or Worked All Ireland reference to a lat/lon point."""
+
     # First check we have a valid grid square, and based on what it looks like, use either the Ordnance Survey, Irish,
     # or UTM grid systems to perform the conversion.
     if re.match(r"^[HNOST][ABCDEFGHJKLMNOPQRSTUVWXYZ][0-9]{2}$", ref):
@@ -20,12 +177,13 @@ def wab_wai_square_to_lat_lon(ref):
     elif re.match(r"^W[AV][0-9]{2}$", ref):
         return utm_grid_square_to_lat_lon(ref)
     else:
-        logging.warn("Invalid WAB/WAI square: " + ref)
+        logging.warning("Invalid WAB/WAI square: " + ref)
         return None
 
 
-# Get a lat/lon point for the centre of an Ordnance Survey grid square
 def os_grid_square_to_lat_lon(ref):
+    """Get a lat/lon point for the centre of an Ordnance Survey grid square"""
+
     # Convert the letters into multipliers for the 500km squares and 100km squares
     offset_500km_multiplier = ord(ref[0]) - 65
     offset_100km_multiplier = ord(ref[1]) - 65
@@ -54,8 +212,9 @@ def os_grid_square_to_lat_lon(ref):
     return lat, lon
 
 
-# Get a lat/lon point for the centre of an Irish Grid square.
 def irish_grid_square_to_lat_lon(ref):
+    """Get a lat/lon point for the centre of an Irish Grid square."""
+
     # Convert the letters into multipliers for the 100km squares
     offset_100km_multiplier = ord(ref[0]) - 65
 
@@ -81,8 +240,9 @@ def irish_grid_square_to_lat_lon(ref):
     return lat, lon
 
 
-# Get a lat/lon point for the centre of a UTM grid square (supports only squares WA & WV for the Channel Islands, nothing else implemented)
 def utm_grid_square_to_lat_lon(ref):
+    """Get a lat/lon point for the centre of a UTM grid square (supports only squares WA & WV for the Channel Islands, nothing else implemented)"""
+
     # Take the numeric parts of the grid square and multiply by 10000 to get metres from the corner of the letter-based grid square
     easting = int(ref[2]) * 10000
     northing = int(ref[3]) * 10000

core/lookup_helper.py

@@ -1,5 +1,7 @@
 import gzip
+import json
 import logging
+import re
 import urllib.parse
 from datetime import timedelta
 
@@ -14,38 +16,41 @@ from requests_cache import CachedSession
 from core.cache_utils import SEMI_STATIC_URL_DATA_CACHE
 from core.config import config
 from core.constants import BANDS, UNKNOWN_BAND, CW_MODES, PHONE_MODES, DATA_MODES, ALL_MODES, \
-    QRZCQ_CALLSIGN_LOOKUP_DATA, HTTP_HEADERS, HAMQTH_PRG
+    HTTP_HEADERS, HAMQTH_PRG, MODE_ALIASES
 
 
-# Singleton class that provides lookup functionality.
 class LookupHelper:
+    """Singleton class that provides lookup functionality."""
 
-    # Create the lookup helper. Note that nothing actually happens until the start() method is called, and that all
-    # lookup methods will fail if start() has not yet been called. This therefore needs starting before any spot or
-    # alert handlers are created.
     def __init__(self):
-        self.CLUBLOG_CALLSIGN_DATA_CACHE = None
+        """Create the lookup helper. Note that nothing actually happens until the start() method is called, and that all
-        self.LOOKUP_LIB_CLUBLOG_XML = None
+        lookup methods will fail if start() has not yet been called. This therefore needs starting before any spot or
-        self.CLUBLOG_XML_AVAILABLE = None
+        alert handlers are created."""
-        self.LOOKUP_LIB_CLUBLOG_API = None
+
-        self.CLUBLOG_XML_DOWNLOAD_LOCATION = None
+        self._clublog_callsign_data_cache = None
-        self.CLUBLOG_API_AVAILABLE = None
+        self._lookup_lib_clublog_xml = None
-        self.CLUBLOG_CTY_XML_CACHE = None
+        self._clublog_xml_available = None
-        self.CLUBLOG_API_KEY = None
+        self._lookup_lib_clublog_api = None
-        self.QRZ_CALLSIGN_DATA_CACHE = None
+        self._clublog_xml_download_location = None
-        self.LOOKUP_LIB_QRZ = None
+        self._clublog_api_available = None
-        self.QRZ_AVAILABLE = None
+        self._clublog_cty_xml_cache = None
-        self.HAMQTH_AVAILABLE = None
+        self._clublog_api_key = None
-        self.HAMQTH_CALLSIGN_DATA_CACHE = None
+        self._qrz_callsign_data_cache = None
-        self.HAMQTH_BASE_URL = "https://www.hamqth.com/xml.php"
+        self._lookup_lib_qrz = None
+        self._qrz_available = None
+        self._hamqth_available = None
+        self._hamqth_callsign_data_cache = None
+        self._hamqth_base_url = "https://www.hamqth.com/xml.php"
         # HamQTH session keys expire after an hour. Rather than working out how much time has passed manually, we cheat
         # and cache the HTTP response for 55 minutes, so when the login URL is queried within 55 minutes of the previous
         # time, you just get the cached response.
-        self.HAMQTH_SESSION_LOOKUP_CACHE = CachedSession("cache/hamqth_session_cache",
+        self._hamqth_session_lookup_cache = CachedSession("cache/hamqth_session_cache",
                                                           expire_after=timedelta(minutes=55))
-        self.CALL_INFO_BASIC = None
+        self._call_info_basic = None
-        self.LOOKUP_LIB_BASIC = None
+        self._lookup_lib_basic = None
-        self.COUNTRY_FILES_CTY_PLIST_DOWNLOAD_LOCATION = None
+        self._country_files_cty_plist_download_location = None
+        self._dxcc_json_download_location = None
+        self._dxcc_data = None
 
     def start(self):
         # Lookup helpers from pyhamtools. We use five (!) of these. The simplest is country-files.com, which downloads
@@ -53,48 +58,66 @@ class LookupHelper:
         # If the user provides login details/API keys, we also set up helpers for QRZ.com, HamQTH, Clublog (live API
         # request), and Clublog (XML download). The lookup functions iterate through these in a sensible order, looking
         # for suitable data.
-        self.COUNTRY_FILES_CTY_PLIST_DOWNLOAD_LOCATION = "cache/cty.plist"
+        self._country_files_cty_plist_download_location = "cache/cty.plist"
-        success = self.download_country_files_cty_plist()
+        success = self._download_country_files_cty_plist()
         if success:
-            self.LOOKUP_LIB_BASIC = LookupLib(lookuptype="countryfile",
+            self._lookup_lib_basic = LookupLib(lookuptype="countryfile",
-                                              filename=self.COUNTRY_FILES_CTY_PLIST_DOWNLOAD_LOCATION)
+                                               filename=self._country_files_cty_plist_download_location)
         else:
-            self.LOOKUP_LIB_BASIC = LookupLib(lookuptype="countryfile")
+            self._lookup_lib_basic = LookupLib(lookuptype="countryfile")
-        self.CALL_INFO_BASIC = Callinfo(self.LOOKUP_LIB_BASIC)
+        self._call_info_basic = Callinfo(self._lookup_lib_basic)
 
-        self.QRZ_AVAILABLE = config["qrz-username"] != "" and config["qrz-password"] != ""
+        self._qrz_available = config["qrz-username"] != "" and config["qrz-password"] != ""
-        if self.QRZ_AVAILABLE:
+        if self._qrz_available:
-            self.LOOKUP_LIB_QRZ = LookupLib(lookuptype="qrz", username=config["qrz-username"],
+            self._lookup_lib_qrz = LookupLib(lookuptype="qrz", username=config["qrz-username"],
                                              pwd=config["qrz-password"])
-        self.QRZ_CALLSIGN_DATA_CACHE = Cache('cache/qrz_callsign_lookup_cache')
+        self._qrz_callsign_data_cache = Cache('cache/qrz_callsign_lookup_cache')
 
-        self.HAMQTH_AVAILABLE = config["hamqth-username"] != "" and config["hamqth-password"] != ""
+        self._hamqth_available = config["hamqth-username"] != "" and config["hamqth-password"] != ""
-        self.HAMQTH_CALLSIGN_DATA_CACHE = Cache('cache/hamqth_callsign_lookup_cache')
+        self._hamqth_callsign_data_cache = Cache('cache/hamqth_callsign_lookup_cache')
 
-        self.CLUBLOG_API_KEY = config["clublog-api-key"]
+        self._clublog_api_key = config["clublog-api-key"]
-        self.CLUBLOG_CTY_XML_CACHE = CachedSession("cache/clublog_cty_xml_cache", expire_after=timedelta(days=10))
+        self._clublog_cty_xml_cache = CachedSession("cache/clublog_cty_xml_cache", expire_after=timedelta(days=10))
-        self.CLUBLOG_API_AVAILABLE = self.CLUBLOG_API_KEY != ""
+        self._clublog_api_available = self._clublog_api_key != ""
-        self.CLUBLOG_XML_DOWNLOAD_LOCATION = "cache/cty.xml"
+        self._clublog_xml_download_location = "cache/cty.xml"
-        if self.CLUBLOG_API_AVAILABLE:
+        if self._clublog_api_available:
-            self.LOOKUP_LIB_CLUBLOG_API = LookupLib(lookuptype="clublogapi", apikey=self.CLUBLOG_API_KEY)
+            self._lookup_lib_clublog_api = LookupLib(lookuptype="clublogapi", apikey=self._clublog_api_key)
-            success = self.download_clublog_ctyxml()
+            success = self._download_clublog_ctyxml()
-            self.CLUBLOG_XML_AVAILABLE = success
+            self._clublog_xml_available = success
             if success:
-                self.LOOKUP_LIB_CLUBLOG_XML = LookupLib(lookuptype="clublogxml",
+                self._lookup_lib_clublog_xml = LookupLib(lookuptype="clublogxml",
-                                                        filename=self.CLUBLOG_XML_DOWNLOAD_LOCATION)
+                                                         filename=self._clublog_xml_download_location)
-        self.CLUBLOG_CALLSIGN_DATA_CACHE = Cache('cache/clublog_callsign_lookup_cache')
+        self._clublog_callsign_data_cache = Cache('cache/clublog_callsign_lookup_cache')
+
+        # We also get a lookup of DXCC data from K0SWE to use for additional lookups of e.g. flags.
+        self._dxcc_json_download_location = "cache/dxcc.json"
+        success = self._download_dxcc_json()
+        if success:
+            with open(self._dxcc_json_download_location) as f:
+                tmp_dxcc_data = json.load(f)["dxcc"]
+                # Reformat as a map for faster lookup
+                self._dxcc_data = {}
+                for dxcc in tmp_dxcc_data:
+                    self._dxcc_data[dxcc["entityCode"]] = dxcc
+        else:
+            logging.error("Could not download DXCC data, flags and similar data may be missing!")
+
+        # Precompile regex matches for DXCCs to improve efficiency when iterating through them
+        for dxcc in (self._dxcc_data.values() if self._dxcc_data else []):
+            dxcc["_prefixRegexCompiled"] = re.compile(dxcc["prefixRegex"])
+
+    def _download_country_files_cty_plist(self):
+        """Download the cty.plist file from country-files.com on first startup. The pyhamtools lib can actually download and use
+        this itself, but it's occasionally offline which causes it to throw an error. By downloading it separately, we can
+        catch errors and handle them, falling back to a previous copy of the file in the cache, and we can use the
+        requests_cache library to prevent re-downloading too quickly if the software keeps restarting."""
 
-    # Download the cty.plist file from country-files.com on first startup. The pyhamtools lib can actually download and use
-    # this itself, but it's occasionally offline which causes it to throw an error. By downloading it separately, we can
-    # catch errors and handle them, falling back to a previous copy of the file in the cache, and we can use the
-    # requests_cache library to prevent re-downloading too quickly if the software keeps restarting.
-    def download_country_files_cty_plist(self):
         try:
             logging.info("Downloading Country-files.com cty.plist...")
             response = SEMI_STATIC_URL_DATA_CACHE.get("https://www.country-files.com/cty/cty.plist",
                                                       headers=HTTP_HEADERS).text
 
-            with open(self.COUNTRY_FILES_CTY_PLIST_DOWNLOAD_LOCATION, "w") as f:
+            with open(self._country_files_cty_plist_download_location, "w") as f:
                 f.write(response)
                 f.flush()
                 return True
@@ -103,17 +126,38 @@ class LookupHelper:
             logging.error("Exception when downloading Clublog cty.xml", e)
             return False
 
-    # Download the cty.xml (gzipped) file from Clublog on first startup, so we can use it in preference to querying the
+    def _download_dxcc_json(self):
-    # database live if possible.
+        """Download the dxcc.json file on first startup."""
-    def download_clublog_ctyxml(self):
+
         try:
-            logging.info("Downloading Clublog cty.xml...")
+            logging.info("Downloading dxcc.json...")
-            response = self.CLUBLOG_CTY_XML_CACHE.get("https://cdn.clublog.org/cty.php?api=" + self.CLUBLOG_API_KEY,
+            response = SEMI_STATIC_URL_DATA_CACHE.get(
+                "https://raw.githubusercontent.com/k0swe/dxcc-json/refs/heads/main/dxcc.json",
+                headers=HTTP_HEADERS).text
+
+            with open(self._dxcc_json_download_location, "w") as f:
+                f.write(response)
+                f.flush()
+                return True
+
+        except Exception as e:
+            logging.error("Exception when downloading dxcc.json", e)
+            return False
+
+    def _download_clublog_ctyxml(self):
+        """Download the cty.xml (gzipped) file from Clublog on first startup, so we can use it in preference to querying the
+        database live if possible."""
+
+        try:
+            logging.info("Downloading Clublog cty.xml.gz...")
+            response = self._clublog_cty_xml_cache.get("https://cdn.clublog.org/cty.php?api=" + self._clublog_api_key,
                                                        headers=HTTP_HEADERS)
-            open(self.CLUBLOG_XML_DOWNLOAD_LOCATION + ".gz", 'wb').write(response.content)
+            logging.info("Caching Clublog cty.xml.gz...")
-            with gzip.open(self.CLUBLOG_XML_DOWNLOAD_LOCATION + ".gz", "rb") as uncompressed:
+            open(self._clublog_xml_download_location + ".gz", 'wb').write(response.content)
+            with gzip.open(self._clublog_xml_download_location + ".gz", "rb") as uncompressed:
                 file_content = uncompressed.read()
-            with open(self.CLUBLOG_XML_DOWNLOAD_LOCATION, "wb") as f:
+            logging.info("Caching Clublog cty.xml...")
+            with open(self._clublog_xml_download_location, "wb") as f:
                 f.write(file_content)
                 f.flush()
                 return True
@@ -122,286 +166,302 @@ class LookupHelper:
             logging.error("Exception when downloading Clublog cty.xml", e)
             return False
 
-    # Infer a mode from the comment
-    def infer_mode_from_comment(self, comment):
-        for mode in ALL_MODES:
-            if mode in comment.upper():
-                return mode
-        return None
-
-    # Infer a "mode family" from a mode.
-    def infer_mode_type_from_mode(self, mode):
-        if mode.upper() in CW_MODES:
-            return "CW"
-        elif mode.upper() in PHONE_MODES:
-            return "PHONE"
-        elif mode.upper() in DATA_MODES:
-            return "DATA"
-        else:
-            if mode.upper() != "OTHER":
-                logging.warn("Found an unrecognised mode: " + mode + ". Developer should categorise this.")
-            return None
-
-    # Infer a band from a frequency in Hz
-    def infer_band_from_freq(self, freq):
-        for b in BANDS:
-            if b.start_freq <= freq <= b.end_freq:
-                return b
-        return UNKNOWN_BAND
-
-    # Infer a country name from a callsign
     def infer_country_from_callsign(self, call):
+        """Infer a country name from a callsign"""
+
         try:
             # Start with the basic country-files.com-based decoder.
-            country = self.CALL_INFO_BASIC.get_country_name(call)
+            country = self._call_info_basic.get_country_name(call)
-        except (KeyError, ValueError) as e:
+        except (KeyError, ValueError):
             country = None
         # Couldn't get anything from basic call info database, try QRZ.com
         if not country:
-            qrz_data = self.get_qrz_data_for_callsign(call)
+            qrz_data = self._get_qrz_data_for_callsign(call)
             if qrz_data and "country" in qrz_data:
                 country = qrz_data["country"]
         # Couldn't get anything from QRZ.com database, try HamQTH
         if not country:
-            hamqth_data = self.get_hamqth_data_for_callsign(call)
+            hamqth_data = self._get_hamqth_data_for_callsign(call)
             if hamqth_data and "country" in hamqth_data:
                 country = hamqth_data["country"]
         # Couldn't get anything from HamQTH database, try Clublog data
         if not country:
-            clublog_data = self.get_clublog_xml_data_for_callsign(call)
+            clublog_data = self._get_clublog_xml_data_for_callsign(call)
             if clublog_data and "Name" in clublog_data:
                 country = clublog_data["Name"]
         if not country:
-            clublog_data = self.get_clublog_api_data_for_callsign(call)
+            clublog_data = self._get_clublog_api_data_for_callsign(call)
             if clublog_data and "Name" in clublog_data:
                 country = clublog_data["Name"]
-        # Couldn't get anything from Clublog database, try QRZCQ data
+        # Couldn't get anything from Clublog database, try DXCC data
         if not country:
-            qrzcq_data = self.get_qrzcq_data_for_callsign(call)
+            dxcc_data = self._get_dxcc_data_for_callsign(call)
-            if qrzcq_data and "country" in qrzcq_data:
+            if dxcc_data and "name" in dxcc_data:
-                country = qrzcq_data["country"]
+                country = dxcc_data["name"]
         return country
 
-    # Infer a DXCC ID from a callsign
     def infer_dxcc_id_from_callsign(self, call):
+        """Infer a DXCC ID from a callsign"""
+
         try:
             # Start with the basic country-files.com-based decoder.
-            dxcc = self.CALL_INFO_BASIC.get_adif_id(call)
+            dxcc = self._call_info_basic.get_adif_id(call)
-        except (KeyError, ValueError) as e:
+        except (KeyError, ValueError):
             dxcc = None
         # Couldn't get anything from basic call info database, try QRZ.com
         if not dxcc:
-            qrz_data = self.get_qrz_data_for_callsign(call)
+            qrz_data = self._get_qrz_data_for_callsign(call)
             if qrz_data and "adif" in qrz_data:
                 dxcc = qrz_data["adif"]
         # Couldn't get anything from QRZ.com database, try HamQTH
         if not dxcc:
-            hamqth_data = self.get_hamqth_data_for_callsign(call)
+            hamqth_data = self._get_hamqth_data_for_callsign(call)
             if hamqth_data and "adif" in hamqth_data:
                 dxcc = hamqth_data["adif"]
         # Couldn't get anything from HamQTH database, try Clublog data
         if not dxcc:
-            clublog_data = self.get_clublog_xml_data_for_callsign(call)
+            clublog_data = self._get_clublog_xml_data_for_callsign(call)
             if clublog_data and "DXCC" in clublog_data:
                 dxcc = clublog_data["DXCC"]
         if not dxcc:
-            clublog_data = self.get_clublog_api_data_for_callsign(call)
+            clublog_data = self._get_clublog_api_data_for_callsign(call)
             if clublog_data and "DXCC" in clublog_data:
                 dxcc = clublog_data["DXCC"]
-        # Couldn't get anything from Clublog database, try QRZCQ data
+        # Couldn't get anything from Clublog database, try DXCC data
         if not dxcc:
-            qrzcq_data = self.get_qrzcq_data_for_callsign(call)
+            dxcc_data = self._get_dxcc_data_for_callsign(call)
-            if qrzcq_data and "dxcc" in qrzcq_data:
+            if dxcc_data and "entityCode" in dxcc_data:
-                dxcc = qrzcq_data["dxcc"]
+                dxcc = dxcc_data["entityCode"]
         return dxcc
 
-    # Infer a continent shortcode from a callsign
     def infer_continent_from_callsign(self, call):
+        """Infer a continent shortcode from a callsign"""
+
         try:
             # Start with the basic country-files.com-based decoder.
-            continent = self.CALL_INFO_BASIC.get_continent(call)
+            continent = self._call_info_basic.get_continent(call)
-        except (KeyError, ValueError) as e:
+        except (KeyError, ValueError):
             continent = None
         # Couldn't get anything from basic call info database, try HamQTH
         if not continent:
-            hamqth_data = self.get_hamqth_data_for_callsign(call)
+            hamqth_data = self._get_hamqth_data_for_callsign(call)
             if hamqth_data and "continent" in hamqth_data:
-                country = hamqth_data["continent"]
+                continent = hamqth_data["continent"]
         # Couldn't get anything from HamQTH database, try Clublog data
         if not continent:
-            clublog_data = self.get_clublog_xml_data_for_callsign(call)
+            clublog_data = self._get_clublog_xml_data_for_callsign(call)
             if clublog_data and "Continent" in clublog_data:
                 continent = clublog_data["Continent"]
         if not continent:
-            clublog_data = self.get_clublog_api_data_for_callsign(call)
+            clublog_data = self._get_clublog_api_data_for_callsign(call)
             if clublog_data and "Continent" in clublog_data:
                 continent = clublog_data["Continent"]
-        # Couldn't get anything from Clublog database, try QRZCQ data
+        # Couldn't get anything from Clublog database, try DXCC data
         if not continent:
-            qrzcq_data = self.get_qrzcq_data_for_callsign(call)
+            dxcc_data = self._get_dxcc_data_for_callsign(call)
-            if qrzcq_data and "continent" in qrzcq_data:
+            # Some DXCCs are in two continents, if so don't use the continent data as we can't be sure
-                continent = qrzcq_data["continent"]
+            if dxcc_data and "continent" in dxcc_data and len(dxcc_data["continent"]) == 1:
+                continent = dxcc_data["continent"][0]
         return continent
 
-    # Infer a CQ zone from a callsign
     def infer_cq_zone_from_callsign(self, call):
+        """Infer a CQ zone from a callsign"""
+
         try:
             # Start with the basic country-files.com-based decoder.
-            cqz = self.CALL_INFO_BASIC.get_cqz(call)
+            cqz = self._call_info_basic.get_cqz(call)
-        except (KeyError, ValueError) as e:
+        except (KeyError, ValueError):
             cqz = None
         # Couldn't get anything from basic call info database, try QRZ.com
         if not cqz:
-            qrz_data = self.get_qrz_data_for_callsign(call)
+            qrz_data = self._get_qrz_data_for_callsign(call)
             if qrz_data and "cqz" in qrz_data:
                 cqz = qrz_data["cqz"]
         # Couldn't get anything from QRZ.com database, try HamQTH
         if not cqz:
-            hamqth_data = self.get_hamqth_data_for_callsign(call)
+            hamqth_data = self._get_hamqth_data_for_callsign(call)
             if hamqth_data and "cq" in hamqth_data:
                 cqz = hamqth_data["cq"]
         # Couldn't get anything from HamQTH database, try Clublog data
         if not cqz:
-            clublog_data = self.get_clublog_xml_data_for_callsign(call)
+            clublog_data = self._get_clublog_xml_data_for_callsign(call)
             if clublog_data and "CQZ" in clublog_data:
                 cqz = clublog_data["CQZ"]
         if not cqz:
-            clublog_data = self.get_clublog_api_data_for_callsign(call)
+            clublog_data = self._get_clublog_api_data_for_callsign(call)
             if clublog_data and "CQZ" in clublog_data:
                 cqz = clublog_data["CQZ"]
-        # Couldn't get anything from Clublog database, try QRZCQ data
+        # Couldn't get anything from Clublog database, try DXCC data
         if not cqz:
-            qrzcq_data = self.get_qrzcq_data_for_callsign(call)
+            dxcc_data = self._get_dxcc_data_for_callsign(call)
-            if qrzcq_data and "cqz" in qrzcq_data:
+            # Some DXCCs are in multiple zones, if so don't use the zone data as we can't be sure
-                cqz = qrzcq_data["cqz"]
+            if dxcc_data and "cq" in dxcc_data and len(dxcc_data["cq"]) == 1:
+                cqz = dxcc_data["cq"][0]
         return cqz
 
-    # Infer a ITU zone from a callsign
     def infer_itu_zone_from_callsign(self, call):
+        """Infer a ITU zone from a callsign"""
+
         try:
             # Start with the basic country-files.com-based decoder.
-            ituz = self.CALL_INFO_BASIC.get_ituz(call)
+            ituz = self._call_info_basic.get_ituz(call)
-        except (KeyError, ValueError) as e:
+        except (KeyError, ValueError):
             ituz = None
         # Couldn't get anything from basic call info database, try QRZ.com
         if not ituz:
-            qrz_data = self.get_qrz_data_for_callsign(call)
+            qrz_data = self._get_qrz_data_for_callsign(call)
             if qrz_data and "ituz" in qrz_data:
                 ituz = qrz_data["ituz"]
         # Couldn't get anything from QRZ.com database, try HamQTH
         if not ituz:
-            hamqth_data = self.get_hamqth_data_for_callsign(call)
+            hamqth_data = self._get_hamqth_data_for_callsign(call)
             if hamqth_data and "itu" in hamqth_data:
                 ituz = hamqth_data["itu"]
-        # Couldn't get anything from HamQTH database, Clublog doesn't provide this, so try QRZCQ data
+        # Couldn't get anything from HamQTH database, Clublog doesn't provide this, so try DXCC data
         if not ituz:
-            qrzcq_data = self.get_qrzcq_data_for_callsign(call)
+            dxcc_data = self._get_dxcc_data_for_callsign(call)
-            if qrzcq_data and "ituz" in qrzcq_data:
+            # Some DXCCs are in multiple zones, if so don't use the zone data as we can't be sure
-                ituz = qrzcq_data["ituz"]
+            if dxcc_data and "itu" in dxcc_data and len(dxcc_data["itu"]) == 1:
+                ituz = dxcc_data["itu"]
         return ituz
 
-    # Infer an operator name from a callsign (requires QRZ.com/HamQTH)
+    def get_flag_for_dxcc(self, dxcc):
-    def infer_name_from_callsign(self, call):
+        """Get an emoji flag for a given DXCC entity ID"""
-        data = self.get_qrz_data_for_callsign(call)
+
+        return self._dxcc_data[dxcc]["flag"] if dxcc in self._dxcc_data else None
+
+    def infer_name_from_callsign_online_lookup(self, call):
+        """Infer an operator name from a callsign (requires QRZ.com/HamQTH)"""
+
+        data = self._get_qrz_data_for_callsign(call)
         if data and "fname" in data:
             name = data["fname"]
             if "name" in data:
                 name = name + " " + data["name"]
             return name
-        data = self.get_hamqth_data_for_callsign(call)
+        data = self._get_hamqth_data_for_callsign(call)
         if data and "nick" in data:
             return data["nick"]
         else:
             return None
 
-    # Infer a latitude and longitude from a callsign (requires QRZ.com/HamQTH)
+    def infer_latlon_from_callsign_online_lookup(self, call):
-    def infer_latlon_from_callsign_qrz(self, call):
+        """Infer a latitude and longitude from a callsign (requires QRZ.com/HamQTH)
-        data = self.get_qrz_data_for_callsign(call)
+        Coordinates that look default are rejected (apologies if your position really is 0,0, enjoy your voyage)"""
-        if data and "latitude" in data and "longitude" in data:
+
-            return [data["latitude"], data["longitude"]]
+        data = self._get_qrz_data_for_callsign(call)
-        data = self.get_hamqth_data_for_callsign(call)
+        if data and "latitude" in data and "longitude" in data and (
-        if data and "latitude" in data and "longitude" in data:
+                float(data["latitude"]) != 0 or float(data["longitude"]) != 0) and -89.9 < float(
-            return [data["latitude"], data["longitude"]]
+                data["latitude"]) < 89.9:
+            return [float(data["latitude"]), float(data["longitude"])]
+        data = self._get_hamqth_data_for_callsign(call)
+        if data and "latitude" in data and "longitude" in data and (
+                float(data["latitude"]) != 0 or float(data["longitude"]) != 0) and -89.9 < float(
+                data["latitude"]) < 89.9:
+            return [float(data["latitude"]), float(data["longitude"])]
         else:
             return None
 
-    # Infer a grid locator from a callsign (requires QRZ.com/HamQTH)
+    def infer_grid_from_callsign_online_lookup(self, call):
-    def infer_grid_from_callsign_qrz(self, call):
+        """Infer a grid locator from a callsign (requires QRZ.com/HamQTH).
-        data = self.get_qrz_data_for_callsign(call)
+        Grids that look default are rejected (apologies if your grid really is AA00aa, enjoy your research)"""
-        if data and "locator" in data:
+
+        data = self._get_qrz_data_for_callsign(call)
+        if data and "locator" in data and data["locator"].upper() != "AA00" and data["locator"].upper() != "AA00AA" and \
+                data["locator"].upper() != "AA00AA00":
             return data["locator"]
-        data = self.get_hamqth_data_for_callsign(call)
+        data = self._get_hamqth_data_for_callsign(call)
-        if data and "grid" in data:
+        if data and "grid" in data and data["grid"].upper() != "AA00" and data["grid"].upper() != "AA00AA" and data[
+            "grid"].upper() != "AA00AA00":
             return data["grid"]
         else:
             return None
 
-    # Infer a latitude and longitude from a callsign (using DXCC, probably very inaccurate)
+    def infer_qth_from_callsign_online_lookup(self, call):
+        """Infer a textual QTH from a callsign (requires QRZ.com/HamQTH)"""
+
+        data = self._get_qrz_data_for_callsign(call)
+        if data and "addr2" in data:
+            return data["addr2"]
+        data = self._get_hamqth_data_for_callsign(call)
+        if data and "qth" in data:
+            return data["qth"]
+        else:
+            return None
+
     def infer_latlon_from_callsign_dxcc(self, call):
+        """Infer a latitude and longitude from a callsign (using DXCC, probably very inaccurate)"""
+
         try:
-            data = self.CALL_INFO_BASIC.get_lat_long(call)
+            data = self._call_info_basic.get_lat_long(call)
             if data and "latitude" in data and "longitude" in data:
-                loc = [data["latitude"], data["longitude"]]
+                loc = [float(data["latitude"]), float(data["longitude"])]
             else:
                 loc = None
         except KeyError:
             loc = None
         # Couldn't get anything from basic call info database, try Clublog data
         if not loc:
-            data = self.get_clublog_xml_data_for_callsign(call)
+            data = self._get_clublog_xml_data_for_callsign(call)
             if data and "Lat" in data and "Lon" in data:
-                loc = [data["Lat"], data["Lon"]]
+                loc = [float(data["Lat"]), float(data["Lon"])]
         if not loc:
-            data = self.get_clublog_api_data_for_callsign(call)
+            data = self._get_clublog_api_data_for_callsign(call)
             if data and "Lat" in data and "Lon" in data:
-                loc = [data["Lat"], data["Lon"]]
+                loc = [float(data["Lat"]), float(data["Lon"])]
         return loc
 
-    # Infer a grid locator from a callsign (using DXCC, probably very inaccurate)
     def infer_grid_from_callsign_dxcc(self, call):
+        """Infer a grid locator from a callsign (using DXCC, probably very inaccurate)"""
+
         latlon = self.infer_latlon_from_callsign_dxcc(call)
-        return latlong_to_locator(latlon[0], latlon[1], 8)
+        grid = None
-
-    # Infer a mode from the frequency (in Hz) according to the band plan. Just a guess really.
-    def infer_mode_from_frequency(self, freq):
         try:
-            return freq_to_band(freq / 1000.0)["mode"]
+            grid = latlong_to_locator(latlon[0], latlon[1], 8)
-        except KeyError:
+        except:
-            return None
+            logging.debug("Invalid lat/lon received for DXCC")
+        return grid
+
+    def _get_qrz_data_for_callsign(self, call):
+        """Utility method to get QRZ.com data from cache if possible, if not get it from the API and cache it"""
 
-    # Utility method to get QRZ.com data from cache if possible, if not get it from the API and cache it
-    def get_qrz_data_for_callsign(self, call):
         # Fetch from cache if we can, otherwise fetch from the API and cache it
-        if call in self.QRZ_CALLSIGN_DATA_CACHE:
+        if call in self._qrz_callsign_data_cache:
-            return self.QRZ_CALLSIGN_DATA_CACHE.get(call)
+            return self._qrz_callsign_data_cache.get(call)
-        elif self.QRZ_AVAILABLE:
+        elif self._qrz_available:
             try:
-                data = self.LOOKUP_LIB_QRZ.lookup_callsign(callsign=call)
+                data = self._lookup_lib_qrz.lookup_callsign(callsign=call)
-                self.QRZ_CALLSIGN_DATA_CACHE.add(call, data, expire=604800)  # 1 week in seconds
+                self._qrz_callsign_data_cache.add(call, data, expire=604800)  # 1 week in seconds
                 return data
             except (KeyError, ValueError):
                 # QRZ had no info for the call, but maybe it had prefixes or suffixes. Try again with the base call.
                 try:
-                    data = self.LOOKUP_LIB_QRZ.lookup_callsign(callsign=callinfo.Callinfo.get_homecall(call))
+                    data = self._lookup_lib_qrz.lookup_callsign(callsign=callinfo.Callinfo.get_homecall(call))
-                    self.QRZ_CALLSIGN_DATA_CACHE.add(call, data, expire=604800)  # 1 week in seconds
+                    self._qrz_callsign_data_cache.add(call, data, expire=604800)  # 1 week in seconds
                     return data
                 except (KeyError, ValueError):
                     # QRZ had no info for the call, that's OK. Cache a None so we don't try to look this up again
-                    self.QRZ_CALLSIGN_DATA_CACHE.add(call, None, expire=604800)  # 1 week in seconds
+                    self._qrz_callsign_data_cache.add(call, None, expire=604800)  # 1 week in seconds
+                    return None
+            except Exception:
+                # General exception like a timeout when communicating with QRZ. Return None this time, but don't cache
+                # that, so we can try again next time.
+                logging.error("Exception when looking up QRZ data")
                 return None
         else:
             return None
 
-    # Utility method to get HamQTH data from cache if possible, if not get it from the API and cache it
+    def _get_hamqth_data_for_callsign(self, call):
-    def get_hamqth_data_for_callsign(self, call):
+        """Utility method to get HamQTH data from cache if possible, if not get it from the API and cache it"""
+
         # Fetch from cache if we can, otherwise fetch from the API and cache it
-        if call in self.HAMQTH_CALLSIGN_DATA_CACHE:
+        if call in self._hamqth_callsign_data_cache:
-            return self.HAMQTH_CALLSIGN_DATA_CACHE.get(call)
+            return self._hamqth_callsign_data_cache.get(call)
-        elif self.HAMQTH_AVAILABLE:
+        elif self._hamqth_available:
             try:
                 # First we need to log in and get a session token.
-                session_data = self.HAMQTH_SESSION_LOOKUP_CACHE.get(
+                session_data = self._hamqth_session_lookup_cache.get(
-                    self.HAMQTH_BASE_URL + "?u=" + urllib.parse.quote_plus(config["hamqth-username"]) +
+                    self._hamqth_base_url + "?u=" + urllib.parse.quote_plus(config["hamqth-username"]) +
                     "&p=" + urllib.parse.quote_plus(config["hamqth-password"]), headers=HTTP_HEADERS).content
                 dict_data = xmltodict.parse(session_data)
                 if "session_id" in dict_data["HamQTH"]["session"]:
@@ -410,84 +470,146 @@ class LookupHelper:
                     # Now look up the actual data.
                     try:
                         lookup_data = SEMI_STATIC_URL_DATA_CACHE.get(
-                            self.HAMQTH_BASE_URL + "?id=" + session_id + "&callsign=" + urllib.parse.quote_plus(
+                            self._hamqth_base_url + "?id=" + session_id + "&callsign=" + urllib.parse.quote_plus(
                                 call) + "&prg=" + HAMQTH_PRG, headers=HTTP_HEADERS).content
                         data = xmltodict.parse(lookup_data)["HamQTH"]["search"]
-                        self.HAMQTH_CALLSIGN_DATA_CACHE.add(call, data, expire=604800)  # 1 week in seconds
+                        self._hamqth_callsign_data_cache.add(call, data, expire=604800)  # 1 week in seconds
                         return data
                     except (KeyError, ValueError):
                         # HamQTH had no info for the call, but maybe it had prefixes or suffixes. Try again with the base call.
                         try:
                             lookup_data = SEMI_STATIC_URL_DATA_CACHE.get(
-                                self.HAMQTH_BASE_URL + "?id=" + session_id + "&callsign=" + urllib.parse.quote_plus(
+                                self._hamqth_base_url + "?id=" + session_id + "&callsign=" + urllib.parse.quote_plus(
-                                    callinfo.Callinfo.get_homecall(call)) + "&prg=" + HAMQTH_PRG, headers=HTTP_HEADERS).content
+                                    callinfo.Callinfo.get_homecall(call)) + "&prg=" + HAMQTH_PRG,
+                                headers=HTTP_HEADERS).content
                             data = xmltodict.parse(lookup_data)["HamQTH"]["search"]
-                            self.HAMQTH_CALLSIGN_DATA_CACHE.add(call, data, expire=604800)  # 1 week in seconds
+                            self._hamqth_callsign_data_cache.add(call, data, expire=604800)  # 1 week in seconds
                             return data
                         except (KeyError, ValueError):
                             # HamQTH had no info for the call, that's OK. Cache a None so we don't try to look this up again
-                            self.HAMQTH_CALLSIGN_DATA_CACHE.add(call, None, expire=604800)  # 1 week in seconds
+                            self._hamqth_callsign_data_cache.add(call, None, expire=604800)  # 1 week in seconds
                             return None
 
                 else:
-                    logging.warn("HamQTH login details incorrect, failed to look up with HamQTH.")
+                    logging.warning("HamQTH login details incorrect, failed to look up with HamQTH.")
             except:
                 logging.error("Exception when looking up HamQTH data")
                 return None
+        return None
+
+    def _get_clublog_api_data_for_callsign(self, call):
+        """Utility method to get Clublog API data from cache if possible, if not get it from the API and cache it"""
 
-    # Utility method to get Clublog API data from cache if possible, if not get it from the API and cache it
-    def get_clublog_api_data_for_callsign(self, call):
         # Fetch from cache if we can, otherwise fetch from the API and cache it
-        if call in self.CLUBLOG_CALLSIGN_DATA_CACHE:
+        if call in self._clublog_callsign_data_cache:
-            return self.CLUBLOG_CALLSIGN_DATA_CACHE.get(call)
+            return self._clublog_callsign_data_cache.get(call)
-        elif self.CLUBLOG_API_AVAILABLE:
+        elif self._clublog_api_available:
             try:
-                data = self.LOOKUP_LIB_CLUBLOG_API.lookup_callsign(callsign=call)
+                data = self._lookup_lib_clublog_api.lookup_callsign(callsign=call)
-                self.CLUBLOG_CALLSIGN_DATA_CACHE.add(call, data, expire=604800)  # 1 week in seconds
+                self._clublog_callsign_data_cache.add(call, data, expire=604800)  # 1 week in seconds
                 return data
             except (KeyError, ValueError):
                 # Clublog had no info for the call, but maybe it had prefixes or suffixes. Try again with the base call.
                 try:
-                    data = self.LOOKUP_LIB_CLUBLOG_API.lookup_callsign(callsign=callinfo.Callinfo.get_homecall(call))
+                    data = self._lookup_lib_clublog_api.lookup_callsign(callsign=callinfo.Callinfo.get_homecall(call))
-                    self.CLUBLOG_CALLSIGN_DATA_CACHE.add(call, data, expire=604800)  # 1 week in seconds
+                    self._clublog_callsign_data_cache.add(call, data, expire=604800)  # 1 week in seconds
                     return data
                 except (KeyError, ValueError):
                     # Clublog had no info for the call, that's OK. Cache a None so we don't try to look this up again
-                    self.CLUBLOG_CALLSIGN_DATA_CACHE.add(call, None, expire=604800)  # 1 week in seconds
+                    self._clublog_callsign_data_cache.add(call, None, expire=604800)  # 1 week in seconds
                     return None
             except APIKeyMissingError:
                 # User API key was wrong, warn
-                logging.error("Could not look up via Clublog API, key " + self.CLUBLOG_API_KEY + " was rejected.")
+                logging.error("Could not look up via Clublog API, key " + self._clublog_api_key + " was rejected.")
                 return None
         else:
             return None
 
-    # Utility method to get Clublog XML data from file
+    def _get_clublog_xml_data_for_callsign(self, call):
-    def get_clublog_xml_data_for_callsign(self, call):
+        """Utility method to get Clublog XML data from file"""
-        if self.CLUBLOG_XML_AVAILABLE:
+
+        if self._clublog_xml_available:
             try:
-                data = self.LOOKUP_LIB_CLUBLOG_XML.lookup_callsign(callsign=call)
+                data = self._lookup_lib_clublog_xml.lookup_callsign(callsign=call)
                 return data
             except (KeyError, ValueError):
                 # Clublog had no info for the call, that's OK. Cache a None so we don't try to look this up again
-                self.CLUBLOG_CALLSIGN_DATA_CACHE.add(call, None, expire=604800)  # 1 week in seconds
+                self._clublog_callsign_data_cache.add(call, None, expire=604800)  # 1 week in seconds
                 return None
         else:
             return None
 
-    # Utility method to get QRZCQ data from our constants table, if we can find it
+    def _get_dxcc_data_for_callsign(self, call):
-    def get_qrzcq_data_for_callsign(self, call):
+        """Utility method to get generic DXCC data from our lookup table, if we can find it"""
-        # Iterate in reverse order - see comments on the data structure itself
+
-        for entry in reversed(QRZCQ_CALLSIGN_LOOKUP_DATA):
+        for entry in self._dxcc_data.values():
-            if call.startswith(entry["prefix"]):
+            if entry["_prefixRegexCompiled"].match(call):
                 return entry
         return None
 
-    # Shutdown method to close down any caches neatly.
     def stop(self):
-        self.QRZ_CALLSIGN_DATA_CACHE.close()
+        """Shutdown method to close down any caches neatly."""
-        self.CLUBLOG_CALLSIGN_DATA_CACHE.close()
+
+        self._qrz_callsign_data_cache.close()
+        self._clublog_callsign_data_cache.close()
 
 
 # Singleton object
 lookup_helper = LookupHelper()
+
+def infer_mode_from_comment(comment):
+    """Infer a mode from the comment"""
+
+    for mode in ALL_MODES:
+        if mode in comment.upper():
+            return mode
+    for mode in MODE_ALIASES.keys():
+        if mode in comment.upper():
+            return MODE_ALIASES[mode]
+    return None
+
+
+def infer_mode_type_from_mode(mode):
+    """Infer a "mode family" from a mode."""
+
+    if mode.upper() in CW_MODES:
+        return "CW"
+    elif mode.upper() in PHONE_MODES:
+        return "PHONE"
+    elif mode.upper() in DATA_MODES:
+        return "DATA"
+    else:
+        if mode.upper() != "OTHER":
+            logging.warning("Found an unrecognised mode: " + mode + ". Developer should categorise this.")
+        return None
+
+
+def infer_band_from_freq(freq):
+    """Infer a band from a frequency in Hz"""
+
+    for b in BANDS:
+        if b.start_freq <= freq <= b.end_freq:
+            return b
+    return UNKNOWN_BAND
+
+
+def infer_mode_from_frequency(freq):
+    """Infer a mode from the frequency (in Hz) according to the band plan. Just a guess really."""
+
+    try:
+        khz = freq / 1000.0
+        mode = freq_to_band(khz)["mode"]
+        # Some additional common digimode ranges in addition to what the 3rd-party freq_to_band function returns.
+        # This is mostly here just because freq_to_band is very specific about things like FT8 frequencies, and e.g.
+        # a spot at 7074.5 kHz will be indicated as LSB, even though it's clearly in the FT8 range. Future updates
+        # might include other common digimode centres of activity here, but this achieves the main goal of keeping
+        # large numbers of clearly-FT* spots off the list of people filtering out digimodes.
+        if (7074 <= khz < 7077) or (10136 <= khz < 10139) or (14074 <= khz < 14077) or (18100 <= khz < 18103) or (
+                21074 <= khz < 21077) or (24915 <= khz < 24918) or (28074 <= khz < 28077):
+            mode = "FT8"
+        if (7047.5 <= khz < 7050.5) or (10140 <= khz < 10143) or (14080 <= khz < 14083) or (
+                18104 <= khz < 18107) or (21140 <= khz < 21143) or (24919 <= khz < 24922) or (28180 <= khz < 28183):
+            mode = "FT4"
+        return mode
+    except KeyError:
+        return None

core/prometheus_metrics_handler.py

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

core/sig_utils.py

@@ -1,116 +1,160 @@
 import csv
+import logging
 
-from pyhamtools.locator import latlong_to_locator
+from pyhamtools.locator import latlong_to_locator, locator_to_latlong
 
 from core.cache_utils import SEMI_STATIC_URL_DATA_CACHE
 from core.constants import SIGS, HTTP_HEADERS
 from core.geo_utils import wab_wai_square_to_lat_lon
-from data.sig_ref import SIGRef
 
 
-# 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):
+    """Utility function to get the regex string for a SIG reference for a named SIG. If no match is found, None will be returned."""
+
     for s in SIGS:
         if s.name.upper() == sig.upper():
             return s.ref_regex
     return None
 
 
-# Look up details of a SIG reference (e.g. POTA park) such as name, lat/lon, and grid.
+def populate_sig_ref_info(sig_ref):
-# Note there is currently no support for KRMNPA location lookup, see issue #61.
+    """Look up details of a SIG reference (e.g. POTA park) such as name, lat/lon, and grid. Takes in a sig_ref object which
-def get_sig_ref_info(sig, sig_ref_id):
+    must at minimum have a "sig" and an "id". The rest of the object will be populated and returned.
-    sig_ref = SIGRef(id=sig_ref_id, sig=sig)
+    Note there is currently no support for KRMNPA location lookup, see issue #61."""
+
+    if sig_ref.sig is None or sig_ref.id is None:
+        logging.warning("Failed to look up sig_ref info, sig or id were not set.")
+
+    sig = sig_ref.sig
+    ref_id = sig_ref.id
+    try:
         if sig.upper() == "POTA":
-        data = SEMI_STATIC_URL_DATA_CACHE.get("https://api.pota.app/park/" + sig_ref_id, headers=HTTP_HEADERS).json()
+            data = SEMI_STATIC_URL_DATA_CACHE.get("https://api.pota.app/park/" + ref_id, headers=HTTP_HEADERS).json()
             if data:
                 fullname = data["name"] if "name" in data else None
                 if fullname and "parktypeDesc" in data and data["parktypeDesc"] != "":
                     fullname = fullname + " " + data["parktypeDesc"]
                 sig_ref.name = fullname
-            sig_ref.url = "https://pota.app/#/park/" + sig_ref_id
+                sig_ref.url = "https://pota.app/#/park/" + ref_id
                 sig_ref.grid = data["grid6"] if "grid6" 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
         elif sig.upper() == "SOTA":
-        data = SEMI_STATIC_URL_DATA_CACHE.get("https://api-db2.sota.org.uk/api/summits/" + sig_ref_id,
+            data = SEMI_STATIC_URL_DATA_CACHE.get("https://api-db2.sota.org.uk/api/summits/" + ref_id,
                                                   headers=HTTP_HEADERS).json()
             if data:
                 sig_ref.name = data["name"] if "name" in data else None
-            sig_ref.url = "https://www.sotadata.org.uk/en/summit/" + sig_ref_id
+                sig_ref.url = "https://www.sotadata.org.uk/en/summit/" + ref_id
                 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/" + sig_ref_id,
+            data = SEMI_STATIC_URL_DATA_CACHE.get("https://api.wwbota.org/bunkers/" + ref_id,
                                                   headers=HTTP_HEADERS).json()
             if data:
                 sig_ref.name = data["name"] if "name" in data else None
-            sig_ref.url = "https://bunkerwiki.org/?s=" + sig_ref_id if sig_ref_id.startswith("B/G") else None
+                sig_ref.url = "https://bunkerwiki.org/?s=" + ref_id if ref_id.startswith("B/G") else None
                 sig_ref.grid = data["locator"] if "locator" in data else None
                 sig_ref.latitude = data["lat"] if "lat" in data else None
                 sig_ref.longitude = data["long"] if "long" in data else None
         elif sig.upper() == "GMA" or sig.upper() == "ARLHS" or sig.upper() == "ILLW" or sig.upper() == "WCA" or sig.upper() == "MOTA" or sig.upper() == "IOTA":
-        data = SEMI_STATIC_URL_DATA_CACHE.get("https://www.cqgma.org/api/ref/?" + sig_ref_id,
+            data = SEMI_STATIC_URL_DATA_CACHE.get("https://www.cqgma.org/api/ref/?" + ref_id,
                                                   headers=HTTP_HEADERS).json()
             if data:
                 sig_ref.name = data["name"] if "name" in data else None
-            sig_ref.url = "https://www.cqgma.org/zinfo.php?ref=" + sig_ref_id
+                sig_ref.url = "https://www.cqgma.org/zinfo.php?ref=" + ref_id
                 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
         elif sig.upper() == "WWFF":
-        sig_ref.url = "https://wwff.co/directory/?showRef=" + sig_ref_id
+            wwff_csv_data = SEMI_STATIC_URL_DATA_CACHE.get("https://wwff.co/wwff-data/wwff_directory.csv",
+                                                           headers=HTTP_HEADERS)
+            wwff_dr = csv.DictReader(wwff_csv_data.content.decode().splitlines())
+            for row in wwff_dr:
+                if row["reference"] == ref_id:
+                    sig_ref.name = row["name"] if "name" in row else None
+                    sig_ref.url = "https://wwff.co/directory/?showRef=" + ref_id
+                    sig_ref.grid = row["iaruLocator"] if "iaruLocator" in row and row["iaruLocator"] != "-" else None
+                    sig_ref.latitude = float(row["latitude"]) if "latitude" in row and row["latitude"] != "-" else None
+                    sig_ref.longitude = float(row["longitude"]) if "longitude" in row and row[
+                        "longitude"] != "-" else None
+                    break
         elif sig.upper() == "SIOTA":
             siota_csv_data = SEMI_STATIC_URL_DATA_CACHE.get("https://www.silosontheair.com/data/silos.csv",
                                                             headers=HTTP_HEADERS)
             siota_dr = csv.DictReader(siota_csv_data.content.decode().splitlines())
             for row in siota_dr:
-            if row["SILO_CODE"] == sig_ref_id:
+                if row["SILO_CODE"] == ref_id:
                     sig_ref.name = row["NAME"] if "NAME" in row else None
                     sig_ref.grid = row["LOCATOR"] if "LOCATOR" in row else None
                     sig_ref.latitude = float(row["LAT"]) if "LAT" in row else None
                     sig_ref.longitude = float(row["LNG"]) if "LNG" in row else None
+                    break
         elif sig.upper() == "WOTA":
             data = SEMI_STATIC_URL_DATA_CACHE.get("https://www.wota.org.uk/mapping/data/summits.json",
                                                   headers=HTTP_HEADERS).json()
             if data:
                 for feature in data["features"]:
-                if feature["properties"]["wotaId"] == sig_ref_id:
+                    if feature["properties"]["wotaId"] == ref_id:
                         sig_ref.name = feature["properties"]["title"]
-                    sig_ref.url = "https://www.wota.org.uk/MM_" + sig_ref_id
+                        # Fudge WOTA URLs. Outlying fell (LDO) URLs don't match their ID numbers but require 214 to be
+                        # added to them
+                        sig_ref.url = "https://www.wota.org.uk/MM_" + ref_id
+                        if ref_id.upper().startswith("LDO-"):
+                            number = int(ref_id.upper().replace("LDO-", ""))
+                            sig_ref.url = "https://www.wota.org.uk/MM_LDO-" + str(number + 214)
                         sig_ref.grid = feature["properties"]["qthLocator"]
                         sig_ref.latitude = feature["geometry"]["coordinates"][1]
                         sig_ref.longitude = feature["geometry"]["coordinates"][0]
+                        break
         elif sig.upper() == "ZLOTA":
             data = SEMI_STATIC_URL_DATA_CACHE.get("https://ontheair.nz/assets/assets.json", headers=HTTP_HEADERS).json()
             if data:
                 for asset in data:
-                if asset["code"] == sig_ref_id:
+                    if asset["code"] == ref_id:
                         sig_ref.name = asset["name"]
-                    sig_ref.url = "https://ontheair.nz/assets/ZLI_OT-030" + sig_ref_id.replace("/", "_")
+                        sig_ref.url = "https://ontheair.nz/assets/ZLI_OT-030" + ref_id.replace("/", "_")
+                        try:
                             sig_ref.grid = latlong_to_locator(asset["y"], asset["x"], 6)
+                        except:
+                            logging.debug("Invalid lat/lon received for reference")
                             sig_ref.latitude = asset["y"]
                             sig_ref.longitude = asset["x"]
+                        break
         elif sig.upper() == "BOTA":
             if not sig_ref.name:
                 sig_ref.name = sig_ref.id
             sig_ref.url = "https://www.beachesontheair.com/beaches/" + sig_ref.name.lower().replace(" ", "-")
+        elif sig.upper() == "LLOTA":
+            data = SEMI_STATIC_URL_DATA_CACHE.get("https://llota.app/api/public/references",
+                                                  headers=HTTP_HEADERS).json()
+            if data:
+                for ref in data:
+                    if ref["reference_code"] == ref_id:
+                        sig_ref.name = ref["name"]
+                        sig_ref.url = "https://llota.app/list/ref/" + ref_id
+                        sig_ref.grid = ref["grid_locator"]
+                        ll = locator_to_latlong(sig_ref.grid)
+                        sig_ref.latitude = ll[0]
+                        sig_ref.longitude = ll[1]
+                        break
+        elif sig.upper() == "WWTOTA":
+            if not sig_ref.name:
+                sig_ref.name = sig_ref.id
+            sig_ref.url = "https://wwtota.com/seznam/karta_rozhledny.php?ref=" + sig_ref.name
         elif sig.upper() == "WAB" or sig.upper() == "WAI":
-        ll = wab_wai_square_to_lat_lon(sig_ref_id)
+            ll = wab_wai_square_to_lat_lon(ref_id)
             if ll:
-            sig_ref.name = sig_ref_id
+                sig_ref.name = ref_id
+                try:
                     sig_ref.grid = latlong_to_locator(ll[0], ll[1], 6)
                     sig_ref.latitude = ll[0]
                     sig_ref.longitude = ll[1]
-
+                except:
+                    logging.debug("Invalid lat/lon received for reference")
+    except:
+        logging.warning("Failed to look up sig_ref info for " + sig + " ref " + ref_id + ".")
     return sig_ref
 
 

core/status_reporter.py

@@ -1,6 +1,6 @@
 import os
 from datetime import datetime
-from threading import Timer
+from threading import Thread, Event
 
 import psutil
 import pytz
@@ -10,66 +10,82 @@ from core.constants import SOFTWARE_VERSION
 from core.prometheus_metrics_handler import memory_use_gauge, spots_gauge, alerts_gauge
 
 
-# Provides a timed update of the application's status data.
 class StatusReporter:
+    """Provides a timed update of the application's status data."""
 
-    # Constructor
     def __init__(self, status_data, run_interval, web_server, cleanup_timer, spots, spot_providers, alerts,
                  alert_providers):
-        self.status_data = status_data
+        """Constructor"""
-        self.run_interval = run_interval
-        self.web_server = web_server
-        self.cleanup_timer = cleanup_timer
-        self.spots = spots
-        self.spot_providers = spot_providers
-        self.alerts = alerts
-        self.alert_providers = alert_providers
-        self.run_timer = None
-        self.startup_time = datetime.now(pytz.UTC)
 
-        self.status_data["software-version"] = SOFTWARE_VERSION
+        self._status_data = status_data
-        self.status_data["server-owner-callsign"] = SERVER_OWNER_CALLSIGN
+        self._run_interval = run_interval
+        self._web_server = web_server
+        self._cleanup_timer = cleanup_timer
+        self._spots = spots
+        self._spot_providers = spot_providers
+        self._alerts = alerts
+        self._alert_providers = alert_providers
+        self._thread = None
+        self._stop_event = Event()
+        self._startup_time = datetime.now(pytz.UTC)
+
+        self._status_data["software-version"] = SOFTWARE_VERSION
+        self._status_data["server-owner-callsign"] = SERVER_OWNER_CALLSIGN
 
-    # Start the cleanup timer
     def start(self):
-        self.run()
+        """Start the reporter thread"""
+
+        self._thread = Thread(target=self._run, daemon=True)
+        self._thread.start()
 
-    # Stop any threads and prepare for application shutdown
     def stop(self):
-        self.run_timer.cancel()
+        """Stop any threads and prepare for application shutdown"""
 
-    # Write status information and reschedule next timer
+        self._stop_event.set()
-    def run(self):
+
-        self.status_data["uptime"] = (datetime.now(pytz.UTC) - self.startup_time).total_seconds()
+    def _run(self):
-        self.status_data["mem_use_mb"] = round(psutil.Process(os.getpid()).memory_info().rss / (1024 * 1024), 3)
+        """Thread entry point: report immediately on startup, then on each interval until stopped"""
-        self.status_data["num_spots"] = len(self.spots)
+
-        self.status_data["num_alerts"] = len(self.alerts)
+        while True:
-        self.status_data["spot_providers"] = list(
+            self._report()
+            if self._stop_event.wait(timeout=self._run_interval):
+                break
+
+    def _report(self):
+        """Write status information"""
+
+        self._status_data["uptime"] = (datetime.now(pytz.UTC) - self._startup_time).total_seconds()
+        self._status_data["mem_use_mb"] = round(psutil.Process(os.getpid()).memory_info().rss / (1024 * 1024), 3)
+        self._status_data["num_spots"] = len(self._spots)
+        self._status_data["num_alerts"] = len(self._alerts)
+        self._status_data["spot_providers"] = list(
             map(lambda p: {"name": p.name, "enabled": p.enabled, "status": p.status,
                            "last_updated": p.last_update_time.replace(
-                               tzinfo=pytz.UTC).timestamp() if p.last_update_time else 0,
+                               tzinfo=pytz.UTC).timestamp() if p.last_update_time.year > 2000 else 0,
                            "last_spot": p.last_spot_time.replace(
-                               tzinfo=pytz.UTC).timestamp() if p.last_spot_time else 0}, self.spot_providers))
+                               tzinfo=pytz.UTC).timestamp() if p.last_spot_time.year > 2000 else 0},
-        self.status_data["alert_providers"] = list(
+                self._spot_providers))
+        self._status_data["alert_providers"] = list(
             map(lambda p: {"name": p.name, "enabled": p.enabled, "status": p.status,
                            "last_updated": p.last_update_time.replace(
-                               tzinfo=pytz.UTC).timestamp() if p.last_update_time else 0},
+                               tzinfo=pytz.UTC).timestamp() if p.last_update_time.year > 2000 else 0},
-                self.alert_providers))
+                self._alert_providers))
-        self.status_data["cleanup"] = {"status": self.cleanup_timer.status,
+        self._status_data["cleanup"] = {"status": self._cleanup_timer.status,
-                                       "last_ran": self.cleanup_timer.last_cleanup_time.replace(
+                                        "last_ran": self._cleanup_timer.last_cleanup_time.replace(
-                                           tzinfo=pytz.UTC).timestamp() if self.cleanup_timer.last_cleanup_time else 0}
+                                            tzinfo=pytz.UTC).timestamp() if self._cleanup_timer.last_cleanup_time else 0}
-        self.status_data["webserver"] = {"status": self.web_server.status,
+        self._status_data["webserver"] = {"status": self._web_server.web_server_metrics["status"],
-                                         "last_api_access": self.web_server.last_api_access_time.replace(
+                                          "last_api_access": self._web_server.web_server_metrics[
-                                             tzinfo=pytz.UTC).timestamp() if self.web_server.last_api_access_time else 0,
+                                              "last_api_access_time"].replace(
-                                         "api_access_count": self.web_server.api_access_counter,
+                                              tzinfo=pytz.UTC).timestamp() if self._web_server.web_server_metrics[
-                                         "last_page_access": self.web_server.last_page_access_time.replace(
+                                              "last_api_access_time"] else 0,
-                                             tzinfo=pytz.UTC).timestamp() if self.web_server.last_page_access_time else 0,
+                                          "api_access_count": self._web_server.web_server_metrics["api_access_counter"],
-                                         "page_access_count": self.web_server.page_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)
+        memory_use_gauge.set(psutil.Process(os.getpid()).memory_info().rss)
-        spots_gauge.set(len(self.spots))
+        spots_gauge.set(len(self._spots))
-        alerts_gauge.set(len(self.alerts))
+        alerts_gauge.set(len(self._alerts))
-
-        self.run_timer = Timer(self.run_interval, self.run)
-        self.run_timer.start()

core/utils.py

@@ -0,0 +1,15 @@
+def serialize_everything(obj):
+    """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."""
+    return obj.__dict__
+
+
+def empty_queue(q):
+    """Empty a queue"""
+
+    while not q.empty():
+        try:
+            q.get_nowait()
+        except:
+            break

data/alert.py

@@ -6,14 +6,14 @@ from datetime import datetime, timedelta
 
 import pytz
 
-from core.constants import DXCC_FLAGS
 from core.lookup_helper import lookup_helper
-from core.sig_utils import get_icon_for_sig, get_sig_ref_info
+from core.sig_utils import populate_sig_ref_info
 
 
-# Data class that defines an alert.
 @dataclass
 class Alert:
+    """Data class that defines an alert."""
+
     # Unique identifier for the alert
     id: str = None
     # Callsigns of the operators that has been alerted
@@ -54,10 +54,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"...
@@ -65,8 +61,9 @@ class Alert:
     # The ID the source gave it, if any.
     source_id: str = None
 
-    # Infer missing parameters where possible
     def infer_missing(self):
+        """Infer missing parameters where possible"""
+
         # If we somehow don't have a start time, set it to zero so it sorts off the bottom of any list but
         # clients can still reliably parse it as a number.
         if not self.start_time:
@@ -84,7 +81,8 @@ class Alert:
         if self.received_time and not self.received_time_iso:
             self.received_time_iso = datetime.fromtimestamp(self.received_time, pytz.UTC).isoformat()
 
-        # DX country, continent, zones etc. from callsign
+        # DX country, continent, zones etc. from callsign. CQ/ITU zone are better looked up with a location but we don't
+        # have a real location for alerts.
         if self.dx_calls and self.dx_calls[0] and not self.dx_country:
             self.dx_country = lookup_helper.infer_country_from_callsign(self.dx_calls[0])
         if self.dx_calls and self.dx_calls[0] and not self.dx_continent:
@@ -95,33 +93,26 @@ class Alert:
             self.dx_itu_zone = lookup_helper.infer_itu_zone_from_callsign(self.dx_calls[0])
         if self.dx_calls and self.dx_calls[0] and not self.dx_dxcc_id:
             self.dx_dxcc_id = lookup_helper.infer_dxcc_id_from_callsign(self.dx_calls[0])
-        if self.dx_dxcc_id and self.dx_dxcc_id in DXCC_FLAGS and not self.dx_flag:
+        if self.dx_dxcc_id and not self.dx_flag:
-            self.dx_flag = DXCC_FLAGS[self.dx_dxcc_id]
+            self.dx_flag = lookup_helper.get_flag_for_dxcc(self.dx_dxcc_id)
 
         # Fetch SIG data. In case a particular API doesn't provide a full set of name, lat, lon & grid for a reference
         # in its initial call, we use this code to populate the rest of the data. This includes working out grid refs
         # from WAB and WAI, which count as a SIG even though there's no real lookup, just maths
         if self.sig_refs and len(self.sig_refs) > 0:
             for sig_ref in self.sig_refs:
-                lookup_data = get_sig_ref_info(sig_ref.sig, sig_ref.id)
+                populate_sig_ref_info(sig_ref)
-                if lookup_data:
-                    # Update the sig_ref data from the lookup
-                    sig_ref.__dict__.update(lookup_data.__dict__)
 
         # If the spot itself doesn't have a SIG yet, but we have at least one SIG reference, take that reference's SIG
         # and apply it to the whole spot.
-        if self.sig_refs and len(self.sig_refs) > 0 and not self.sig:
+        if self.sig_refs and len(self.sig_refs) > 0 and 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.
         if self.dx_calls and not self.dx_names:
-            self.dx_names = list(map(lambda c: lookup_helper.infer_name_from_callsign(c), self.dx_calls))
+            self.dx_names = list(map(lambda c: lookup_helper.infer_name_from_callsign_online_lookup(c), self.dx_calls))
 
         # Always create an ID based on a hash of every parameter *except* received_time. This is used as the index
         # to a map, which as a byproduct avoids us having multiple duplicate copies of the object that are identical
@@ -133,14 +124,16 @@ class Alert:
         self_copy.received_time_iso = ""
         self.id = hashlib.sha256(str(self_copy).encode("utf-8")).hexdigest()
 
-    # JSON serialise
     def to_json(self):
+        """JSON serialise"""
+
         return json.dumps(self, default=lambda o: o.__dict__, sort_keys=True)
 
-    # Decide if this alert has expired (in which case it should not be added to the system in the first place, and not
-    # returned by the web server if later requested, and removed by the cleanup functions. "Expired" is defined as
-    # either having an end_time in the past, or if it only has a start_time, then that start time was more than 3 hours
-    # ago. If it somehow doesn't have a start_time either, it is considered to be expired.
     def expired(self):
+        """Decide if this alert has expired (in which case it should not be added to the system in the first place, and not
+        returned by the web server if later requested, and removed by the cleanup functions). "Expired" is defined as
+        either having an end_time in the past, or if it only has a start_time, then that start time was more than 3 hours
+        ago. If it somehow doesn't have a start_time either, it is considered to be expired."""
+
         return not self.start_time or (self.end_time and self.end_time < datetime.now(pytz.UTC).timestamp()) or (
                 not self.end_time and self.start_time < (datetime.now(pytz.UTC) - timedelta(hours=3)).timestamp())

data/band.py

@@ -1,15 +1,13 @@
 from dataclasses import dataclass
 
-# Data class that defines a band.
+
 @dataclass
 class Band:
+    """Data class that defines a band."""
+
     # Band name
     name: str
     # Start frequency, in Hz
     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

@@ -1,14 +1,13 @@
 from dataclasses import dataclass
 
-# Data class that defines a Special Interest Group.
+
 @dataclass
 class SIG:
+    """Data class that defines a Special Interest Group."""
+
     # SIG name, e.g. "POTA"
     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

@@ -1,9 +1,11 @@
 from dataclasses import dataclass
 
-# Data class that defines a Special Interest Group "info" or reference. As well as the basic reference ID we include a
+
-# name and a lookup URL.
 @dataclass
 class SIGRef:
+    """Data class that defines a Special Interest Group "info" or reference. As well as the basic reference ID we include a
+    name and a lookup URL."""
+
     # Reference ID, e.g. "GB-0001".
     id: str
     # SIG that this reference is in, e.g. "POTA".
@@ -18,3 +20,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

@@ -4,20 +4,24 @@ import json
 import logging
 import re
 from dataclasses import dataclass
-from datetime import datetime
+from datetime import datetime, timedelta
 
 import pytz
 from pyhamtools.locator import locator_to_latlong, latlong_to_locator
 
-from core.constants import DXCC_FLAGS
+from core.config import MAX_SPOT_AGE
-from core.lookup_helper import lookup_helper
+from core.constants import MODE_ALIASES
-from core.sig_utils import get_icon_for_sig, get_sig_ref_info, ANY_SIG_REGEX, get_ref_regex_for_sig
+from core.geo_utils import lat_lon_to_cq_zone, lat_lon_to_itu_zone
+from core.lookup_helper import lookup_helper, infer_band_from_freq, infer_mode_from_comment, infer_mode_from_frequency, \
+    infer_mode_type_from_mode
+from core.sig_utils import populate_sig_ref_info, ANY_SIG_REGEX, get_ref_regex_for_sig
 from data.sig_ref import SIGRef
 
 
-# Data class that defines a spot.
 @dataclass
 class Spot:
+    """Data class that defines a spot."""
+
     # Unique identifier for the spot
     id: str = None
 
@@ -27,6 +31,9 @@ class Spot:
     dx_call: str = None
     # Name of the operator that has been spotted
     dx_name: str = None
+    # QTH of the operator that has been spotted. This could be from any SIG refs or could be from online lookup of their
+    # home QTH.
+    dx_qth: str = None
     # Country of the DX operator
     dx_country: str = None
     # Country flag of the DX operator
@@ -103,18 +110,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
 
@@ -136,8 +131,9 @@ class Spot:
     # The ID the source gave it, if any.
     source_id: str = None
 
-    # Infer missing parameters where possible
     def infer_missing(self):
+        """Infer missing parameters where possible"""
+
         # If we somehow don't have a spot time, set it to zero so it sorts off the bottom of any list but
         # clients can still reliably parse it as a number.
         if not self.time:
@@ -160,19 +156,15 @@ class Spot:
             if len(split) > 1 and split[1] != "#":
                 self.dx_ssid = split[1]
 
-        # DX country, continent, zones etc. from callsign
+        # DX country, continent etc. from callsign
         if self.dx_call and not self.dx_country:
             self.dx_country = lookup_helper.infer_country_from_callsign(self.dx_call)
         if self.dx_call and not self.dx_continent:
             self.dx_continent = lookup_helper.infer_continent_from_callsign(self.dx_call)
-        if self.dx_call and not self.dx_cq_zone:
-            self.dx_cq_zone = lookup_helper.infer_cq_zone_from_callsign(self.dx_call)
-        if self.dx_call and not self.dx_itu_zone:
-            self.dx_itu_zone = lookup_helper.infer_itu_zone_from_callsign(self.dx_call)
         if self.dx_call and not self.dx_dxcc_id:
             self.dx_dxcc_id = lookup_helper.infer_dxcc_id_from_callsign(self.dx_call)
-        if self.dx_dxcc_id and self.dx_dxcc_id in DXCC_FLAGS and not self.dx_flag:
+        if self.dx_dxcc_id and not self.dx_flag:
-            self.dx_flag = DXCC_FLAGS[self.dx_dxcc_id]
+            self.dx_flag = lookup_helper.get_flag_for_dxcc(self.dx_dxcc_id)
 
         # Clean up spotter call if it has an SSID or -# from RBN
         if self.de_call and "-" in self.de_call:
@@ -197,53 +189,57 @@ class Spot:
 
         # Spotter country, continent, zones etc. from callsign.
         # DE call with no digits, or APRS servers starting "T2" are not things we can look up location for
-        if self.de_call and any(char.isdigit() for char in self.de_call) and not (self.de_call.startswith("T2") and self.source == "APRS-IS"):
+        if self.de_call and any(char.isdigit() for char in self.de_call) and not (
+                self.de_call.startswith("T2") and self.source == "APRS-IS"):
             if not self.de_country:
                 self.de_country = lookup_helper.infer_country_from_callsign(self.de_call)
             if not self.de_continent:
                 self.de_continent = lookup_helper.infer_continent_from_callsign(self.de_call)
             if not self.de_dxcc_id:
                 self.de_dxcc_id = lookup_helper.infer_dxcc_id_from_callsign(self.de_call)
-            if self.de_dxcc_id and self.de_dxcc_id in DXCC_FLAGS and not self.de_flag:
+            if self.de_dxcc_id and not self.de_flag:
-                self.de_flag = DXCC_FLAGS[self.de_dxcc_id]
+                self.de_flag = lookup_helper.get_flag_for_dxcc(self.de_dxcc_id)
 
         # Band from frequency
         if self.freq and not self.band:
-            band = lookup_helper.infer_band_from_freq(self.freq)
+            band = 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:
             self.mode_source = "SPOT"
         if self.comment and not self.mode:
-            self.mode = lookup_helper.infer_mode_from_comment(self.comment)
+            self.mode = infer_mode_from_comment(self.comment)
             self.mode_source = "COMMENT"
         if self.freq and not self.mode:
-            self.mode = lookup_helper.infer_mode_from_frequency(self.freq)
+            self.mode = infer_mode_from_frequency(self.freq)
             self.mode_source = "BANDPLAN"
 
-        # Normalise "generic digital" modes. "DIGITAL", "DIGI" and "DATA" are just the same thing with no extra
+        # Normalise mode if necessary.
-        # information, so standardise on "DATA"
+        if self.mode in MODE_ALIASES:
-        if self.mode == "DIGI" or self.mode == "DIGITAL":
+            self.mode = MODE_ALIASES[self.mode]
-            self.mode = "DATA"
 
         # Mode type from mode
         if self.mode and not self.mode_type:
-            self.mode_type = lookup_helper.infer_mode_type_from_mode(self.mode)
+            self.mode_type = 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 we have a latitude or grid at this point, it can only have been provided by the spot itself
-        if self.dx_latitude:
+        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.
+        if not self.sig and self.sig_refs and len(self.sig_refs) > 0:
+            self.sig = self.sig_refs[0].sig.upper()
+
         # See if we already have a SIG reference, but the comment looks like it contains more for the same SIG. This
         # should catch e.g. POTA comments like "2-fer: GB-0001 GB-0002".
-        if self.comment and self.sig_refs and len(self.sig_refs) > 0:
+        if self.comment and self.sig_refs and len(self.sig_refs) > 0 and self.sig_refs[0].sig:
             sig = self.sig_refs[0].sig.upper()
-            all_comment_refs = re.findall(get_ref_regex_for_sig(sig), self.comment)
+            regex = get_ref_regex_for_sig(sig)
-            for ref in all_comment_refs:
+            if regex:
-                self.append_sig_ref_if_missing(SIGRef(id=ref.upper(), sig=sig))
+                all_comment_ref_matches = re.finditer(r"(^|\W)(" + regex + r")(^|\W)", self.comment, re.IGNORECASE)
+                for ref_match in all_comment_ref_matches:
+                    self._append_sig_ref_if_missing(SIGRef(id=ref_match.group(2).upper(), sig=sig))
 
         # See if the comment looks like it contains any SIGs (and optionally SIG references) that we can
         # add to the spot. This should catch cluster spot comments like "POTA GB-0001 WWFF GFF-0001" and e.g. POTA
@@ -261,25 +257,23 @@ class Spot:
                 # If so, add that to the sig_refs list for this spot.
                 ref_regex = get_ref_regex_for_sig(found_sig)
                 if ref_regex:
-                    ref_matches = re.finditer(r"(^|\W)" + found_sig + r"($|\W)(" + ref_regex + r")($|\W)", self.comment, re.IGNORECASE)
+                    ref_matches = re.finditer(r"(^|\W)" + found_sig + r"($|\W)(" + ref_regex + r")($|\W)", self.comment,
+                                              re.IGNORECASE)
                     for ref_match in ref_matches:
-                        self.append_sig_ref_if_missing(SIGRef(id=ref_match.group(3).upper(), sig=found_sig))
+                        self._append_sig_ref_if_missing(SIGRef(id=ref_match.group(3).upper(), sig=found_sig))
 
         # Fetch SIG data. In case a particular API doesn't provide a full set of name, lat, lon & grid for a reference
         # in its initial call, we use this code to populate the rest of the data. This includes working out grid refs
         # from WAB and WAI, which count as a SIG even though there's no real lookup, just maths
         if self.sig_refs and len(self.sig_refs) > 0:
             for sig_ref in self.sig_refs:
-                lookup_data = get_sig_ref_info(sig_ref.sig, sig_ref.id)
+                sig_ref = populate_sig_ref_info(sig_ref)
-                if lookup_data:
-                    # Update the sig_ref data from the lookup
-                    sig_ref.__dict__.update(lookup_data.__dict__)
                 # If the spot itself doesn't have location yet, but the SIG ref does, extract it
-                    if lookup_data.grid and not self.dx_grid:
+                if sig_ref.grid and not self.dx_grid:
-                        self.dx_grid = lookup_data.grid
+                    self.dx_grid = sig_ref.grid
-                    if lookup_data.latitude and not self.dx_latitude:
+                if sig_ref.latitude and not self.dx_latitude:
-                        self.dx_latitude = lookup_data.latitude
+                    self.dx_latitude = sig_ref.latitude
-                        self.dx_longitude = lookup_data.longitude
+                    self.dx_longitude = sig_ref.longitude
                     if self.sig == "WAB" or self.sig == "WAI":
                         self.dx_location_source = "WAB/WAI GRID"
                     else:
@@ -290,15 +284,14 @@ 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)
-
         # DX Grid to lat/lon and vice versa in case one is missing
         if self.dx_grid and not self.dx_latitude:
+            try:
                 ll = locator_to_latlong(self.dx_grid)
                 self.dx_latitude = ll[0]
                 self.dx_longitude = ll[1]
+            except:
+                logging.debug("Invalid grid received for spot")
         if self.dx_latitude and self.dx_longitude and not self.dx_grid:
             try:
                 self.dx_grid = latlong_to_locator(self.dx_latitude, self.dx_longitude, 8)
@@ -313,15 +306,24 @@ class Spot:
         # the actual spotting 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.
         if self.dx_call and not self.dx_name:
-            self.dx_name = lookup_helper.infer_name_from_callsign(self.dx_call)
+            self.dx_name = lookup_helper.infer_name_from_callsign_online_lookup(self.dx_call)
         if self.dx_call and not self.dx_latitude:
-            latlon = lookup_helper.infer_latlon_from_callsign_qrz(self.dx_call)
+            latlon = lookup_helper.infer_latlon_from_callsign_online_lookup(self.dx_call)
             if latlon:
                 self.dx_latitude = latlon[0]
                 self.dx_longitude = latlon[1]
-            self.dx_grid = lookup_helper.infer_grid_from_callsign_qrz(self.dx_call)
+            self.dx_grid = lookup_helper.infer_grid_from_callsign_online_lookup(self.dx_call)
             self.dx_location_source = "HOME QTH"
 
+        # Determine a "QTH" string. If we have a SIG ref, pick the first one and turn it into a suitable stirng,
+        # otherwise see what they have set on an online lookup service.
+        if self.sig_refs and len(self.sig_refs) > 0:
+            self.dx_qth = self.sig_refs[0].id
+            if self.sig_refs[0].name:
+                self.dx_qth = self.dx_qth + " " + self.sig_refs[0].name
+        else:
+            self.dx_qth = lookup_helper.infer_qth_from_callsign_online_lookup(self.dx_call)
+
         # Last resort for getting a DX position, use the DXCC entity.
         if self.dx_call and not self.dx_latitude:
             latlon = lookup_helper.infer_latlon_from_callsign_dxcc(self.dx_call)
@@ -331,21 +333,35 @@ class Spot:
                 self.dx_grid = lookup_helper.infer_grid_from_callsign_dxcc(self.dx_call)
                 self.dx_location_source = "DXCC"
 
+        # CQ and ITU zone lookup, preferably from location but failing that, from callsign
+        if not self.dx_cq_zone:
+            if self.dx_latitude:
+                self.dx_cq_zone = lat_lon_to_cq_zone(self.dx_latitude, self.dx_longitude)
+            elif self.dx_call:
+                self.dx_cq_zone = lookup_helper.infer_cq_zone_from_callsign(self.dx_call)
+        if not self.dx_itu_zone:
+            if self.dx_latitude:
+                self.dx_itu_zone = lat_lon_to_itu_zone(self.dx_latitude, self.dx_longitude)
+            elif self.dx_call:
+                self.dx_itu_zone = lookup_helper.infer_itu_zone_from_callsign(self.dx_call)
+
         # DX Location is "good" if it is from a spot, or from QRZ if the callsign doesn't contain a slash, so the operator
         # is likely at home.
-        self.dx_location_good = (self.dx_location_source == "SPOT" or self.dx_location_source == "SIG REF LOOKUP"
+        self.dx_location_good = self.dx_latitude and self.dx_longitude and (
+                self.dx_location_source == "SPOT" or self.dx_location_source == "SIG REF LOOKUP"
                 or self.dx_location_source == "WAB/WAI GRID"
                 or (self.dx_location_source == "HOME QTH" and not "/" in self.dx_call))
 
         # DE with no digits and APRS servers starting "T2" are not things we can look up location for
-        if self.de_call and any(char.isdigit() for char in self.de_call) and not (self.de_call.startswith("T2") and self.source == "APRS-IS"):
+        if self.de_call and any(char.isdigit() for char in self.de_call) and not (
+                self.de_call.startswith("T2") and self.source == "APRS-IS"):
             # DE operator position lookup, using QRZ.com.
             if not self.de_latitude:
-                latlon = lookup_helper.infer_latlon_from_callsign_qrz(self.de_call)
+                latlon = lookup_helper.infer_latlon_from_callsign_online_lookup(self.de_call)
                 if latlon:
                     self.de_latitude = latlon[0]
                     self.de_longitude = latlon[1]
-                self.de_grid = lookup_helper.infer_grid_from_callsign_qrz(self.de_call)
+                self.de_grid = lookup_helper.infer_grid_from_callsign_online_lookup(self.de_call)
 
             # Last resort for getting a DE position, use the DXCC entity.
             if not self.de_latitude:
@@ -365,15 +381,29 @@ class Spot:
         self_copy.received_time_iso = ""
         self.id = hashlib.sha256(str(self_copy).encode("utf-8")).hexdigest()
 
-    # JSON serialise
     def to_json(self):
+        """JSON serialise"""
+
         return json.dumps(self, default=lambda o: o.__dict__, sort_keys=True)
 
-    # Append a sig_ref to the list, so long as it's not already there.
+    def _append_sig_ref_if_missing(self, new_sig_ref):
-    def append_sig_ref_if_missing(self, new_sig_ref):
+        """Append a sig_ref to the list, so long as it's not already there."""
+
         if not self.sig_refs:
             self.sig_refs = []
+        new_sig_ref.id = new_sig_ref.id.strip().upper()
+        new_sig_ref.sig = new_sig_ref.sig.strip().upper()
+        if new_sig_ref.id == "":
+            return
         for sig_ref in self.sig_refs:
-            if sig_ref.id.upper() == new_sig_ref.id.upper() and sig_ref.sig.upper() == new_sig_ref.sig.upper():
+            if sig_ref.id == new_sig_ref.id and sig_ref.sig == new_sig_ref.sig:
                 return
         self.sig_refs.append(new_sig_ref)
+
+    def expired(self):
+        """Decide if this spot has expired (in which case it should not be added to the system in the first place, and not
+        returned by the web server if later requested, and removed by the cleanup functions). "Expired" is defined as
+        either having a time further ago than the server's MAX_SPOT_AGE. If it somehow doesn't have a time either, it is
+        considered to be expired."""
+
+        return not self.time or self.time < (datetime.now(pytz.UTC) - timedelta(seconds=MAX_SPOT_AGE)).timestamp()

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
@@ -13,3 +12,7 @@ rss-parser~=2.1.1
 pyproj~=3.7.2
 prometheus_client~=0.23.1
 beautifulsoup4~=4.14.2
+websocket-client~=1.9.0
+tornado~=6.5.4
+tornado_eventsource~=3.0.0
+geopandas~=1.1.2

server/handlers/api/addspot.py

@@ -0,0 +1,145 @@
+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 infer_band_from_freq
+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
+
+
+class APISpotHandler(tornado.web.RequestHandler):
+    """API request handler for /api/v1/spot (POST)"""
+
+    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 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,190 @@
+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, empty_queue
+
+SSE_HANDLER_MAX_QUEUE_SIZE = 100
+SSE_HANDLER_QUEUE_CHECK_INTERVAL = 5000
+
+
+class APIAlertsHandler(tornado.web.RequestHandler):
+    """API request handler for /api/v1/alerts"""
+
+    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")
+
+
+class APIAlertsStreamHandler(tornado_eventsource.handler.EventSourceHandler):
+    """API request handler for /api/v1/alerts/stream"""
+
+    def initialize(self, sse_alert_queues, web_server_metrics):
+        self._sse_alert_queues = sse_alert_queues
+        self._web_server_metrics = web_server_metrics
+
+    def custom_headers(self):
+        """Custom headers to avoid e.g. nginx reverse proxy from buffering SSE data"""
+
+        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.warning("Exception when serving SSE socket", e)
+
+    def close(self):
+        """When the user closes the socket, empty our queue and remove it from the list so the server no longer fills it"""
+
+        try:
+            if self._alert_queue in self._sse_alert_queues:
+                self._sse_alert_queues.remove(self._alert_queue)
+            empty_queue(self._alert_queue)
+        except:
+            pass
+        try:
+            self._heartbeat.stop()
+        except:
+            pass
+        self._alert_queue = None
+        super().close()
+
+    def _callback(self):
+        """Callback to check if anything has arrived in the queue, and if so send it to the client"""
+
+        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.warning("Exception in SSE callback, connection will be closed.")
+            self.close()
+
+
+def get_alert_list_with_filters(all_alerts, query):
+    """Utility method to apply filters to the overall alert list and return only a subset. Enables query parameters in
+    the main "alerts" GET call."""
+
+    # 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
+
+
+def alert_allowed_by_query(alert, query):
+    """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."""
+
+    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 (query.get(
+                        "dxpeditions_skip_max_duration_check").upper() == "TRUE" 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,182 @@
+import json
+import logging
+import re
+from datetime import datetime
+
+import pytz
+import tornado
+
+from core.constants import SIGS
+from core.geo_utils import lat_lon_for_grid_sw_corner_plus_size, lat_lon_to_cq_zone, lat_lon_to_itu_zone
+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
+
+
+class APILookupCallHandler(tornado.web.RequestHandler):
+    """API request handler for /api/v1/lookup/call"""
+
+    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")
+
+
+class APILookupSIGRefHandler(tornado.web.RequestHandler):
+    """API request handler for /api/v1/lookup/sigref"""
+
+    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()
+                ref_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), ref_id):
+                        data = populate_sig_ref_info(SIGRef(id=ref_id, sig=sig))
+                        self.write(json.dumps(data, default=serialize_everything))
+
+                    else:
+                        self.write(
+                            json.dumps("Error - '" + ref_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")
+
+
+class APILookupGridHandler(tornado.web.RequestHandler):
+    """API request handler for /api/v1/lookup/grid"""
+
+    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()}
+
+            # "grid" query param must exist.
+            if "grid" in query_params.keys():
+                grid = query_params.get("grid").upper()
+                lat, lon, lat_cell_size, lon_cell_size = lat_lon_for_grid_sw_corner_plus_size(grid)
+                if lat is not None and lon is not None and lat_cell_size is not None and lon_cell_size is not None:
+                    center_lat = lat + lat_cell_size / 2.0
+                    center_lon = lon + lon_cell_size / 2.0
+                    center_cq_zone = lat_lon_to_cq_zone(center_lat, center_lon)
+                    center_itu_zone = lat_lon_to_itu_zone(center_lat, center_lon)
+
+                    response = {
+                        "center": {
+                            "latitude": center_lat,
+                            "longitude": center_lon,
+                            "cq_zone": center_cq_zone,
+                            "itu_zone": center_itu_zone
+                        },
+                        "southwest": {
+                            "latitude": lat,
+                            "longitude": lon,
+                        },
+                        "northeast": {
+                            "latitude": lat + lat_cell_size,
+                            "longitude": lon + lon_cell_size,
+                        }}
+                    self.write(json.dumps(response, default=serialize_everything))
+
+            else:
+                self.write(json.dumps("Error - grid 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,47 @@
+import json
+from datetime import datetime
+
+import pytz
+import tornado
+
+from core.config import MAX_SPOT_AGE, ALLOW_SPOTTING
+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
+
+
+class APIOptionsHandler(tornado.web.RequestHandler):
+    """API request handler for /api/v1/options"""
+
+    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}
+        # 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")
+
+        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,251 @@
+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, empty_queue
+
+SSE_HANDLER_MAX_QUEUE_SIZE = 1000
+SSE_HANDLER_QUEUE_CHECK_INTERVAL = 5000
+
+
+class APISpotsHandler(tornado.web.RequestHandler):
+    """API request handler for /api/v1/spots"""
+
+    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")
+
+
+class APISpotsStreamHandler(tornado_eventsource.handler.EventSourceHandler):
+    """API request handler for /api/v1/spots/stream"""
+
+    def initialize(self, sse_spot_queues, web_server_metrics):
+        self._sse_spot_queues = sse_spot_queues
+        self._web_server_metrics = web_server_metrics
+
+    def custom_headers(self):
+        """Custom headers to avoid e.g. nginx reverse proxy from buffering SSE data"""
+
+        return {"Cache-Control": "no-store",
+                "X-Accel-Buffering": "no"}
+
+    def open(self):
+        """Called once on the client opening a connection, set things up"""
+
+        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.warning("Exception when serving SSE socket", e)
+
+    def close(self):
+        """When the user closes the socket, empty our queue and remove it from the list so the server no longer fills it"""
+
+        try:
+            if self._spot_queue in self._sse_spot_queues:
+                self._sse_spot_queues.remove(self._spot_queue)
+            empty_queue(self._spot_queue)
+        except:
+            pass
+        try:
+            self._heartbeat.stop()
+        except:
+            pass
+        self._spot_queue = None
+        super().close()
+
+    def _callback(self):
+        """Callback to check if anything has arrived in the queue, and if so send it to the client"""
+
+        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.warning("Exception in SSE callback, connection will be closed.")
+            self.close()
+
+
+def get_spot_list_with_filters(all_spots, query):
+    """Utility method to apply filters to the overall spot list and return only a subset. Enables query parameters in
+    the main "spots" GET call."""
+
+    # 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
+
+
+def spot_allowed_by_query(spot, query):
+    """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."""
+
+    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:
+                    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,28 @@
+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
+
+
+class APIStatusHandler(tornado.web.RequestHandler):
+    """API request handler for /api/v1/status"""
+
+    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,13 @@
+import tornado
+from prometheus_client import CONTENT_TYPE_LATEST
+
+from core.prometheus_metrics_handler import get_metrics
+
+
+class PrometheusMetricsHandler(tornado.web.RequestHandler):
+    """Handler for Prometheus metrics endpoint"""
+
+    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,27 @@
+from datetime import datetime
+
+import pytz
+import tornado
+
+from core.config import ALLOW_SPOTTING, WEB_UI_OPTIONS
+from core.constants import SOFTWARE_VERSION
+from core.prometheus_metrics_handler import page_requests_counter
+
+
+class PageTemplateHandler(tornado.web.RequestHandler):
+    """Handler for all HTML pages generated from templates"""
+
+    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,
+                    web_ui_options=WEB_UI_OPTIONS)

server/webserver.py

@@ -1,484 +1,141 @@
-import json
+import asyncio
 import logging
-import re
+import os
-from datetime import datetime, timedelta
-from threading import Thread
 
-import bottle
+import tornado
-import pytz
+from tornado.web import StaticFileHandler
-from bottle import run, request, response, template
 
-from core.config import MAX_SPOT_AGE, ALLOW_SPOTTING
+from core.utils import empty_queue
-from core.constants import BANDS, ALL_MODES, MODE_TYPES, SIGS, CONTINENTS, SOFTWARE_VERSION, UNKNOWN_BAND
+from server.handlers.api.addspot import APISpotHandler
-from core.lookup_helper import lookup_helper
+from server.handlers.api.alerts import APIAlertsHandler, APIAlertsStreamHandler
-from core.prometheus_metrics_handler import page_requests_counter, get_metrics, api_requests_counter
+from server.handlers.api.lookups import APILookupCallHandler, APILookupSIGRefHandler, APILookupGridHandler
-from core.sig_utils import get_ref_regex_for_sig, get_sig_ref_info
+from server.handlers.api.options import APIOptionsHandler
-from data.sig_ref import SIGRef
+from server.handlers.api.spots import APISpotsHandler, APISpotsStreamHandler
-from data.spot import Spot
+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:
+    """Provides the public-facing web server."""
 
-    # Constructor
     def __init__(self, spots, alerts, status_data, port):
-        self.last_page_access_time = None
+        """Constructor"""
-        self.last_api_access_time = None
-        self.page_access_counter = 0
-        self.api_access_counter = 0
-        self.spots = spots
-        self.alerts = alerts
-        self.status_data = status_data
-        self.port = port
-        self.thread = Thread(target=self.run)
-        self.thread.daemon = True
-        self.status = "Starting"
 
-        # Base template data
+        self._spots = spots
-        bottle.BaseTemplate.defaults['software_version'] = SOFTWARE_VERSION
+        self._alerts = alerts
-        bottle.BaseTemplate.defaults['allow_spotting'] = ALLOW_SPOTTING
+        self._sse_spot_queues = []
+        self._sse_alert_queues = []
+        self._status_data = status_data
+        self._port = port
+        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"
+        }
 
-        # 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/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)
-
-    # Start the web server
     def start(self):
-        self.thread.start()
+        """Start the web server"""
 
-    # Run the web server itself. This blocks until the server is shut down, so it runs in a separate thread.
+        asyncio.run(self._start_inner())
-    def run(self):
-        logging.info("Starting web server on port " + str(self.port) + "...")
-        self.status = "Waiting"
-        run(host='localhost', port=self.port)
 
-    # Serve the JSON API /spots endpoint
+    def stop(self):
-    def serve_spots_api(self):
+        """Stop the web server"""
+
+        self._shutdown_event.set()
+
+    async def _start_inner(self):
+        """Start method (async). Sets up the Tornado application."""
+
+        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/lookup/grid", APILookupGridHandler, {"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()
+
+    def notify_new_spot(self, spot):
+        """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."""
+
+        for queue in self._sse_spot_queues:
             try:
-            data = self.get_spot_list_with_filters()
+                queue.put(spot)
-            return self.serve_api(data)
+            except:
-        except ValueError as e:
+                # Cleanup thread was probably deleting the queue, that's fine
-            logging.error(e)
+                pass
-            response.content_type = 'application/json'
+        pass
-            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 notify_new_alert(self, alert):
-    def serve_alerts_api(self):
+        """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."""
+
+        for queue in self._sse_alert_queues:
             try:
-            data = self.get_alert_list_with_filters()
+                queue.put(alert)
-            return self.serve_api(data)
+            except:
-        except ValueError as e:
+                # Cleanup thread was probably deleting the queue, that's fine
-            logging.error(e)
+                pass
-            response.content_type = 'application/json'
+        pass
-            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)
 
-    # Look up data for a callsign
+    def clean_up_sse_queues(self):
-    def serve_call_lookup_api(self):
+        """Clean up any SSE queues that are growing too large; probably their client disconnected and we didn't catch it
+        properly for some reason."""
+
+        for q in self._sse_spot_queues:
             try:
-            # Reject if no callsign
+                if q.full():
-            query = bottle.request.query
+                    logging.warning(
-            if not "call" in query.keys():
+                        "A full SSE spot queue was found, presumably because the client disconnected strangely. It has been removed.")
-                response.content_type = 'application/json'
+                    self._sse_spot_queues.remove(q)
-                response.status = 422
+                    empty_queue(q)
-                return json.dumps("Error - call must be provided", default=serialize_everything)
+            except:
-            call = query.get("call").upper()
+                # Probably got deleted already on another thread
-
+                pass
-            # Reject badly formatted callsigns
+        for q in self._sse_alert_queues:
-            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,
-                "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
+                if q.full():
-            query = bottle.request.query
+                    logging.warning(
-            if not "sig" in query.keys() or not "id" in query.keys():
+                        "A full SSE alert queue was found, presumably because the client disconnected strangely. It has been removed.")
-                response.content_type = 'application/json'
+                    self._sse_alert_queues.remove(q)
-                response.status = 422
+                    empty_queue(q)
-                return json.dumps("Error - sig and id must be provided", default=serialize_everything)
+            except:
-            sig = query.get("sig").upper()
+                # Probably got deleted already on another thread
-            id = query.get("id").upper()
+                pass
-
+        pass
-            # 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 = get_sig_ref_info(sig, id)
-            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"
-            if not spot.sig:
-                spot.icon = "desktop"
-            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. We'll then filter it accordingly.
-        # We can filter by spot time and received time with "since" and "received_since", which take a UNIX timestamp
-        # in seconds UTC.
-        # We can also filter by source, sig, band, mode, dx_continent and de_continent. Each of these accepts a single
-        # value or a comma-separated list.
-        # We can filter by comments, accepting a single string, where the API will only return spots where the comment
-        # contains the provided value (case-insensitive).
-        # We can "de-dupe" spots, so only the latest spot will be sent for each callsign.
-        # We can provide a "limit" number as well. Spots are always returned newest-first; "limit" limits to only the
-        # most recent X spots.
-        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)
-        for k in query.keys():
-            match k:
-                case "since":
-                    since = datetime.fromtimestamp(int(query.get(k)), pytz.UTC).timestamp()
-                    spots = [s for s in spots if s.time and s.time > since]
-                case "max_age":
-                    max_age = int(query.get(k))
-                    since = (datetime.now(pytz.UTC) - timedelta(seconds=max_age)).timestamp()
-                    spots = [s for s in spots if s.time and s.time > since]
-                case "received_since":
-                    since = datetime.fromtimestamp(int(query.get(k)), pytz.UTC).timestamp()
-                    spots = [s for s in spots if s.received_time and s.received_time > since]
-                case "source":
-                    sources = query.get(k).split(",")
-                    spots = [s for s in spots if s.source and s.source in sources]
-                case "sig":
-                    # If a list of sigs is provided, the spot must have a sig and it must match one of them
-                    sigs = query.get(k).split(",")
-                    spots = [s for s in spots if s.sig and s.sig in sigs]
-                case "needs_sig":
-                    # If true, a sig is required, regardless of what it is, it just can't be missing.
-                    needs_sig = query.get(k).upper() == "TRUE"
-                    if needs_sig:
-                        spots = [s for s in spots if s.sig]
-                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:
-                        spots = [s for s in spots if s.sig_refs and len(s.sig_refs) > 0]
-                case "band":
-                    bands = query.get(k).split(",")
-                    spots = [s for s in spots if s.band and s.band in bands]
-                case "mode":
-                    modes = query.get(k).split(",")
-                    spots = [s for s in spots if s.mode in modes]
-                case "mode_type":
-                    mode_families = query.get(k).split(",")
-                    spots = [s for s in spots if s.mode_type and s.mode_type in mode_families]
-                case "dx_continent":
-                    dxconts = query.get(k).split(",")
-                    spots = [s for s in spots if s.dx_continent and s.dx_continent in dxconts]
-                case "de_continent":
-                    deconts = query.get(k).split(",")
-                    spots = [s for s in spots if s.de_continent and s.de_continent in deconts]
-                case "comment_includes":
-                    comment_includes = query.get(k).strip()
-                    spots = [s for s in spots if s.comment and comment_includes.upper() in s.comment.upper()]
-                case "dx_call_includes":
-                    dx_call_includes = query.get(k).strip()
-                    spots = [s for s in spots if s.dx_call and dx_call_includes.upper() in s.dx_call.upper()]
-                case "allow_qrt":
-                    # If false, spots that are flagged as QRT are not returned.
-                    prevent_qrt = query.get(k).upper() == "FALSE"
-                    if prevent_qrt:
-                        spots = [s for s in spots if not s.qrt or s.qrt == 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:
-                        spots = [s for s in spots if s.dx_location_good]
-                case "dedupe":
-                    # 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.
-                    dedupe = query.get(k).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
-        # If we have a "limit" parameter, we apply that last, regardless of where it appeared in the list of keys.
-        if "limit" in query.keys():
-            spots = spots[:int(query.get("limit"))]
-        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. We'll then filter it accordingly.
-        # We can filter by received time with "received_since", which take a UNIX timestamp in seconds UTC.
-        # We can also filter by source, sig, and dx_continent. Each of these accepts a single
-        # value or a comma-separated list.
-        # We can provide a "limit" number as well. Alerts are always returned newest-first; "limit" limits to only the
-        # most recent X alerts.
-        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)
-        # We never want alerts that seem to be in the past
-        alerts = list(filter(lambda alert: not alert.expired(), alerts))
-        alerts = sorted(alerts, key=lambda alert: (alert.start_time if alert and alert.start_time else 0))
-        for k in query.keys():
-            match k:
-                case "received_since":
-                    since = datetime.fromtimestamp(int(query.get(k)), pytz.UTC)
-                    alerts = [a for a in alerts if a.received_time and a.received_time > since]
-                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.
-                    dxpeditions_skip_check = bool(query.get(
-                        "dxpeditions_skip_max_duration_check")) if "dxpeditions_skip_max_duration_check" in query.keys() else False
-                    alerts = [a for a in alerts if (a.end_time and a.end_time - a.start_time <= max_duration) or
-                              not a.end_time or (dxpeditions_skip_check and a.is_dxpedition)]
-                case "source":
-                    sources = query.get(k).split(",")
-                    alerts = [a for a in alerts if a.source and a.source in sources]
-                case "sig":
-                    sigs = query.get(k).split(",")
-                    alerts = [a for a in alerts if a.sig and a.sig in sigs]
-                case "dx_continent":
-                    dxconts = query.get(k).split(",")
-                    alerts = [a for a in alerts if a.dx_continent and a.dx_continent in dxconts]
-                case "dx_call_includes":
-                    dx_call_includes = query.get(k).strip()
-                    spots = [a for a in alerts if a.dx_call and dx_call_includes.upper() in a.dx_call.upper()]
-        # If we have a "limit" parameter, we apply that last, regardless of where it appeared in the list of keys.
-        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}
-        # 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
-
-
-# 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__

spothole.py

@@ -1,6 +1,7 @@
 # Main script
 import importlib
 import logging
+import os
 import signal
 import sys
 
@@ -16,36 +17,45 @@ from server.webserver import WebServer
 # Globals
 spots = Cache('cache/spots_cache')
 alerts = Cache('cache/alerts_cache')
+web_server = None
 status_data = {}
 spot_providers = []
 alert_providers = []
 cleanup_timer = None
+run = True
 
 
-# Shutdown function
 def shutdown(sig, frame):
-    logging.info("Stopping program, this may take a few seconds...")
+    """Shutdown function"""
-    for p in spot_providers:
+
-        if p.enabled:
+    global run
-            p.stop()
+
-    for p in alert_providers:
+    logging.info("Stopping program...")
-        if p.enabled:
+    web_server.stop()
-            p.stop()
+    for sp in spot_providers:
+        if sp.enabled:
+            sp.stop()
+    for ap in alert_providers:
+        if ap.enabled:
+            ap.stop()
     cleanup_timer.stop()
     lookup_helper.stop()
     spots.close()
     alerts.close()
+    os._exit(0)
 
 
-# Utility method to get a spot provider based on the class specified in its config entry.
 def get_spot_provider_from_config(config_providers_entry):
+    """Utility method to get a spot provider based on the class specified in its config entry."""
+
     module = importlib.import_module('spotproviders.' + config_providers_entry["class"].lower())
     provider_class = getattr(module, config_providers_entry["class"])
     return provider_class(config_providers_entry)
 
 
-# Utility method to get an alert provider based on the class specified in its config entry.
 def get_alert_provider_from_config(config_providers_entry):
+    """Utility method to get an alert provider based on the class specified in its config entry."""
+
     module = importlib.import_module('alertproviders.' + config_providers_entry["class"].lower())
     provider_class = getattr(module, config_providers_entry["class"])
     return provider_class(config_providers_entry)
@@ -72,11 +82,14 @@ if __name__ == '__main__':
     # Set up lookup helper
     lookup_helper.start()
 
+    # Set up web server
+    web_server = WebServer(spots=spots, alerts=alerts, status_data=status_data, port=WEB_SERVER_PORT)
+
     # Fetch, set up and start spot providers
     for entry in config["spot-providers"]:
         spot_providers.append(get_spot_provider_from_config(entry))
     for p in spot_providers:
-        p.setup(spots=spots)
+        p.setup(spots=spots, web_server=web_server)
         if p.enabled:
             p.start()
 
@@ -84,18 +97,14 @@ if __name__ == '__main__':
     for entry in config["alert-providers"]:
         alert_providers.append(get_alert_provider_from_config(entry))
     for p in alert_providers:
-        p.setup(alerts=alerts)
+        p.setup(alerts=alerts, web_server=web_server)
         if p.enabled:
             p.start()
 
     # Set up timer to clear spot list of old data
-    cleanup_timer = CleanupTimer(spots=spots, alerts=alerts, cleanup_interval=60)
+    cleanup_timer = CleanupTimer(spots=spots, alerts=alerts, web_server=web_server, cleanup_interval=60)
     cleanup_timer.start()
 
-    # Set up web server
-    web_server = WebServer(spots=spots, alerts=alerts, status_data=status_data, port=WEB_SERVER_PORT)
-    web_server.start()
-
     # Set up status reporter
     status_reporter = StatusReporter(status_data=status_data, spots=spots, alerts=alerts, web_server=web_server,
                                      cleanup_timer=cleanup_timer, spot_providers=spot_providers,
@@ -103,3 +112,8 @@ if __name__ == '__main__':
     status_reporter.start()
 
     logging.info("Startup complete.")
+
+    # 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

@@ -10,32 +10,32 @@ from data.spot import Spot
 from spotproviders.spot_provider import SpotProvider
 
 
-# Spot provider for the APRS-IS.
 class APRSIS(SpotProvider):
+    """Spot provider for the APRS-IS."""
 
     def __init__(self, provider_config):
         super().__init__(provider_config)
-        self.thread = Thread(target=self.connect)
+        self._thread = Thread(target=self._connect)
-        self.thread.daemon = True
+        self._thread.daemon = True
-        self.aprsis = None
+        self._aprsis = None
 
     def start(self):
-        self.thread.start()
+        self._thread.start()
 
-    def connect(self):
+    def _connect(self):
-        self.aprsis = aprslib.IS(SERVER_OWNER_CALLSIGN)
+        self._aprsis = aprslib.IS(SERVER_OWNER_CALLSIGN)
         self.status = "Connecting"
         logging.info("APRS-IS connecting...")
-        self.aprsis.connect()
+        self._aprsis.connect()
-        self.aprsis.consumer(self.handle)
+        self._aprsis.consumer(self._handle)
         logging.info("APRS-IS connected.")
 
     def stop(self):
         self.status = "Shutting down"
-        self.aprsis.close()
+        self._aprsis.close()
-        self.thread.join()
+        self._thread.join()
 
-    def handle(self, data):
+    def _handle(self, data):
         # Split SSID in "from" call and store separately
         from_parts = data["from"].split("-").upper()
         dx_call = from_parts[0]
@@ -51,11 +51,11 @@ 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(
-                    time=datetime.now(pytz.UTC).timestamp()) # APRS-IS spots are live so we can assume spot time is "now"
+                        pytz.UTC).timestamp())  # APRS-IS spots are live so we can assume spot time is "now"
 
         # Add to our list
-        self.submit(spot)
+        self._submit(spot)
 
         self.status = "OK"
         self.last_update_time = datetime.now(pytz.UTC)

spotproviders/dxcluster.py

@@ -12,84 +12,89 @@ 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.
 class DXCluster(SpotProvider):
-    # Note the callsign pattern deliberately excludes calls ending in "-#", which are from RBN and can be enabled by
+    """Spot provider for a DX Cluster. Hostname, port, login_prompt, login_callsign and allow_rbn_spots are provided in config.
-    # default on some clusters. If you want RBN spots, there is a separate provider for that.
+    See config-example.yml for examples."""
-    CALLSIGN_PATTERN = "([a-z|0-9|/]+)"
+
-    FREQUENCY_PATTERN = "([0-9|.]+)"
+    _LINE_PATTERN_EXCLUDE_RBN = re.compile(
-    LINE_PATTERN = re.compile(
+        r"^DX de ([a-z0-9/]+):\s+([0-9.]+)\s+([a-z0-9/]+)\s+(.*)\s+(\d{4}Z)",
-        "^DX de " + CALLSIGN_PATTERN + ":\\s+" + FREQUENCY_PATTERN + "\\s+" + CALLSIGN_PATTERN + "\\s+(.*)\\s+(\\d{4}Z)",
+        re.IGNORECASE)
+    _LINE_PATTERN_ALLOW_RBN = re.compile(
+        r"^DX de ([a-z0-9/]+)-?#?:\s+([0-9.]+)\s+([a-z0-9/]+)\s+(.*)\s+(\d{4}Z)",
         re.IGNORECASE)
 
-    # Constructor requires hostname and port
     def __init__(self, provider_config):
+        """Constructor requires hostname and port"""
+
         super().__init__(provider_config)
-        self.hostname = provider_config["host"]
+        self._hostname = provider_config["host"]
-        self.port = provider_config["port"]
+        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.telnet = None
+        self._login_callsign = provider_config[
-        self.thread = Thread(target=self.handle)
+            "login_callsign"] if "login_callsign" in provider_config else SERVER_OWNER_CALLSIGN
-        self.thread.daemon = True
+        self._allow_rbn_spots = provider_config["allow_rbn_spots"] if "allow_rbn_spots" in provider_config else False
-        self.run = True
+        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
+        self._running = True
 
     def start(self):
-        self.thread.start()
+        self._thread.start()
 
     def stop(self):
-        self.run = False
+        self._running = False
-        self.telnet.close()
+        self._telnet.close()
-        self.thread.join()
+        self._thread.join()
 
-    def handle(self):
+    def _handle(self):
-        while self.run:
+        while self._running:
             connected = False
-            while not connected and self.run:
+            while not connected and self._running:
                 try:
                     self.status = "Connecting"
-                    logging.info("DX Cluster " + self.hostname + " connecting...")
+                    logging.info("DX Cluster " + self._hostname + " connecting...")
-                    self.telnet = telnetlib3.Telnet(self.hostname, self.port)
+                    self._telnet = telnetlib3.Telnet(self._hostname, self._port)
-                    self.telnet.read_until(self.login_prompt.encode("latin-1"))
+                    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.")
+                    logging.info("DX Cluster " + self._hostname + " connected.")
-                except Exception as e:
+                except Exception:
                     self.status = "Error"
-                    logging.exception("Exception while connecting to DX Cluster Provider (" + self.hostname + ").")
+                    logging.exception("Exception while connecting to DX Cluster Provider (" + self._hostname + ").")
                     sleep(5)
 
             self.status = "Waiting for Data"
-            while connected and self.run:
+            while connected and self._running:
                 try:
                     # Check new telnet info against regular expression
-                    telnet_output = self.telnet.read_until("\n".encode("latin-1"))
+                    telnet_output = self._telnet.read_until("\n".encode("latin-1"))
-                    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)
+                        spot_datetime = datetime.combine(datetime.now(pytz.UTC).date(), spot_time.time(), tzinfo=pytz.UTC)
                         spot = Spot(source=self.name,
                                     dx_call=match.group(3),
                                     de_call=match.group(1),
                                     freq=float(match.group(2)) * 1000,
                                     comment=match.group(4).strip(),
-                                    icon="desktop",
                                     time=spot_datetime.timestamp())
 
                         # Add to our list
-                        self.submit(spot)
+                        self._submit(spot)
 
                         self.status = "OK"
                         self.last_update_time = datetime.now(pytz.UTC)
-                        logging.debug("Data received from DX Cluster " + self.hostname + ".")
+                        logging.debug("Data received from DX Cluster " + self._hostname + ".")
 
-                except Exception as e:
+                except Exception:
                     connected = False
-                    if self.run:
+                    if self._running:
                         self.status = "Error"
-                        logging.exception("Exception in DX Cluster Provider (" + self.hostname + ")")
+                        logging.exception("Exception in DX Cluster Provider (" + self._hostname + ")")
                         sleep(5)
                     else:
-                        logging.info("DX Cluster " + self.hostname + " shutting down...")
+                        logging.info("DX Cluster " + self._hostname + " shutting down...")
                         self.status = "Shutting down"
 
             self.status = "Disconnected"

spotproviders/gma.py

@@ -5,14 +5,14 @@ import pytz
 
 from core.cache_utils import SEMI_STATIC_URL_DATA_CACHE
 from core.constants import HTTP_HEADERS
-from core.sig_utils import get_icon_for_sig
 from data.sig_ref import SIGRef
 from data.spot import Spot
 from spotproviders.http_spot_provider import HTTPSpotProvider
 
 
-# Spot provider for General Mountain Activity
 class GMA(HTTPSpotProvider):
+    """Spot provider for General Mountain Activity"""
+
     POLL_INTERVAL_SEC = 120
     SPOTS_URL = "https://www.cqgma.org/api/spots/25/"
     # GMA spots don't contain the details of the programme they are for, we need a separate lookup for that
@@ -21,7 +21,7 @@ class GMA(HTTPSpotProvider):
     def __init__(self, provider_config):
         super().__init__(provider_config, self.SPOTS_URL, self.POLL_INTERVAL_SEC)
 
-    def http_response_to_spots(self, http_response):
+    def _http_response_to_spots(self, http_response):
         new_spots = []
         # Iterate through source data
         for source_spot in http_response.json()["RCD"]:
@@ -37,11 +37,15 @@ class GMA(HTTPSpotProvider):
                         sig_refs=[SIGRef(id=source_spot["REF"], sig="", name=source_spot["NAME"])],
                         time=datetime.strptime(source_spot["DATE"] + source_spot["TIME"], "%Y%m%d%H%M").replace(
                             tzinfo=pytz.UTC).timestamp(),
-                        dx_latitude=float(source_spot["LAT"]) if (source_spot["LAT"] and source_spot["LAT"] != "") else None,
+                        dx_latitude=float(source_spot["LAT"]) if (
+                                    source_spot["LAT"] and source_spot["LAT"] != "") else None,
                         # Seen GMA spots with no (or empty) lat/lon
-                        dx_longitude=float(source_spot["LON"]) if (source_spot["LON"] and source_spot["LON"] != "") else None)
+                        dx_longitude=float(source_spot["LON"]) if (
+                                    source_spot["LON"] and source_spot["LON"] != "") else None)
 
             # GMA doesn't give what programme (SIG) the reference is for until we separately look it up.
+            if "REF" in source_spot:
+                try:
                     ref_response = SEMI_STATIC_URL_DATA_CACHE.get(self.REF_INFO_URL_ROOT + source_spot["REF"],
                                                                   headers=HTTP_HEADERS)
                     # Sometimes this is blank, so handle that
@@ -51,26 +55,37 @@ class GMA(HTTPSpotProvider):
                         # spots come through with reftype=POTA or reftype=WWFF. SOTA is harder to figure out because both SOTA
                         # and GMA summits come through with reftype=Summit, so we must check for the presence of a "sota" entry
                         # to determine if it's a SOTA summit.
-                if ref_info["reftype"] not in ["POTA", "WWFF"] and (ref_info["reftype"] != "Summit" or ref_info["sota"] == ""):
+                        if "reftype" in ref_info and ref_info["reftype"] not in ["POTA", "WWFF"] and (
+                                ref_info["reftype"] != "Summit" or "sota" not in ref_info or ref_info["sota"] == ""):
                             match ref_info["reftype"]:
                                 case "Summit":
                                     spot.sig_refs[0].sig = "GMA"
+                                    spot.sig = "GMA"
                                 case "IOTA Island":
                                     spot.sig_refs[0].sig = "IOTA"
+                                    spot.sig = "IOTA"
                                 case "Lighthouse (ILLW)":
                                     spot.sig_refs[0].sig = "ILLW"
+                                    spot.sig = "ILLW"
                                 case "Lighthouse (ARLHS)":
                                     spot.sig_refs[0].sig = "ARLHS"
+                                    spot.sig = "ARLHS"
                                 case "Castle":
                                     spot.sig_refs[0].sig = "WCA"
+                                    spot.sig = "WCA"
                                 case "Mill":
                                     spot.sig_refs[0].sig = "MOTA"
+                                    spot.sig = "MOTA"
                                 case _:
-                            logging.warn("GMA spot found with ref type " + ref_info[
+                                    logging.warning("GMA spot found with ref type " + ref_info[
                                         "reftype"] + ", developer needs to add support for this!")
                                     spot.sig_refs[0].sig = ref_info["reftype"]
+                                    spot.sig = ref_info["reftype"]
 
                             # Add to our list. Don't worry about de-duping, removing old spots etc. at this point; other code will do
                             # that for us.
                             new_spots.append(spot)
+                except:
+                    logging.warning("Exception when looking up " + self.REF_INFO_URL_ROOT + source_spot[
+                        "REF"] + ", ignoring this spot for now")
         return new_spots

spotproviders/hema.py

@@ -5,14 +5,14 @@ import pytz
 import requests
 
 from core.constants import HTTP_HEADERS
-from core.sig_utils import get_icon_for_sig
 from data.sig_ref import SIGRef
 from data.spot import Spot
 from spotproviders.http_spot_provider import HTTPSpotProvider
 
 
-# Spot provider for HuMPs Excluding Marilyns Award
 class HEMA(HTTPSpotProvider):
+    """Spot provider for HuMPs Excluding Marilyns Award"""
+
     POLL_INTERVAL_SEC = 300
     # HEMA wants us to check for a "spot seed" from the API and see if it's actually changed before querying the main
     # data API. So it's actually the SPOT_SEED_URL that we pass into the constructor and get the superclass to call on a
@@ -24,13 +24,13 @@ class HEMA(HTTPSpotProvider):
 
     def __init__(self, provider_config):
         super().__init__(provider_config, self.SPOT_SEED_URL, self.POLL_INTERVAL_SEC)
-        self.spot_seed = ""
+        self._spot_seed = ""
 
-    def http_response_to_spots(self, http_response):
+    def _http_response_to_spots(self, http_response):
         # OK, source data is actually just the spot seed at this point. We'll then go on to fetch real data if we know
         # this has changed.
-        spot_seed_changed = http_response.text != self.spot_seed
+        spot_seed_changed = http_response.text != self._spot_seed
-        self.spot_seed = http_response.text
+        self._spot_seed = http_response.text
 
         new_spots = []
         # OK, if the spot seed actually changed, now we make the real request for data.
@@ -53,8 +53,10 @@ class HEMA(HTTPSpotProvider):
                                 freq=float(freq_mode_match.group(1)) * 1000000,
                                 mode=freq_mode_match.group(2).upper(),
                                 comment=spotter_comment_match.group(2),
+                                sig="HEMA",
                                 sig_refs=[SIGRef(id=spot_items[3].upper(), sig="HEMA", name=spot_items[4])],
-                                time=datetime.strptime(spot_items[0], "%d/%m/%Y %H:%M").replace(tzinfo=pytz.UTC).timestamp(),
+                                time=datetime.strptime(spot_items[0], "%d/%m/%Y %H:%M").replace(
+                                    tzinfo=pytz.UTC).timestamp(),
                                 dx_latitude=float(spot_items[7]),
                                 dx_longitude=float(spot_items[8]))
 

spotproviders/http_spot_provider.py

@@ -1,7 +1,6 @@
 import logging
 from datetime import datetime
-from threading import Timer, Thread
+from threading import Thread, Event
-from time import sleep
 
 import pytz
 import requests
@@ -10,54 +9,56 @@ from core.constants import HTTP_HEADERS
 from spotproviders.spot_provider import SpotProvider
 
 
-# Generic spot provider class for providers that request data via HTTP(S). Just for convenience to avoid code
-# duplication. Subclasses of this query the individual APIs for data.
 class HTTPSpotProvider(SpotProvider):
+    """Generic spot provider class for providers that request data via HTTP(S). Just for convenience to avoid code
+    duplication. Subclasses of this query the individual APIs for data."""
 
     def __init__(self, provider_config, url, poll_interval):
         super().__init__(provider_config)
-        self.url = url
+        self._url = url
-        self.poll_interval = poll_interval
+        self._poll_interval = poll_interval
-        self.poll_timer = None
+        self._thread = None
+        self._stop_event = Event()
 
     def start(self):
-        # Fire off a one-shot thread to run poll() for the first time, just to ensure start() returns immediately and
+        # Fire off the polling thread. It will poll immediately on startup, then sleep for poll_interval between
-        # the application can continue starting. The thread itself will then die, and the timer will kick in on its own
+        # subsequent polls, so start() returns immediately and the application can continue starting.
-        # thread.
+        logging.info("Set up query of " + self.name + " spot API every " + str(self._poll_interval) + " seconds.")
-        logging.info("Set up query of " + self.name + " spot API every " + str(self.poll_interval) + " seconds.")
+        self._thread = Thread(target=self._run, daemon=True)
-        thread = Thread(target=self.poll)
+        self._thread.start()
-        thread.daemon = True
-        thread.start()
 
     def stop(self):
-        if self.poll_timer:
+        self._stop_event.set()
-            self.poll_timer.cancel()
 
-    def poll(self):
+    def _run(self):
+        while True:
+            self._poll()
+            if self._stop_event.wait(timeout=self._poll_interval):
+                break
+
+    def _poll(self):
         try:
             # Request data from API
             logging.debug("Polling " + self.name + " spot API...")
-            http_response = requests.get(self.url, headers=HTTP_HEADERS)
+            http_response = requests.get(self._url, headers=HTTP_HEADERS)
             # Pass off to the subclass for processing
-            new_spots = self.http_response_to_spots(http_response)
+            new_spots = self._http_response_to_spots(http_response)
             # Submit the new spots for processing. There might not be any spots for the less popular programs.
             if new_spots:
-                self.submit_batch(new_spots)
+                self._submit_batch(new_spots)
 
             self.status = "OK"
             self.last_update_time = datetime.now(pytz.UTC)
             logging.debug("Received data from " + self.name + " spot API.")
 
-        except Exception as e:
+        except Exception:
             self.status = "Error"
             logging.exception("Exception in HTTP JSON Spot Provider (" + self.name + ")")
-            sleep(1)
+            self._stop_event.wait(timeout=1)
 
-        self.poll_timer = Timer(self.poll_interval, self.poll)
+    def _http_response_to_spots(self, http_response):
-        self.poll_timer.start()
+        """Convert an HTTP response returned by the API into spot data. The whole response is provided here so the subclass
+        implementations can check for HTTP status codes if necessary, and handle the response as JSON, XML, text, whatever
+        the API actually provides."""
 
-    # Convert an HTTP response returned by the API into spot data. The whole response is provided here so the subclass
-    # implementations can check for HTTP status codes if necessary, and handle the response as JSON, XML, text, whatever
-    # the API actually provides.
-    def http_response_to_spots(self, http_response):
         raise NotImplementedError("Subclasses must implement this method")

spotproviders/llota.py

@@ -0,0 +1,42 @@
+from datetime import datetime
+
+from data.sig_ref import SIGRef
+from data.spot import Spot
+from spotproviders.http_spot_provider import HTTPSpotProvider
+
+
+class LLOTA(HTTPSpotProvider):
+    """Spot provider for Lagos y Lagunas On the Air"""
+
+    POLL_INTERVAL_SEC = 120
+    SPOTS_URL = "https://llota.app/api/public/spots"
+
+    def __init__(self, provider_config):
+        super().__init__(provider_config, self.SPOTS_URL, self.POLL_INTERVAL_SEC)
+
+    def _http_response_to_spots(self, http_response):
+        new_spots = []
+        # Iterate through source data
+        for source_spot in http_response.json():
+            # Find the most recent spotter and comment from the history array
+            comment = None
+            spotter = None
+            if "history" in source_spot and len(source_spot["history"]) > 0:
+                comment = source_spot["history"][-1]["comment"]
+                spotter = source_spot["history"][-1]["spotter_callsign"]
+            # Convert to our spot format
+            spot = Spot(source=self.name,
+                        source_id=source_spot["id"],
+                        dx_call=source_spot["callsign"].upper(),
+                        de_call=spotter.upper() if spotter else None,
+                        freq=float(source_spot["frequency"]) * 1000000,
+                        mode=source_spot["mode"].upper(),
+                        comment=comment,
+                        sig="LLOTA",
+                        sig_refs=[SIGRef(id=source_spot["reference"], sig="LLOTA", name=source_spot["reference_name"])],
+                        time=datetime.fromisoformat(source_spot["updated_at"].replace("Z", "+00:00")).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.
+            new_spots.append(spot)
+        return new_spots

spotproviders/parksnpeaks.py

@@ -4,14 +4,14 @@ from datetime import datetime
 
 import pytz
 
-from core.sig_utils import get_icon_for_sig
 from data.sig_ref import SIGRef
 from data.spot import Spot
 from spotproviders.http_spot_provider import HTTPSpotProvider
 
 
-# Spot provider for Parks n Peaks
 class ParksNPeaks(HTTPSpotProvider):
+    """Spot provider for Parks n Peaks"""
+
     POLL_INTERVAL_SEC = 120
     SPOTS_URL = "https://www.parksnpeaks.org/api/ALL"
     SIOTA_LIST_URL = "https://www.silosontheair.com/data/silos.csv"
@@ -19,7 +19,7 @@ class ParksNPeaks(HTTPSpotProvider):
     def __init__(self, provider_config):
         super().__init__(provider_config, self.SPOTS_URL, self.POLL_INTERVAL_SEC)
 
-    def http_response_to_spots(self, http_response):
+    def _http_response_to_spots(self, http_response):
         new_spots = []
         # Iterate through source data
         for source_spot in http_response.json():
@@ -27,12 +27,14 @@ class ParksNPeaks(HTTPSpotProvider):
             spot = Spot(source=self.name,
                         source_id=source_spot["actID"],
                         dx_call=source_spot["actCallsign"].upper(),
-                        de_call=source_spot["actSpoter"].upper() if source_spot["actSpoter"] != "" else None,  # typo exists in API
+                        de_call=source_spot["actSpoter"].upper() if source_spot["actSpoter"] != "" else None,
+                        # typo exists in API
                         freq=float(source_spot["actFreq"].replace(",", "")) * 1000000 if (
                                 source_spot["actFreq"] != "") else None,
                         # Seen PNP spots with empty frequency, and with comma-separated thousands digits
                         mode=source_spot["actMode"].upper(),
                         comment=source_spot["actComments"],
+                        sig=source_spot["actClass"].upper(),
                         sig_refs=[SIGRef(id=source_spot["actSiteID"], sig=source_spot["actClass"].upper())],
                         time=datetime.strptime(source_spot["actTime"], "%Y-%m-%d %H:%M:%S").replace(
                             tzinfo=pytz.UTC).timestamp())
@@ -48,7 +50,7 @@ class ParksNPeaks(HTTPSpotProvider):
 
             # Log a warning for the developer if PnP gives us an unknown programme we've never seen before
             if spot.sig_refs[0].sig not in ["POTA", "SOTA", "WWFF", "SIOTA", "ZLOTA", "KRMNPA"]:
-                logging.warn("PNP spot found with sig " + spot.sig + ", developer needs to add support for this!")
+                logging.warning("PNP spot found with sig " + spot.sig + ", developer needs to add support for this!")
 
             # If this is POTA, SOTA, WWFF or ZLOTA data we already have it through other means, so ignore. Otherwise,
             # add to the spot list.

spotproviders/pota.py

@@ -1,25 +1,22 @@
-import re
 from datetime import datetime
 
 import pytz
 
-from core.sig_utils import get_icon_for_sig, get_ref_regex_for_sig
 from data.sig_ref import SIGRef
 from data.spot import Spot
 from spotproviders.http_spot_provider import HTTPSpotProvider
 
 
-# Spot provider for Parks on the Air
 class POTA(HTTPSpotProvider):
+    """Spot provider for Parks on the Air"""
+
     POLL_INTERVAL_SEC = 120
     SPOTS_URL = "https://api.pota.app/spot/activator"
-    # Might need to look up extra park data
-    PARK_URL_ROOT = "https://api.pota.app/park/"
 
     def __init__(self, provider_config):
         super().__init__(provider_config, self.SPOTS_URL, self.POLL_INTERVAL_SEC)
 
-    def http_response_to_spots(self, http_response):
+    def _http_response_to_spots(self, http_response):
         new_spots = []
         # Iterate through source data
         for source_spot in http_response.json():
@@ -31,6 +28,7 @@ class POTA(HTTPSpotProvider):
                         freq=float(source_spot["frequency"]) * 1000,
                         mode=source_spot["mode"].upper(),
                         comment=source_spot["comments"],
+                        sig="POTA",
                         sig_refs=[SIGRef(id=source_spot["reference"], sig="POTA", name=source_spot["name"])],
                         time=datetime.strptime(source_spot["spotTime"], "%Y-%m-%dT%H:%M:%S").replace(
                             tzinfo=pytz.UTC).timestamp(),

spotproviders/rbn.py

@@ -12,82 +12,80 @@ from data.spot import Spot
 from spotproviders.spot_provider import SpotProvider
 
 
-# Spot provider for the Reverse Beacon Network. Connects to a single port, if you want both CW/RTTY (port 7000) and FT8
-# (port 7001) you need to instantiate two copies of this. The port is provided as an argument to the constructor.
 class RBN(SpotProvider):
-    CALLSIGN_PATTERN = "([a-z|0-9|/]+)"
+    """Spot provider for the Reverse Beacon Network. Connects to a single port, if you want both CW/RTTY (port 7000) and FT8
-    FREQUENCY_PATTERM = "([0-9|.]+)"
+    (port 7001) you need to instantiate two copies of this. The port is provided as an argument to the constructor."""
-    LINE_PATTERN = re.compile(
+
-        "^DX de " + CALLSIGN_PATTERN + "-.*:\\s+" + FREQUENCY_PATTERM + "\\s+" + CALLSIGN_PATTERN + "\\s+(.*)\\s+(\\d{4}Z)",
+    _LINE_PATTERN = re.compile(
+        r"^DX de ([a-z0-9/]+)-.*:\s+([0-9.]+)\s+([a-z0-9/]+)\s+(.*)\s+(\d{4}Z)",
         re.IGNORECASE)
 
-    # Constructor requires port number.
     def __init__(self, provider_config):
-        super().__init__(provider_config)
+        """Constructor requires port number."""
-        self.port = provider_config["port"]
-        self.telnet = None
-        self.thread = Thread(target=self.handle)
-        self.thread.daemon = True
-        self.run = True
 
+        super().__init__(provider_config)
+        self._port = provider_config["port"]
+        self._telnet = None
+        self._thread = Thread(target=self._handle)
+        self._thread.daemon = True
+        self._running = True
 
     def start(self):
-        self.thread.start()
+        self._thread.start()
 
     def stop(self):
-        self.run = False
+        self._running = False
-        self.telnet.close()
+        self._telnet.close()
-        self.thread.join()
+        self._thread.join()
 
-    def handle(self):
+    def _handle(self):
-        while self.run:
+        while self._running:
             connected = False
-            while not connected and self.run:
+            while not connected and self._running:
                 try:
                     self.status = "Connecting"
-                    logging.info("RBN port " + str(self.port) + " connecting...")
+                    logging.info("RBN port " + str(self._port) + " connecting...")
-                    self.telnet = telnetlib3.Telnet("telnet.reversebeacon.net", self.port)
+                    self._telnet = telnetlib3.Telnet("telnet.reversebeacon.net", self._port)
-                    telnet_output = self.telnet.read_until("Please enter your call: ".encode("latin-1"))
+                    telnet_output = self._telnet.read_until("Please enter your call: ".encode("latin-1"))
-                    self.telnet.write((SERVER_OWNER_CALLSIGN + "\n").encode("latin-1"))
+                    self._telnet.write((SERVER_OWNER_CALLSIGN + "\n").encode("latin-1"))
                     connected = True
-                    logging.info("RBN port " + str(self.port) + " connected.")
+                    logging.info("RBN port " + str(self._port) + " connected.")
-                except Exception as e:
+                except Exception:
                     self.status = "Error"
-                    logging.exception("Exception while connecting to RBN (port " + str(self.port) + ").")
+                    logging.exception("Exception while connecting to RBN (port " + str(self._port) + ").")
                     sleep(5)
 
             self.status = "Waiting for Data"
-            while connected and self.run:
+            while connected and self._running:
                 try:
                     # Check new telnet info against regular expression
-                    telnet_output = self.telnet.read_until("\n".encode("latin-1"))
+                    telnet_output = self._telnet.read_until("\n".encode("latin-1"))
-                    match = self.LINE_PATTERN.match(telnet_output.decode("latin-1"))
+                    match = self._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)
+                        spot_datetime = datetime.combine(datetime.now(pytz.UTC).date(), spot_time.time(), tzinfo=pytz.UTC)
                         spot = Spot(source=self.name,
                                     dx_call=match.group(3),
                                     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
-                        self.submit(spot)
+                        self._submit(spot)
 
                         self.status = "OK"
                         self.last_update_time = datetime.now(pytz.UTC)
-                        logging.debug("Data received from RBN on port " + str(self.port) + ".")
+                        logging.debug("Data received from RBN on port " + str(self._port) + ".")
 
-                except Exception as e:
+                except Exception:
                     connected = False
-                    if self.run:
+                    if self._running:
                         self.status = "Error"
-                        logging.exception("Exception in RBN provider (port " + str(self.port) + ")")
+                        logging.exception("Exception in RBN provider (port " + str(self._port) + ")")
                         sleep(5)
                     else:
-                        logging.info("RBN provider (port " + str(self.port) + ") shutting down...")
+                        logging.info("RBN provider (port " + str(self._port) + ") shutting down...")
                         self.status = "Shutting down"
 
             self.status = "Disconnected"

spotproviders/sota.py

@@ -3,14 +3,14 @@ from datetime import datetime
 import requests
 
 from core.constants import HTTP_HEADERS
-from core.sig_utils import get_icon_for_sig
 from data.sig_ref import SIGRef
 from data.spot import Spot
 from spotproviders.http_spot_provider import HTTPSpotProvider
 
 
-# Spot provider for Summits on the Air
 class SOTA(HTTPSpotProvider):
+    """Spot provider for Summits on the Air"""
+
     POLL_INTERVAL_SEC = 120
     # SOTA wants us to check for an "epoch" from the API and see if it's actually changed before querying the main data
     # APIs. So it's actually the EPOCH_URL that we pass into the constructor and get the superclass to call on a timer.
@@ -22,13 +22,13 @@ class SOTA(HTTPSpotProvider):
 
     def __init__(self, provider_config):
         super().__init__(provider_config, self.EPOCH_URL, self.POLL_INTERVAL_SEC)
-        self.api_epoch = ""
+        self._api_epoch = ""
 
-    def http_response_to_spots(self, http_response):
+    def _http_response_to_spots(self, http_response):
         # OK, source data is actually just the epoch at this point. We'll then go on to fetch real data if we know this
         # has changed.
-        epoch_changed = http_response.text != self.api_epoch
+        epoch_changed = http_response.text != self._api_epoch
-        self.api_epoch = http_response.text
+        self._api_epoch = http_response.text
 
         new_spots = []
         # OK, if the epoch actually changed, now we make the real request for data.
@@ -42,12 +42,15 @@ class SOTA(HTTPSpotProvider):
                             dx_call=source_spot["activatorCallsign"].upper(),
                             dx_name=source_spot["activatorName"],
                             de_call=source_spot["callsign"].upper(),
-                            freq=(float(source_spot["frequency"]) * 1000000) if (source_spot["frequency"] is not None) else None, # Seen SOTA spots with no frequency!
+                            freq=(float(source_spot["frequency"]) * 1000000) if (
+                                        source_spot["frequency"] is not None) else None,
+                            # Seen SOTA spots with no frequency!
                             mode=source_spot["mode"].upper(),
                             comment=source_spot["comments"],
-                            sig_refs=[SIGRef(id=source_spot["summitCode"], sig="SOTA", name=source_spot["summitName"])],
+                            sig="SOTA",
-                            time=datetime.fromisoformat(source_spot["timeStamp"]).timestamp(),
+                            sig_refs=[SIGRef(id=source_spot["summitCode"], sig="SOTA", name=source_spot["summitName"],
-                            activation_score=source_spot["points"])
+                                             activation_score=source_spot["points"])],
+                            time=datetime.fromisoformat(source_spot["timeStamp"].replace("Z", "+00:00")).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

@@ -2,53 +2,69 @@ from datetime import datetime
 
 import pytz
 
-from core.constants import SOFTWARE_NAME, SOFTWARE_VERSION
+from core.config import MAX_SPOT_AGE
-from core.config import SERVER_OWNER_CALLSIGN, MAX_SPOT_AGE
 
 
-# Generic spot provider class. Subclasses of this query the individual APIs for data.
 class SpotProvider:
+    """Generic spot provider class. Subclasses of this query the individual APIs for data."""
 
-    # Constructor
     def __init__(self, provider_config):
+        """Constructor"""
+
         self.name = provider_config["name"]
         self.enabled = provider_config["enabled"]
         self.last_update_time = datetime.min.replace(tzinfo=pytz.UTC)
         self.last_spot_time = datetime.min.replace(tzinfo=pytz.UTC)
         self.status = "Not Started" if self.enabled else "Disabled"
-        self.spots = None
+        self._spots = None
+        self._web_server = None
 
-    # Set up the provider, e.g. giving it the spot list to work from
+    def setup(self, spots, web_server):
-    def setup(self, spots):
+        """Set up the provider, e.g. giving it the spot list to work from"""
-        self.spots = spots
+
+        self._spots = spots
+        self._web_server = web_server
 
-    # Start the provider. This should return immediately after spawning threads to access the remote resources
     def start(self):
+        """Start the provider. This should return immediately after spawning threads to access the remote resources"""
+
         raise NotImplementedError("Subclasses must implement this method")
 
-    # Submit a batch of spots retrieved from the provider. Only spots that are newer than the last spot retrieved
+    def _submit_batch(self, spots):
-    # by this provider will be added to the spot list, to prevent duplications. Spots passing the check will also have
+        """Submit a batch of spots retrieved from the provider. Only spots that are newer than the last spot retrieved
-    # their infer_missing() method called to complete their data set. This is called by the API-querying
+        by this provider will be added to the spot list, to prevent duplications. Spots passing the check will also have
-    # subclasses on receiving spots.
+        their infer_missing() method called to complete their data set. This is called by the API-querying
-    def submit_batch(self, spots):
+        subclasses on receiving 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 s: (s.time if s and s.time else 0))
         for spot in spots:
             if datetime.fromtimestamp(spot.time, pytz.UTC) > self.last_spot_time:
-                # Fill in any blanks
+                # Fill in any blanks and add to the list
                 spot.infer_missing()
-                # Add to the list
+                self._add_spot(spot)
-                self.spots.add(spot.id, spot, expire=MAX_SPOT_AGE)
+        if spots:
             self.last_spot_time = datetime.fromtimestamp(max(map(lambda s: s.time, spots)), pytz.UTC)
 
-    # Submit a single spot retrieved from the provider. This will be added to the list regardless of its age. Spots
+    def _submit(self, spot):
-    # passing the check will also have their infer_missing() method called to complete their data set. This is called by
+        """Submit a single spot retrieved from the provider. This will be added to the list regardless of its age. Spots
-    # the data streaming subclasses, which can be relied upon not to re-provide old spots.
+        passing the check will also have their infer_missing() method called to complete their data set. This is called by
-    def submit(self, spot):
+        the data streaming subclasses, which can be relied upon not to re-provide old spots."""
-        # Fill in any blanks
+
+        # Fill in any blanks and add to the list
         spot.infer_missing()
-        # Add to the list
+        self._add_spot(spot)
-        self.spots.add(spot.id, spot, expire=MAX_SPOT_AGE)
         self.last_spot_time = datetime.fromtimestamp(spot.time, pytz.UTC)
 
-    # Stop any threads and prepare for application shutdown
+    def _add_spot(self, spot):
+        if not spot.expired():
+            self._spots.add(spot.id, spot, expire=MAX_SPOT_AGE)
+            # Ping the web server in case we have any SSE connections that need to see this immediately
+            if self._web_server:
+                self._web_server.notify_new_spot(spot)
+
     def stop(self):
+        """Stop any threads and prepare for application shutdown"""
+
         raise NotImplementedError("Subclasses must implement this method")

spotproviders/sse_spot_provider.py

@@ -9,30 +9,31 @@ from requests_sse import EventSource
 from core.constants import HTTP_HEADERS
 from spotproviders.spot_provider import SpotProvider
 
-# Spot provider using Server-Sent Events.
+
 class SSESpotProvider(SpotProvider):
+    """Spot provider using Server-Sent Events."""
 
     def __init__(self, provider_config, url):
         super().__init__(provider_config)
-        self.url = url
+        self._url = url
-        self.event_source = None
+        self._event_source = None
-        self.thread = None
+        self._thread = None
-        self.stopped = False
+        self._stopped = False
-        self.last_event_id = None
+        self._last_event_id = None
 
     def start(self):
         logging.info("Set up SSE connection to " + self.name + " spot API.")
-        self.stopped = False
+        self._stopped = False
-        self.thread = Thread(target=self.run)
+        self._thread = Thread(target=self._run)
-        self.thread.daemon = True
+        self._thread.daemon = True
-        self.thread.start()
+        self._thread.start()
 
     def stop(self):
-        self.stopped = True
+        self._stopped = True
-        if self.event_source:
+        if self._event_source:
-            self.event_source.close()
+            self._event_source.close()
-        if self.thread:
+        if self._thread:
-            self.thread.join()
+            self._thread.join()
 
     def _on_open(self):
         self.status = "Waiting for Data"
@@ -40,37 +41,39 @@ class SSESpotProvider(SpotProvider):
     def _on_error(self):
         self.status = "Connecting"
 
-    def run(self):
+    def _run(self):
-        while not self.stopped:
+        while not self._stopped:
             try:
                 logging.debug("Connecting to " + self.name + " spot API...")
                 self.status = "Connecting"
-                with EventSource(self.url, headers=HTTP_HEADERS, latest_event_id=self.last_event_id, timeout=30,
+                with EventSource(self._url, headers=HTTP_HEADERS, latest_event_id=self._last_event_id, timeout=30,
                                  on_open=self._on_open, on_error=self._on_error) as event_source:
-                    self.event_source = event_source
+                    self._event_source = event_source
-                    for event in self.event_source:
+                    for event in self._event_source:
                         if event.type == 'message':
                             try:
-                                self.last_event_id = event.last_event_id
+                                self._last_event_id = event.last_event_id
-                                new_spot = self.sse_message_to_spot(event.data)
+                                new_spot = self._sse_message_to_spot(event.data)
                                 if new_spot:
-                                    self.submit(new_spot)
+                                    self._submit(new_spot)
 
                                 self.status = "OK"
                                 self.last_update_time = datetime.now(pytz.UTC)
                                 logging.debug("Received data from " + self.name + " spot API.")
 
-                            except Exception as e:
+                            except Exception:
-                                logging.exception("Exception processing message from SSE Spot Provider (" + self.name + ")")
+                                logging.exception(
+                                    "Exception processing message from SSE Spot Provider (" + self.name + ")")
 
-            except Exception as e:
+            except Exception:
                 self.status = "Error"
                 logging.exception("Exception in SSE Spot Provider (" + self.name + ")")
             else:
                 self.status = "Disconnected"
             sleep(5)  # Wait before trying to reconnect
 
-    # Convert an SSE message received from the API into a spot. The whole message data is provided here so the subclass
+    def _sse_message_to_spot(self, message_data):
-    # implementations can handle the message as JSON, XML, text, whatever the API actually provides.
+        """Convert an SSE message received from the API into a spot. The whole message data is provided here so the subclass
-    def sse_message_to_spot(self, message_data):
+        implementations can handle the message as JSON, XML, text, whatever the API actually provides."""
+
         raise NotImplementedError("Subclasses must implement this method")

spotproviders/ukpacketnet.py

@@ -1,24 +1,22 @@
 import re
-from datetime import datetime, timedelta
+from datetime import datetime
 
 import pytz
-from requests_cache import CachedSession
 
-from core.constants import HTTP_HEADERS
-from core.sig_utils import get_icon_for_sig, get_ref_regex_for_sig
 from data.spot import Spot
 from spotproviders.http_spot_provider import HTTPSpotProvider
 
 
-# Spot provider for UK Packet Radio network API
 class UKPacketNet(HTTPSpotProvider):
+    """Spot provider for UK Packet Radio network API"""
+
     POLL_INTERVAL_SEC = 600
     SPOTS_URL = "https://nodes.ukpacketradio.network/api/nodedata"
 
     def __init__(self, provider_config):
         super().__init__(provider_config, self.SPOTS_URL, self.POLL_INTERVAL_SEC)
 
-    def http_response_to_spots(self, http_response):
+    def _http_response_to_spots(self, http_response):
         new_spots = []
         # Iterate through source data
         nodes = http_response.json()["nodes"]
@@ -38,20 +36,26 @@ class UKPacketNet(HTTPSpotProvider):
                                 # First build a "full" comment combining some of the extra info
                                 comment = listed_port["comment"] if "comment" in listed_port else ""
                                 comment = (comment + " " + listed_port["mode"]) if "mode" in listed_port else comment
-                                comment = (comment + " " + listed_port["modulation"]) if "modulation" in listed_port else comment
+                                comment = (comment + " " + listed_port[
-                                comment = (comment + " " + str(listed_port["baud"]) + " baud") if "baud" in listed_port and listed_port["baud"] > 0 else comment
+                                    "modulation"]) if "modulation" in listed_port else comment
+                                comment = (comment + " " + str(
+                                    listed_port["baud"]) + " baud") if "baud" in listed_port and listed_port[
+                                    "baud"] > 0 else comment
 
                                 # Get frequency from the comment if it's not set properly in the data structure. This is
                                 # very hacky but a lot of node comments contain their frequency as the first or second
                                 # word of their comment, but not in the proper data structure field.
-                                freq = listed_port["freq"] if "freq" in listed_port and listed_port["freq"] > 0 else None
+                                freq = listed_port["freq"] if "freq" in listed_port and listed_port[
+                                    "freq"] > 0 else None
                                 if not freq and comment:
                                     possible_freq = comment.split(" ")[0].upper().replace("MHZ", "")
-                                    if re.match(r"^[0-9.]+$", possible_freq) and possible_freq != "1200" and possible_freq != "9600":
+                                    if re.match(r"^[0-9.]+$",
+                                                possible_freq) and possible_freq != "1200" and possible_freq != "9600":
                                         freq = float(possible_freq) * 1000000
                                     if not freq and len(comment.split(" ")) > 1:
                                         possible_freq = comment.split(" ")[1].upper().replace("MHZ", "")
-                                        if re.match(r"^[0-9.]+$", possible_freq) and possible_freq != "1200" and possible_freq != "9600":
+                                        if re.match(r"^[0-9.]+$",
+                                                    possible_freq) and possible_freq != "1200" and possible_freq != "9600":
                                             freq = float(possible_freq) * 1000000
                                     # Check for a found frequency likely having been in kHz, sorry to all GHz packet folks
                                     if freq and freq > 1000000000:
@@ -64,9 +68,10 @@ class UKPacketNet(HTTPSpotProvider):
                                             freq=freq,
                                             mode="PKT",
                                             comment=comment,
-                                            icon="tower-cell",
+                                            time=datetime.strptime(heard["lastHeard"], "%Y-%m-%d %H:%M:%S").replace(
-                                            time=datetime.strptime(heard["lastHeard"], "%Y-%m-%d %H:%M:%S").replace(tzinfo=pytz.UTC).timestamp(),
+                                                tzinfo=pytz.UTC).timestamp(),
-                                            de_grid=node["location"]["locator"] if "locator" in node["location"] else None,
+                                            de_grid=node["location"]["locator"] if "locator" in node[
+                                                "location"] else None,
                                             de_latitude=node["location"]["coords"]["lat"],
                                             de_longitude=node["location"]["coords"]["lon"])
 
@@ -81,7 +86,8 @@ class UKPacketNet(HTTPSpotProvider):
         # data, and we can use that to look these up.
         for spot in new_spots:
             if spot.dx_call in nodes:
-                spot.dx_grid = nodes[spot.dx_call]["location"]["locator"] if "locator" in nodes[spot.dx_call]["location"] else None
+                spot.dx_grid = nodes[spot.dx_call]["location"]["locator"] if "locator" in nodes[spot.dx_call][
+                    "location"] else None
                 spot.dx_latitude = nodes[spot.dx_call]["location"]["coords"]["lat"]
                 spot.dx_longitude = nodes[spot.dx_call]["location"]["coords"]["lon"]
 

spotproviders/websocket_spot_provider.py

@@ -0,0 +1,77 @@
+import logging
+from datetime import datetime
+from threading import Thread
+from time import sleep
+
+import pytz
+from websocket import create_connection
+
+from core.constants import HTTP_HEADERS
+from spotproviders.spot_provider import SpotProvider
+
+
+class WebsocketSpotProvider(SpotProvider):
+    """Spot provider using websockets."""
+
+    def __init__(self, provider_config, url):
+        super().__init__(provider_config)
+        self._url = url
+        self._ws = None
+        self._thread = None
+        self._stopped = False
+        self._last_event_id = None
+
+    def start(self):
+        logging.info("Set up websocket connection to " + self.name + " spot API.")
+        self._stopped = False
+        self._thread = Thread(target=self._run)
+        self._thread.daemon = True
+        self._thread.start()
+
+    def stop(self):
+        self._stopped = True
+        if self._ws:
+            self._ws.close()
+        if self._thread:
+            self._thread.join()
+
+    def _on_open(self):
+        self.status = "Waiting for Data"
+
+    def _on_error(self):
+        self.status = "Connecting"
+
+    def _run(self):
+        while not self._stopped:
+            try:
+                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:
+                        new_spot = self._ws_message_to_spot(data)
+                        if new_spot:
+                            self._submit(new_spot)
+
+                        self.status = "OK"
+                        self.last_update_time = datetime.now(pytz.UTC)
+                        logging.debug("Received data from " + self.name + " spot API.")
+
+                    except Exception:
+                        logging.exception(
+                            "Exception processing message from Websocket Spot Provider (" + self.name + ")")
+
+            except Exception as e:
+                self.status = "Error"
+                logging.exception("Exception in Websocket Spot Provider (" + self.name + ")", e)
+            else:
+                self.status = "Disconnected"
+            sleep(5)  # Wait before trying to reconnect
+
+    def _ws_message_to_spot(self, b):
+        """Convert a WS message received from the API into a spot. The exact message data (in bytes) is provided here so the
+        subclass implementations can handle the message as string, JSON, XML, whatever the API actually provides."""
+
+        raise NotImplementedError("Subclasses must implement this method")

spotproviders/wota.py

@@ -1,16 +1,18 @@
+import logging
+import re
 from datetime import datetime
 
 import pytz
 from rss_parser import RSSParser
 
-from core.sig_utils import get_icon_for_sig
 from data.sig_ref import SIGRef
 from data.spot import Spot
 from spotproviders.http_spot_provider import HTTPSpotProvider
 
 
-# Spot provider for Wainwrights on the Air
 class WOTA(HTTPSpotProvider):
+    """Spot provider for Wainwrights on the Air"""
+
     POLL_INTERVAL_SEC = 120
     SPOTS_URL = "https://www.wota.org.uk/spots_rss.php"
     LIST_URL = "https://www.wota.org.uk/mapping/data/summits.json"
@@ -19,12 +21,13 @@ class WOTA(HTTPSpotProvider):
     def __init__(self, provider_config):
         super().__init__(provider_config, self.SPOTS_URL, self.POLL_INTERVAL_SEC)
 
-    def http_response_to_spots(self, http_response):
+    def _http_response_to_spots(self, http_response):
         new_spots = []
         rss = RSSParser.parse(http_response.content.decode())
         # Iterate through source data
         for source_spot in rss.channel.items:
 
+            try:
                 # Reject GUID missing or zero
                 if not source_spot.guid or not source_spot.guid.content or source_spot.guid.content == "http://www.wota.org.uk/spots/0":
                     continue
@@ -43,16 +46,18 @@ class WOTA(HTTPSpotProvider):
                 # Pick apart the description
                 desc_split = source_spot.description.split(". ")
                 freq_mode = desc_split[0].replace("Frequencies/modes:", "").strip()
-            freq_mode_split = freq_mode.split("-")
+                freq_mode_split = re.split(r'[\-\s]+', freq_mode)
                 freq_hz = float(freq_mode_split[0]) * 1000000
-            mode = freq_mode_split[1]
+                mode = None
+                if len(freq_mode_split) > 1:
+                    mode = freq_mode_split[1].upper()
 
                 comment = None
                 if len(desc_split) > 1:
                     comment = desc_split[1].strip()
                 spotter = None
                 if len(desc_split) > 2:
-                spotter = desc_split[2].replace("Spotted by ", "").replace(".", "").strip()
+                    spotter = desc_split[2].replace("Spotted by ", "").replace(".", "").upper().strip()
 
                 time = datetime.strptime(source_spot.pub_date.content, self.RSS_DATE_TIME_FORMAT).astimezone(pytz.UTC)
 
@@ -64,8 +69,11 @@ class WOTA(HTTPSpotProvider):
                             freq=freq_hz,
                             mode=mode,
                             comment=comment,
+                            sig="WOTA",
                             sig_refs=[SIGRef(id=ref, sig="WOTA", name=ref_name)] if ref else [],
                             time=time.timestamp())
 
                 new_spots.append(spot)
+            except Exception as e:
+                logging.error("Exception parsing WOTA spot", e)
         return new_spots

spotproviders/wwbota.py

@@ -1,20 +1,20 @@
 import json
 from datetime import datetime
 
-from core.sig_utils import get_icon_for_sig
 from data.sig_ref import SIGRef
 from data.spot import Spot
 from spotproviders.sse_spot_provider import SSESpotProvider
 
 
-# Spot provider for Worldwide Bunkers on the Air
 class WWBOTA(SSESpotProvider):
+    """Spot provider for Worldwide Bunkers on the Air"""
+
     SPOTS_URL = "https://api.wwbota.net/spots/"
 
     def __init__(self, provider_config):
         super().__init__(provider_config, self.SPOTS_URL)
 
-    def sse_message_to_spot(self, message):
+    def _sse_message_to_spot(self, message):
         source_spot = json.loads(message)
         # Convert to our spot format. First we unpack references, because WWBOTA spots can have more than one for
         # n-fer activations.
@@ -29,8 +29,9 @@ class WWBOTA(SSESpotProvider):
                     freq=float(source_spot["freq"]) * 1000000,
                     mode=source_spot["mode"].upper(),
                     comment=source_spot["comment"],
+                    sig="WWBOTA",
                     sig_refs=refs,
-                    time=datetime.fromisoformat(source_spot["time"]).timestamp(),
+                    time=datetime.fromisoformat(source_spot["time"].replace("Z", "+00:00")).timestamp(),
                     # WWBOTA spots can contain multiple references for bunkers being activated simultaneously. For
                     # now, we will just pick the first one to use as our grid, latitude and longitude.
                     dx_grid=source_spot["references"][0]["locator"],

spotproviders/wwff.py

@@ -2,21 +2,21 @@ from datetime import datetime
 
 import pytz
 
-from core.sig_utils import get_icon_for_sig
 from data.sig_ref import SIGRef
 from data.spot import Spot
 from spotproviders.http_spot_provider import HTTPSpotProvider
 
 
-# Spot provider for Worldwide Flora & Fauna
 class WWFF(HTTPSpotProvider):
+    """Spot provider for Worldwide Flora & Fauna"""
+
     POLL_INTERVAL_SEC = 120
     SPOTS_URL = "https://spots.wwff.co/static/spots.json"
 
     def __init__(self, provider_config):
         super().__init__(provider_config, self.SPOTS_URL, self.POLL_INTERVAL_SEC)
 
-    def http_response_to_spots(self, http_response):
+    def _http_response_to_spots(self, http_response):
         new_spots = []
         # Iterate through source data
         for source_spot in http_response.json():
@@ -28,6 +28,7 @@ class WWFF(HTTPSpotProvider):
                         freq=float(source_spot["frequency_khz"]) * 1000,
                         mode=source_spot["mode"].upper(),
                         comment=source_spot["remarks"],
+                        sig="WWFF",
                         sig_refs=[SIGRef(id=source_spot["reference"], sig="WWFF", name=source_spot["reference_name"])],
                         time=datetime.fromtimestamp(source_spot["spot_time"], tz=pytz.UTC).timestamp(),
                         dx_latitude=source_spot["latitude"],

spotproviders/wwtota.py

@@ -0,0 +1,42 @@
+from datetime import datetime
+
+import json
+
+from data.sig_ref import SIGRef
+from data.spot import Spot
+from spotproviders.http_spot_provider import HTTPSpotProvider
+
+
+class WWTOTA(HTTPSpotProvider):
+    """Spot provider for Towers on the Air"""
+
+    POLL_INTERVAL_SEC = 120
+    SPOTS_URL = "https://wwtota.com/api/cluster_live.php"
+
+    def __init__(self, provider_config):
+        super().__init__(provider_config, self.SPOTS_URL, self.POLL_INTERVAL_SEC)
+
+    def _http_response_to_spots(self, http_response):
+        new_spots = []
+        response_fixed = http_response.text.replace("\\/", "/")
+        response_json = json.loads(response_fixed)
+
+        # Iterate through source data
+        for source_spot in response_json["spots"]:
+            # Convert to our spot format
+            likely_freq = float(source_spot["freq"]) * 1000
+            if likely_freq < 1000000:
+                likely_freq = likely_freq * 1000
+            spot = Spot(source=self.name,
+                        dx_call=source_spot["call"].upper(),
+                        freq=likely_freq,
+                        comment=source_spot["comment"],
+                        sig="WWTOTA",
+                        sig_refs=[SIGRef(id=source_spot["ref"], sig="WWTOTA")],
+                        time=datetime.strptime(response_json["updated"][:10] + source_spot["time"],
+                                               "%Y-%m-%d%H:%M").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.
+            new_spots.append(spot)
+        return new_spots

spotproviders/xota.py

@@ -0,0 +1,57 @@
+import csv
+import json
+import logging
+from datetime import datetime
+
+import pytz
+
+from data.sig_ref import SIGRef
+from data.spot import Spot
+from spotproviders.websocket_spot_provider import WebsocketSpotProvider
+
+
+class XOTA(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 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."""
+
+    LOCATION_DATA = {}
+    SIG = None
+
+    def __init__(self, provider_config):
+        super().__init__(provider_config, provider_config["url"])
+        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, b):
+        string = b.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=ref_id, sig=self.SIG, url=source_spot["reference"]["website"], latitude=lat,
+                                     longitude=lon)],
+                    time=datetime.now(pytz.UTC).timestamp(),
+                    dx_latitude=lat,
+                    dx_longitude=lon,
+                    qrt=source_spot["state"] != "active")
+        return spot

spotproviders/zlota.py

@@ -2,14 +2,14 @@ from datetime import datetime
 
 import pytz
 
-from core.sig_utils import get_icon_for_sig
 from data.sig_ref import SIGRef
 from data.spot import Spot
 from spotproviders.http_spot_provider import HTTPSpotProvider
 
 
-# Spot provider for ZLOTA
 class ZLOTA(HTTPSpotProvider):
+    """Spot provider for ZLOTA"""
+
     POLL_INTERVAL_SEC = 120
     SPOTS_URL = "https://ontheair.nz/api/spots?zlota_only=true"
     LIST_URL = "https://ontheair.nz/assets/assets.json"
@@ -17,7 +17,7 @@ class ZLOTA(HTTPSpotProvider):
     def __init__(self, provider_config):
         super().__init__(provider_config, self.SPOTS_URL, self.POLL_INTERVAL_SEC)
 
-    def http_response_to_spots(self, http_response):
+    def _http_response_to_spots(self, http_response):
         new_spots = []
         # Iterate through source data
         for source_spot in http_response.json():
@@ -34,8 +34,10 @@ class ZLOTA(HTTPSpotProvider):
                         freq=freq_hz,
                         mode=source_spot["mode"].upper().strip(),
                         comment=source_spot["comments"],
+                        sig="ZLOTA",
                         sig_refs=[SIGRef(id=source_spot["reference"], sig="ZLOTA", name=source_spot["name"])],
-                        time=datetime.fromisoformat(source_spot["referenced_time"]).astimezone(pytz.UTC).timestamp())
+                        time=datetime.fromisoformat(source_spot["referenced_time"].replace("Z", "+00:00")).astimezone(
+                            pytz.UTC).timestamp())
 
             new_spots.append(spot)
         return new_spots

templates/about.html

@@ -0,0 +1,72 @@
+{% extends "base.html" %}
+{% block content %}
+
+<div id="info-container" class="mt-4">
+    <h2 class="mt-4 mb-4">About Spothole</h2>
+    <p>Spothole is a utility to aggregate "spots" from amateur radio DX clusters and xOTA spotting sites, and provide an open JSON API as well as a website to browse the data.</p>
+    <p>While there are several other web-based interfaces to DX clusters, and sites that aggregate spots from various outdoor activity programmes for amateur radio, Spothole differentiates itself by supporting a larger number of data sources, and by being "API first" rather than just providing a web front-end. This allows other software to be built on top of it.</p>
+    <p>The API is deliberately well-defined with an <a href="/apidocs/openapi.yml">OpenAPI specification</a> and <a href="/apidocs">API documentation</a>. The API delivers spots in a consistent format regardless of the data source, freeing developers from needing to know how each individual data source presents its data.</p>
+    <p>Spothole itself is also open source, Public Domain licenced code that anyone can take and modify. <a href="https://git.ianrenton.com/ian/metaspot/">The source code is here</a>.</p>
+    <p>The software was written by <a href="https://ianrenton.com">Ian Renton, MØTRT</a> and other contributors. Full details are available in the <a href="https://git.ianrenton.com/ian/spothole/src/branch/main/README.md">README file</a>.</p>
+    <p>This server is running Spothole version {{software_version}}.</p>
+    <h2 class="mt-4 mb-4">Using Spothole</h2>
+    <p>There are a number of different ways to use Spothole, depending on what you want to do with it and your level of technical skill:</p>
+    <ol><li>You can <b>use it on the web</b>, like you are (probably) doing right now. This is how most people use it, to look up spots and alerts, and make interesting QSOs.</li>
+    <li>If you are using an Android or iOS device, you can <b>"install" it on your device</b>. Spothole is a Progressive Web App, meaning it's not delivered through app stores, but if you open the page on Chrome (Android) or Safari (iOS) there will be an option in the menu to install it. It will then appear in your main app menu.</li>
+    <li>You can <b>embed the web interface in another website</b> to show its spots in a custom dashboard or the like. The usage is explained in more detail in the <a href="https://git.ianrenton.com/ian/spothole/src/branch/main/README.md">README file</a>.</li>
+    <li>You can <b>write your own client using the Spothole API</b>, using the main Spothole instance to provide data, and do whatever you like with it. The README contains guidance on how to do this, and the full API docs are linked above. You can also find reference implementations in the form of Spothole's own web-based front end, plus my other two tools built on Spothole: <a href="https://fieldspotter.radio">Field Spotter</a> and the <a href="https://qsomap.m0trt.radio">QSO Map Tool</a>.</li>
+    <li>If you want to <b>run your own version of Spothole</b> so you can customise the configuration, such as enabling sources that I disable on the main instance, you can do that too. The README contains not only advice on how to set up Spothole but how to get it auto-starting with systemd, using an nginx reverse proxy, and setting up HTTPS support with certbot.</li>
+    <li>Finally, you can of course download the source code and <b>develop Spothole to meet your needs</b>. Whether you contribute your changes back to the main repository is up to you. As usual, the README file contains some advice on the structure of the repository, and how to get started writing your own spot provider.</li></ol>
+    <h2 id="faq" class="mt-4">FAQ</h2>
+    <h4 class="mt-4">"Spots"? "DX Clusters"? What does any of this mean?</h4>
+    <p>This is a tool for amateur ("ham") radio users. Many amateur radio operators like to make contacts with others who are doing something more interesting than sitting in their home "shack", such as people in rarely-seen countries, remote islands, or on mountaintops. Such operators are often "spotted", i.e. when someone speaks to them, they will put the details such as their operating frequency into an online system, to let others know where to find them. A DX Cluster is one type of those systems. Most outdoor radio awards programmes, such as "Parks on the Air" (POTA) have their own websites for posting spots.</p>
+    <p>Spothole is an "aggregator" for those spots, so it checks lots of different services for data, and brings it all together in one place. So no matter what kinds of interesting spots you are looking for, you can find them here.</p>
+    <p>As well as spots, it also provides a similar feed of "alerts". This is where amateur radio users who are going to interesting places soon will announce their intentions.</p>
+    <h4 class="mt-4">What are "DX", "DE" and modes?</h4>
+    <p>In amateur radio terminology, the "DX" contact is the "interesting" one that is using the frequency shown and looking for callers. They might be on a remote island or just in a local park, but either way it's interesting enough that someone has "spotted" them. The callsign listed under "DE" is the person who entered the spot of the "DX" operator. "Modes" are the type of communication they are using. For example you might see "CW" which is Morse Code, or voice "modes" like SSB or FM, or more exotic "data" modes which are used for computer-to-computer communication.</p>
+    <h4 class="mt-4">What data sources are supported?</h4>
+    <p>Spothole can retrieve spots from: <a href="https://www.dxcluster.info/telnet/">Telnet-based DX clusters</a>, the <a href="https://www.reversebeacon.net/">Reverse Beacon Network (RBN)</a>, the <a href="https://www.aprs-is.net/">APRS Internet Service (APRS-IS)</a>, <a href="https://pota.app">POTA</a>, <a href="https://www.sota.org.uk/">SOTA</a>, <a href="https://wwff.co/">WWFF</a>, <a href="https://www.cqgma.org/">GMA</a>, <a href="https://wwbota.net/">WWBOTA</a>, <a href="http://www.hema.org.uk/">HEMA</a>, <a href="https://www.parksnpeaks.org/">Parks 'n' Peaks</a>, <a href="https://ontheair.nz">ZLOTA</a>, <a href="https://www.wota.org.uk/">WOTA</a>, <a href="https://llota.app">LLOTA</a>, <a href="https://wwtota.com">WWTOTA</a>, the <a href="https://ukpacketradio.network/">UK Packet Repeater Network</a>, and any site based on the <a href="https://github.com/nischu/xOTA">xOTA software by nischu</a>.</p>
+    <p>Spothole can retrieve alerts from: <a href="https://www.ng3k.com/">NG3K</a>, <a href="https://pota.app">POTA</a>, <a href="https://www.sota.org.uk/">SOTA</a>, <a href="https://wwff.co/">WWFF</a>, <a href="https://www.parksnpeaks.org/">Parks 'n' Peaks</a>, <a href="https://www.wota.org.uk/">WOTA</a> and <a href="https://www.beachesontheair.com/">BOTA</a>.</p>
+    <p>Note that the server owner has not necessarily enabled all these data sources. In particular it is common to disable RBN, to avoid the server being swamped with FT8 traffic, and to disable APRS-IS and UK Packet Net so that the server only displays stations where there is likely to be an operator physically present for a QSO.</p>
+    <p>Between the various data sources, the following Special Interest Groups (SIGs) are supported: Parks on the Air (POTA), Summits on the Air (SOTA), Worldwide Flora & Fauna (WWFF), Global Mountain Activity (GMA), Worldwide Bunkers on the Air (WWBOTA), HuMPs Excluding Marilyns Award (HEMA), Islands on the Air (IOTA), Mills on the Air (MOTA), the Amateur Radio Lighthouse Socirty (ARLHS), International Lighthouse Lightship Weekend (ILLW), Silos on the Air (SIOTA), World Castles Award (WCA), New Zealand on the Air (ZLOTA), Keith Roget Memorial National Parks Award (KRMNPA), Wainwrights on the Air (WOTA), Beaches on the Air (BOTA), Lagos y Lagunas On the Air (LLOTA), Towers on the Air (WWTOTA), Worked All Britain (WAB), Worked All Ireland (WAI), and Toilets on the Air (TOTA).</p>
+    <p>As of the time of writing in November 2025, I think Spothole captures essentially all outdoor radio programmes that have a defined reference list, and almost certainly those that have a spotting/alerting API. If you know of one I've missed, please let me know!</p>
+    <h4 class="mt-4">Why can I filter spots by both SIG and Source? Isn't that basically the same thing?</h4>
+    <p>Mostly, but not quite. While POTA spots generally come from the POTA source and so on, there are a few exceptions:</p>
+    <ol><li>Sources like GMA and Parks 'n' Peaks provide spots for multiple different programmes (SIGs).</li>
+    <li>Cluster spots may name SIGs in their comment, in which case the source remains the Cluster, but a SIG is assigned.</li>
+    <li>Some SIGs, such as Worked all Britain (WAB), don't have their own spotting site and can <em>only</em> be identified through comments on spots retrieved from other sources.</li>
+    <li>SIGs have well-defined names, whereas the server owner may name the sources as they see fit.</li></ol>
+    <p>Spothole's web interface exists not just for the end user, but also as a reference implementation for the API, so I have chosen to demonstrate both methods of filtering.</p>
+    <h4 class="mt-4">How is this better than DXheat, DXsummit, POTA's own website, etc?</h4>
+    <p>It's probably not? But it's nice to have choice.</p>
+    <p>I think it's got three key advantages over those sites:</p>
+    <ol><li>It provides a public, <a href="/apidocs">well-documented API</a> with an <a href="/apidocs/openapi.yml">OpenAPI specification</a>. Other sites don't have official APIs or don't bother documenting them publicly, because they want people to use their web page. I like Spothole's web page, but you don't have to use it&mdash;if you're a programmer, you can build your own software on Spothole's API. Spothole does the hard work of taking all the various data sources and providing a consistent, well-documented data set. You can then do the fun bit of writing your own application.</li>
+    <li>It grabs data from a lot more sources. I've seen other sites that pull in DX Cluster and POTA spots together, but nothing on the scale of what Spothole supports.</li>
+    <li>Spothole is open source, so anyone can contribute the code to support a new data source or add new features, and share them with the community.</li></ol>
+    <h4 class="mt-4">Why does this website ask me if I want to install it?</h4>
+    <p>Spothole is a Progressive Web App, which means you can install it on an Android or iOS device by opening the site in Chrome or Safari respectively, and clicking "Install" on the pop-up panel. It'll only prompt you once, so if you dismiss the prompt and change your mind, you'll find an Install / Add to Home Screen option on your browser's menu.</p>
+    <p>Installing Spothole on your phone is completely optional, the website works exactly the same way as the "app" does.</p>
+    <h4 class="mt-4">Why hasn't my spot/alert shown up yet?</h4>
+    <p>To avoid putting too much load on the various servers that Spothole connects to, the Spothole server only polls them once every two minutes for spots, and once every 30 minutes for alerts. (Some sources, such as DX clusters, RBN, APRS-IS and WWBOTA use a non-polling mechanism, and their updates will therefore arrive more quickly.) Then if you are using the web interface, that has its own rate at which it fetches the data from Spothole. This is instant for the main spots list, with new spots appearing immediately at the top of the list, while the map and bands displays update once a minute, and the alerts display updates once every 5 minutes. So you could be waiting around three minutes to see a newly added spot, or 40 minutes to see a newly added alert.</p>
+    <h4 class="mt-4">What licence does Spothole use?</h4>
+    <p>Spothole's source code is licenced under the Public Domain. You can write a Spothole client, run your own server, modify it however you like, you can claim you wrote it and charge people £1000 for a copy, I don't really mind. (Please don't do the last one. But if you're using my code for something cool, it would be nice to hear from you!)</p>
+    <h2 class="mt-4">Data Accuracy</h2>
+    <p>Please note that the data coming out of Spothole is only as good as the data going in. People mis-hear and make typos when spotting callsigns all the time. There are also plenty of cases where Spothole's data, particularly location data, may be inaccurate. For example, there are POTA parks that span multiple US states, countries that span multiple CQ zones, portable operators with no requirement to sign /P, etc. 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.</p>
+    <h2 id="privacy" class="mt-4">Privacy</h2>
+    <p>Spothole collects no data about you, and there is no way to enter personally identifying information into the site apart from by spotting and alerting through Spothole or the various services it connects to. All spots and alerts are "timed out" and deleted from the system after a set interval, which by default is one hour for spots and one week for alerts.</p>
+    <p>Settings you select from Spothole's menus are sent to the server, in order to provide the data with the requested filters. They are also stored in your browser's local storage, so that your preferences are remembered between sessions.</p>
+    <p>There are no trackers, no ads, and no cookies.</p>
+    {% if len(web_ui_options["support-button-html"]) > 0 %}
+        <p><strong>Caveat: </strong> The owner of this server has chosen to inject their own content into the "spots" page. This is designed for a "donate" or "support this server" button. The functionality of this injected content is the responsibility of the server owner, rather than the Spothole software.</p>
+    {% end %}
+    <p>Spothole is open source, so you can audit <a href="https://git.ianrenton.com/ian/spothole">the code</a> if you like.</p>
+    <h2 class="mt-4">Thanks</h2>
+    <p>This project would not have been possible without those volunteers who have taken it upon themselves to run DX clusters, xOTA programmes, DXpedition lists, callsign lookup databases, and other online tools on which Spothole's data is based.</p>
+    <p>Spothole is also dependent on a number of Python libraries, in particular pyhamtools, and many JavaScript libraries, as well as the Font Awesome icon set and flag icons from the Noto Color Emoji set, and MIT-licenced GeoJSON files for CQ and ITU zones from HA8TKS.</p>
+    <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=1772224426"></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"></script>
+<script src="/js/common.js?v=1772224426"></script>
-<script src="/js/add-spot.js"></script>
+<script src="/js/add-spot.js?v=1772224426"></script>
 <script>$(document).ready(function() { $("#nav-link-add-spot").addClass("active"); }); <!-- highlight active page in nav --></script>
+
+{% end %}

templates/alerts.html

@@ -0,0 +1,63 @@
+{% extends "base.html" %}
+{% block content %}
+
+<div class="mt-3">
+    <div id="settingsButtonRow" class="row mb-3">
+        <div class="col-auto me-auto pt-3">
+            {% module Template("widgets/refresh-timer.html", web_ui_options=web_ui_options) %}
+        </div>
+        <div class="col-auto">
+            <div class="d-inline-flex gap-1">
+                {% module Template("widgets/filters-display-buttons.html", web_ui_options=web_ui_options) %}
+            </div>
+        </div>
+    </div>
+
+    <div id="filters-area" class="appearing-panel card mb-3">
+        {% module Template("widgets/filters-area-header.html", web_ui_options=web_ui_options) %}
+        <div class="card-body">
+            <div class="row row-cols-1 row-cols-md-3 g-4">
+                <div class="col">
+                    {% module Template("cards/dx-continent.html", web_ui_options=web_ui_options) %}
+                </div>
+                <div class="col">
+                    {% module Template("cards/sources.html", web_ui_options=web_ui_options) %}
+                </div>
+                <div class="col">
+                    {% module Template("cards/duration-limit-alerts.html", web_ui_options=web_ui_options) %}
+                </div>
+            </div>
+        </div>
+    </div>
+
+    <div id="display-area" class="appearing-panel card mb-3">
+        {% module Template("widgets/display-area-header.html", web_ui_options=web_ui_options) %}
+        <div class="card-body">
+            <div id="display-container" class="row row-cols-1 row-cols-md-3 g-4">
+                <div class="col">
+                    {% module Template("cards/time-zone.html", web_ui_options=web_ui_options) %}
+                </div>
+                <div class="col">
+                    {% module Template("cards/number-of-alerts.html", web_ui_options=web_ui_options) %}
+                </div>
+                <div class="col">
+                    {% module Template("cards/color-scheme.html", web_ui_options=web_ui_options) %}
+                </div>
+                <div class="col">
+                    {% module Template("cards/table-columns-alerts.html", web_ui_options=web_ui_options) %}
+                </div>
+            </div>
+        </div>
+    </div>
+
+    <div id="table-container">
+        <table id="table" class="table"><thead><tr class="table-primary"></tr></thead><tbody></tbody></table>
+    </div>
+
+</div>
+
+<script src="/js/common.js?v=1772224426"></script>
+<script src="/js/alerts.js?v=1772224426"></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

@@ -0,0 +1,70 @@
+{% extends "base.html" %}
+{% block content %}
+
+<div class="mt-3">
+    <div id="settingsButtonRow" class="row mb-3">
+        <div class="col-auto me-auto pt-3">
+            {% module Template("widgets/refresh-timer.html", web_ui_options=web_ui_options) %}
+        </div>
+        <div class="col-auto">
+            <div class="d-inline-flex gap-1">
+                {% module Template("widgets/filters-display-buttons.html", web_ui_options=web_ui_options) %}
+            </div>
+        </div>
+    </div>
+
+    <div id="filters-area" class="appearing-panel card mb-3">
+        {% module Template("widgets/filters-area-header.html", web_ui_options=web_ui_options) %}
+        <div class="card-body">
+            <div class="row row-cols-1 g-4 mb-4 row-cols-md-3">
+                <div class="col">
+                    {% module Template("cards/bands.html", web_ui_options=web_ui_options) %}
+                </div>
+                <div class="col">
+                    {% module Template("cards/sigs.html", web_ui_options=web_ui_options) %}
+                </div>
+                <div class="col">
+                    {% module Template("cards/sources.html", web_ui_options=web_ui_options) %}
+                </div>
+            </div>
+            <div class="row row-cols-1 row-cols-md-3 g-4">
+                <div class="col">
+                    {% module Template("cards/dx-continent.html", web_ui_options=web_ui_options) %}
+                </div>
+                <div class="col">
+                    {% module Template("cards/de-continent.html", web_ui_options=web_ui_options) %}
+                </div>
+                <div class="col">
+                    {% module Template("cards/modes.html", web_ui_options=web_ui_options) %}
+                </div>
+            </div>
+        </div>
+    </div>
+
+    <div id="display-area" class="appearing-panel card mb-3">
+        {% module Template("widgets/display-area-header.html", web_ui_options=web_ui_options) %}
+        <div class="card-body">
+            <div id="display-container" class="row row-cols-1 row-cols-md-4 g-4">
+                <div class="col">
+                    {% module Template("cards/spot-age.html", web_ui_options=web_ui_options) %}
+                </div>
+                <div class="col">
+                    {% module Template("cards/color-scheme-and-band-color-scheme.html", web_ui_options=web_ui_options) %}
+                </div>
+            </div>
+        </div>
+    </div>
+
+    <div id="bands-container"></div>
+
+</div>
+
+<script>
+    let spotProvidersEnabledByDefault = {% raw json_encode(web_ui_options["spot-providers-enabled-by-default"]) %};
+</script>
+<script src="/js/common.js?v=1772224426"></script>
+<script src="/js/spotsbandsandmap.js?v=1772224426"></script>
+<script src="/js/bands.js?v=1772224426"></script>
+<script>$(document).ready(function() { $("#nav-link-bands").addClass("active"); }); <!-- highlight active page in nav --></script>
+
+{% end %}

templates/base.html

@@ -3,7 +3,7 @@
 <head>
     <meta charset="utf-8"/>
     <meta name="viewport" content="width=device-width, initial-scale=1.0, viewport-fit=cover">
-    <meta name="color-scheme" content="light">
+    <meta name="color-scheme" content="light dark">
     <meta name="theme-color" content="white"/>
     <meta name="mobile-web-app-capable" content="yes">
     <meta name="apple-mobile-web-app-capable" content="yes">
@@ -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,27 +44,33 @@
     <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=1772224426"></script>
+    <script src="https://misc.ianrenton.com/jsutils/storage.js?v=1772224426"></script>
+    <script src="https://misc.ianrenton.com/jsutils/ui-ham.js?v=1772224426"></script>
+    <script src="https://misc.ianrenton.com/jsutils/geo.js?v=1772224426"></script>
 
 </head>
 <body>
 <div class="container">
-    <nav class="navbar navbar-expand-lg bg-body p-0 border-bottom">
+    <nav id="header" class="navbar navbar-expand-lg bg-body p-0 border-bottom">
         <div class="container-fluid p-0">
             <a class="navbar-brand" href="/">
-                <img src="/img/logo.png" width="192" height="60" alt="Spothole">
+                <img src="/img/logo.png" class="logo" width="192" height="60" alt="Spothole">
             </a>
-            <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbarTogglerDemo02" aria-controls="navbarTogglerDemo02" aria-expanded="false" aria-label="Toggle navigation">
+            <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar-toggler-content" aria-controls="navbar-toggler-content" aria-expanded="false" aria-label="Toggle navigation">
               <span class="navbar-toggler-icon"></span>
             </button>
-            <div class="collapse navbar-collapse" id="navbarTogglerDemo02">
+            <div class="collapse navbar-collapse" id="navbar-toggler-content">
                 <ul class="navbar-nav me-auto mb-2 mb-lg-0">
                     <li class="nav-item ms-4"><a href="/" class="nav-link" id="nav-link-spots"><i class="fa-solid fa-tower-cell"></i> Spots</a></li>
                     <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:
+                  {% 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>
+                    <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
+                  {% 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,11 +81,11 @@
 
     <main>
 
-{{!base}}
+{% block content %}{% end %}
 
     </main>
 
-    <div class="hideonmobile hideonmap">
+    <div id="footer" class="hideonmobile hideonmap">
         <footer class="d-flex flex-wrap justify-content-between align-items-center py-3 my-4 border-top">
             <p class="col-md-4 mb-0 text-body-secondary">Made with love by <a href="https://ianrenton.com" class="text-body-secondary">Ian, MØTRT</a> and other contributors.</p>
             <p class="col-md-4 mb-0 justify-content-center text-body-secondary" style="text-align: center;">Spothole v{{software_version}}</p>
@@ -101,5 +107,7 @@
     </div>
 </div>
 
+<div id="embeddedModeFooter" class="text-body-secondary pt-2 px-3 pb-1">Powered by <img src="/img/logo.png" class="logo" width="96" height="30" alt="Spothole"></div>
+
 </body>
 </html>

templates/cards/bands.html

@@ -0,0 +1,6 @@
+<div class="card">
+    <div class="card-body">
+        <h5 class="card-title">Bands</h5>
+        <p id="band-options" class="card-text spothole-card-text"></p>
+    </div>
+</div>

templates/cards/color-scheme-and-band-color-scheme.html

@@ -0,0 +1,11 @@
+<div class="card">
+    <div class="card-body">
+        <h5 class="card-title">Theme</h5>
+        <p class="card-text spothole-card-text">
+            {% module Template("widgets/color-scheme.html", web_ui_options=web_ui_options) %}
+        </p>
+        <p class="card-text spothole-card-text">
+            {% module Template("widgets/band-color-scheme.html", web_ui_options=web_ui_options) %}
+        </p>
+    </div>
+</div>

templates/cards/color-scheme.html

@@ -0,0 +1,8 @@
+<div class="card">
+    <div class="card-body">
+        <h5 class="card-title">Theme</h5>
+        <p class="card-text spothole-card-text">
+            {% module Template("widgets/color-scheme.html", web_ui_options=web_ui_options) %}
+        </p>
+    </div>
+</div>

templates/cards/de-continent.html

@@ -0,0 +1,6 @@
+<div class="card">
+    <div class="card-body">
+        <h5 class="card-title">DE Continent</h5>
+        <p id="de-continent-options" class="card-text spothole-card-text"></p>
+    </div>
+</div>

templates/cards/duration-limit-alerts.html

@@ -0,0 +1,19 @@
+<div class="card">
+    <div class="card-body">
+        <h5 class="card-title">Duration Limit <i class='fa-solid fa-circle-question' title='Some users create long-duration alerts for the period they will be generally in and around xOTA references, when they are not indending to be on the air most of the time. Use this control to restrict the maximum duration of spots that the software will display, and exclude any with a long duration, to avoid these filling up the list. By default, we allow DXpeditions to be displayed even if they are longer than this limit, because on a DXpedition the operators typically ARE on the air most of the time.'></i></h5>
+        <p class="card-text spothole-card-text">
+            Hide any alerts lasting more than:<br/>
+            <select id="max-duration" class="storeable-select form-select" onclick="filtersUpdated();" style="width: 8em; display: inline-block;">
+                <option value="10800">3 hours</option>
+                <option value="43200">12 hours</option>
+                <option value="86400" selected>24 hours</option>
+                <option value="604800">1 week</option>
+                <option value="2419200">4 weeks</option>
+                <option value="9999999999">No limit</option>
+            </select>
+        </p>
+        <p class='card-text spothole-card-text' style='line-height: 1.5em !important;'>
+            <input class="form-check-input storeable-checkbox" type="checkbox" value="" onclick="filtersUpdated();" id="dxpeditions_skip_max_duration_check" checked><label class="form-check-label ms-2" for="dxpeditions_skip_max_duration_check">Allow DXpeditions that are longer</label>
+        </p>
+    </div>
+</div>

templates/cards/dx-continent.html

@@ -0,0 +1,6 @@
+<div class="card">
+    <div class="card-body">
+        <h5 class="card-title">DX Continent</h5>
+        <p id="dx-continent-options" class="card-text spothole-card-text"></p>
+    </div>
+</div>

templates/cards/location.html

@@ -0,0 +1,9 @@
+<div class="card">
+    <div class="card-body">
+        <h5 class="card-title">Location</h5>
+            <div class="form-group spothole-card-text">
+                <label for="userGrid">Your grid:</label>
+                <input type="text" class="storeable-text form-control" id="userGrid" placeholder="AA00aa" oninput="userGridUpdated();" style="width: 10em; display: inline-block;">
+            </div>
+    </div>
+</div>

templates/cards/map-features.html

@@ -0,0 +1,11 @@
+<div class="card">
+    <div class="card-body">
+        <h5 class="card-title">Map Features</h5>
+        <div class="form-group">
+            <div class="form-check form-check-inline">
+              <input class="form-check-input storeable-checkbox" type="checkbox" id="mapShowGeodesics" value="mapShowGeodesics" oninput="displayUpdated();">
+              <label class="form-check-label" for="mapShowGeodesics">Geodesic Lines</label>
+            </div>
+        </div>
+    </div>
+</div>

templates/cards/modes.html

@@ -0,0 +1,6 @@
+<div class="card">
+    <div class="card-body">
+        <h5 class="card-title">Modes</h5>
+        <p id="mode-options" class="card-text spothole-card-text"></p>
+    </div>
+</div>

templates/cards/number-of-alerts.html

@@ -0,0 +1,13 @@
+<div class="card">
+    <div class="card-body">
+        <h5 class="card-title">Number of Alerts</h5>
+        <p class="card-text spothole-card-text">Show up to
+            <select id="alerts-to-fetch" class="storeable-select form-select ms-2" oninput="filtersUpdated();"  style="width: 5em;display: inline-block;">
+            {% for c in web_ui_options["alert-count"] %}
+                <option value="{{c}}" {% if web_ui_options["alert-count-default"] == c %}selected{% end %}>{{c}}</option>
+            {% end %}
+            </select>
+            alerts
+        </p>
+    </div>
+</div>

templates/cards/number-of-spots.html

@@ -0,0 +1,13 @@
+<div class="card">
+    <div class="card-body">
+        <h5 class="card-title">Number of Spots</h5>
+        <p class="card-text spothole-card-text">Show up to
+            <select id="spots-to-fetch" class="storeable-select form-select ms-2 me-2 d-inline-block" oninput="filtersUpdated();" style="width: 5em; display: inline-block;">
+            {% for c in web_ui_options["spot-count"] %}
+                <option value="{{c}}" {% if web_ui_options["spot-count-default"] == c %}selected{% end %}>{{c}}</option>
+            {% end %}
+            </select>
+            spots
+        </p>
+    </div>
+</div>

templates/cards/sigs.html

@@ -0,0 +1,6 @@
+<div class="card">
+    <div class="card-body">
+        <h5 class="card-title">SIGs</h5>
+        <p id="sig-options" class="card-text spothole-card-text"></p>
+    </div>
+</div>

templates/cards/sources.html

@@ -0,0 +1,6 @@
+<div class="card">
+    <div class="card-body">
+        <h5 class="card-title">Sources</h5>
+        <p id="source-options" class="card-text spothole-card-text"></p>
+    </div>
+</div>

templates/cards/spot-age.html

@@ -0,0 +1,13 @@
+<div class="card">
+    <div class="card-body">
+        <h5 class="card-title">Spot Age</h5>
+        <p class="card-text spothole-card-text">Last
+            <select id="max-spot-age" class="storeable-select form-select ms-2 me-2 d-inline-block" oninput="filtersUpdated();" style="width: 5em; display: inline-block;">
+                {% for a in web_ui_options["max-spot-age"] %}
+                    <option value="{{a*60}}" {% if web_ui_options["max-spot-age-default"] == a*60 %}selected{% end %}>{{a}}</option>
+                {% end %}
+            </select>
+            minutes
+        </p>
+    </div>
+</div>

templates/cards/table-columns-alerts.html

@@ -0,0 +1,35 @@
+<div class="card">
+    <div class="card-body">
+        <h5 class="card-title">Table Columns</h5>
+        <div class="form-group">
+            <div class="form-check form-check-inline">
+              <input class="form-check-input storeable-checkbox" type="checkbox" id="tableShowStartTime" value="tableShowStartTime" oninput="columnsUpdated();" checked>
+              <label class="form-check-label" for="tableShowStartTime">Start Time</label>
+            </div>
+            <div class="form-check form-check-inline">
+              <input class="form-check-input storeable-checkbox" type="checkbox" id="tableShowEndTime" value="tableShowEndTime" oninput="columnsUpdated();" checked>
+              <label class="form-check-label" for="tableShowEndTime">End Time</label>
+            </div>
+            <div class="form-check form-check-inline">
+              <input class="form-check-input storeable-checkbox" type="checkbox" id="tableShowDX" value="tableShowDX" oninput="columnsUpdated();" checked>
+              <label class="form-check-label" for="tableShowDX">DX</label>
+            </div>
+            <div class="form-check form-check-inline">
+              <input class="form-check-input storeable-checkbox" type="checkbox" id="tableShowFreqsModes" value="tableShowFreqsModes" oninput="columnsUpdated();" checked>
+              <label class="form-check-label" for="tableShowFreqsModes">Frequencies & Modes</label>
+            </div>
+            <div class="form-check form-check-inline">
+              <input class="form-check-input storeable-checkbox" type="checkbox" id="tableShowComment" value="tableShowComment" oninput="columnsUpdated();" checked>
+              <label class="form-check-label" for="tableShowComment">Comment</label>
+            </div>
+            <div class="form-check form-check-inline">
+              <input class="form-check-input storeable-checkbox" type="checkbox" id="tableShowSource" value="tableShowSource" oninput="columnsUpdated();" checked>
+              <label class="form-check-label" for="tableShowSource">Source</label>
+            </div>
+            <div class="form-check form-check-inline">
+              <input class="form-check-input storeable-checkbox" type="checkbox" id="tableShowRef" value="tableShowRef" oninput="columnsUpdated();" checked>
+              <label class="form-check-label" for="tableShowRef">Ref.</label>
+            </div>
+        </div>
+    </div>
+</div>

templates/cards/table-columns-spots.html

@@ -0,0 +1,47 @@
+<div class="card">
+    <div class="card-body">
+        <h5 class="card-title">Table Columns</h5>
+        <div class="form-group">
+            <div class="form-check form-check-inline">
+              <input class="form-check-input storeable-checkbox" type="checkbox" id="tableShowTime" value="tableShowTime" oninput="columnsUpdated();" checked>
+              <label class="form-check-label" for="tableShowTime">Time</label>
+            </div>
+            <div class="form-check form-check-inline">
+              <input class="form-check-input storeable-checkbox" type="checkbox" id="tableShowDX" value="tableShowDX" oninput="columnsUpdated();" checked>
+              <label class="form-check-label" for="tableShowDX">DX</label>
+            </div>
+            <div class="form-check form-check-inline">
+              <input class="form-check-input storeable-checkbox" type="checkbox" id="tableShowFreq" value="tableShowFreq" oninput="columnsUpdated();" checked>
+              <label class="form-check-label" for="tableShowFreq">Frequency</label>
+            </div>
+            <div class="form-check form-check-inline">
+              <input class="form-check-input storeable-checkbox" type="checkbox" id="tableShowMode" value="tableShowMode" oninput="columnsUpdated();" checked>
+              <label class="form-check-label" for="tableShowMode">Mode</label>
+            </div>
+            <div class="form-check form-check-inline">
+              <input class="form-check-input storeable-checkbox" type="checkbox" id="tableShowComment" value="tableShowComment" oninput="columnsUpdated();" checked>
+              <label class="form-check-label" for="tableShowComment">Comment</label>
+            </div>
+            <div class="form-check form-check-inline">
+              <input class="form-check-input storeable-checkbox" type="checkbox" id="tableShowBearing" value="tableShowBearing" oninput="columnsUpdated();">
+              <label class="form-check-label" for="tableShowBearing">Bearing</label>
+            </div>
+            <div class="form-check form-check-inline">
+              <input class="form-check-input storeable-checkbox" type="checkbox" id="tableShowType" value="tableShowType" oninput="columnsUpdated();" checked>
+              <label class="form-check-label" for="tableShowType">Type</label>
+            </div>
+            <div class="form-check form-check-inline">
+              <input class="form-check-input storeable-checkbox" type="checkbox" id="tableShowRef" value="tableShowRef" oninput="columnsUpdated();" checked>
+              <label class="form-check-label" for="tableShowRef">Ref.</label>
+            </div>
+            <div class="form-check form-check-inline">
+              <input class="form-check-input storeable-checkbox" type="checkbox" id="tableShowDE" value="tableShowDE" oninput="columnsUpdated();" checked>
+              <label class="form-check-label" for="tableShowDE">DE</label>
+            </div>
+            <div class="form-check form-check-inline">
+              <input class="form-check-input storeable-checkbox" type="checkbox" id="tableShowWorkedCheckbox" value="tableShowWorkedCheckbox" oninput="columnsUpdated();" checked>
+              <label class="form-check-label" for="tableShowWorkedCheckbox">Worked?</label>
+            </div>
+        </div>
+    </div>
+</div>

templates/cards/time-zone.html

@@ -0,0 +1,11 @@
+<div class="card">
+    <div class="card-body">
+        <h5 class="card-title">Time Zone</h5>
+        <p class="card-text spothole-card-text"> Use
+            <select id="timeZone" class="storeable-select form-select ms-2 me-2 d-inline-block" oninput="timeZoneUpdated();" style="width: 8em; display: inline-block;">
+                <option value="UTC" selected>UTC</option>
+                <option value="local">Local time</option>
+            </select>
+        </p>
+    </div>
+</div>

templates/cards/worked-calls.html

@@ -0,0 +1,6 @@
+<div class="card">
+    <div class="card-body">
+        <h5 class="card-title">Worked Calls</h5>
+        <button type="button" class="btn btn-primary" onClick="clearWorked();">Clear worked calls</button>
+    </div>
+</div>

templates/map.html

@@ -0,0 +1,78 @@
+{% extends "base.html" %}
+{% block content %}
+
+<div id="map">
+    <div id="settingsButtonRowMap" class="mt-3 px-3" style="z-index: 1002; position: relative;">
+        <div class="row mb-3">
+            <div class="col-auto me-auto pt-3"></div>
+            <div class="col-auto">
+                <div class="d-inline-flex gap-1">
+                    {% module Template("widgets/filters-display-buttons.html", web_ui_options=web_ui_options) %}
+                </div>
+            </div>
+        </div>
+
+        <div id="filters-area" class="appearing-panel card mb-3">
+        {% module Template("widgets/filters-area-header.html", web_ui_options=web_ui_options) %}
+            <div class="card-body">
+                <div class="row row-cols-1 g-4 mb-4 row-cols-md-3">
+                    <div class="col">
+                        {% module Template("cards/bands.html", web_ui_options=web_ui_options) %}
+                    </div>
+                    <div class="col">
+                        {% module Template("cards/sigs.html", web_ui_options=web_ui_options) %}
+                    </div>
+                    <div class="col">
+                        {% module Template("cards/sources.html", web_ui_options=web_ui_options) %}
+                    </div>
+                </div>
+                <div class="row row-cols-1 row-cols-md-3 g-4">
+                    <div class="col">
+                        {% module Template("cards/dx-continent.html", web_ui_options=web_ui_options) %}
+                    </div>
+                    <div class="col">
+                        {% module Template("cards/de-continent.html", web_ui_options=web_ui_options) %}
+                    </div>
+                    <div class="col">
+                        {% module Template("cards/modes.html", web_ui_options=web_ui_options) %}
+                    </div>
+                </div>
+            </div>
+        </div>
+
+        <div id="display-area" class="appearing-panel card mb-3">
+            {% module Template("widgets/display-area-header.html", web_ui_options=web_ui_options) %}
+            <div class="card-body">
+                <div id="display-container" class="row row-cols-1 row-cols-md-4 g-4">
+                    <div class="col">
+                        {% module Template("cards/spot-age.html", web_ui_options=web_ui_options) %}
+                    </div>
+                    <div class="col">
+                        {% module Template("cards/map-features.html", web_ui_options=web_ui_options) %}
+                    </div>
+                    <div class="col">
+                        {% module Template("cards/color-scheme-and-band-color-scheme.html", web_ui_options=web_ui_options) %}
+                    </div>
+                </div>
+            </div>
+        </div>
+    </div>
+</div>
+
+<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/leaflet@1.9.4/dist/leaflet.min.css">
+<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/leaflet-extra-markers@1.2.2/dist/css/leaflet.extra-markers.min.css">
+<script src="https://cdn.jsdelivr.net/npm/leaflet@1.9.4/dist/leaflet.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/leaflet-providers@2.0.0/leaflet-providers.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/leaflet-extra-markers@1.2.2/src/assets/js/leaflet.extra-markers.min.js" type="module"></script>
+<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>
+    let spotProvidersEnabledByDefault = {% raw json_encode(web_ui_options["spot-providers-enabled-by-default"]) %};
+</script>
+<script src="/js/common.js?v=1772224426"></script>
+<script src="/js/spotsbandsandmap.js?v=1772224426"></script>
+<script src="/js/map.js?v=1772224426"></script>
+<script>$(document).ready(function() { $("#nav-link-map").addClass("active"); }); <!-- highlight active page in nav --></script>
+
+{% end %}

templates/spots.html

@@ -0,0 +1,95 @@
+{% 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">
+  <i class="fa-solid fa-circle-info"></i> <strong>What is Spothole?</strong><br/>Spothole is an aggregator of amateur radio spots from DX clusters and outdoor activity programmes. It's free for anyone to use and includes an API that developers can build other applications on. For more information, check out the <a href="/about" class="alert-link">"About" page</a>. If that sounds like nonsense to you, you can visit <a href="/about#faq" class="alert-link">the FAQ section</a> to learn more.
+  <button type="button" id="intro-box-dismiss" class="btn-close" data-bs-dismiss="alert" aria-label="Close"></button>
+</div>
+</div>
+
+<div class="mt-3">
+    <div id="settingsButtonRow" class="row mb-3">
+        <div class="col-md-4 mb-3 mb-md-0">
+            <div class="d-inline-flex gap-3">
+                {% module Template("widgets/run-pause.html", web_ui_options=web_ui_options) %}
+                <div class="d-inline-flex">{% raw web_ui_options["support-button-html"] %}</div>
+            </div>
+        </div>
+        <div class="col-md-8 text-end">
+            <div class="d-inline-flex gap-3">
+                {% module Template("widgets/search.html", web_ui_options=web_ui_options) %}
+                {% module Template("widgets/filters-display-buttons.html", web_ui_options=web_ui_options) %}
+            </div>
+        </div>
+    </div>
+
+    <div id="filters-area" class="appearing-panel card mb-3">
+        {% module Template("widgets/filters-area-header.html", web_ui_options=web_ui_options) %}
+        <div class="card-body">
+            <div class="row row-cols-1 g-4 mb-4 row-cols-md-3">
+                <div class="col">
+                    {% module Template("cards/bands.html", web_ui_options=web_ui_options) %}
+                </div>
+                <div class="col">
+                    {% module Template("cards/sigs.html", web_ui_options=web_ui_options) %}
+                </div>
+                <div class="col">
+                    {% module Template("cards/sources.html", web_ui_options=web_ui_options) %}
+                </div>
+            </div>
+            <div class="row row-cols-1 row-cols-md-3 g-4">
+                <div class="col">
+                    {% module Template("cards/dx-continent.html", web_ui_options=web_ui_options) %}
+                </div>
+                <div class="col">
+                    {% module Template("cards/de-continent.html", web_ui_options=web_ui_options) %}
+                </div>
+                <div class="col">
+                    {% module Template("cards/modes.html", web_ui_options=web_ui_options) %}
+                </div>
+            </div>
+        </div>
+    </div>
+
+    <div id="display-area" class="appearing-panel card mb-3">
+        {% module Template("widgets/display-area-header.html", web_ui_options=web_ui_options) %}
+        <div class="card-body">
+            <div id="display-container" class="row row-cols-1 row-cols-md-4 g-4">
+                <div class="col">
+                    {% module Template("cards/time-zone.html", web_ui_options=web_ui_options) %}
+                </div>
+                <div class="col">
+                    {% module Template("cards/number-of-spots.html", web_ui_options=web_ui_options) %}
+                </div>
+                <div class="col">
+                    {% module Template("cards/location.html", web_ui_options=web_ui_options) %}
+                </div>
+                <div class="col">
+                    {% module Template("cards/worked-calls.html", web_ui_options=web_ui_options) %}
+                </div>
+                <div class="col">
+                    {% module Template("cards/color-scheme-and-band-color-scheme.html", web_ui_options=web_ui_options) %}
+                </div>
+                <div class="col">
+                    {% module Template("cards/table-columns-spots.html", web_ui_options=web_ui_options) %}
+                </div>
+            </div>
+        </div>
+    </div>
+
+    <div id="table-container">
+        <table id="table" class="table"><thead><tr class="table-primary"></tr></thead><tbody></tbody></table>
+    </div>
+
+</div>
+
+<script>
+    let spotProvidersEnabledByDefault = {% raw json_encode(web_ui_options["spot-providers-enabled-by-default"]) %};
+</script>
+<script src="/js/common.js?v=1772224426"></script>
+<script src="/js/spotsbandsandmap.js?v=1772224426"></script>
+<script src="/js/spots.js?v=1772224426"></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"></script>
+<script src="/js/common.js?v=1772224426"></script>
-<script src="/js/status.js"></script>
+<script src="/js/status.js?v=1772224426"></script>
 <script>$(document).ready(function() { $("#nav-link-status").addClass("active"); }); <!-- highlight active page in nav --></script>
+
+{% end %}

templates/widgets/band-color-scheme.html

@@ -0,0 +1,13 @@
+<label class="form-check-label" for="band-color-scheme">Band color scheme</label><br/>
+<select id="band-color-scheme" class="storeable-select form-select d-inline-block" oninput="setBandColorSchemeFromUI();" style="display: inline-block;">
+    <option value="PSK Reporter" {% if web_ui_options["band-color-scheme-default"] == "PSK Reporter" %}selected{% end %}>PSK Reporter</option>
+    <option value="PSK Reporter (Adjusted)" {% if web_ui_options["band-color-scheme-default"] == "PSK Reporter (Adjusted)" %}selected{% end %}>PSK Reporter (Adjusted)</option>
+    <option value="RBN" {% if web_ui_options["band-color-scheme-default"] == "RBN" %}selected{% end %}>RBN</option>
+    <option value="Ham Rainbow" {% if web_ui_options["band-color-scheme-default"] == "Ham Rainbow" %}selected{% end %}>Ham Rainbow</option>
+    <option value="Ham Rainbow (Reverse)" {% if web_ui_options["band-color-scheme-default"] == "Ham Rainbow (Reverse)" %}selected{% end %}>Ham Rainbow (Reverse)</option>
+    <option value="Kate Morley" {% if web_ui_options["band-color-scheme-default"] == "Kate Morley" %}selected{% end %}>Kate Morley</option>
+    <option value="ColorBrewer" {% if web_ui_options["band-color-scheme-default"] == "ColorBrewer" %}selected{% end %}>ColorBrewer</option>
+    <option value="IWantHue" {% if web_ui_options["band-color-scheme-default"] == "IWantHue" %}selected{% end %}>IWantHue</option>
+    <option value="IWantHue (Color Blind)" {% if web_ui_options["band-color-scheme-default"] == "IWantHue (Color Blind)" %}selected{% end %}>IWantHue (Color Blind)</option>
+    <option value="Mokole" {% if web_ui_options["band-color-scheme-default"] == "Mokole" %}selected{% end %}>Mokole</option>
+</select>

templates/widgets/color-scheme.html

@@ -0,0 +1,6 @@
+<label class="form-check-label" for="color-scheme">UI color scheme</label>
+<select id="color-scheme" class="storeable-select form-select d-inline-block" oninput="setColorSchemeFromUI();" style="display: inline-block;">
+    <option value="auto" {% if web_ui_options["color-scheme-default"] == "auto" %}selected{% end %}>Automatic</option>
+    <option value="light" {% if web_ui_options["color-scheme-default"] == "light" %}selected{% end %}>Light</option>
+    <option value="dark" {% if web_ui_options["color-scheme-default"] == "dark" %}selected{% end %}>Dark</option>
+</select>

templates/widgets/display-area-header.html

@@ -0,0 +1,10 @@
+<div class="card-header text-white bg-primary">
+    <div class="row">
+        <div class="col-auto me-auto">
+            Display
+        </div>
+        <div class="col-auto d-inline-flex">
+            <button id="close-display-button" type="button" class="btn-close btn-close-white" aria-label="Close" onclick="closeDisplayPanel();"></button>
+        </div>
+    </div>
+</div>

templates/widgets/filters-area-header.html

@@ -0,0 +1,10 @@
+<div class="card-header text-white bg-primary">
+    <div class="row">
+        <div class="col-auto me-auto">
+            Filters
+        </div>
+        <div class="col-auto d-inline-flex">
+            <button id="close-filters-button" type="button" class="btn-close btn-close-white" aria-label="Close" onclick="closeFiltersPanel();"></button>
+        </div>
+    </div>
+</div>

templates/widgets/filters-display-buttons.html

@@ -0,0 +1,4 @@
+<div class="d-inline-flex gap-1">
+    <button id="filters-button" type="button" class="btn btn-outline-primary" data-bs-toggle="button" onclick="toggleFiltersPanel();"><i class="fa-solid fa-filter"></i>&nbsp;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>&nbsp;Display</button>
+</div>

templates/widgets/refresh-timer.html

@@ -0,0 +1 @@
+<div id="timing-container">Loading...</div>

templates/widgets/run-pause.html

@@ -0,0 +1,7 @@
+<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>&nbsp;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>&nbsp;Pause</label>
+</span>

templates/widgets/search.html

@@ -0,0 +1,4 @@
+<span 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>

views/webpage_about.tpl

@@ -1,45 +0,0 @@
-% rebase('webpage_base.tpl')
-
-<div id="info-container" class="mt-4">
-    <h2 class="mt-4 mb-4">About Spothole</h2>
-    <p>Spothole is a utility to aggregate "spots" from amateur radio DX clusters and xOTA spotting sites, and provide an open JSON API as well as a website to browse the data.</p>
-    <p>While there are several other web-based interfaces to DX clusters, and sites that aggregate spots from various outdoor activity programmes for amateur radio, Spothole differentiates itself by supporting a large number of data sources, and by being "API first" rather than just providing a web front-end. This allows other software to be built on top of it.</p>
-    <p>The API is deliberately well-defined with an <a href="/apidocs/openapi.yml">OpenAPI specification</a> and <a href="/apidocs">API documentation</a>. The API delivers spots in a consistent format regardless of the data source, freeing developers from needing to know how each individual data source presents its data.</p>
-    <p>Spothole itself is also open source, Public Domain licenced code that anyone can take and modify. <a href="https://git.ianrenton.com/ian/metaspot/">The source code is here</a>. If you want to run your own copy of Spothole, or start modifying it for your own purposes, the <a href="https://git.ianrenton.com/ian/spothole/src/branch/main/README.md">README file</a> contains a description of how the software works and how it's laid out, as well as instructions for configuring systemd, nginx and anything else you might need to run your own server.</p>
-    <p>The software was written by <a href="https://ianrenton.com">Ian Renton, MØTRT</a> and other contributors. Full details are available in the README.</p>
-    <p>This server is running Spothole version {{software_version}}.</p>
-    <h2 id="faq" class="mt-4">FAQ</h2>
-    <h4 class="mt-4">"Spots"? "DX Clusters"? What does any of this mean?</h4>
-    <p>This is a tool for amateur ("ham") radio users. Many amateur radio operators like to make contacts with others who are doing something more interesting than sitting in their home "shack", such as people in rarely-seen countries, remote islands, or on mountaintops. Such operators are often "spotted", i.e. when someone speaks to them, they will put the details such as their operating frequency into an online system, to let others know where to find them. A DX Cluster is one type of those systems. Most outdoor radio awards programmes, such as "Parks on the Air" (POTA) have their own websites for posting spots.</p>
-    <p>Spothole is an "aggregator" for those spots, so it checks lots of different services for data, and brings it all together in one place. So no matter what kinds of interesting spots you are looking for, you can find them here.</p>
-    <p>As well as spots, it also provides a similar feed of "alerts". This is where amateur radio users who are going to interesting places soon will announce their intentions.</p>
-    <h4 class="mt-4">What are "DX", "DE" and modes?</h4>
-    <p>In amateur radio terminology, the "DX" contact is the "interesting" one that is using the frequency shown. They might be on a remote island or just in a local park, but either way it's interesting enough that someone has "spotted" them. The callsign listed under "DE" is the person who spotted the "DX" operator. "Modes" are the type of communication they are using. You might see "CW" which is Morse Code, or voice "modes" like SSB or FM, or more exotic "data" modes which are used for computer-to-computer communication.</p>
-    <h4 class="mt-4">What data sources are supported?</h4>
-    <p>Spothole can retrieve spots from: Telnet-based DX clusters, the Reverse Beacon Network (RBN), the APRS Internet Service (APRS-IS), POTA, SOTA, WWFF, GMA, WWBOTA, HEMA, Parks 'n' Peaks, ZLOTA, WOTA, and the UK Packet Repeater Network.</p>
-    <p>Spothole can retrieve alerts from: NG3K, POTA, SOTA, WWFF, Parks 'n' Peaks, WOTA and BOTA.</p>
-    <p>Note that the server owner has not necessarily enabled all these data sources. In particular it is common to disable RBN, to avoid the server being swamped with FT8 traffic, and to disable APRS-IS and UK Packet Net so that the server only displays stations where there is likely to be an operator physically present for a QSO.</p>
-    <p>Between the various data sources, the following Special Interest Groups (SIGs) are supported: POTA, SOTA, WWFF, GMA, WWBOTA, HEMA, IOTA, MOTS, ARLHS, ILLW, SIOTA, WCA, ZLOTA, KRMNPA, WOTA, BOTA, WAB & WAI.</p>
-    <h4 class="mt-4">How is this better than DXheat, DXsummit, POTA's own website, etc?</h4>
-    <p>It's probably not? But it's nice to have choice.</p>
-    <p>I think it's got two key advantages over those sites:</p>
-    <ol><li>It provides a public, <a href="/apidocs">well-documented API</a> with an <a href="/apidocs/openapi.yml">OpenAPI specification</a>. Other sites don't have official APIs or don't bother documenting them publicly, because they want people to use their web page. I like Spothole's web page, but you don't have to use it&mdash;if you're a programmer, you can build your own software on Spothole's API. Spothole does the hard work of taking all the various data sources and providing a consistent, well-documented data set. You can then do the fun bit of writing your own application.</li>
-    <li>It grabs data from a lot more sources, and it's easy to add more. Since it's open source, anyone can contribute a new data source and share it with the community.</li></ol>
-    <h4 class="mt-4">Why does this website ask me if I want to install it?</h4>
-    <p>Spothole is a Progressive Web App, which means you can install it on an Android or iOS device by opening the site in Chrome or Safari respectively, and clicking "Install" on the pop-up panel. It'll only prompt you once, so if you dismiss the prompt and change your mind, you'll find an Install / Add to Home Screen option on your browser's menu.</p>
-    <p>Installing Spothole on your phone is completely optional, the website works exactly the same way as the "app" does.</p>
-    <h4 class="mt-4">Why hasn't my spot/alert shown up yet?</h4>
-    <p>To avoid putting too much load on the various servers that Spothole connects to, the Spothole server only polls them once every two minutes for spots, and once every hour for alerts. (Some sources, such as DX clusters, RBN, APRS-IS and WWBOTA use a non-polling mechanism, and their updates will therefore arrive more quickly.) Then if you are using the web interface, that has its own rate at which it reloads the data from Spothole, which is once a minute for spots or 30 minutes for alerts. So you could be waiting around three minutes to see a newly added spot, or 90 minutes to see a newly added alert.</p>
-    <h4 class="mt-4">What licence does Spothole use?</h4>
-    <p>Spothole's source code is licenced under the Public Domain. You can write a Spothole client, run your own server, modify it however you like, you can claim you wrote it and charge people £1000 for a copy, I don't really mind. (Please don't do the last one. But if you're using my code for something cool, it would be nice to hear from you!)</p>
-    <h2 id="privacy" class="mt-4">Privacy</h2>
-    <p>Spothole collects no data about you, and there is no way to enter personally identifying information into the site apart from by spotting and alerting through Spothole or the various services it connects to. All spots and alerts are "timed out" and deleted from the system after a set interval, which by default is one hour for spots and one week for alerts.</p>
-    <p>Settings you select from Spothole's menus are sent to the server, in order to provide the data with the requested filters. They are also stored in your browser's local storage, so that your preferences are remembered between sessions.</p>
-    <p>There are no trackers, no ads, and no cookies.</p>
-    <p>Spothole is open source, so you can audit <a href="https://git.ianrenton.com/ian/spothole">the code</a> if you like.</p>
-    <h2 class="mt-4">Thanks</h2>
-    <p>This project would not have been possible without those volunteers who have taken it upon themselves to run DX clusters, xOTA programmes, DXpedition lists, callsign lookup databases, and other online tools on which Spothole's data is based.</p>
-    <p>Spothole is also dependent on a number of Python libraries, in particular pyhamtools, and many JavaScript libraries, as well as the Font Awesome icon set.</p>
-</div>
-
-<script>$(document).ready(function() { $("#nav-link-about").addClass("active"); }); <!-- highlight active page in nav --></script>

views/webpage_alerts.tpl

@@ -1,162 +0,0 @@
-% rebase('webpage_base.tpl')
-
-<div class="mt-3">
-    <div class="row">
-        <div class="col-auto me-auto pt-3">
-            <p id="timing-container">Loading...</p>
-        </div>
-        <div class="col-auto">
-            <p class="d-inline-flex gap-1">
-                <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>
-            </p>
-        </div>
-    </div>
-
-    <div id="filters-area" class="appearing-panel card mb-3">
-        <div class="card-header text-white bg-primary">
-            <div class="row">
-                <div class="col-auto me-auto">
-                    Filters
-                </div>
-                <div class="col-auto d-inline-flex">
-                    <button id="close-filters-button" type="button" class="btn-close btn-close-white" aria-label="Close" onclick="closeFiltersPanel();"></button>
-                </div>
-            </div>
-
-        </div>
-        <div class="card-body">
-            <div class="row row-cols-1 row-cols-md-3 g-4">
-                <div class="col">
-                    <div class="card">
-                        <div class="card-body">
-                            <h5 class="card-title">DX Continent</h5>
-                            <p id="dx-continent-options" class="card-text spothole-card-text"></p>
-                        </div>
-                    </div>
-                </div>
-                <div class="col">
-                    <div class="card">
-                        <div class="card-body">
-                            <h5 class="card-title">Sources</h5>
-                            <p id="source-options" class="card-text spothole-card-text"></p>
-                        </div>
-                    </div>
-                </div>
-                <div class="col">
-                    <div class="card">
-                        <div class="card-body">
-                            <h5 class="card-title">Duration Limit <i class='fa-solid fa-circle-question' title='Some users create long-duration alerts for the period they will be generally in and around xOTA references, when they are not indending to be on the air most of the time. Use this control to restrict the maximum duration of spots that the software will display, and exclude any with a long duration, to avoid these filling up the list. By default, we allow DXpeditions to be displayed even if they are longer than this limit, because on a DXpedition the operators typically ARE on the air most of the time.'></i></h5>
-                            <p class="card-text spothole-card-text">
-                                Hide any alerts lasting more than:<br/>
-                                <select id="max-duration" class="storeable-select form-select" onclick="filtersUpdated();" style="width: 8em; display: inline-block;">
-                                    <option value="10800">3 hours</option>
-                                    <option value="43200">12 hours</option>
-                                    <option value="86400" selected>24 hours</option>
-                                    <option value="604800">1 week</option>
-                                    <option value="2419200">4 weeks</option>
-                                    <option value="9999999999">No limit</option>
-                                </select>
-                            </p>
-                            <p class='card-text spothole-card-text' style='line-height: 1.5em !important;'>
-                                <input class="form-check-input storeable-checkbox" type="checkbox" value="" onclick="filtersUpdated();" id="dxpeditions_skip_max_duration_check" checked><label class="form-check-label ms-2" for="dxpeditions_skip_max_duration_check">Allow DXpeditions that are longer</label>
-                            </p>
-                        </div>
-                    </div>
-                </div>
-            </div>
-        </div>
-    </div>
-
-    <div id="display-area" class="appearing-panel card mb-3">
-        <div class="card-header text-white bg-primary">
-            <div class="row">
-                <div class="col-auto me-auto">
-                    Display
-                </div>
-                <div class="col-auto d-inline-flex">
-                    <button id="close-display-button" type="button" class="btn-close btn-close-white" aria-label="Close" onclick="closeDisplayPanel();"></button>
-                </div>
-            </div>
-
-        </div>
-        <div class="card-body">
-            <div id="display-container" class="row row-cols-1 row-cols-md-3 g-4">
-                <div class="col">
-                    <div class="card">
-                        <div class="card-body">
-                            <h5 class="card-title">Time Zone</h5>
-                            <p class="card-text spothole-card-text"> Use
-                                <select id="timeZone" class="storeable-select form-select ms-2 me-2 d-inline-block" oninput="timeZoneUpdated();" style="width: 8em; display: inline-block;">
-                                    <option value="UTC" selected>UTC</option>
-                                    <option value="local">Local time</option>
-                                </select>
-                            </p>
-                        </div>
-                    </div>
-                </div>
-                <div class="col">
-                    <div class="card">
-                        <div class="card-body">
-                            <h5 class="card-title">Number of Alerts</h5>
-                            <p class="card-text spothole-card-text">Show up to
-                                <select id="alerts-to-fetch" class="storeable-select form-select ms-2" oninput="filtersUpdated();"  style="width: 5em;display: inline-block;">
-                                    <option value="25">25</option>
-                                    <option value="50">50</option>
-                                    <option value="100" selected>100</option>
-                                    <option value="200">200</option>
-                                    <option value="500">500</option>
-                                </select>
-                                alerts
-                            </p>
-                        </div>
-                    </div>
-                </div>
-                <div class="col">
-                    <div class="card">
-                        <div class="card-body">
-                            <h5 class="card-title">Table Data</h5>
-                            <div class="form-group">
-                                <div class="form-check form-check-inline">
-                                  <input class="form-check-input storeable-checkbox" type="checkbox" id="tableShowStartTime" value="tableShowStartTime" oninput="columnsUpdated();" checked>
-                                  <label class="form-check-label" for="tableShowStartTime">Start Time</label>
-                                </div>
-                                <div class="form-check form-check-inline">
-                                  <input class="form-check-input storeable-checkbox" type="checkbox" id="tableShowEndTime" value="tableShowEndTime" oninput="columnsUpdated();" checked>
-                                  <label class="form-check-label" for="tableShowEndTime">End Time</label>
-                                </div>
-                                <div class="form-check form-check-inline">
-                                  <input class="form-check-input storeable-checkbox" type="checkbox" id="tableShowDX" value="tableShowDX" oninput="columnsUpdated();" checked>
-                                  <label class="form-check-label" for="tableShowDX">DX</label>
-                                </div>
-                                <div class="form-check form-check-inline">
-                                  <input class="form-check-input storeable-checkbox" type="checkbox" id="tableShowFreqsModes" value="tableShowFreqsModes" oninput="columnsUpdated();" checked>
-                                  <label class="form-check-label" for="tableShowFreqsModes">Frequencies & Modes</label>
-                                </div>
-                                <div class="form-check form-check-inline">
-                                  <input class="form-check-input storeable-checkbox" type="checkbox" id="tableShowComment" value="tableShowComment" oninput="columnsUpdated();" checked>
-                                  <label class="form-check-label" for="tableShowComment">Comment</label>
-                                </div>
-                                <div class="form-check form-check-inline">
-                                  <input class="form-check-input storeable-checkbox" type="checkbox" id="tableShowSource" value="tableShowSource" oninput="columnsUpdated();" checked>
-                                  <label class="form-check-label" for="tableShowSource">Source</label>
-                                </div>
-                                <div class="form-check form-check-inline">
-                                  <input class="form-check-input storeable-checkbox" type="checkbox" id="tableShowRef" value="tableShowRef" oninput="columnsUpdated();" checked>
-                                  <label class="form-check-label" for="tableShowRef">Ref.</label>
-                                </div>
-                            </div>
-                        </div>
-                    </div>
-                </div>
-            </div>
-        </div>
-    </div>
-
-    <div id="table-container"></div>
-
-</div>
-
-<script src="/js/common.js"></script>
-<script src="/js/alerts.js"></script>
-<script>$(document).ready(function() { $("#nav-link-alerts").addClass("active"); }); <!-- highlight active page in nav --></script>

views/webpage_bands.tpl

@@ -1,117 +0,0 @@
-% rebase('webpage_base.tpl')
-
-<div class="mt-3">
-    <div class="row">
-        <div class="col-auto me-auto pt-3">
-            <p id="timing-container">Loading...</p>
-        </div>
-        <div class="col-auto">
-            <p class="d-inline-flex gap-1">
-                <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>
-            </p>
-        </div>
-    </div>
-
-    <div id="filters-area" class="appearing-panel card mb-3">
-        <div class="card-header text-white bg-primary">
-            <div class="row">
-                <div class="col-auto me-auto">
-                    Filters
-                </div>
-                <div class="col-auto d-inline-flex">
-                    <button id="close-filters-button" type="button" class="btn-close btn-close-white" aria-label="Close" onclick="closeFiltersPanel();"></button>
-                </div>
-            </div>
-
-        </div>
-        <div class="card-body">
-            <div class="row row-cols-1 g-4 mb-4">
-                <div class="col">
-                    <div class="card">
-                        <div class="card-body">
-                            <h5 class="card-title">Bands</h5>
-                            <p id="band-options" class="card-text spothole-card-text"></p>
-                        </div>
-                    </div>
-                </div>
-            </div>
-            <div class="row row-cols-1 row-cols-md-4 g-4">
-                <div class="col">
-                    <div class="card">
-                        <div class="card-body">
-                            <h5 class="card-title">DX Continent</h5>
-                            <p id="dx-continent-options" class="card-text spothole-card-text"></p>
-                        </div>
-                    </div>
-                </div>
-                <div class="col">
-                    <div class="card">
-                        <div class="card-body">
-                            <h5 class="card-title">DE Continent</h5>
-                            <p id="de-continent-options" class="card-text spothole-card-text"></p>
-                        </div>
-                    </div>
-                </div>
-                <div class="col">
-                    <div class="card">
-                        <div class="card-body">
-                            <h5 class="card-title">Modes</h5>
-                            <p id="mode-options" class="card-text spothole-card-text"></p>
-                        </div>
-                    </div>
-                </div>
-                <div class="col">
-                    <div class="card">
-                        <div class="card-body">
-                            <h5 class="card-title">Sources</h5>
-                            <p id="source-options" class="card-text spothole-card-text"></p>
-                        </div>
-                    </div>
-                </div>
-            </div>
-        </div>
-    </div>
-
-    <div id="display-area" class="appearing-panel card mb-3">
-        <div class="card-header text-white bg-primary">
-            <div class="row">
-                <div class="col-auto me-auto">
-                    Display
-                </div>
-                <div class="col-auto d-inline-flex">
-                    <button id="close-display-button" type="button" class="btn-close btn-close-white" aria-label="Close" onclick="closeDisplayPanel();"></button>
-                </div>
-            </div>
-
-        </div>
-        <div class="card-body">
-            <div id="display-container" class="row row-cols-1 row-cols-md-4 g-4">
-                <div class="col">
-                    <div class="card">
-                        <div class="card-body">
-                            <h5 class="card-title">Spot Age</h5>
-                            <p class="card-text spothole-card-text">Last
-                                <select id="max-spot-age" class="storeable-select form-select ms-2 me-2 d-inline-block" oninput="filtersUpdated();" style="width: 5em; display: inline-block;">
-                                    <option value="300">5</option>
-                                    <option value="600">10</option>
-                                    <option value="1800" selected>30</option>
-                                    <option value="3600">60</option>
-                                </select>
-                                minutes
-                            </p>
-                        </div>
-                    </div>
-                </div>
-            </div>
-        </div>
-    </div>
-
-    <div id="bands-container"></div>
-
-</div>
-
-<script src="/js/common.js"></script>
-<script src="/js/spotandmap.js"></script>
-<script src="/js/bands.js"></script>
-<script>$(document).ready(function() { $("#nav-link-bands").addClass("active"); }); <!-- highlight active page in nav --></script>

views/webpage_map.tpl

@@ -1,135 +0,0 @@
-% rebase('webpage_base.tpl')
-
-<div id="map">
-    <div id="maptools" class="mt-3 px-3" style="z-index: 1002; position: relative;">
-        <div class="row">
-            <div class="col-auto me-auto pt-3"></div>
-            <div class="col-auto">
-                <p class="d-inline-flex gap-1">
-                    <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>
-                </p>
-            </div>
-        </div>
-
-        <div id="filters-area" class="appearing-panel card mb-3">
-            <div class="card-header text-white bg-primary">
-                <div class="row">
-                    <div class="col-auto me-auto">
-                        Filters
-                    </div>
-                    <div class="col-auto d-inline-flex">
-                        <button id="close-filters-button" type="button" class="btn-close btn-close-white" aria-label="Close" onclick="closeFiltersPanel();"></button>
-                    </div>
-                </div>
-
-            </div>
-            <div class="card-body">
-                <div class="row row-cols-1 g-4 mb-4">
-                    <div class="col">
-                        <div class="card">
-                            <div class="card-body">
-                                <h5 class="card-title">Bands</h5>
-                                <p id="band-options" class="card-text spothole-card-text"></p>
-                            </div>
-                        </div>
-                    </div>
-                </div>
-                <div class="row row-cols-1 row-cols-md-4 g-4">
-                    <div class="col">
-                        <div class="card">
-                            <div class="card-body">
-                                <h5 class="card-title">DX Continent</h5>
-                                <p id="dx-continent-options" class="card-text spothole-card-text"></p>
-                            </div>
-                        </div>
-                    </div>
-                    <div class="col">
-                        <div class="card">
-                            <div class="card-body">
-                                <h5 class="card-title">DE Continent</h5>
-                                <p id="de-continent-options" class="card-text spothole-card-text"></p>
-                            </div>
-                        </div>
-                    </div>
-                    <div class="col">
-                        <div class="card">
-                            <div class="card-body">
-                                <h5 class="card-title">Modes</h5>
-                                <p id="mode-options" class="card-text spothole-card-text"></p>
-                            </div>
-                        </div>
-                    </div>
-                    <div class="col">
-                        <div class="card">
-                            <div class="card-body">
-                                <h5 class="card-title">Sources</h5>
-                                <p id="source-options" class="card-text spothole-card-text"></p>
-                            </div>
-                        </div>
-                    </div>
-                </div>
-            </div>
-        </div>
-
-        <div id="display-area" class="appearing-panel card mb-3">
-            <div class="card-header text-white bg-primary">
-                <div class="row">
-                    <div class="col-auto me-auto">
-                        Display
-                    </div>
-                    <div class="col-auto d-inline-flex">
-                        <button id="close-display-button" type="button" class="btn-close btn-close-white" aria-label="Close" onclick="closeDisplayPanel();"></button>
-                    </div>
-                </div>
-
-            </div>
-            <div class="card-body">
-                <div id="display-container" class="row row-cols-1 row-cols-md-4 g-4">
-                    <div class="col">
-                        <div class="card">
-                            <div class="card-body">
-                                <h5 class="card-title">Spot Age</h5>
-                                <p class="card-text spothole-card-text">Last
-                                    <select id="max-spot-age" class="storeable-select form-select ms-2 me-2 d-inline-block" oninput="filtersUpdated();" style="width: 5em; display: inline-block;">
-                                        <option value="300">5</option>
-                                        <option value="600">10</option>
-                                        <option value="1800" selected>30</option>
-                                        <option value="3600">60</option>
-                                    </select>
-                                    minutes
-                                </p>
-                            </div>
-                        </div>
-                    </div>
-                    <div class="col">
-                        <div class="card">
-                            <div class="card-body">
-                                <h5 class="card-title">Map Features</h5>
-                                <div class="form-group">
-                                    <div class="form-check form-check-inline">
-                                      <input class="form-check-input storeable-checkbox" type="checkbox" id="mapShowGeodesics" value="mapShowGeodesics" oninput="displayUpdated();">
-                                      <label class="form-check-label" for="mapShowGeodesics">Geodesic Lines</label>
-                                    </div>
-                                </div>
-                            </div>
-                        </div>
-                    </div>
-                </div>
-            </div>
-        </div>
-    </div>
-</div>
-
-<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/leaflet@1.9.4/dist/leaflet.min.css">
-<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/leaflet-extra-markers@1.2.2/dist/css/leaflet.extra-markers.min.css">
-<script src="https://cdn.jsdelivr.net/npm/leaflet@1.9.4/dist/leaflet.min.js"></script>
-<script src="https://cdn.jsdelivr.net/npm/leaflet-providers@2.0.0/leaflet-providers.min.js"></script>
-<script src="https://cdn.jsdelivr.net/npm/leaflet-extra-markers@1.2.2/src/assets/js/leaflet.extra-markers.min.js" type="module"></script>
-<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"></script>
-<script src="/js/spotandmap.js"></script>
-<script src="/js/map.js"></script>
-<script>$(document).ready(function() { $("#nav-link-map").addClass("active"); }); <!-- highlight active page in nav --></script>

views/webpage_spots.tpl

@@ -1,197 +0,0 @@
-% rebase('webpage_base.tpl')
-
-<div id="intro-box" class="permanently-dismissible-box mt-3">
-<div class="alert alert-primary alert-dismissible fade show" role="alert">
-  <i class="fa-solid fa-circle-info"></i> <strong>What is Spothole?</strong><br/>Spothole is an aggregator of amateur radio spots from DX clusters and outdoor activity programmes. It's free for anyone to use and includes an API that developers can build other applications on. For more information, check out the <a href="/about" class="alert-link">"About" page</a>. If that sounds like nonsense to you, you can visit <a href="/about#faq" class="alert-link">the FAQ section</a> to learn more.
-  <button type="button" id="intro-box-dismiss" class="btn-close" data-bs-dismiss="alert" aria-label="Close"></button>
-</div>
-</div>
-
-<div class="mt-3">
-    <div class="row">
-        <div class="col-auto me-auto pt-3">
-            <p id="timing-container">Loading...</p>
-        </div>
-        <div class="col-auto">
-            <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="text" class="form-control" oninput="filtersUpdated();" placeholder="Search for call">
-                </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>
-            </p>
-        </div>
-    </div>
-
-    <div id="filters-area" class="appearing-panel card mb-3">
-        <div class="card-header text-white bg-primary">
-            <div class="row">
-                <div class="col-auto me-auto">
-                    Filters
-                </div>
-                <div class="col-auto d-inline-flex">
-                    <button id="close-filters-button" type="button" class="btn-close btn-close-white" aria-label="Close" onclick="closeFiltersPanel();"></button>
-                </div>
-            </div>
-
-        </div>
-        <div class="card-body">
-            <div class="row row-cols-1 g-4 mb-4">
-                <div class="col">
-                    <div class="card">
-                        <div class="card-body">
-                            <h5 class="card-title">Bands</h5>
-                            <p id="band-options" class="card-text spothole-card-text"></p>
-                        </div>
-                    </div>
-                </div>
-            </div>
-            <div class="row row-cols-1 row-cols-md-4 g-4">
-                <div class="col">
-                    <div class="card">
-                        <div class="card-body">
-                            <h5 class="card-title">DX Continent</h5>
-                            <p id="dx-continent-options" class="card-text spothole-card-text"></p>
-                        </div>
-                    </div>
-                </div>
-                <div class="col">
-                    <div class="card">
-                        <div class="card-body">
-                            <h5 class="card-title">DE Continent</h5>
-                            <p id="de-continent-options" class="card-text spothole-card-text"></p>
-                        </div>
-                    </div>
-                </div>
-                <div class="col">
-                    <div class="card">
-                        <div class="card-body">
-                            <h5 class="card-title">Modes</h5>
-                            <p id="mode-options" class="card-text spothole-card-text"></p>
-                        </div>
-                    </div>
-                </div>
-                <div class="col">
-                    <div class="card">
-                        <div class="card-body">
-                            <h5 class="card-title">Sources</h5>
-                            <p id="source-options" class="card-text spothole-card-text"></p>
-                        </div>
-                    </div>
-                </div>
-            </div>
-        </div>
-    </div>
-
-    <div id="display-area" class="appearing-panel card mb-3">
-        <div class="card-header text-white bg-primary">
-            <div class="row">
-                <div class="col-auto me-auto">
-                    Display
-                </div>
-                <div class="col-auto d-inline-flex">
-                    <button id="close-display-button" type="button" class="btn-close btn-close-white" aria-label="Close" onclick="closeDisplayPanel();"></button>
-                </div>
-            </div>
-
-        </div>
-        <div class="card-body">
-            <div id="display-container" class="row row-cols-1 row-cols-md-4 g-4">
-                <div class="col">
-                    <div class="card">
-                        <div class="card-body">
-                            <h5 class="card-title">Time Zone</h5>
-                            <p class="card-text spothole-card-text"> Use
-                                <select id="timeZone" class="storeable-select form-select ms-2 me-2 d-inline-block" oninput="timeZoneUpdated();" style="width: 8em; display: inline-block;">
-                                    <option value="UTC" selected>UTC</option>
-                                    <option value="local">Local time</option>
-                                </select>
-                            </p>
-                        </div>
-                    </div>
-                </div>
-                <div class="col">
-                    <div class="card">
-                        <div class="card-body">
-                            <h5 class="card-title">Number of Spots</h5>
-                            <p class="card-text spothole-card-text">Show up to
-                                <select id="spots-to-fetch" class="storeable-select form-select ms-2 me-2 d-inline-block" oninput="filtersUpdated();" style="width: 5em; display: inline-block;">
-                                    <option value="10">10</option>
-                                    <option value="25">25</option>
-                                    <option value="50" selected>50</option>
-                                    <option value="100">100</option>
-                                </select>
-                                spots
-                            </p>
-                        </div>
-                    </div>
-                </div>
-                <div class="col">
-                    <div class="card">
-                        <div class="card-body">
-                            <h5 class="card-title">Table Columns</h5>
-                            <div class="form-group">
-                                <div class="form-check form-check-inline">
-                                  <input class="form-check-input storeable-checkbox" type="checkbox" id="tableShowTime" value="tableShowTime" oninput="columnsUpdated();" checked>
-                                  <label class="form-check-label" for="tableShowTime">Time</label>
-                                </div>
-                                <div class="form-check form-check-inline">
-                                  <input class="form-check-input storeable-checkbox" type="checkbox" id="tableShowDX" value="tableShowDX" oninput="columnsUpdated();" checked>
-                                  <label class="form-check-label" for="tableShowDX">DX</label>
-                                </div>
-                                <div class="form-check form-check-inline">
-                                  <input class="form-check-input storeable-checkbox" type="checkbox" id="tableShowFreq" value="tableShowFreq" oninput="columnsUpdated();" checked>
-                                  <label class="form-check-label" for="tableShowFreq">Frequency</label>
-                                </div>
-                                <div class="form-check form-check-inline">
-                                  <input class="form-check-input storeable-checkbox" type="checkbox" id="tableShowMode" value="tableShowMode" oninput="columnsUpdated();" checked>
-                                  <label class="form-check-label" for="tableShowMode">Mode</label>
-                                </div>
-                                <div class="form-check form-check-inline">
-                                  <input class="form-check-input storeable-checkbox" type="checkbox" id="tableShowComment" value="tableShowComment" oninput="columnsUpdated();" checked>
-                                  <label class="form-check-label" for="tableShowComment">Comment</label>
-                                </div>
-                                <div class="form-check form-check-inline">
-                                  <input class="form-check-input storeable-checkbox" type="checkbox" id="tableShowBearing" value="tableShowBearing" oninput="columnsUpdated();">
-                                  <label class="form-check-label" for="tableShowBearing">Bearing</label>
-                                </div>
-                                <div class="form-check form-check-inline">
-                                  <input class="form-check-input storeable-checkbox" type="checkbox" id="tableShowType" value="tableShowType" oninput="columnsUpdated();" checked>
-                                  <label class="form-check-label" for="tableShowType">Type</label>
-                                </div>
-                                <div class="form-check form-check-inline">
-                                  <input class="form-check-input storeable-checkbox" type="checkbox" id="tableShowRef" value="tableShowRef" oninput="columnsUpdated();" checked>
-                                  <label class="form-check-label" for="tableShowRef">Ref.</label>
-                                </div>
-                                <div class="form-check form-check-inline">
-                                  <input class="form-check-input storeable-checkbox" type="checkbox" id="tableShowDE" value="tableShowDE" oninput="columnsUpdated();" checked>
-                                  <label class="form-check-label" for="tableShowDE">DE</label>
-                                </div>
-                            </div>
-                        </div>
-                    </div>
-                </div>
-                <div class="col">
-                    <div class="card">
-                        <div class="card-body">
-                            <h5 class="card-title">Location</h5>
-                                <div class="form-group spothole-card-text">
-                                    <label for="userGrid">Your grid:</label>
-                                    <input type="text" class="storeable-text form-control" id="userGrid" placeholder="AA00aa" oninput="userGridUpdated();" style="width: 10em; display: inline-block;">
-                                </div>
-                        </div>
-                    </div>
-                </div>
-            </div>
-        </div>
-    </div>
-
-    <div id="table-container"></div>
-
-</div>
-
-<script src="/js/common.js"></script>
-<script src="/js/spotandmap.js"></script>
-<script src="/js/spots.js"></script>
-<script>$(document).ready(function() { $("#nav-link-spots").addClass("active"); }); <!-- highlight active page in nav --></script>