Merge branch 'main' into 95-send-spots-to-xota

# Conflicts:
#	README.md
#	config-example.yml
#	core/config.py
#	server/handlers/api/addspot.py
#	server/handlers/api/options.py
#	static/js/add-spot.js
#	static/js/bands.js
#	static/js/map.js

.idea/encodings.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="Encoding">
+    <file url="file://$PROJECT_DIR$/datafiles/MUNICIPIOS.csv" charset="ISO-8859-1" />
+  </component>
+</project>

.idea/spothole.iml

@@ -2,8 +2,9 @@
 <module type="PYTHON_MODULE" version="4">
   <component name="NewModuleRootManager">
     <content url="file://$MODULE_DIR$">
+      <sourceFolder url="file://$MODULE_DIR$" isTestSource="false" />
       <excludeFolder url="file://$MODULE_DIR$/.venv" />
-      <excludeFolder url="file://$MODULE_DIR$/webassets/vendor" />
+      <excludeFolder url="file://$MODULE_DIR$/static/vendor" />
     </content>
     <orderEntry type="jdk" jdkName="Python 3.13 virtualenv at ~/code/spothole/.venv" jdkType="Python SDK" />
     <orderEntry type="sourceFolder" forTests="false" />

README.md

@@ -1,4 +1,4 @@
-# ![Spothole](/webassets/img/logo.png)
+# ![Spothole](/static/img/logo.png)
 
 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.
@@ -19,6 +19,8 @@ Supported data sources include DX Clusters, the Reverse Beacon Network (RBN), th
 SOTA, WWFF, GMA, WWBOTA, HEMA, Parks 'n' Peaks, ZLOTA, WOTA, BOTA, LLOTA, WWTOTA, Tiles on the Air, the UK Packet
 Repeater Network, NG3K, and any site based on the xOTA software by nischu.
 
+Additional Special Interest Groups (SIGs) without their own specific data source include WAB, WAI and DME.
+
 ![Screenshot](/images/screenshot2.png)
 
 ![Screenshot](/images/screenshot3.png)
@@ -87,15 +89,15 @@ 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
+* Refer to the API docs. These are built on an OpenAPI definition file (`/static/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. For example, your app could call
   `https://spothole.app/api/v2/spots` once every few minutes. 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"
+* Refer to the provided HTML/JS interface for a reference on different approaches. For example, the "alerts"/"upcoming"
-  pages simply query the main spot API on a timer, whereas the main/spots page combines this approach with using the
+  page simply query the main spot API on a timer, whereas the spots, map and bands pages combine this approach with
-  Server-Sent Events (SSE) endpoint to update live.
+  using the Server-Sent Events (SSE) endpoint to update live.
 * Let me know if you get stuck, I'm happy to help.
 
 Please don't hammer the API with an unnecessarily high request rate. For example, Spothole only queries the POTA API
@@ -316,93 +318,78 @@ To set up nginx as a reverse proxy that sits in front of Spothole, first ensure
 
 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.
+update that on the "proxy_pass" line, and if you installed Spothole somewhere other than `/home/spothole/spothole`,
+adjust the alias location for serving static files.
+
+(The latter section, configuring the nginx server to serve static files directly, improves efficiency because it saves
+Spothole itself from serving JS, CSS etc. files. If you can't do this for some reason, e.g. your nginx and spothole are
+on different computers, you can omit the `location /static/ {}` block.)
 
 ```nginx
 server {
     server_name spothole.app;
 
+    # Global proxy settings
+    proxy_http_version 1.1;
+    proxy_set_header Connection "";
+    proxy_connect_timeout 10s;
+    proxy_buffering on;
+    
+    # Pass on IP address and host information to Spothole, in case logging this information is required
+    proxy_set_header X-Real-IP $remote_addr;
+    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+    proxy_set_header Host $http_host;
+    proxy_set_header X-Forwarded-Proto $scheme;
+
     # Wellknown area for Lets Encrypt
     location /.well-known/ {
         alias /var/www/html/.well-known/;
     }
+
+    # Load static assets directly from the Spothole static directory
+    location /static/ {
+        alias /home/spothole/spothole/static/;
+        expires 1h;
+        add_header Cache-Control "public, max-age=3600, must-revalidate";
+    }
     
     # SSE endpoints
-    location ~ ^/api/v2/(spots|alerts)/stream {
+    location ~ ^/api/v2/(spots|alerts)/stream/? {
         proxy_pass http://127.0.0.1:8080;
         
-        # Allow keep-alive
+        # Remove buffering, remove caching, add suitable timeouts for SSE API calls
-        proxy_http_version 1.1;
-        proxy_set_header Connection "";
-        
-        # Set correct content type for SSE API calls
-        add_header Content-Type text/event-stream always;
-        
-        # Set remove buffering, remove caching, add suitable timeouts for SSE API calls
         proxy_buffering off;
         proxy_cache off;
         proxy_read_timeout 24h;
-        proxy_connect_timeout 10s;
         proxy_send_timeout 24h;
         proxy_set_header X-Accel-Buffering no;
         add_header Cache-Control no-store always;
         
         # Allow cross-origin requests to API
         proxy_hide_header Access-Control-Allow-Origin;
-        add_header Access-Control-Allow-Origin * always;
+        add_header Access-Control-Allow-Origin * always; 
-        
-        # Pass on IP address and host information to Spothole, in case logging this information is required
-        proxy_set_header X-Real-IP $remote_addr;
-        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
-        proxy_set_header Host $http_host;
-        proxy_set_header X-Forwarded-Proto $scheme;
     }
 
     # Other API endpoints
     location /api/ {
         proxy_pass http://127.0.0.1:8080;
         
-        # Allow keep-alive
+        # Remove buffering, remove caching, add suitable timeouts for API calls
-        proxy_http_version 1.1;
+        proxy_buffering off;
-        proxy_set_header Connection "";
-        
-        # Set up buffering, remove caching, add suitable timeouts for API calls
-        proxy_buffering on;
         proxy_cache off;
         proxy_read_timeout 30s;
-        proxy_connect_timeout 10s;
         add_header Cache-Control no-store always;
         
         # Allow cross-origin requests to API
         proxy_hide_header Access-Control-Allow-Origin;
         add_header Access-Control-Allow-Origin * always;
-        
-        # Pass on IP address and host information to Spothole, in case logging this information is required
-        proxy_set_header X-Real-IP $remote_addr;
-        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
-        proxy_set_header Host $http_host;
-        proxy_set_header X-Forwarded-Proto $scheme;
     }
 
-    # Static assets
+    # Templated pages
     location / {
         proxy_pass http://127.0.0.1:8080;
-        
-        # Allow keep-alive
-        proxy_http_version 1.1;
-        proxy_set_header Connection "";
-        
-        # Set up buffering and caching, add suitable timeouts for static asset requests
-        proxy_buffering on;
         proxy_read_timeout 30s;
-        proxy_connect_timeout 10s;
+        add_header Cache-Control "no-cache, must-revalidate" always;
-        add_header Cache-Control "public, max-age=3600, must-revalidate" always;
-        
-        # Pass on IP address and host information to Spothole, in case logging this information is required
-        proxy_set_header X-Real-IP $remote_addr;
-        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
-        proxy_set_header Host $http_host;
-        proxy_set_header X-Forwarded-Proto $scheme;
     }
 }
 ```
@@ -465,12 +452,12 @@ To navigate your way around the source code, this list may help.
 
 *HTML/JS/CSS front-end code*
 
-* `/webassets` - Root for static files served by the web server
+* `/static` - Root for static files served by the web server. These are all served from a path starting `/static/`.
-* `/webassets/apidocs` - Contains the OpenAPI spec (`openapi.yml`)
+* `/static/apidocs` - Contains the OpenAPI spec (`openapi.yml`)
-* `/webassets/css` - CSS files used by the web front-end
+* `/static/css` - CSS files used by the web front-end
-* `/webassets/img` - image files used by the web front-end
+* `/static/img` - image files used by the web front-end
-* `/webassets/js` - JavaScript used by the web front-end
+* `/static/js` - JavaScript used by the web front-end
-* `/webassets/vendor` - Third-party libraries (CSS, JS, fonts and images)
+* `/static/vendor` - Third-party libraries (CSS, JS, fonts and images)
 
 *Miscellaneous*
 
@@ -515,17 +502,21 @@ The same approach as above is also used for alert providers.
 As well as being my work, I have also gratefully received feature patches from Steven, M1SDH.
 
 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.
+my knowledge, created by HA8TKS for his CQ and ITU zone layers for Leaflet. `/datafiles` also contains a
+`MUNICIPIOS.csv` file, from the "Nomenclátor Geográfico de Municipios y Entidades de Población" data set sourced from
+[el Centro Nacional de Información Geográfica](https://centrodedescargas.cnig.es/CentroDescargas/home).
+`didbase-stations.csv` and the TOTA CSV files were created by me based on publicly available data from GIRO and from
+maps of conference centres.
 
 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.
+`/static/img/flags/` directory.
 
 The software uses a number of Python libraries as listed in `requirements.txt`, and a number of JavaScript libraries.
 This project would not have been possible without these libraries, so many thanks to their developers.
 
 ### Third Party Libraries
 
-A number of third-party libraries are self-hosted in the `/webassets/vendor/` directory. These files are subject to
+A number of third-party libraries are self-hosted in the `/static/vendor/` directory. These files are subject to
 their own licences and are not covered by the overall licence declared in the `LICENSE` file.
 
 A number of third-party libraries are self-hosted in the `/webassets/vendor/` directory. These files are subject to

alertproviders/http_alert_provider.py

@@ -4,6 +4,7 @@ from threading import Thread, Event
 
 import pytz
 import requests
+from requests.exceptions import ConnectionError, ReadTimeout, ConnectTimeout
 
 from alertproviders.alert_provider import AlertProvider
 from core.constants import HTTP_HEADERS
@@ -41,16 +42,25 @@ class HTTPAlertProvider(AlertProvider):
             # Request data from API
             logging.debug("Polling " + self.name + " alert API...")
             http_response = requests.get(self._url, headers=HTTP_HEADERS, timeout=(5, 30))
-            # Pass off to the subclass for processing
+            # Check response code was good
-            new_alerts = self._http_response_to_alerts(http_response)
+            if http_response.ok:
-            # Submit the new alerts for processing. There might not be any alerts for the less popular programs.
+                # Pass off to the subclass for processing
-            if new_alerts:
+                new_alerts = self._http_response_to_alerts(http_response)
-                self._submit_batch(new_alerts)
+                # 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.status = "OK"
+                self.status = "OK"
-            self.last_update_time = datetime.now(pytz.UTC)
+                self.last_update_time = datetime.now(pytz.UTC)
-            logging.debug("Received data from " + self.name + " alert API.")
+                logging.debug("Received data from " + self.name + " alert API.")
+            else:
+                self.status = "Error"
+                logging.warning(f"HTTP {http_response.status_code} when calling {self.name} alerts API.")
 
+        except ConnectionError:
+            logging.warning(f"Connection error when accessing {self.name} alerts API.")
+        except (ConnectTimeout, ReadTimeout):
+            logging.warning(f"Timeout when accessing {self.name} alerts API.")
         except Exception:
             self.status = "Error"
             logging.exception("Exception in HTTP JSON Alert Provider (" + self.name + ")")

alertproviders/parksnpeaks.py

@@ -33,18 +33,24 @@ class ParksNPeaks(HTTPAlertProvider):
             start_time = datetime.strptime(source_alert["alTime"], "%Y-%m-%d %H:%M:%S").replace(
                 tzinfo=pytz.UTC).timestamp()
 
+            sigrefs = []
+            # PnP can give us an alert of class "QRP" which is the only one that's not a real SIG in Spothole's list,
+            # so mask this out if we got it.
+            if sig != "QRP":
+                sigrefs = [SIGRef(id=sig_ref, sig=sig, name=sig_ref_name)]
+
             # Convert to our alert format
             alert = Alert(source=self.name,
                           source_id=source_alert["alID"],
                           dx_calls=[source_alert["CallSign"].upper()],
                           freqs_modes=source_alert["Freq"] + " " + source_alert["MODE"],
                           comment=source_alert["Comments"],
-                          sig_refs=[SIGRef(id=sig_ref, sig=sig, name=sig_ref_name)],
+                          sig_refs=sigrefs,
                           start_time=start_time,
                           is_dxpedition=False)
 
             # 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"]:
+            if sig and sig not in ["POTA", "SOTA", "WWFF", "SiOTA", "ZLOTA", "KRMNPA", "LLOTA", "QRP"]:
                 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

config-example.yml

@@ -66,8 +66,8 @@ spot-providers:
     name: "LLOTA"
     enabled: true
 
-  - class: "WWTOTA"
+  - class: "Towers"
-    name: "WWTOTA"
+    name: "Towers"
     enabled: true
 
   - class: "Tiles"
@@ -225,6 +225,14 @@ allow-upstream-spotting: true
 recaptcha-site-key: ""
 recaptcha-secret-key: ""
 
+# Log web requests? Useful to see what your users are requesting in terms of pages and API endpoints, but will fill up
+# your log quickly on a popular server.
+log-web-requests: false
+
+# Minimum severity of log statements to print to the system log. Defaults to INFO, change to DEBUG if you need more
+# information.
+log-level: INFO
+
 # Options for the web UI.
 web-ui-options:
   spot-count: [ 10, 25, 50, 100 ]

core/cache_utils.py

@@ -1,3 +1,4 @@
+import threading
 from datetime import timedelta
 
 from requests_cache import CachedSession
@@ -5,6 +6,22 @@ from requests_cache import CachedSession
 # Cache for "semi-static" data such as the locations of parks, CSVs of reference lists, etc.
 # This has an expiry time of 30 days, so will re-request from the source after that amount
 # of time has passed. This is used throughout Spothole to cache data that does not change
-# rapidly.
+# rapidly. The ThreadSafeSession construct here protects it against some multithreading
-SEMI_STATIC_URL_DATA_CACHE = CachedSession("cache/semi_static_url_data_cache",
+# contention weirdness we sometimes used to see on startup where the cache was hammered
-                                           expire_after=timedelta(days=30))
+# pretty hard. The expanded list of allowable_codes ensures we also cache and return 400-type
+# responses, e.g "this SOTA summit ref doesn't actually exist", to avoid hammering remote
+# servers for data they've told us they can't provide.
+_session = CachedSession("cache/semi_static_url_data_cache", expire_after=timedelta(days=30),
+                         allowable_codes=(200, 400, 401, 403, 404))
+_lock = threading.Lock()
+
+
+class _ThreadSafeSession:
+    """Wraps CachedSession with a lock to prevent concurrent SQLite access across threads."""
+
+    def get(self, *args, **kwargs):
+        with _lock:
+            return _session.get(*args, **kwargs)
+
+
+SEMI_STATIC_URL_DATA_CACHE = _ThreadSafeSession()

core/config.py

@@ -25,6 +25,8 @@ WEB_UI_OPTIONS = config.get("web-ui-options", {})
 API_ONLY_MODE = config.get("api-only-mode", False)
 RECAPTCHA_SECRET_KEY = config.get("recaptcha-secret-key", "")
 RECAPTCHA_SITE_KEY = config.get("recaptcha-site-key", "")
+LOG_LEVEL = config.get("log-level", "INFO")
+LOG_WEB_REQUESTS = config.get("log-web-requests", False)
 
 # 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.

core/constants.py

@@ -11,28 +11,29 @@ HAMQTH_PRG = ("Spothole v" + SOFTWARE_VERSION + " operated by " + SERVER_OWNER_C
 
 # Special Interest Groups
 SIGS = [
-    SIG(name="POTA", description="Parks on the Air", ref_regex=r"([A-Z]{2}\-\d{4,5}|K\-TEST)"),
+    SIG(name="POTA", comment_names=["POTA"], description="Parks on the Air", ref_regex=r"[A-Z]{2}\-\d{4,5}|K\-TEST"),
-    SIG(name="SOTA", description="Summits on the Air", ref_regex=r"[A-Z0-9]{1,3}\/[A-Z]{2}\-\d{3}"),
+    SIG(name="SOTA", comment_names=["SOTA"], description="Summits on the Air", ref_regex=r"[A-Z0-9]{1,3}\/[A-Z]{2}\-\d{3}"),
-    SIG(name="WWFF", description="World Wide Flora & Fauna", ref_regex=r"[A-Z0-9]{1,3}FF\-\d{4}"),
+    SIG(name="WWFF", comment_names=["WWFF"], description="World Wide Flora & Fauna", ref_regex=r"[A-Z0-9]{1,3}FF\-\d{4}"),
-    SIG(name="GMA", description="Global Mountain Activity", ref_regex=r"[A-Z0-9]{1,3}\/[A-Z]{2}\-\d{3}"),
+    SIG(name="GMA", comment_names=["GMA"], description="Global Mountain Activity", ref_regex=r"[A-Z0-9]{1,3}\/[A-Z]{2}\-\d{3}"),
-    SIG(name="WWBOTA", description="Worldwide Bunkers on the Air", ref_regex=r"B\/[A-Z0-9]{1,3}\-\d{3,4}"),
+    SIG(name="WWBOTA", comment_names=["WWBOTA", "BOTA"], description="Worldwide Bunkers on the Air", ref_regex=r"B\/[A-Z0-9]{1,3}\-\d{3,4}"),
-    SIG(name="HEMA", description="HuMPs Excluding Marilyns Award", ref_regex=r"[A-Z0-9]{1,3}\/[A-Z]{3}\-\d{3}"),
+    SIG(name="HEMA", comment_names=["HEMA"], description="HuMPs Excluding Marilyns Award", ref_regex=r"[A-Z0-9]{1,3}\/[A-Z]{3}\-\d{3}"),
-    SIG(name="IOTA", description="Islands on the Air", ref_regex=r"[A-Z]{2}\-\d{3}"),
+    SIG(name="IOTA", comment_names=["IOTA"], description="Islands on the Air", ref_regex=r"[A-Z]{2}\-\d{3}"),
-    SIG(name="MOTA", description="Mills on the Air", ref_regex=r"X\d{4,6}"),
+    SIG(name="MOTA", comment_names=["MOTA"], description="Mills on the Air", ref_regex=r"X\d{4,6}"),
-    SIG(name="ARLHS", description="Amateur Radio Lighthouse Society", ref_regex=r"[A-Z]{3}\-\d{3,4}"),
+    SIG(name="ARLHS", comment_names=["ARLHS"], description="Amateur Radio Lighthouse Society", ref_regex=r"[A-Z]{3}\-\d{3,4}"),
-    SIG(name="ILLW", description="International Lighthouse & Lightship Weekend", ref_regex=r"[A-Z]{2}\d{4}"),
+    SIG(name="ILLW", comment_names=["ILLW"], description="International Lighthouse & Lightship Weekend", ref_regex=r"[A-Z]{2}\d{4}"),
-    SIG(name="SIOTA", description="Silos on the Air", ref_regex=r"[A-Z]{2}\-[A-Z]{3}\d"),
+    SIG(name="SiOTA", comment_names=["SIOTA"], description="Silos on the Air", ref_regex=r"[A-Z]{2}\-[A-Z]{3}\d"),
-    SIG(name="WCA", description="World Castles Award", ref_regex=r"[A-Z0-9]{1,3}\-\d{5}"),
+    SIG(name="WCA", comment_names=["WCA"], description="World Castles Award", ref_regex=r"[A-Z0-9]{1,3}\-\d{5}"),
-    SIG(name="ZLOTA", description="New Zealand on the Air", ref_regex=r"ZL[A-Z]/[A-Z]{2}\-\d{3,4}"),
+    SIG(name="ZLOTA", comment_names=["ZLOTA"], description="New Zealand on the Air", ref_regex=r"ZL[A-Z]/[A-Z]{2}\-\d{3,4}"),
-    SIG(name="WOTA", description="Wainwrights on the Air", ref_regex=r"[A-Z]{3}-[0-9]{2}"),
+    SIG(name="WOTA", comment_names=["WOTA"], description="Wainwrights on the Air", ref_regex=r"[A-Z]{3}-[0-9]{2}"),
-    SIG(name="BOTA", description="Beaches on the Air"),
+    SIG(name="BOTA", comment_names=[], description="Beaches on the Air"),
-    SIG(name="KRMNPA", description="Keith Roget Memorial National Parks Award"),
+    SIG(name="KRMNPA", comment_names=["KRMNPA"], description="Keith Roget Memorial National Parks Award"),
-    SIG(name="LLOTA", description="Lagos y Lagunas on the Air", ref_regex=r"[A-Z]{2}\-\d{4}"),
+    SIG(name="LLOTA", comment_names=["LLOTA"], description="Lagos y Lagunas on the Air", ref_regex=r"LL[A-Z]{2}\-\d{4}"),
-    SIG(name="WWTOTA", description="Towers on the Air", ref_regex=r"[A-Z]{2}R\-\d{4}"),
+    SIG(name="Towers", comment_names=["TOTA"], description="Towers on the Air", ref_regex=r"[A-Z]{2,3}R\-\d{4}"),
-    SIG(name="Tiles", description="Tiles on the Air", ref_regex=r"[A-Za-z]{2}[0-9]{2}[A-Za-z]{2}"),
+    SIG(name="Tiles", comment_names=[], description="Tiles on the Air", ref_regex=r"[A-Za-z]{2}[0-9]{2}[A-Za-z]{2}"),
-    SIG(name="WAB", description="Worked All Britain", ref_regex=r"[A-Z]{1,2}[0-9]{2}"),
+    SIG(name="WAB", comment_names=["WAB"], description="Worked All Britain", ref_regex=r"[A-Z]{1,2}[0-9]{2}"),
-    SIG(name="WAI", description="Worked All Ireland", ref_regex=r"[A-Z][0-9]{2}"),
+    SIG(name="WAI", comment_names=["WAI"], description="Worked All Ireland", ref_regex=r"[A-Z][0-9]{2}"),
-    SIG(name="TOTA", description="Toilets on the Air", ref_regex=r"T\-[0-9]{2}")
+    SIG(name="DME", comment_names=["DME"], description="Diplomas de Municipios Españoles", ref_regex=r"\d{4,5}"),
+    SIG(name="Toilets", comment_names=[], description="Toilets on the Air", ref_regex=r"T\-[0-9]{2}")
 ]
 
 # Modes. Note "DIGI" and "DIGITAL" are also supported but are normalised into "DATA".
@@ -103,5 +104,6 @@ PROPAGATION_MODES = {
     "AU": "Aurora",
     "MS": "Meteor scatter",
     "RS": "Rain scatter",
-    "AS": "Aircraft scatter"
+    "AS": "Aircraft scatter",
+    "SAT": "Satellite"
 }

core/lookup_helper.py

@@ -5,13 +5,13 @@ import re
 import urllib.parse
 from datetime import timedelta
 
-import requests
 import xmltodict
 from diskcache import Cache
 from pyhamtools import LookupLib, Callinfo, callinfo
 from pyhamtools.exceptions import APIKeyMissingError
 from pyhamtools.frequency import freq_to_band
 from pyhamtools.locator import latlong_to_locator
+from requests.exceptions import ConnectionError, ReadTimeout, ConnectTimeout
 from requests_cache import CachedSession
 
 from core.cache_utils import SEMI_STATIC_URL_DATA_CACHE
@@ -143,13 +143,21 @@ class LookupHelper:
         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
+                                                      headers=HTTP_HEADERS)
 
-            with open(self._country_files_cty_plist_download_location, "w") as f:
+            if response.ok:
-                f.write(response)
+                with open(self._country_files_cty_plist_download_location, "w") as f:
-                f.flush()
+                    f.write(response.text)
-                return True
+                    f.flush()
+                    return True
+            else:
+                logging.warning(f"HTTP {response.status_code} when downloading Country-files.com cty.plist.")
+                return False
 
+        except ConnectionError:
+            logging.warning(f"Connection error when downloading Clublog cty.xml.")
+        except (ConnectTimeout, ReadTimeout):
+            logging.warning(f"Timeout when downloading Clublog cty.xml.")
         except Exception as e:
             logging.error("Exception when downloading Clublog cty.xml", e)
             return False
@@ -161,13 +169,21 @@ class LookupHelper:
             logging.info("Downloading dxcc.json...")
             response = SEMI_STATIC_URL_DATA_CACHE.get(
                 "https://raw.githubusercontent.com/k0swe/dxcc-json/refs/heads/main/dxcc.json",
-                headers=HTTP_HEADERS).text
+                headers=HTTP_HEADERS)
 
-            with open(self._dxcc_json_download_location, "w") as f:
+            if response.ok:
-                f.write(response)
+                with open(self._dxcc_json_download_location, "w") as f:
-                f.flush()
+                    f.write(response.text)
-                return True
+                    f.flush()
+                    return True
+            else:
+                logging.warning(f"HTTP {response.status_code} when downloading dxcc.json.")
+                return False
 
+        except ConnectionError:
+            logging.warning(f"Connection error when downloading dxcc.json.")
+        except (ConnectTimeout, ReadTimeout):
+            logging.warning(f"Timeout when downloading dxcc.json.")
         except Exception as e:
             logging.error("Exception when downloading dxcc.json", e)
             return False
@@ -490,25 +506,47 @@ class LookupHelper:
 
         # Try the call as given, then fall back to the base call (strips /P, /M etc.)
         calls_to_try = [call]
-        home_call = callinfo.Callinfo.get_homecall(call)
+        try:
-        if home_call != call:
+            home_call = callinfo.Callinfo.get_homecall(call)
-            calls_to_try.append(home_call)
+            if home_call != call:
+                calls_to_try.append(home_call)
+        except ValueError:
+            logging.debug("Could not look up home call for callsign %s", call)
 
         for lookup_call in calls_to_try:
             try:
-                lookup_response = requests.get(
+                response = SEMI_STATIC_URL_DATA_CACHE.get(
                     self._qrz_base_url + "?s=" + session_key + "&callsign=" + urllib.parse.quote_plus(lookup_call),
-                    headers=HTTP_HEADERS, timeout=10).content
+                    headers=HTTP_HEADERS, timeout=10)
-                raw = xmltodict.parse(lookup_response).get("QRZDatabase", {}).get("Callsign")
+                if response.ok:
-                if raw:
+                    qrz_response = xmltodict.parse(response.content).get("QRZDatabase", {})
-                    data = _normalize_qrz_data(raw)
+                    if qrz_response:
-                    self._qrz_callsign_data_cache.add(call, data, expire=604800)  # 1 week in seconds
+                        if "Callsign" in qrz_response:
-                    return data
+                            data = _normalize_qrz_data(qrz_response.get("Callsign"))
+                            self._qrz_callsign_data_cache.add(call, data, expire=604800)  # 1 week in seconds
+                            return data
+                        elif "Session" in qrz_response and "Error" in qrz_response.get("Session"):
+                            # Errors here are normally just "callsign not in database", no need to log that ourselves
+                            # above debug level.
+                            logging.debug("QRZ returned an error looking up callsign %s: %s", lookup_call,
+                                          qrz_response.get("Session").get("Error"))
+
+                    elif not response.from_cache:
+                        logging.warning("QRZ returned a malformed response looking up callsign %s", lookup_call)
+                elif not response.from_cache:
+                    logging.warning("HTTP %d looking up callsign %s using QRZ", lookup_call)
+
             except (KeyError, ValueError):
                 continue
+            except ConnectionError:
+                logging.warning(f"Connection error when looking up callsign %s using QRZ", lookup_call)
+                continue
+            except (ConnectTimeout, ReadTimeout):
+                logging.warning(f"Timeout when looking up callsign %s using QRZ.", lookup_call)
+                continue
             except Exception:
-                logging.error("Exception when looking up QRZ data")
+                logging.error("Exception when looking up callsign %s using QRZ", lookup_call, exc_info=True)
-                return None
+                continue
 
         # Not found in QRZ; cache None so we don't keep retrying
         self._qrz_callsign_data_cache.add(call, None, expire=604800)  # 1 week in seconds
@@ -546,23 +584,36 @@ class LookupHelper:
 
         # Try the call as given, then fall back to the base call (strips /P, /M etc.)
         calls_to_try = [call]
-        home_call = callinfo.Callinfo.get_homecall(call)
+        try:
-        if home_call != call:
+            home_call = callinfo.Callinfo.get_homecall(call)
-            calls_to_try.append(home_call)
+            if home_call != call:
+                calls_to_try.append(home_call)
+        except ValueError:
+            logging.debug("Could not look up home call for callsign %s", call)
 
         for lookup_call in calls_to_try:
             try:
-                lookup_data = SEMI_STATIC_URL_DATA_CACHE.get(
+                response = SEMI_STATIC_URL_DATA_CACHE.get(
                     self._hamqth_base_url + "?id=" + session_id + "&callsign=" + urllib.parse.quote_plus(
-                        lookup_call) + "&prg=" + HAMQTH_PRG, headers=HTTP_HEADERS).content
+                        lookup_call) + "&prg=" + HAMQTH_PRG, headers=HTTP_HEADERS)
-                data = xmltodict.parse(lookup_data)["HamQTH"]["search"]
+                if response.ok:
-                self._hamqth_callsign_data_cache.add(call, data, expire=604800)  # 1 week in seconds
+                    data = xmltodict.parse(response.content)["HamQTH"]["search"]
-                return data
+                    self._hamqth_callsign_data_cache.add(call, data, expire=604800)  # 1 week in seconds
+                    return data
+                elif not response.from_cache:
+                    logging.warning("HTTP %d looking up callsign %s using HamQTH", response.status_code, lookup_call)
+
             except (KeyError, ValueError):
                 continue
+            except ConnectionError:
+                logging.warning(f"Connection error when looking up callsign %s using HamQTH", lookup_call)
+                continue
+            except (ConnectTimeout, ReadTimeout):
+                logging.warning(f"Timeout when looking up callsign %s using HamQTH", lookup_call)
+                continue
             except Exception:
-                logging.error("Exception when looking up HamQTH data")
+                logging.error("Exception when looking up callsign %s using HamQTH", lookup_call, exc_info=True)
-                return None
+                continue
 
         # Not found in HamQTH; cache None so we don't keep retrying
         self._hamqth_callsign_data_cache.add(call, None, expire=604800)  # 1 week in seconds

core/sig_utils.py

@@ -2,11 +2,25 @@ import csv
 import logging
 
 from pyhamtools.locator import latlong_to_locator, locator_to_latlong
+from requests.exceptions import ConnectionError, ReadTimeout, ConnectTimeout
 
 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
 
+# Load Spanish municipality data for the DME programme. There's no convenient lookup API for this, so we embed the data
+# file in Spothole and load it on startup.
+with open("datafiles/MUNICIPIOS.csv", encoding="latin-1") as _f:
+    _DME_INDEX = {row["COD_INE"][:5]: row for row in csv.DictReader(_f, delimiter=";")}
+# Caches for data for the SIGs where we have to download a whole global reference list, rather than looking up a single
+# reference. These get populated from the SEMI_STATIC_URL_DATA_CACHE only if the data actually came
+# live from the internet, to avoid repopulating them every time we pull the same data from the cache.
+_WWFF_INDEX_CACHE = {}
+_SIOTA_INDEX_CACHE = {}
+_WOTA_INDEX_CACHE = {}
+_ZLOTA_INDEX_CACHE = {}
+_LLOTA_INDEX_CACHE = {}
+
 
 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."""
@@ -17,6 +31,16 @@ def get_ref_regex_for_sig(sig):
     return None
 
 
+def get_sig_name_from_comment_name(sig):
+    """Utility function to get the name of a SIG from its "comment name". Generally these will be the same but there are
+    some cases (e.g. is "TOTA" Towers, Tiles or Toilets?) where we need to transform one to the other."""
+
+    for s in SIGS:
+        if any(n.upper() == sig.upper() for n in s.comment_names):
+            return s.name
+    return None
+
+
 def populate_sig_ref_info(sig_ref):
     """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
     must at minimum have a "sig" and an "id". The rest of the object will be populated and returned.
@@ -29,72 +53,137 @@ def populate_sig_ref_info(sig_ref):
     ref_id = sig_ref.id
     try:
         if sig.upper() == "POTA":
-            data = SEMI_STATIC_URL_DATA_CACHE.get("https://api.pota.app/park/" + ref_id, headers=HTTP_HEADERS).json()
+            response = SEMI_STATIC_URL_DATA_CACHE.get("https://api.pota.app/park/" + ref_id, headers=HTTP_HEADERS)
-            if data:
+            if response.ok:
-                fullname = str(data["name"]) if "name" in data else None
+                data = response.json()
-                if fullname and "parktypeDesc" in data and data["parktypeDesc"] != "":
+                if data:
-                    fullname = fullname + " " + data["parktypeDesc"]
+                    fullname = str(data["name"]) if "name" in data else None
-                sig_ref.name = fullname
+                    if fullname and "parktypeDesc" in data and data["parktypeDesc"] != "":
-                sig_ref.url = "https://pota.app/#/park/" + ref_id
+                        fullname = fullname + " " + data["parktypeDesc"]
-                sig_ref.grid = data["grid6"] if "grid6" in data else None
+                    sig_ref.name = fullname
-                sig_ref.latitude = data["latitude"] if "latitude" in data else None
+                    sig_ref.url = "https://pota.app/#/park/" + ref_id
-                sig_ref.longitude = data["longitude"] if "longitude" in data else None
+                    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 not response.from_cache:
+                    logging.warning("Malformed response looking up %s ref %s", sig, ref_id)
+            elif not response.from_cache:
+                logging.warning("HTTP %d looking up %s ref %s", response.status_code, sig, ref_id)
+
         elif sig.upper() == "SOTA":
-            data = SEMI_STATIC_URL_DATA_CACHE.get("https://api-db2.sota.org.uk/api/summits/" + ref_id,
+            response = SEMI_STATIC_URL_DATA_CACHE.get("https://api-db2.sota.org.uk/api/summits/" + ref_id,
-                                                  headers=HTTP_HEADERS).json()
+                                                      headers=HTTP_HEADERS)
-            if data:
+            if response.ok:
-                sig_ref.name = data["name"] if "name" in data else None
+                data = response.json()
-                sig_ref.url = "https://www.sotadata.org.uk/en/summit/" + ref_id
+                if data:
-                sig_ref.grid = data["locator"] if "locator" in data else None
+                    sig_ref.name = data["name"] if "name" in data else None
-                sig_ref.latitude = data["latitude"] if "latitude" in data else None
+                    sig_ref.url = "https://www.sotadata.org.uk/en/summit/" + ref_id
-                sig_ref.longitude = data["longitude"] if "longitude" in data else None
+                    sig_ref.grid = data["locator"] if "locator" in data else None
-                sig_ref.activation_score = data["points"] if "points" 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 not response.from_cache:
+                    logging.warning("Malformed response looking up %s ref %s", sig, ref_id)
+            elif not response.from_cache:
+                logging.warning("HTTP %d looking up %s ref %s", response.status_code, sig, ref_id)
+
         elif sig.upper() == "WWBOTA":
-            data = SEMI_STATIC_URL_DATA_CACHE.get("https://api.wwbota.org/bunkers/" + ref_id,
+            response = SEMI_STATIC_URL_DATA_CACHE.get("https://api.wwbota.org/bunkers/" + ref_id,
-                                                  headers=HTTP_HEADERS).json()
+                                                      headers=HTTP_HEADERS)
-            if data:
+            if response.ok:
-                sig_ref.name = data["name"] if "name" in data else None
+                data = response.json()
-                sig_ref.url = "https://bunkerwiki.org/?s=" + ref_id if ref_id.startswith("B/G") else None
+                if data:
-                sig_ref.grid = data["locator"] if "locator" in data else None
+                    sig_ref.name = data["name"] if "name" in data else None
-                sig_ref.latitude = data["lat"] if "lat" in data else None
+                    sig_ref.url = "https://bunkerwiki.org/?s=" + ref_id if ref_id.startswith("B/G") else None
-                sig_ref.longitude = data["long"] if "long" in data 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 not response.from_cache:
+                    logging.warning("Malformed response looking up %s ref %s", sig, ref_id)
+            elif not response.from_cache:
+                logging.warning("HTTP %d looking up %s ref %s", response.status_code, sig, ref_id)
+
         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/?" + ref_id,
+            response = SEMI_STATIC_URL_DATA_CACHE.get("https://www.cqgma.org/api/ref/?" + ref_id,
-                                                  headers=HTTP_HEADERS).json()
+                                                      headers=HTTP_HEADERS)
-            if data:
+            if response.ok:
-                sig_ref.name = data["name"] if "name" in data else None
+                data = response.json()
-                sig_ref.url = "https://www.cqgma.org/zinfo.php?ref=" + ref_id
+                if data:
-                sig_ref.grid = data["locator"] if "locator" in data else None
+                    sig_ref.name = data["name"] if "name" in data else None
-                sig_ref.latitude = data["latitude"] if "latitude" in data else None
+                    sig_ref.url = "https://www.cqgma.org/zinfo.php?ref=" + ref_id
-                sig_ref.longitude = data["longitude"] if "longitude" in data else None
+                    sig_ref.grid = data["locator"] if "locator" in data else None
+
+                    # For some things (just IOTA?) the GMA actually returns a box where "latitude" and "longitude" are
+                    # the zeroest corner of the box, then "lat2" and "lng2" provide the other corner. We detect this
+                    # and provide a single lat/lon for the centre. Otherwise if we don't have these extra parameters,
+                    # just use the single point we have.
+                    if data.get("latitude") is not None and data.get("longitude") is not None and data.get(
+                            "lat2") is not None and data.get("lng2") is not None:
+                        sig_ref.latitude = (float(data["latitude"]) + float(data["lat2"])) / 2.0
+                        sig_ref.longitude = (float(data["longitude"]) + float(data["lng2"])) / 2.0
+                    else:
+                        sig_ref.latitude = float(data["latitude"]) if data.get("latitude") is not None else None
+                        sig_ref.longitude = float(data["longitude"]) if data.get("longitude") is not None else None
+                elif not response.from_cache:
+                    logging.warning("Malformed response looking up %s ref %s via GMA", sig, ref_id)
+            elif not response.from_cache:
+                logging.warning("HTTP %d looking up %s ref %s", response.status_code, sig, ref_id)
+
         elif sig.upper() == "WWFF":
-            wwff_csv_data = SEMI_STATIC_URL_DATA_CACHE.get("https://wwff.co/wwff-data/wwff_directory.csv",
+            response = SEMI_STATIC_URL_DATA_CACHE.get("https://wwff.co/wwff-data/wwff_directory.csv",
-                                                           headers=HTTP_HEADERS)
+                                                      headers=HTTP_HEADERS)
-            wwff_index = {row["reference"]: row for row in csv.DictReader(wwff_csv_data.content.decode().splitlines())}
+            if response.ok:
-            row = wwff_index.get(ref_id)
+                global _WWFF_INDEX_CACHE
-            if row:
+                if not bool(_WWFF_INDEX_CACHE) or not response.from_cache:
-                sig_ref.name = row["name"] if "name" in row else None
+                    # New data from WWFF, update our internal map
-                sig_ref.url = "https://wwff.co/directory/?showRef=" + ref_id
+                    _WWFF_INDEX_CACHE = {row["reference"]: row for row in
-                sig_ref.grid = row["iaruLocator"] if "iaruLocator" in row and row["iaruLocator"] != "-" else None
+                                         csv.DictReader(response.content.decode().splitlines())}
-                sig_ref.latitude = float(row["latitude"]) if "latitude" in row and row["latitude"] != "-" else None
+                row = _WWFF_INDEX_CACHE.get(ref_id)
-                sig_ref.longitude = float(row["longitude"]) if "longitude" in row and row["longitude"] != "-" else None
+                if row:
+                    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
+                elif not response.from_cache:
+                    logging.warning("WWFF database did not contain data for ref %s", ref_id)
+            elif not response.from_cache:
+                logging.warning("HTTP %d looking up %s ref %s", response.status_code, sig, ref_id)
+
         elif sig.upper() == "SIOTA":
-            siota_csv_data = SEMI_STATIC_URL_DATA_CACHE.get("https://www.silosontheair.com/data/silos.csv",
+            response = SEMI_STATIC_URL_DATA_CACHE.get("https://www.silosontheair.com/data/silos.csv",
-                                                            headers=HTTP_HEADERS)
+                                                      headers=HTTP_HEADERS)
-            siota_index = {row["SILO_CODE"]: row for row in
+            if response.ok:
-                           csv.DictReader(siota_csv_data.content.decode().splitlines())}
+                global _SIOTA_INDEX_CACHE
-            row = siota_index.get(ref_id)
+                if not bool(_SIOTA_INDEX_CACHE) or not response.from_cache:
-            if row:
+                    # New data from SIOTA, update our internal map
-                sig_ref.name = row["NAME"] if "NAME" in row else None
+                    _SIOTA_INDEX_CACHE = {row["SILO_CODE"]: row for row in
-                sig_ref.grid = row["LOCATOR"] if "LOCATOR" in row else None
+                                          csv.DictReader(response.content.decode().splitlines())}
-                sig_ref.latitude = float(row["LAT"]) if "LAT" in row else None
+                row = _SIOTA_INDEX_CACHE.get(ref_id)
-                sig_ref.longitude = float(row["LNG"]) if "LNG" in row else None
+                if row:
+                    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
+                elif not response.from_cache:
+                    logging.warning("SIOTA database did not contain data for ref %s", ref_id)
+            elif not response.from_cache:
+                logging.warning("HTTP %d looking up %s ref %s", response.status_code, sig, ref_id)
+
         elif sig.upper() == "WOTA":
-            data = SEMI_STATIC_URL_DATA_CACHE.get("https://www.wota.org.uk/mapping/data/summits.json",
+            response = SEMI_STATIC_URL_DATA_CACHE.get("https://www.wota.org.uk/mapping/data/summits.json",
-                                                  headers=HTTP_HEADERS).json()
+                                                      headers=HTTP_HEADERS)
-            if data:
+            if response.ok:
-                for feature in data["features"]:
+                data = response.json()
-                    if feature["properties"]["wotaId"] == ref_id:
+                if data:
+                    global _WOTA_INDEX_CACHE
+                    if not bool(_WOTA_INDEX_CACHE) or not response.from_cache:
+                        # New data from WOTA, update our internal map
+                        _WOTA_INDEX_CACHE = {feature["properties"]["wotaId"]: feature for feature in
+                                             data.get("features", [])}
+                    feature = _WOTA_INDEX_CACHE.get(ref_id)
+                    if feature:
                         sig_ref.name = feature["properties"]["title"]
                         # Fudge WOTA URLs. Outlying fell (LDO) URLs don't match their ID numbers but require 214 to be
                         # added to them
@@ -105,42 +194,68 @@ def populate_sig_ref_info(sig_ref):
                         sig_ref.grid = feature["properties"]["qthLocator"]
                         sig_ref.latitude = feature["geometry"]["coordinates"][1]
                         sig_ref.longitude = feature["geometry"]["coordinates"][0]
-                        break
+                elif not response.from_cache:
+                    logging.warning("Malformed response looking up %s ref %s", sig, ref_id)
+            elif not response.from_cache:
+                logging.warning("HTTP %d looking up %s ref %s", response.status_code, sig, ref_id)
+
         elif sig.upper() == "ZLOTA":
-            data = SEMI_STATIC_URL_DATA_CACHE.get("https://ontheair.nz/assets/assets.json", headers=HTTP_HEADERS).json()
+            response = SEMI_STATIC_URL_DATA_CACHE.get("https://ontheair.nz/assets/assets.json", headers=HTTP_HEADERS)
-            if data:
+            if response.ok:
-                for asset in data:
+                data = response.json()
-                    if asset["code"] == ref_id:
+                if isinstance(data, list):
+                    global _ZLOTA_INDEX_CACHE
+                    if not bool(_ZLOTA_INDEX_CACHE) or not response.from_cache:
+                        # New data from ZLOTA, update our internal map
+                        _ZLOTA_INDEX_CACHE = {asset["code"]: asset for asset in data}
+                    asset = _ZLOTA_INDEX_CACHE.get(ref_id)
+                    if asset:
                         sig_ref.name = asset["name"]
-                        sig_ref.url = "https://ontheair.nz/assets/ZLI_OT-030" + ref_id.replace("/", "_")
+                        sig_ref.url = "https://ontheair.nz/assets/" + 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 not response.from_cache:
+                    logging.warning("Malformed response looking up %s ref %s", sig, ref_id)
+            elif not response.from_cache:
+                logging.warning("HTTP %d looking up %s ref %s", response.status_code, sig, ref_id)
+
         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",
+            response = SEMI_STATIC_URL_DATA_CACHE.get("https://llota.app/api/public/references",
-                                                  headers=HTTP_HEADERS).json()
+                                                      headers=HTTP_HEADERS)
-            if data:
+            if response.ok:
-                for ref in data:
+                data = response.json()
-                    if ref["reference_code"] == ref_id:
+                if isinstance(data, list):
+                    global _LLOTA_INDEX_CACHE
+                    if not bool(_LLOTA_INDEX_CACHE) or not response.from_cache:
+                        # New data from LLOTA, update our internal map
+                        _LLOTA_INDEX_CACHE = {ref["reference_code"]: ref for ref in data}
+                    ref = _LLOTA_INDEX_CACHE.get(ref_id)
+                    if ref:
                         sig_ref.name = str(ref["name"])
                         sig_ref.url = "https://llota.app/list/ref/" + ref_id
                         sig_ref.grid = str(ref["grid_locator"])
                         ll = locator_to_latlong(sig_ref.grid)
                         sig_ref.latitude = ll[0]
                         sig_ref.longitude = ll[1]
-                        break
+                elif not response.from_cache:
+                    logging.warning("Malformed response looking up %s ref %s", sig, ref_id)
+            elif not response.from_cache:
+                logging.warning("HTTP %d looking up %s ref %s", response.status_code, sig, ref_id)
+
         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=" + str(sig_ref.name)
+
         elif sig.upper() == "TILES":
             # Tiles on the Air just uses Maidenhead 6-digit squares, so ID, Name and Grid are all the same
             if not sig_ref.name:
@@ -151,6 +266,7 @@ def populate_sig_ref_info(sig_ref):
                 ll = locator_to_latlong(str(sig_ref.grid))
                 sig_ref.latitude = ll[0]
                 sig_ref.longitude = ll[1]
+
         elif sig.upper() == "WAB" or sig.upper() == "WAI":
             ll = wab_wai_square_to_lat_lon(ref_id)
             if ll:
@@ -160,14 +276,33 @@ def populate_sig_ref_info(sig_ref):
                     sig_ref.latitude = ll[0]
                     sig_ref.longitude = ll[1]
                 except:
-                    logging.debug("Invalid lat/lon received for reference")
+                    logging.warning("Invalid lat/lon received for WAB/WAI reference")
-    except:
+
-        logging.warning("Failed to look up sig_ref info for " + sig + " ref " + ref_id + ".")
+        elif sig.upper() == "DME":
+            # Zero-pad to 5 digits to match our source data
+            row = _DME_INDEX.get(ref_id.zfill(5))
+            if row:
+                sig_ref.name = row["NOMBRE_ACTUAL"] + ", " + row["PROVINCIA"]
+                sig_ref.latitude = float(row["LATITUD_ETRS89_REGCAN95"].replace(",", ".")) if row.get(
+                    "LATITUD_ETRS89_REGCAN95") else None
+                sig_ref.longitude = float(row["LONGITUD_ETRS89_REGCAN95"].replace(",", ".")) if row.get(
+                    "LONGITUD_ETRS89_REGCAN95") else None
+                if sig_ref.latitude and sig_ref.longitude:
+                    try:
+                        sig_ref.grid = latlong_to_locator(sig_ref.latitude, sig_ref.longitude, 6)
+                    except Exception:
+                        logging.warning("Invalid lat/lon received for DME reference")
+            else:
+                logging.warning("DME database did not contain data for ref %s", ref_id)
+
+    except ConnectionError:
+        logging.warning("Connection error when looking up sig_ref info for " + sig + " ref " + ref_id)
+    except (ConnectTimeout, ReadTimeout):
+        logging.warning(f"Timeout when looking up sig_ref info for " + sig + " ref " + ref_id)
+    except Exception:
+        logging.error("Exception when looking up sig_ref info for " + sig + " ref " + ref_id, exc_info=True)
     return sig_ref
 
 
-# Regex matching any SIG
+# Regex matching any SIG's "comment name", i.e. how it may be referred to in spot comments
-ANY_SIG_REGEX = r"(" + r"|".join(list(map(lambda p: p.name, SIGS))) + r")"
+ANY_SIG_REGEX = r"(" + r"|".join(n for s in SIGS for n in s.comment_names) + r")"
-
-# Regex matching any SIG reference
-ANY_XOTA_SIG_REF_REGEX = r"[\w\/]+\-\d+"

core/utils.py

@@ -1,8 +1,11 @@
-def serialize_everything(obj):
+import simplejson
-    """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 safe_json_dumps(obj):
-    return obj.__dict__
+    """Safe version of json.dumps that also converts objects to dicts so they can be output, and ignores NaN floats
+    which are invalid in JSON."""
+
+    return simplejson.dumps(obj, ensure_ascii=False, ignore_nan=True, default=lambda o: o.__dict__)
 
 
 def empty_queue(q):

data/sig.py

@@ -1,13 +1,21 @@
-from dataclasses import dataclass
+from dataclasses import dataclass, field
 
 
 @dataclass
 class SIG:
-    """Data class that defines a Special Interest Group."""
+    """Data class that defines a Special Interest Group. Each contains a name and a longer form description.
+     They also contain comment_names which attempts to separate out the way people might refer to it in
+     cluster comments from how it is referred to in the UI & API. (For example, "TOTA" in cluster spot comments
+     almost always means Towers on the Air, but no single programme is referred to in the UI as "TOTA" as
+     it's ambiguous between Towers, Toilets and Tiles. And while Beaches got the name "BOTA" first, "BOTA" spots
+     are much more likely to be bunkers.) Finally, there is a ref_regex which provides a regular expression to
+     match what references (such as parks and summits) look like for that programme."""
 
-    # SIG name, e.g. "POTA"
+    # SIG name as used in the UI and API, e.g. "Towers"
     name: str
-    # Description, e.g. "Parks on the Air"
+    # Description, e.g. "Towers on the Air"
     description: str
+    # SIG names as they might appear in cluster spot comments, e.g. ["TOTA"]
+    comment_names: list[str] = field(default_factory=list)
     # Regex matcher for references, e.g. for POTA r"[A-Z]{2}\-\d+".
-    ref_regex: str = None
+    ref_regex: str | None = None

data/spot.py

@@ -14,7 +14,7 @@ from core.constants import MODE_ALIASES, PROPAGATION_MODES
 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 core.sig_utils import populate_sig_ref_info, ANY_SIG_REGEX, get_ref_regex_for_sig, get_sig_name_from_comment_name
 from data.sig_ref import SIGRef
 
 
@@ -133,6 +133,17 @@ class Spot:
     # The ID the source gave it, if any.
     source_id: str | None = None
 
+    def __post_init__(self):
+        """Normalise fields that don't survive a plain dict to Spot conversion. This is used in the "add spot" API
+        endpoint where the client is submitting JSON, and we want to recreate a full Spot object, including nested
+        objects such as the sig_refs list.."""
+
+        if self.sig_refs:
+            self.sig_refs = [
+                sig_ref if isinstance(sig_ref, SIGRef) else SIGRef(**sig_ref)
+                for sig_ref in self.sig_refs
+            ]
+
     def infer_missing(self, credentials=None):
         """Infer missing parameters where possible"""
 
@@ -253,16 +264,9 @@ class Spot:
         if self.comment:
             sig_matches = re.finditer(r"(^|\W)" + ANY_SIG_REGEX + r"($|\W)", self.comment, re.IGNORECASE)
             for sig_match in sig_matches:
-                # See what SIG we think this is
+                # First of all, if we haven't got a SIG for this spot set yet, now we have. This covers things like cluster
-                found_sig = sig_match.group(2).upper()
-
-                # "TOTA" is now ambiguous, with Toilets and Towers both using it. If we have found "TOTA" in a comment,
-                # ignore it as we can't tell what it is.
-                if found_sig != "TOTA":
-                    continue
-
-                # Now, if we haven't got a SIG for this spot set yet, now we have. This covers things like cluster
                 # spots where the comment is just "POTA".
+                found_sig = get_sig_name_from_comment_name(sig_match.group(2))
                 if not self.sig:
                     self.sig = found_sig
 
@@ -270,7 +274,7 @@ 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,
+                    ref_matches = re.finditer(r"(^|\W)" + found_sig + r"([ -])(" + 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))
@@ -297,29 +301,29 @@ class Spot:
         if self.sig_refs and len(self.sig_refs) > 0 and not self.sig:
             self.sig = self.sig_refs[0].sig
 
-        # Parse "de_grid<prop_mode>dx_grid" structures from the comment, e.g. "JN61ES<ES>JM56XT" or "JO02GQ<>KN17LG".
+        # Parse "de_grid<prop_mode>dx_grid" structures from the comment, e.g. "JN61ES(ES)JM56XT" or "JO02GQ<>KN17LG".
         # These are common on cluster spots and can provide grid references in preference to e.g. QRZ lookup, as well as
-        # being the only source we have for propagation mode.
+        # being the only source we have for propagation mode. Brace for nightmare regex from hell.
         if self.comment:
             grid_mode_grid_match = re.search(
-                r'\b([A-Ra-r]{2}\d{2}(?:[A-Xa-x]{2}(?:\d{2})?)?)<([^>]*)>([A-Ra-r]{2}\d{2}(?:[A-Xa-x]{2}(?:\d{2})?)?)\b',
+                r'\b([A-Ra-r]{2}\d{2}(?:[A-Xa-x]{2}(?:\d{2})?)?)(?:<([^>]*)>|\(([^)]*)\))([A-Ra-r]{2}\d{2}(?:[A-Xa-x]{2}(?:\d{2})?)?)\b',
                 self.comment)
             if grid_mode_grid_match:
                 # regex matches, so extract grids:
                 if not self.de_grid:
                     self.de_grid = grid_mode_grid_match.group(1).upper()
                 if not self.dx_grid:
-                    self.dx_grid = grid_mode_grid_match.group(3).upper()
+                    self.dx_grid = grid_mode_grid_match.group(4).upper()
                     self.dx_location_source = "SPOT"
 
-                # And extract propagation mode:
+                # And extract propagation mode (group 2 for <...>, group 3 for (...)):
-                mode_tag = grid_mode_grid_match.group(2).upper()
+                mode_tag = (grid_mode_grid_match.group(2) or grid_mode_grid_match.group(3) or "").upper()
                 if mode_tag and not self.propagation_mode:
                     if mode_tag in PROPAGATION_MODES:
                         self.propagation_mode = PROPAGATION_MODES[mode_tag]
                     else:
                         self.propagation_mode = mode_tag
-                        logging.info("Seen a new propagation mode tag not yet in the system: {}", mode_tag)
+                        logging.info("Seen a new propagation mode tag not yet in the system: %s", mode_tag)
 
         # DX Grid to lat/lon and vice versa in case one is missing
         if self.dx_grid and not self.dx_latitude:

requirements.txt

@@ -16,4 +16,5 @@ beautifulsoup4~=4.14.2
 websocket-client~=1.8.0
 tornado~=6.4.2
 tornado_eventsource~=3.0.0
-geopandas~=0.13.2
+geopandas~=0.13.2
+simplejson~=4.1.1

server/handlers/api/addspot.py

@@ -1,4 +1,3 @@
-import json
 import logging
 import re
 import threading
@@ -16,8 +15,7 @@ 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 core.utils import safe_json_dumps
-from data.sig_ref import SIGRef
 from data.spot import Spot
 from spotproviders.spot_provider import SpotProvider
 
@@ -49,8 +47,7 @@ class APISpotHandler(tornado.web.RequestHandler):
             # 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.",
+                self.write(safe_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
@@ -58,8 +55,7 @@ class APISpotHandler(tornado.web.RequestHandler):
             # Reject if format not json
             if not self.request.headers.get('Content-Type', '').startswith("application/json"):
                 self.set_status(415)
-                self.write(
+                self.write(safe_json_dumps("Error - request Content-Type must be application/json"))
-                    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
@@ -68,7 +64,7 @@ class APISpotHandler(tornado.web.RequestHandler):
             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.write(safe_json_dumps("Error - request body is empty"))
                 self.set_header("Cache-Control", "no-store")
                 self.set_header("Content-Type", "application/json")
                 return
@@ -106,20 +102,10 @@ class APISpotHandler(tornado.web.RequestHandler):
             # Convert spot field to a Spot object
             spot = Spot(**spot_data)
 
-            # 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 and spot.sig_refs:
-                real_sig_refs = []
-                for dict_obj in spot.sig_refs:
-                    dict_obj = {**dict_obj, "sig": spot.sig}
-                    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.",
+                self.write(safe_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
@@ -127,15 +113,13 @@ class APISpotHandler(tornado.web.RequestHandler):
             # 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.",
+                self.write(safe_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.",
+                self.write(safe_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
@@ -143,8 +127,7 @@ class APISpotHandler(tornado.web.RequestHandler):
             # 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.",
+                self.write(safe_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
@@ -154,8 +137,7 @@ class APISpotHandler(tornado.web.RequestHandler):
                     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.",
+                self.write(safe_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
@@ -164,9 +146,8 @@ class APISpotHandler(tornado.web.RequestHandler):
             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(
+                self.write(safe_json_dumps(
-                    "Error - '" + spot.sig_refs[0].id + "' does not look like a valid reference for " + spot.sig + ".",
+                    "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
@@ -241,14 +222,14 @@ class APISpotHandler(tornado.web.RequestHandler):
                 self.write(json.dumps("Warning - " + upstream_warning, default=serialize_everything))
                 self.set_status(201)
             else:
-                self.write(json.dumps("OK", default=serialize_everything))
+                self.write(safe_json_dumps("OK"))
                 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)
+            logging.error("Exception when handling client request to add spot API: %s", e, exc_info=True)
-            self.write(json.dumps("Error - an internal server error occurred.", default=serialize_everything))
+            self.write(safe_json_dumps("Error - an internal server error occurred."))
             self.set_status(500)
             self.set_header("Cache-Control", "no-store")
             self.set_header("Content-Type", "application/json")

server/handlers/api/alerts.py

@@ -1,5 +1,4 @@
 import copy
-import json
 import logging
 from datetime import datetime
 from queue import Queue
@@ -12,7 +11,7 @@ from tornado import httputil
 from tornado.web import Application
 
 from core.prometheus_metrics_handler import api_requests_counter
-from core.utils import serialize_everything, empty_queue
+from core.utils import safe_json_dumps, empty_queue
 from data.lookup_credentials import extract_credentials
 
 SSE_HANDLER_MAX_QUEUE_SIZE = 100
@@ -57,15 +56,14 @@ class APIAlertsHandler(tornado.web.RequestHandler):
             data = get_alert_list_with_filters(self._alerts, query_params)
             if credentials:
                 data = self._enrich(data, credentials)
-            self.write(json.dumps(data, default=serialize_everything))
+            self.write(safe_json_dumps(data))
             self.set_status(200)
         except ValueError as e:
-            logging.error(e)
+            self.write(safe_json_dumps("Bad request - " + str(e)))
-            self.write(json.dumps("Bad request - " + str(e), default=serialize_everything))
             self.set_status(400)
         except Exception as e:
-            logging.error(e)
+            logging.error("Exception when handling client request to alerts API: %s", e, exc_info=True)
-            self.write(json.dumps("Error - an internal server error occurred.", default=serialize_everything))
+            self.write(safe_json_dumps("Error - an internal server error occurred."))
             self.set_status(500)
         self.set_header("Cache-Control", "no-store")
         self.set_header("Content-Type", "application/json")
@@ -150,7 +148,7 @@ class APIAlertsStreamHandler(tornado_eventsource.handler.EventSourceHandler):
                             if self._credentials:
                                 alert = copy.deepcopy(alert)
                                 alert.infer_missing(self._credentials)
-                            self.write_message(msg=json.dumps(alert, default=serialize_everything))
+                            self.write_message(msg=safe_json_dumps(alert))
 
                 else:
                     # Send a keepalive comment if the queue was empty

server/handlers/api/dxstats.py

@@ -1,4 +1,5 @@
 import json
+import logging
 from collections import Counter
 from datetime import datetime, timedelta
 from typing import Any
@@ -9,6 +10,7 @@ from tornado import httputil
 from tornado.web import Application
 
 from core.prometheus_metrics_handler import api_requests_counter
+from core.utils import safe_json_dumps
 
 CONTINENTS = ["EU", "NA", "SA", "AS", "AF", "OC", "AN"]
 BANDS = ["160m", "80m", "60m", "40m", "30m", "20m", "17m", "15m", "12m", "10m", "6m"]
@@ -29,29 +31,35 @@ class APIDxStatsHandler(tornado.web.RequestHandler):
         self._web_server_metrics = web_server_metrics
 
     def get(self):
-        self._web_server_metrics["last_api_access_time"] = datetime.now(pytz.UTC)
+        try:
-        self._web_server_metrics["api_access_counter"] += 1
+            self._web_server_metrics["last_api_access_time"] = datetime.now(pytz.UTC)
-        self._web_server_metrics["status"] = "OK"
+            self._web_server_metrics["api_access_counter"] += 1
-        api_requests_counter.inc()
+            self._web_server_metrics["status"] = "OK"
+            api_requests_counter.inc()
 
-        one_hour_ago = (datetime.now(pytz.UTC) - timedelta(hours=1)).timestamp()
+            one_hour_ago = (datetime.now(pytz.UTC) - timedelta(hours=1)).timestamp()
-        counts = Counter()
+            counts = Counter()
 
-        for key in self._spots.iterkeys():
+            for key in self._spots.iterkeys():
-            spot = self._spots.get(key)
+                spot = self._spots.get(key)
-            if spot is None:
+                if spot is None:
-                continue
+                    continue
-            if not spot.time or spot.time < one_hour_ago:
+                if not spot.time or spot.time < one_hour_ago:
-                continue
+                    continue
-            if spot.de_continent in CONTINENTS_SET and spot.dx_continent in CONTINENTS_SET and spot.band in BANDS_SET:
+                if spot.de_continent in CONTINENTS_SET and spot.dx_continent in CONTINENTS_SET and spot.band in BANDS_SET:
-                counts[spot.de_continent, spot.dx_continent, spot.band] += 1
+                    counts[spot.de_continent, spot.dx_continent, spot.band] += 1
 
-        result = {
+            result = {
-            de: {dx: {band: counts[de, dx, band] for band in BANDS} for dx in CONTINENTS}
+                de: {dx: {band: counts[de, dx, band] for band in BANDS} for dx in CONTINENTS}
-            for de in CONTINENTS
+                for de in CONTINENTS
-        }
+            }
 
-        self.write(json.dumps(result))
+            self.write(json.dumps(result))
-        self.set_status(200)
+            self.set_status(200)
-        self.set_header("Cache-Control", "no-store")
+            self.set_header("Cache-Control", "no-store")
-        self.set_header("Content-Type", "application/json")
+            self.set_header("Content-Type", "application/json")
+
+        except Exception as e:
+            logging.error("Exception when handling client request to dx stats API: %s", e, exc_info=True)
+            self.write(safe_json_dumps("Error - an internal server error occurred."))
+            self.set_status(500)

server/handlers/api/lookups.py

@@ -1,4 +1,3 @@
-import json
 import logging
 import re
 from datetime import datetime
@@ -13,7 +12,7 @@ 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 core.utils import safe_json_dumps
 from data.lookup_credentials import extract_credentials
 from data.sig_ref import SIGRef
 from data.spot import Spot
@@ -65,19 +64,18 @@ class APILookupCallHandler(tornado.web.RequestHandler):
                         "longitude": fake_spot.dx_longitude,
                         "location_source": fake_spot.dx_location_source
                     }
-                    self.write(json.dumps(data, default=serialize_everything))
+                    self.write(safe_json_dumps(data))
 
                 else:
-                    self.write(json.dumps("Error - '" + call + "' does not look like a valid callsign.",
+                    self.write(safe_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.write(safe_json_dumps("Error - call must be provided"))
                 self.set_status(422)
 
         except Exception as e:
-            logging.error(e)
+            logging.error("Exception when handling client request to call lookup API: %s", e, exc_info=True)
-            self.write(json.dumps("Error - an internal server error occurred.", default=serialize_everything))
+            self.write(safe_json_dumps("Error - an internal server error occurred."))
             self.set_status(500)
 
         self.set_header("Cache-Control", "no-store")
@@ -111,27 +109,25 @@ class APILookupSIGRefHandler(tornado.web.RequestHandler):
             if "sig" in query_params.keys() and "id" in query_params.keys():
                 sig = str(query_params.get("sig")).upper()
                 ref_id = str(query_params.get("id")).upper()
-                if sig in list(map(lambda p: p.name, SIGS)):
+                if sig in list(map(lambda p: p.name.upper(), 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))
+                        self.write(safe_json_dumps(data))
 
                     else:
-                        self.write(
+                        self.write(safe_json_dumps(
-                            json.dumps(
+                                "Error - '" + ref_id + "' does not look like a valid reference ID for " + sig + "."))
-                                "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.write(safe_json_dumps("Error - sig '" + sig + "' is not known."))
                     self.set_status(422)
             else:
-                self.write(json.dumps("Error - sig and id must be provided", default=serialize_everything))
+                self.write(safe_json_dumps("Error - sig and id must be provided"))
                 self.set_status(422)
 
         except Exception as e:
-            logging.error(e)
+            logging.error("Exception when handling client request to sig ref lookup API: %s", e, exc_info=True)
-            self.write(json.dumps("Error - an internal server error occurred.", default=serialize_everything))
+            self.write(safe_json_dumps("Error - an internal server error occurred."))
             self.set_status(500)
 
         self.set_header("Cache-Control", "no-store")
@@ -185,15 +181,15 @@ class APILookupGridHandler(tornado.web.RequestHandler):
                             "latitude": lat + lat_cell_size,
                             "longitude": lon + lon_cell_size,
                         }}
-                    self.write(json.dumps(response, default=serialize_everything))
+                    self.write(safe_json_dumps(response))
 
             else:
-                self.write(json.dumps("Error - grid must be provided", default=serialize_everything))
+                self.write(safe_json_dumps("Error - grid must be provided"))
                 self.set_status(422)
 
         except Exception as e:
-            logging.error(e)
+            logging.error("Exception when handling client request to grid ref lookup API: %s", e, exc_info=True)
-            self.write(json.dumps("Error - an internal server error occurred.", default=serialize_everything))
+            self.write(safe_json_dumps("Error - an internal server error occurred."))
             self.set_status(500)
 
         self.set_header("Cache-Control", "no-store")

server/handlers/api/options.py

@@ -1,4 +1,4 @@
-import json
+import logging
 from datetime import datetime
 from typing import Any
 
@@ -10,7 +10,7 @@ from tornado.web import Application
 from core.config import MAX_SPOT_AGE, ALLOW_SPOTTING
 from core.constants import BANDS, ALL_MODES, MODE_TYPES, SIGS, CONTINENTS, PROPAGATION_MODES
 from core.prometheus_metrics_handler import api_requests_counter
-from core.utils import serialize_everything
+from core.utils import safe_json_dumps
 
 
 class APIOptionsHandler(tornado.web.RequestHandler):
@@ -28,19 +28,20 @@ class APIOptionsHandler(tornado.web.RequestHandler):
         self._spot_providers = spot_providers or []
 
     def get(self):
-        # Metrics
+        try:
-        self._web_server_metrics["last_api_access_time"] = datetime.now(pytz.UTC)
+            # Metrics
-        self._web_server_metrics["api_access_counter"] += 1
+            self._web_server_metrics["last_api_access_time"] = datetime.now(pytz.UTC)
-        self._web_server_metrics["status"] = "OK"
+            self._web_server_metrics["api_access_counter"] += 1
-        api_requests_counter.inc()
+            self._web_server_metrics["status"] = "OK"
+            api_requests_counter.inc()
 
-        # Build a map of SIG name -> list of provider names that can submit spots for that SIG
+            # Build a map of SIG name -> list of provider names that can submit spots for that SIG
         spot_submit_providers = {}
         for provider in self._spot_providers:
             if not provider.enabled:
                 continue
             for sig in SIGS:
-                if provider.can_submit_spot(sig.name):
+                    if provider.can_submit_spot(sig.name):
                     spot_submit_providers.setdefault(sig.name, []).append(provider.name)
 
         # Spot/alert sources are filtered for only ones that are enabled in config, no point letting the user toggle
@@ -51,8 +52,8 @@ class APIOptionsHandler(tornado.web.RequestHandler):
             map(lambda p: p["name"], filter(lambda p: p["enabled"], self._status_data["alert_providers"])))
         # If spotting to this server is enabled, "API" is another valid spot source even though it does not come from
         # one of our providers.
-        if ALLOW_SPOTTING:
+            if ALLOW_SPOTTING:
-            spot_sources.append("API")
+                spot_sources.append("API")
 
         options = {"bands": BANDS,
                    "modes": ALL_MODES,
@@ -61,12 +62,17 @@ class APIOptionsHandler(tornado.web.RequestHandler):
                    "spot_sources": spot_sources,
                    "alert_sources": alert_sources,
                    "continents": CONTINENTS,
-                   "propagation_modes": PROPAGATION_MODES.values(),
+                   "propagation_modes": list(PROPAGATION_MODES.values()),
                    "max_spot_age": MAX_SPOT_AGE,
                    "spot_allowed": ALLOW_SPOTTING,
                    "spot_submit_providers": spot_submit_providers}
 
-        self.write(json.dumps(options, default=serialize_everything))
+            self.write(safe_json_dumps(options))
-        self.set_status(200)
+            self.set_status(200)
-        self.set_header("Cache-Control", "no-store")
+            self.set_header("Cache-Control", "no-store")
-        self.set_header("Content-Type", "application/json")
+            self.set_header("Content-Type", "application/json")
+
+        except Exception as e:
+            logging.error("Exception when handling client request to options API: %s", e, exc_info=True)
+            self.write(safe_json_dumps("Error - an internal server error occurred."))
+            self.set_status(500)

server/handlers/api/solar_conditions.py

@@ -1,3 +1,4 @@
+import logging
 from datetime import datetime
 from typing import Any
 
@@ -7,6 +8,7 @@ from tornado import httputil
 from tornado.web import Application
 
 from core.prometheus_metrics_handler import api_requests_counter
+from core.utils import safe_json_dumps
 
 
 class APISolarConditionsHandler(tornado.web.RequestHandler):
@@ -22,13 +24,19 @@ class APISolarConditionsHandler(tornado.web.RequestHandler):
         self._web_server_metrics = web_server_metrics
 
     def get(self):
-        # Metrics
+        try:
-        self._web_server_metrics["last_api_access_time"] = datetime.now(pytz.UTC)
+            # Metrics
-        self._web_server_metrics["api_access_counter"] += 1
+            self._web_server_metrics["last_api_access_time"] = datetime.now(pytz.UTC)
-        self._web_server_metrics["status"] = "OK"
+            self._web_server_metrics["api_access_counter"] += 1
-        api_requests_counter.inc()
+            self._web_server_metrics["status"] = "OK"
+            api_requests_counter.inc()
 
-        self.write(self._solar_conditions.to_json())
+            self.write(self._solar_conditions.to_json())
-        self.set_status(200)
+            self.set_status(200)
-        self.set_header("Cache-Control", "no-store")
+            self.set_header("Cache-Control", "no-store")
-        self.set_header("Content-Type", "application/json")
+            self.set_header("Content-Type", "application/json")
+
+        except Exception as e:
+            logging.error("Exception when handling client request to solar conditions API: %s", e, exc_info=True)
+            self.write(safe_json_dumps("Error - an internal server error occurred."))
+            self.set_status(500)

server/handlers/api/spots.py

@@ -1,5 +1,4 @@
 import copy
-import json
 import logging
 from datetime import datetime, timedelta
 from queue import Queue
@@ -12,7 +11,7 @@ from tornado import httputil
 from tornado.web import Application
 
 from core.prometheus_metrics_handler import api_requests_counter
-from core.utils import serialize_everything, empty_queue
+from core.utils import safe_json_dumps, empty_queue
 from data.lookup_credentials import extract_credentials
 
 SSE_HANDLER_MAX_QUEUE_SIZE = 1000
@@ -57,15 +56,14 @@ class APISpotsHandler(tornado.web.RequestHandler):
             data = get_spot_list_with_filters(self._spots, query_params)
             if credentials:
                 data = self._enrich(data, credentials)
-            self.write(json.dumps(data, default=serialize_everything))
+            self.write(safe_json_dumps(data))
             self.set_status(200)
         except ValueError as e:
-            logging.error(e)
+            self.write(safe_json_dumps("Bad request - " + str(e)))
-            self.write(json.dumps("Bad request - " + str(e), default=serialize_everything))
             self.set_status(400)
         except Exception as e:
-            logging.error(e)
+            logging.error("Excedption when handling client request to spots API: %s", e, exc_info=True)
-            self.write(json.dumps("Error - an internal server error occurred.", default=serialize_everything))
+            self.write(safe_json_dumps("Error - an internal server error occurred."))
             self.set_status(500)
         self.set_header("Cache-Control", "no-store")
         self.set_header("Content-Type", "application/json")
@@ -152,7 +150,7 @@ class APISpotsStreamHandler(tornado_eventsource.handler.EventSourceHandler):
                             if self._credentials:
                                 spot = copy.deepcopy(spot)
                                 spot.infer_missing(self._credentials)
-                            self.write_message(msg=json.dumps(spot, default=serialize_everything))
+                            self.write_message(msg=safe_json_dumps(spot))
 
                 else:
                     # Send a keepalive comment if the queue was empty

server/handlers/api/status.py

@@ -1,4 +1,4 @@
-import json
+import logging
 from datetime import datetime
 from typing import Any
 
@@ -8,7 +8,7 @@ from tornado import httputil
 from tornado.web import Application
 
 from core.prometheus_metrics_handler import api_requests_counter
-from core.utils import serialize_everything
+from core.utils import safe_json_dumps
 
 
 class APIStatusHandler(tornado.web.RequestHandler):
@@ -24,13 +24,19 @@ class APIStatusHandler(tornado.web.RequestHandler):
         self._web_server_metrics = web_server_metrics
 
     def get(self):
-        # Metrics
+        try:
-        self._web_server_metrics["last_api_access_time"] = datetime.now(pytz.UTC)
+            # Metrics
-        self._web_server_metrics["api_access_counter"] += 1
+            self._web_server_metrics["last_api_access_time"] = datetime.now(pytz.UTC)
-        self._web_server_metrics["status"] = "OK"
+            self._web_server_metrics["api_access_counter"] += 1
-        api_requests_counter.inc()
+            self._web_server_metrics["status"] = "OK"
+            api_requests_counter.inc()
 
-        self.write(json.dumps(self._status_data, default=serialize_everything))
+            self.write(safe_json_dumps(self._status_data))
-        self.set_status(200)
+            self.set_status(200)
-        self.set_header("Cache-Control", "no-store")
+            self.set_header("Cache-Control", "no-store")
-        self.set_header("Content-Type", "application/json")
+            self.set_header("Content-Type", "application/json")
+
+        except Exception as e:
+            logging.error("Exception when handling client request to status API: %s", e, exc_info=True)
+            self.write(safe_json_dumps("Error - an internal server error occurred."))
+            self.set_status(500)

server/handlers/manifesthandler.py

@@ -0,0 +1,11 @@
+import tornado.web
+
+from core.config import BASE_URL
+
+
+class ManifestHandler(tornado.web.RequestHandler):
+    """Handler for manifest.webmanifest, which needs BASE_URL inserted and a custom content-type"""
+
+    def get(self):
+        self.set_header("Content-Type", "application/manifest+json; charset=UTF-8")
+        self.render("manifest.webmanifest", baseurl=BASE_URL)

server/webserver.py

@@ -5,7 +5,7 @@ import os
 import tornado
 from tornado.web import StaticFileHandler
 
-from core.config import ALLOW_SPOTTING, WEB_SERVER_PORT, API_ONLY_MODE
+from core.config import ALLOW_SPOTTING, WEB_SERVER_PORT, API_ONLY_MODE, LOG_WEB_REQUESTS, BASE_URL
 from core.utils import empty_queue
 from server.handlers.api.addspot import APISpotHandler
 from server.handlers.api.v1_compatability import V1RedirectHandler, V1GoneHandler
@@ -16,6 +16,7 @@ from server.handlers.api.options import APIOptionsHandler
 from server.handlers.api.solar_conditions import APISolarConditionsHandler
 from server.handlers.api.spots import APISpotsHandler, APISpotsStreamHandler
 from server.handlers.api.status import APIStatusHandler
+from server.handlers.manifesthandler import ManifestHandler
 from server.handlers.metrics import PrometheusMetricsHandler
 from server.handlers.pagetemplate import PageTemplateHandler
 
@@ -110,11 +111,16 @@ class WebServer:
             if ALLOW_SPOTTING:
                 ui_routes += [(r"/add-spot", PageTemplateHandler, {"template_name": "add_spot", **handler_opts})]
 
-        # API docs, Prometheus metrics, and finally static assets are always available regardless of API-only mode.
+        # API docs, Prometheus metrics, webapp manifest and static assets are always available regardless of API-only
+        # mode.
         misc_routes = [
             (r"/apidocs", PageTemplateHandler, {"template_name": "apidocs", **handler_opts}),
             (r"/metrics", PrometheusMetricsHandler),
-            (r"/(.*)", StaticFileHandler, {"path": os.path.join(_HERE, "../webassets")})
+            (r"/manifest.webmanifest", ManifestHandler),
+            # If e.g. nginx is configured as a reverse proxy with a hard-coded path to static files, as per the README,
+            # this will never have to handle anything, but having it here allows Spothole to work without nginx for
+            # testing.
+            (r"/static/(.*)", StaticFileHandler, {"path": os.path.join(_HERE, "../static")})
         ]
 
         app = tornado.web.Application(api_routes + v1_compat_routes + ui_routes + misc_routes,
@@ -123,6 +129,7 @@ class WebServer:
                                       debug=False)
         app.listen(self._port, xheaders=True)
         logging.info("Web server running on port " + str(WEB_SERVER_PORT))
+        logging.info("You can access your copy of Spothole at " + BASE_URL)
         await self._shutdown_event.wait()
 
     def notify_new_spot(self, spot):
@@ -176,20 +183,22 @@ class WebServer:
         pass
 
 def request_log(handler):
-    """Custom log function to provide more data about requests."""
+    """Custom log function to provide more data about requests when enabled, and to provide the ability to turn off
+    web request logging altogetether."""
 
-    if handler.get_status() < 500:
+    if LOG_WEB_REQUESTS:
-        log_method = logging.info
+        if handler.get_status() < 500:
-    else:
+            log_method = logging.info
-        log_method = logging.warning
+        else:
+            log_method = logging.warning
 
-    request = handler.request
+        request = handler.request
-    client_ip = request.remote_ip
+        client_ip = request.remote_ip
-    referrer = request.headers.get("Referer", "-")
+        referrer = request.headers.get("Referer", "-")
-    user_agent = request.headers.get("User-Agent", "-")
+        user_agent = request.headers.get("User-Agent", "-")
 
-    log_method(
+        log_method(
-        f'{client_ip} - "{request.method} {request.uri}" '
+            f'{client_ip} - "{request.method} {request.uri}" '
-        f'{handler.get_status()} {request.request_time():.2f}ms | '
+            f'{handler.get_status()} {request.request_time():.2f}ms | '
-        f'Ref: {referrer} | UA: {user_agent}'
+            f'Ref: {referrer} | UA: {user_agent}'
-    )
+        )

solarconditionsproviders/giroionosonde.py

@@ -5,6 +5,7 @@ from threading import Thread, Event
 
 import pytz
 import requests
+from requests.exceptions import ConnectionError, ReadTimeout, ConnectTimeout
 
 from core.constants import HTTP_HEADERS
 from solarconditionsproviders.ionosonde_utils import compute_band_states
@@ -127,10 +128,18 @@ class GIROIonosonde(SolarConditionsProvider):
         from_str = from_time.strftime("%Y.%m.%d+%H:%M:%S")
         to_str = to_time.strftime("%Y.%m.%d+%H:%M:%S")
         url = f"{LGDC_URL}?ursiCode={ursi}&charName=foF2,MUFD,fmin&DMUF=3000&fromDate={from_str}&toDate={to_str}"
-        response = requests.get(url, headers=HTTP_HEADERS, timeout=(5, 15))
+        try:
-        if response.status_code != 200:
+            http_response = requests.get(url, headers=HTTP_HEADERS, timeout=(5, 15))
+            if not http_response.ok:
+                logging.warning(f"HTTP {http_response.status_code} when calling Giro ionosonde API.")
+                return None, None, None
+            return self._parse_all(http_response.text)
+        except (ConnectTimeout, ReadTimeout):
+            logging.warning(f"Timeout when accessing Giro ionosonde API.")
+            return None, None, None
+        except ConnectionError:
+            logging.warning("Connection error when accessing Giro ionosonde API.")
             return None, None, None
-        return self._parse_all(response.text)
 
     @staticmethod
     def _parse_all(text):

solarconditionsproviders/hamqsl.py

@@ -18,10 +18,6 @@ class HamQSL(HTTPSolarConditionsProvider):
         super().__init__(provider_config, URL, POLL_INTERVAL)
 
     def _http_response_to_solar_conditions(self, http_response):
-        if http_response.status_code != 200:
-            logging.warning("HamQSL solar conditions API returned HTTP " + str(http_response.status_code))
-            return None
-
         root = ElementTree.fromstring(http_response.text)
         sd = root.find("solardata")
         if sd is None:

solarconditionsproviders/http_solar_conditions_provider.py

@@ -4,6 +4,7 @@ from threading import Thread, Event
 
 import pytz
 import requests
+from requests.exceptions import ConnectionError, ReadTimeout, ConnectTimeout
 
 from core.constants import HTTP_HEADERS
 from solarconditionsproviders.solar_conditions_provider import SolarConditionsProvider
@@ -39,13 +40,22 @@ class HTTPSolarConditionsProvider(SolarConditionsProvider):
         try:
             logging.debug("Polling " + self.name + " solar conditions API...")
             http_response = requests.get(self._url, headers=HTTP_HEADERS, timeout=(5, 30))
-            new_data = self._http_response_to_solar_conditions(http_response)
+            # Check response code was good
-            self.update_data(new_data)
+            if http_response.ok:
+                new_data = self._http_response_to_solar_conditions(http_response)
+                self.update_data(new_data)
 
-            self.status = "OK"
+                self.status = "OK"
-            self.last_update_time = datetime.now(pytz.UTC)
+                self.last_update_time = datetime.now(pytz.UTC)
-            logging.debug("Received data from " + self.name + " solar conditions API.")
+                logging.debug("Received data from " + self.name + " solar conditions API.")
+            else:
+                self.status = "Error"
+                logging.warning(f"HTTP {http_response.status_code} when calling {self.name} solar conditions API.")
 
+        except ConnectionError:
+            logging.warning(f"Connection error when accessing {self.name} solar conditions API.")
+        except (ConnectTimeout, ReadTimeout):
+            logging.warning(f"Timeout when accessing {self.name} solar conditions API.")
         except Exception:
             self.status = "Error"
             logging.exception("Exception in HTTP Solar Conditions Provider (" + self.name + ")")

solarconditionsproviders/kc2gprop.py

@@ -4,6 +4,7 @@ from threading import Thread, Event
 
 import pytz
 import requests
+from requests.exceptions import ConnectionError, ReadTimeout, ConnectTimeout
 
 from core.constants import HTTP_HEADERS
 from solarconditionsproviders.ionosonde_utils import compute_band_states
@@ -44,9 +45,9 @@ class KC2GProp(SolarConditionsProvider):
     def _poll(self):
         try:
             logging.debug("Polling KC2G ionosonde data...")
-            response = requests.get(KC2G_URL, headers=HTTP_HEADERS, timeout=(5, 30))
+            http_response = requests.get(KC2G_URL, headers=HTTP_HEADERS, timeout=(5, 30))
-            if response.status_code != 200:
+            if not http_response.ok:
-                logging.warning(f"KC2G ionosonde API returned HTTP {response.status_code}")
+                logging.warning(f"HTTP {http_response.status_code} when calling KG2G ionosonde API.")
                 return
 
             now = datetime.now(timezone.utc)
@@ -57,7 +58,7 @@ class KC2GProp(SolarConditionsProvider):
             ionosonde_data = dict(self._solar_conditions.ionosonde_data or {})
             updated_count = 0
 
-            for reading in response.json():
+            for reading in http_response.json():
                 station = reading.get("station", {})
                 ursi = station.get("code")
                 name = station.get("name")
@@ -115,6 +116,10 @@ class KC2GProp(SolarConditionsProvider):
             self.last_update_time = datetime.now(pytz.UTC)
             logging.debug(f"Updated KC2G ionosonde data for {updated_count} stations.")
 
+        except ConnectionError:
+            logging.warning("Connection error when accessing KC2G ionosonde API.")
+        except (ConnectTimeout, ReadTimeout):
+            logging.warning(f"Timeout when accessing KC2G ionosonde API.")
         except Exception:
             self.status = "Error"
             logging.exception("Exception in KC2G ionosonde data provider")

solarconditionsproviders/noaa3dayforecast.py

@@ -80,10 +80,6 @@ class NOAA3dayForecast(HTTPSolarConditionsProvider):
         return result if result else None
 
     def _http_response_to_solar_conditions(self, http_response):
-        if http_response.status_code != 200:
-            logging.warning("NOAA K-index forecast API returned HTTP " + str(http_response.status_code))
-            return None
-
         lines = http_response.text.splitlines()
 
         # Find the "NOAA Kp index breakdown" section header

spothole.py

@@ -8,7 +8,7 @@ import sys
 from diskcache import Cache
 
 from core.cleanup import CleanupTimer
-from core.config import config, SERVER_OWNER_CALLSIGN
+from core.config import config, SERVER_OWNER_CALLSIGN, LOG_LEVEL
 from core.constants import SOFTWARE_VERSION
 from core.lookup_helper import lookup_helper
 from core.status_reporter import StatusReporter
@@ -84,9 +84,9 @@ def get_solar_conditions_provider_from_config(config_providers_entry):
 if __name__ == '__main__':
     # Set up logging
     root = logging.getLogger()
-    root.setLevel(logging.INFO)
+    root.setLevel(LOG_LEVEL)
     handler = logging.StreamHandler(sys.stdout)
-    handler.setLevel(logging.INFO)
+    handler.setLevel(LOG_LEVEL)
     formatter = logging.Formatter("%(levelname)s : %(message)s")
     handler.setFormatter(formatter)
     root.handlers.clear()

spotproviders/gma.py

@@ -14,9 +14,9 @@ class GMA(HTTPSpotProvider):
     """Spot provider for General Mountain Activity"""
 
     POLL_INTERVAL_SEC = 120
-    SPOTS_URL = "https://www.cqgma.org/api/spots/25/"
+    SPOTS_URL = "https://www.gma.rocks/api/spots/25/"
     # GMA spots don't contain the details of the programme they are for, we need a separate lookup for that
-    REF_INFO_URL_ROOT = "https://www.cqgma.org/api/ref/?"
+    REF_INFO_URL_ROOT = "https://www.gma.rocks/api/ref/?"
 
     def __init__(self, provider_config):
         # Ensure there is an API key in our config, and set up the query URL using it. If no key is provided,
@@ -37,34 +37,38 @@ class GMA(HTTPSpotProvider):
                 spot = Spot(source=self.name,
                             dx_call=source_spot["ACTIVATOR"].upper(),
                             de_call=source_spot["SPOTTER"].upper(),
-                            freq=float(source_spot["QRG"]) * 1000 if (source_spot["QRG"] != "") else None,
+                            # Seen GMA spots with no frequency or with "QRT" in this field
-                            # Seen GMA spots with no frequency
+                            freq=float(source_spot["QRG"]) * 1000 if (
-                            mode=source_spot["MODE"].upper() if "<>" not in source_spot["MODE"] else None,
+                                    source_spot["QRG"] != "" and source_spot["QRG"] != "QRT") else None,
                             # Filter out some weird mode strings
+                            mode=source_spot["MODE"].upper() if "<>" not in source_spot["MODE"] else None,
                             comment=source_spot["TEXT"],
                             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(),
+                            # Seen GMA spots with no (or empty) lat/lon
                             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)
+                                    source_spot["LON"] and source_spot["LON"] != "") else None,
+                            qrt=source_spot["QRG"] == "QRT")
 
                 # 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
+                        # Sometimes this is blank even if it's a 200 response, so handle that
-                        if ref_response.text is not None and ref_response.text != "":
+                        if ref_response.ok and ref_response.text is not None and ref_response.text != "":
                             ref_info = ref_response.json()
                             # If this is POTA, SOTA or WWFF data we already have it through other means, so ignore. POTA and WWFF
                             # 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 spot.sig_refs and "reftype" in ref_info and ref_info["reftype"] not in ["POTA", "WWFF"] and (
+                            if spot.sig_refs and "reftype" in ref_info and ref_info["reftype"] not in ["POTA",
-                                    ref_info["reftype"] != "Summit" or "sota" not in ref_info or ref_info["sota"] == ""):
+                                                                                                       "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"
@@ -90,9 +94,17 @@ class GMA(HTTPSpotProvider):
                                         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
+                                # Add to our list. Don't worry about de-duping, removing old spots etc. at this point;
-                                # that for us.
+                                # other code will do that for us.
                                 new_spots.append(spot)
+
+                        elif not ref_response.from_cache:
+                            if not ref_response.ok:
+                                logging.warning(
+                                    f"HTTP {ref_response.status_code} when looking up GMA ref {source_spot["REF"]}")
+                            else:
+                                logging.warning(
+                                    f"GMA API returned a malformed response when looking up ref {source_spot["REF"]}")
                     except:
                         logging.warning("Exception when looking up " + self.REF_INFO_URL_ROOT + source_spot[
                             "REF"] + ", ignoring this spot for now")

spotproviders/hema.py

@@ -1,8 +1,10 @@
+import logging
 import re
 from datetime import datetime
 
 import pytz
 import requests
+from requests.exceptions import ConnectionError, ReadTimeout, ConnectTimeout
 
 from core.constants import HTTP_HEADERS
 from data.sig_ref import SIGRef
@@ -35,36 +37,41 @@ class HEMA(HTTPSpotProvider):
         new_spots = []
         # OK, if the spot seed actually changed, now we make the real request for data.
         if spot_seed_changed:
-            source_data = requests.get(self.SPOTS_URL, headers=HTTP_HEADERS, timeout=(5, 30))
+            try:
-            source_data_items = source_data.text.split("=")
+                source_data = requests.get(self.SPOTS_URL, headers=HTTP_HEADERS, timeout=(5, 30))
-            # Iterate through source data items.
+                source_data_items = source_data.text.split("=")
-            for source_spot in source_data_items:
+                # Iterate through source data items.
-                spot_items = source_spot.split(";")
+                for source_spot in source_data_items:
-                # Any line with less than 9 items is not a proper spot line
+                    spot_items = source_spot.split(";")
-                if len(spot_items) >= 9:
+                    # Any line with less than 9 items is not a proper spot line
-                    # Fiddle with some data to extract bits we need. Freq/mode and spotter/comment come in combined fields.
+                    if len(spot_items) >= 9:
-                    freq_mode_match = re.search(self.FREQ_MODE_PATTERN, spot_items[5])
+                        # Fiddle with some data to extract bits we need. Freq/mode and spotter/comment come in combined fields.
-                    spotter_comment_match = re.search(self.SPOTTER_COMMENT_PATTERN, spot_items[6])
+                        freq_mode_match = re.search(self.FREQ_MODE_PATTERN, spot_items[5])
-                    if not freq_mode_match or not spotter_comment_match:
+                        spotter_comment_match = re.search(self.SPOTTER_COMMENT_PATTERN, spot_items[6])
-                        continue
+                        if not freq_mode_match or not spotter_comment_match:
+                            continue
 
-                    # Convert to our spot format
+                        # Convert to our spot format
-                    spot = Spot(source=self.name,
+                        spot = Spot(source=self.name,
-                                dx_call=spot_items[2].upper(),
+                                    dx_call=spot_items[2].upper(),
-                                de_call=spotter_comment_match.group(1).upper(),
+                                    de_call=spotter_comment_match.group(1).upper(),
-                                freq=float(freq_mode_match.group(1)) * 1000000,
+                                    freq=float(freq_mode_match.group(1)) * 1000000,
-                                mode=freq_mode_match.group(2).upper(),
+                                    mode=freq_mode_match.group(2).upper(),
-                                comment=spotter_comment_match.group(2),
+                                    comment=spotter_comment_match.group(2),
-                                sig="HEMA",
+                                    sig="HEMA",
-                                sig_refs=[SIGRef(id=spot_items[3].upper(), sig="HEMA", name=spot_items[4])],
+                                    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(
+                                    time=datetime.strptime(spot_items[0], "%d/%m/%Y %H:%M").replace(
-                                    tzinfo=pytz.UTC).timestamp(),
+                                        tzinfo=pytz.UTC).timestamp(),
-                                dx_latitude=float(spot_items[7]),
+                                    dx_latitude=float(spot_items[7]),
-                                dx_longitude=float(spot_items[8]))
+                                    dx_longitude=float(spot_items[8]))
 
-                    # Add to our list. Don't worry about de-duping, removing old spots etc. at this point; other code will do
+                        # Add to our list. Don't worry about de-duping, removing old spots etc. at this point; other
-                    # that for us.
+                        # code will do that for us.
-                    new_spots.append(spot)
+                        new_spots.append(spot)
+            except (ConnectTimeout, ReadTimeout):
+                logging.warning(f"Timeout when accessing HEMA spots API.")
+            except ConnectionError:
+                logging.warning("Connection error when accessing HEMA spots API.")
         return new_spots
 
     def can_submit_spot(self, sig):

spotproviders/http_spot_provider.py

@@ -4,6 +4,8 @@ from threading import Thread, Event
 
 import pytz
 import requests
+from requests import ReadTimeout
+from requests.exceptions import ConnectionError, ConnectTimeout
 
 from core.constants import HTTP_HEADERS
 from spotproviders.spot_provider import SpotProvider
@@ -50,16 +52,25 @@ class HTTPSpotProvider(SpotProvider):
             # Request data from API
             logging.debug("Polling " + self.name + " spot API...")
             http_response = requests.get(self._url, headers=HTTP_HEADERS, timeout=(5, 30))
-            # Pass off to the subclass for processing
+            # Check response code was good
-            new_spots = self._http_response_to_spots(http_response)
+            if http_response.ok:
-            # Submit the new spots for processing. There might not be any spots for the less popular programs.
+                # Pass off to the subclass for processing
-            if new_spots:
+                new_spots = self._http_response_to_spots(http_response)
-                self._submit_batch(new_spots)
+                # 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.status = "OK"
+                self.status = "OK"
-            self.last_update_time = datetime.now(pytz.UTC)
+                self.last_update_time = datetime.now(pytz.UTC)
-            logging.debug("Received data from " + self.name + " spot API.")
+                logging.debug("Received data from " + self.name + " spot API.")
+            else:
+                self.status = "Error"
+                logging.warning(f"HTTP {http_response.status_code} when calling {self.name} spot API.")
 
+        except ConnectionError:
+            logging.warning(f"Connection error when accessing {self.name} spots API.")
+        except (ConnectTimeout, ReadTimeout):
+            logging.warning(f"Timeout when accessing {self.name} spots API.")
         except Exception:
             self.status = "Error"
             logging.exception("Exception in HTTP JSON Spot Provider (" + self.name + ")")

spotproviders/parksnpeaks.py

@@ -34,8 +34,8 @@ class ParksNPeaks(HTTPSpotProvider):
                             dx_call=source_spot["actCallsign"].upper(),
                             de_call=source_spot["actSpoter"].upper() if source_spot["actSpoter"] != "" else None,
                             # typo exists in API
-                            freq=float(source_spot["actFreq"].replace(",", "")) * 1000000 if (
+                            freq=float(source_spot["actFreq"].replace(",", "").replace("+-", "")
-                                    source_spot["actFreq"] != "") else None,
+                                       .replace("+/-", "").strip()) * 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"],
@@ -61,7 +61,7 @@ class ParksNPeaks(HTTPSpotProvider):
                         sig_refs[0].name = source_spot["actLocation"]
 
                     # Log a warning for the developer if PnP gives us an unknown programme we've never seen before
-                    if sig not in ["POTA", "SOTA", "WWFF", "SIOTA", "ZLOTA", "KRMNPA"]:
+                    if sig not in ["POTA", "SOTA", "WWFF", "SIOTA", "ZLOTA", "KRMNPA", "LLOTA"]:
                         logging.warning("PNP spot found with sig " + sig + ", developer needs to add support for this!")
 
                 # Add new spot to the list

spotproviders/sota.py

@@ -1,6 +1,8 @@
+import logging
 from datetime import datetime
 
 import requests
+from requests.exceptions import ConnectionError, ReadTimeout, ConnectTimeout
 
 from core.constants import HTTP_HEADERS, SSB_SUB_MODES, DV_SUB_MODES
 from data.sig_ref import SIGRef
@@ -36,28 +38,33 @@ class SOTA(HTTPSpotProvider):
         new_spots = []
         # OK, if the epoch actually changed, now we make the real request for data.
         if epoch_changed:
-            source_data = requests.get(self.SPOTS_URL, headers=HTTP_HEADERS, timeout=(5, 30)).json()
+            try:
-            # Iterate through source data
+                source_data = requests.get(self.SPOTS_URL, headers=HTTP_HEADERS, timeout=(5, 30)).json()
-            for source_spot in source_data:
+                # Iterate through source data
-                # Convert to our spot format
+                for source_spot in source_data:
-                spot = Spot(source=self.name,
+                    # Convert to our spot format
-                            source_id=source_spot["id"],
+                    spot = Spot(source=self.name,
-                            dx_call=source_spot["activatorCallsign"].upper(),
+                                source_id=source_spot["id"],
-                            dx_name=source_spot["activatorName"],
+                                dx_call=source_spot["activatorCallsign"].upper(),
-                            de_call=source_spot["callsign"].upper(),
+                                dx_name=source_spot["activatorName"],
-                            freq=(float(source_spot["frequency"]) * 1000000) if (
+                                de_call=source_spot["callsign"].upper(),
-                                    source_spot["frequency"] is not None) else None,
+                                freq=(float(source_spot["frequency"]) * 1000000) if (
-                            # Seen SOTA spots with no frequency!
+                                        source_spot["frequency"] is not None) else None,
-                            mode=source_spot["mode"].upper(),
+                                # Seen SOTA spots with no frequency!
-                            comment=source_spot["comments"],
+                                mode=source_spot["mode"].upper(),
-                            sig="SOTA",
+                                comment=source_spot["comments"],
-                            sig_refs=[SIGRef(id=source_spot["summitCode"], sig="SOTA", name=source_spot["summitName"],
+                                sig="SOTA",
-                                             activation_score=source_spot["points"])],
+                                sig_refs=[SIGRef(id=source_spot["summitCode"], sig="SOTA", name=source_spot["summitName"],
-                            time=datetime.fromisoformat(source_spot["timeStamp"].replace("Z", "+00:00")).timestamp())
+                                                 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
+                    # Add to our list. Don't worry about de-duping, removing old spots etc. at this point; other code will do
-                # that for us.
+                    # that for us.
-                new_spots.append(spot)
+                    new_spots.append(spot)
+            except ConnectionError:
+                logging.warning("Connection error when accessing SOTA spots API")
+            except (ConnectTimeout, ReadTimeout):
+                logging.warning(f"Timeout when accessing SOTA spots API.")
         return new_spots
 
     def can_submit_spot(self, sig):

spotproviders/towers.py

@@ -6,7 +6,7 @@ from data.spot import Spot
 from spotproviders.http_spot_provider import HTTPSpotProvider
 
 
-class WWTOTA(HTTPSpotProvider):
+class Towers(HTTPSpotProvider):
     """Spot provider for Towers on the Air"""
 
     POLL_INTERVAL_SEC = 120

static/apidocs/openapi.yml

@@ -11,7 +11,7 @@ info:
 
     Please note that the data coming out of Spothole is only as good as the data going in. People mis-hear and make typos when spotting callsigns all the time, and there are plenty of areas where Spothole's location data may be inaccurate. If you are doing something where accuracy is important, such as contesting, you should not rely on Spothole's data to fill in any gaps in your log.
 
-    Spothole's source code is located at https://git.ianrenton.com/ian/spothole and the README there provides setup instructions if you would like to run your own copy. A demonstration server of Spothole is located at https://spothole.app.
+    Spothole's source code is located at https://git.ianrenton.com/ian/spothole and the README there provides setup instructions if you would like to run your own copy. A demonstration server of Spothole is located at https://spothole.app. The README also contains some examples of how you could query the API of the demonstration server to integrate the data into your own apps.
 
     ## Changelog
     
@@ -26,6 +26,11 @@ info:
     ### 1.4
     
     * Spots can now include a "propagation_mode" field, and the `/options` call enumerates the options that can have.
+    * Added support for the Diploma de Municipios Españoles (DME) SIG
+    * Renamed some SIGs to avoid confusion between Towers, Tiles and Toilets
+    * Added `comment_names` to SIGs in the `/options`, to reflect how they might be referred to in spot comments where
+      it differs from their `name`.
+    * Added `propagation_mode` field to spots
 
     ### 1.3
 
@@ -785,7 +790,7 @@ components:
         - ZLOTA
         - WOTA
         - LLOTA
-        - WWTOTA
+        - Towers
         - Tiles
         - Cluster
         - RBN
@@ -804,7 +809,7 @@ components:
         - HEMA
         - WCA
         - MOTA
-        - SIOTA
+        - SiOTA
         - ARLHS
         - ILLW
         - ZLOTA
@@ -813,11 +818,12 @@ components:
         - WOTA
         - BOTA
         - LLOTA
-        - WWTOTA
+        - Towers
         - Tiles
         - WAB
         - WAI
-        - TOTA
+        - DME
+        - Toilets
       example: POTA
 
     SIGNameIncludingNoSIG:
@@ -1435,6 +1441,16 @@ components:
           type: string
           description: The full name of the SIG
           example: Parks on the Air
+        comment_names:
+          type: array
+          description: >
+            Names by which this SIG may be referred to in cluster spot comments. Most SIGs have a
+            single entry matching their programme name (e.g. ["POTA"]), but some have none (where
+            the name is ambiguous with other SIGs, such as Tiles and Toilets on the Air) or multiple
+            entries (e.g. WWBOTA accepts both "WWBOTA" and "BOTA" since the latter is often used).
+          items:
+            type: string
+          example: [ "TOTA" ]
         ref_regex:
           type: string
           description: >