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

# Conflicts:
#	core/constants.py
#	data/spot.py

.dockerignore

@@ -1,7 +0,0 @@
-/.venv
-__pycache__
-*.pyc
-/config.yml
-/cache/
-.git
-.gitignore

.idea/spothole.iml

@@ -2,9 +2,8 @@
 <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$/static/vendor" />
+      <excludeFolder url="file://$MODULE_DIR$/webassets/vendor" />
     </content>
     <orderEntry type="jdk" jdkName="Python 3.13 virtualenv at ~/code/spothole/.venv" jdkType="Python SDK" />
     <orderEntry type="sourceFolder" forTests="false" />

Dockerfile

@@ -1,8 +0,0 @@
-FROM python:3.13-slim
-
-WORKDIR /app
-COPY . .
-RUN pip install --no-cache-dir -r requirements.txt
-EXPOSE 8080
-
-CMD ["python3", "spothole.py"]

README.md

@@ -1,4 +1,4 @@
-# ![Spothole](/static/img/logo.png)
+# ![Spothole](/webassets/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.
@@ -33,17 +33,484 @@ see [https://spothole.app/apidocs](https://spothole.app/apidocs) for the API det
 This is a Progressive Web App, so you can also "install" it to your Android or iOS device by accessing it in Chrome or
 Safari respectively, and following the menu-driven process for installing PWAs.
 
-You are more than welcome to use the data and the API that Spothole provides to power your own software, to run your
-own Spothole server, or to modify it in any way. More details can be found in the following sections:
+You are more than welcome to use the data and the API that Spothole provides to power your own software. There are many
+ways to do this; see below.
 
-* [Embedding Spothole in another website](docs/embedding.md)
-* [Writing your own client](docs/clients.md)
-* [Running your own copy](docs/running.md)
-  * [nginx reverse proxy configuration](docs/nginx.md)
-  * [systemd service file](docs/systemd.md)
-  * [Running in Docker](docs/docker.md)
-  * [Use of multiple cluster logins](docs/multicluster.md)
-* [Modifying the source code](docs/modifying.md)
+## Embedding Spothole in another website
+
+You can embed Spothole's web interface in another website, e.g. for use as part of a ham radio custom dashboard.
+
+URL parameters can be used to trigger an "embedded" mode which hides the headers, footers and settings. In this mode,
+you provide configuration for the various filter and display options via additional URL parameters. Any settings that
+the user has set for Spothole are ignored. This is so that the embedding site can select, for example, their choice of
+dark mode or SIG filters, which will not impact how Spothole appears when the user accesses it directly. Effectively, it
+becomes separate to their normal Spothole settings.
+
+Setting `embedded` to true is important for the rest of the settings to be applied; otherwise, the user's defaults will
+be used in preference to the URL params.
+
+These are supplied with the URL to the page you want to embed, for example for an embedded version of the band map in
+dark mode, use `https://spothole.app/bands?embedded=true&dark-mode=true`. For an embedded version of the main spots/home
+page in the system light/dark mode, use `https://spothole.app/?embedded=true`. For dark mode showing 70cm TOTA spots
+only, use `https://spothole.app/?embedded=true&dark-mode=true&sig=TOTA&band=70cm`. Providing no URL params causes the
+page to be loaded in the normal way it would when accessed directly in the user's browser.
+
+The supported parameters are as follows. Generally these match the equivalent parameters in the real Spothole API, where
+a mapping exists.
+
+| Name             | Allowed Values          | Default | Example                 | Description                                                                                                                                                           |
+|------------------|-------------------------|---------|-------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `embedded`       | `true`, `false`         | `false` | `?embedded=true`        | Enables embedded mode.                                                                                                                                                |
+| `color-scheme`   | `light`, `dark`, `auto` | `auto`  | `?color-scheme=dark`    | Forces light or dark mode in preference to the operating system default.                                                                                              |
+| `time-zone`      | `UTC`, `local`          | `UTC`   | `?time-zone=local`      | Sets times to be in UTC or local time.                                                                                                                                |
+| `limit`          | 10, 25, 50, 100         | 50      | `?limit=50`             | Sets the number of spots that will be displayed on the main spots page                                                                                                |
+| `limit`          | 25, 50, 100, 200, 500   | 100     | `?limit=100`            | Sets the number of alerts that will be displayed on the alerts page                                                                                                   |
+| `max_age`        | 300, 600, 1800, 3600    | 1800    | `?max_age=1800`         | Sets the maximum age of spots displayed on the map and bands pages, in seconds.                                                                                       |
+| `band`           | Comma-separated list    | (all)   | `?band=20m,40m`         | Sets the list of bands that will be shown on the spots, bands and map pages. Available options match the labels of the buttons in the standard web interface.         |
+| `sig`            | Comma-separated list    | (all)   | `?sig=POTA,SOTA,NO_SIG` | Sets the list of SIGs that will be shown on the spots, bands and map pages. Available options match the labels of the buttons in the standard web interface.          |
+| `source`         | Comma-separated list    | (all)   | `?source=Cluster`       | Sets the list of sources that will be shown on any spot or alert pages. Available options match the labels of the buttons in the standard web interface.              |
+| `mode_type`      | Comma-separated list    | (all)   | `?mode_type=PHONE,CW`   | Sets the list of mode types that will be shown on the spots, bands and map pages. Available options match the labels of the buttons in the standard web interface.    |
+| `dx_continent`   | Comma-separated list    | (all)   | `?dx_continent=NA,SA`   | Sets the list of DX Continents that will be shown on any spot or alert pages. Available options match the labels of the buttons in the standard web interface.        |
+| `de_continent`   | Comma-separated list    | (all)   | `?de_continent=EU`      | Sets the list of DE Continents that will be shown on the spots, bands and map pages. Available options match the labels of the buttons in the standard web interface. |
+| `map-center-lat` | Numeric (decimal)       | (auto)  | `?map-center-lat=51.5`  | Sets the initial latitude of the map centre on the map page. If omitted, the map auto-fits to the loaded spots.                                                       |
+| `map-center-lon` | Numeric (decimal)       | (auto)  | `?map-center-lon=-0.1`  | Sets the initial longitude of the map centre on the map page. If omitted, the map auto-fits to the loaded spots.                                                      |
+| `map-zoom`       | Numeric (integer)       | (auto)  | `?map-zoom=6`           | Sets the initial zoom level of the map on the map page. If omitted, the map auto-fits to the loaded spots.                                                            |
+
+See the comment at the end of the next section regarding reliability and uptime of the "main" server.
+
+## Writing your own client
+
+One of the key strengths of Spothole is that the API is well-defined and open to anyone to use. This means you can build
+your own software that uses data from Spothole.
+
+As well as the main API endpoints to fetch spots and alerts, with various possible query parameters, there are also
+Server-Sent Events (SSE) API endpoints to receive a live feed, plus various utility lookup endpoints for things like
+callsign and park data.
+
+Various approaches exist to writing your own client, but in general:
+
+* Refer to the API docs. These are built on an OpenAPI definition file (`/webassets/apidocs/openapi.yml`), which you can
+  automatically use to generate a client skeleton using various software.
+* Call the main "spots" or "alerts" API endpoints to get the data you want. 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"
+  pages simply query the main spot API on a timer, whereas the main/spots page combines this approach with using the
+  Server-Sent Events (SSE) endpoint to update live.
+* Let me know if you get stuck, I'm happy to help.
+
+Please don't hammer the API with an unnecessarily high request rate. For example, Spothole only queries the POTA API
+once every two minutes, so if your client is interested in POTA data there's no need to poll Spothole any more often
+than that.
+
+If you absolutely must be informed within seconds of a spot arriving in Spothole, please use the SSE endpoints instead,
+e.g. `https://spothole.app/api/v2/spots/stream`.
+
+If you want to handle different types of spot or alert differently within your client, please consider making a single
+request to the Spothole API to retrieve all the data, then filtering on your side. For example, call
+`https://spothole.app/api/v2/spots?sig=POTA,SOTA` rather than making two separate calls to
+`https://spothole.app/api/v2/spots?sig=POTA` and `https://spothole.app/api/v2/spots?sig=SOTA`.
+
+Remember, here at Spothole Inc. we offer an industry-standard "five nines" uptime on our server, with our own unique
+twist: we don't tell you which side of the decimal point the nines start! (Translation: This is a hobby project.
+`spothole.app` runs on the same server as my blog and other stuff. It might go down without warning. By all means base
+your own project on data from the main server if you like, but if you want any control over reliability and downtime,
+please run your own copy instead.)
+
+## Running your own copy
+
+If you want to run a copy of Spothole with different configuration settings than the main instance, you can download it
+and run it on your own local machine or server.
+
+You will require Python version 3.8 or later. If you encounter an error about `gdal-config` during the following
+process, you will also need `libgdal-dev` installed.
+
+To download and set up Spothole on a Debian server, run the following commands. Other operating systems will likely be
+similar.
+
+```bash
+git clone ssh://git@git.ianrenton.com/ian/spothole.git
+cd spothole
+python3 -m venv ./.venv
+source .venv/bin/activate
+pip install -r requirements.txt
+deactivate
+cp config-example.yml config.yml
+```
+
+Then edit `config.yml` in your text editor of choice to set up the software as you like it. Mostly, this will involve
+enabling or disabling the various providers of spot and alert data.
+
+By default, all outdoor programme providers are enabled, as is one cluster node and the NG3K DXpedition data. The RBN
+spot providers are turned off by default due to the volume of traffic from CW/RTTY/FT8 skimmers, and the APRS and Packet
+spot providers are off by default on the assumption that Spothole users want a spot with a human at the other end of it,
+but all can be easily re-enabled.
+
+Other parameters you will want to update include the base URL to your instance, and whether you want to serve a full
+web-based DX cluster interface or just the API endpoints for client software to use.
+
+`config.yml` has an entry for a Clublog API key. If provided, this will allow Spothole to retrieve some more information
+about DX spots. The software will work just fine without it, but you may find a few country flags etc. are less accurate
+or missing. Clublog API keys are free, but you'll need to get your own by submitting a helpdesk ticket and explaining
+what you'll use it for. The admin team are happy with the rate of requests made by my Spothole server, so unless you
+change the source code of yours to radically increase the rate of querying Clublog, I'm sure they will be fine with your
+server too.
+
+Once you're happy with the content of `config.yml`, you can proceed to running the software.
+
+To run the software this time and any future times you want to run it directly from the command line:
+
+```bash
+source .venv/bin/activate
+python3 spothole.py
+```
+
+The software can take a few seconds to start up, mostly because it is downloading an updated file to match callsigns to
+countries. This is normal, don't panic!
+
+If you see some errors on startup, check your configuration, e.g. in case you have specified a port for the web server
+that is already in use by something else.
+
+### Multiple cluster nodes with different settings
+
+Dan, S50U has written in with his Spothole cluster settings. He is using a cluster node which provides RBN spots, and
+uses different SSIDs on his callsign to get different settings when logged into the same cluster node. For example:
+
+```
+  -
+    class: "DXCluster"
+    name: "S50CLX"
+    enabled: true
+    host: "s50clx.si"
+    port: 41112
+    login_prompt: "login: "
+    login_callsign: "callsign-10"
+```
+
+Telnet to DXSpider and log in with "callsign-10" and execute the following commands:
+
+`CLEAR/SPOTS ALL` (delete all previous filters)<br/>
+`UNSET/ANN` (stop announce messages)<br/>
+`UNSET/WCY` (stop wcy messages)<br/>
+`UNSET/WWV` (stop wwv messages)<br/>
+`SET/DX` (enable human DX spots)
+
+```
+  -
+    class: "DXCluster"
+    name: "RBN CW"
+    enabled: true
+    host: "s50clx.si"
+    port: 41112
+    login_prompt: "login: "
+    login_callsign: "callsign-11"
+    allow_rbn_spots: true
+    enabled-by-default-in-web-ui: false
+```
+
+Telnet to DXSpider and log in with "callsign-11" and execute the following commands:
+
+`CLEAR/SPOTS ALL` (delete all previous filters)<br/>
+`UNSET/ANN` (stop announce messages)<br/>
+`UNSET/WCY` (stop wcy messages)<br/>
+`UNSET/WWV` (stop wwv messages)<br/>
+`UNSET/DX` (stop human DX spots)<br/>
+`SET/SKIMMER CW` (enable CW RBN spots)
+
+```
+  -
+    class: "DXCluster"
+    name: "RBN RTTY"
+    enabled: true
+    host: "s50clx.si"
+    port: 41112
+    login_prompt: "login: "
+    login_callsign: "callsign-12"
+    allow_rbn_spots: true
+    enabled-by-default-in-web-ui: false
+```
+
+Telnet to DXSpider and log in with "callsign-12" and execute the following commands:
+
+`CLEAR/SPOTS ALL` (delete all previous filters)<br/>
+`UNSET/ANN` (stop announce messages)<br/>
+`UNSET/WCY` (stop wcy messages)<br/>
+`UNSET/WWV` (stop wwv messages)<br/>
+`UNSET/DX` (stop human DX spots)<br/>
+`SET/SKIMMER RTTY` (enable RTTY RBN spots)
+
+```
+  -
+    class: "DXCluster"
+    name: "RBN FT4/8"
+    enabled: true
+    host: "s50clx.si"
+    port: 41112
+    login_prompt: "login: "
+    login_callsign: "callsign-13"
+    allow_rbn_spots: true
+    enabled-by-default-in-web-ui: false
+```
+
+Telnet to DXSpider and log in with "callsign-13" and execute the following commands:
+
+`CLEAR/SPOTS ALL` (delete all previous filters)<br/>
+`UNSET/ANN` (stop announce messages)<br/>
+`UNSET/WCY` (stop wcy messages)<br/>
+`UNSET/WWV` (stop wwv messages)<br/>
+`UNSET/DX` (stop human DX spots)<br/>
+`SET/SKIMMER FT` (enable FT RBN spots)
+
+For each callsign-SSID, we also specify our basic information with commands:
+
+`SET/NAME Spothole10`, Spothole11... etc.<br/>
+`SET/QTH Cerkno`<br/>
+`SET/QRA JN66XD`<br/>
+`SET/HOME S50CLX`
+
+### systemd configuration
+
+If you want Spothole to run automatically on startup on a Linux distribution that uses `systemd`, follow the
+instructions here. For distros that don't use `systemd`, or Windows/OSX/etc., you can find generic instructions for your
+OS online.
+
+Create a file at `/etc/systemd/system/spothole.service`. Give it the following content, adjusting for the user you want
+to run it as and the directory in which you have installed it:
+
+```
+[Unit]
+Description=Spothole
+After=syslog.target network.target
+
+[Service]
+Type=simple
+User=spothole
+WorkingDirectory=/home/spothole/spothole
+ExecStart=/home/spothole/spothole/.venv/bin/python /home/spothole/spothole/spothole.py --serve-in-foreground
+Restart=on-abort
+
+[Install]
+WantedBy=multi-user.target
+```
+
+Run the following:
+
+```bash
+sudo systemctl daemon-reload
+sudo systemctl enable spothole
+sudo systemctl start spothole
+```
+
+Check the service has started up correctly with `sudo journalctl -u spothole -f`.
+
+### nginx Reverse Proxy configuration
+
+Web servers generally serve their pages from port 80. However, it's best not to serve Spothole's web interface directly
+on port 80, as that requires root privileges on a Linux system. It also and prevents us using HTTPS to serve a secure
+site, since Spothole itself doesn't directly support acting as an HTTPS server. The normal solution to this is to use
+a "reverse proxy" setup, where a general web server handles HTTP and HTTP requests (to port 80 & 443 respectively), then
+passes on the request to the back-end application (in this case Spothole). nginx is a common choice for this general web
+server.
+
+To set up nginx as a reverse proxy that sits in front of Spothole, first ensure it's installed e.g.
+`sudo apt install nginx`, and enabled e.g. `sudo systemd enable nginx`.
+
+Create a file at `/etc/nginx/sites-available/` called `spothole`. Give it the following contents, replacing
+`spothole.app` with the domain name on which you want to run Spothole. If you changed the port on which Spothole runs,
+update that on the "proxy_pass" line too.
+
+```nginx
+server {
+    server_name spothole.app;
+
+    # Wellknown area for Lets Encrypt
+    location /.well-known/ {
+        alias /var/www/html/.well-known/;
+    }
+    
+    # SSE endpoints
+    location ~ ^/api/v2/(spots|alerts)/stream {
+        proxy_pass http://127.0.0.1:8080;
+        
+        # Allow keep-alive
+        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;
+        
+        # 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
+        proxy_http_version 1.1;
+        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
+    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 "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;
+    }
+}
+```
+
+One further change you might want to make to the file above is the `add_header Access-Control-Allow-Origin` statements.
+These are what's used on
+my own Spothole server to make sure that other third-party web-based software can get the data from my instance, and
+applies to any endpoint underneath `/api`. If you want
+*your* Spothole instance to be set up the same way, so that others can write software in JavaScript that can access it,
+leave this intact. But if you want your Spothole instance to only be usable by scripts running on the web server you
+write,
+you can remove these lines. (Note that this doesn't stop other people writing *non-web-based* software that accesses
+your
+Spothole API&mdash;the enforcement of cross-origin headers only happens within the user's browser. If you need to lock
+your
+instance down so that no-one else can access it with *any* software, that's an aspect of nginx or firewall config that
+you will need
+to find help with elsewhere.)
+
+Now, make a symbolic link to enable the site:
+
+```bash
+cd /etc/nginx/sites-enabled
+sudo ln -sf ../sites-available/spothole
+```
+
+Test that your nginx config isn't broken using `nginx -t`. If it works, restart nginx with
+`sudo systemctl restart nginx`.
+
+If you haven't already done so, set up a DNS entry to make sure requests for your domain name end up at the server
+that's running Spothole.
+
+You should now be able to access the web interface by going to the domain from your browser.
+
+Once that's working, [install certbot](https://certbot.eff.org/instructions?ws=nginx&os=snap) onto your server. Run it
+as root, and when prompted pick your domain name from the list. After a few seconds, it should successfully provision a
+certificate and modify your nginx config files automatically. You should then be able to access the site via HTTPS.
+
+## Modifying the source code
+
+Spothole is Public Domain licenced, so you can grab the source code and start modifying it for your own needs.
+Contributions of code back to the main repository are encouraged, but completely optional.
+
+### Code structure
+
+To navigate your way around the source code, this list may help.
+
+*Python back-end code*
+
+* `/core` - Core classes and scripts
+* `/data` - Data storage classes
+* `/spotproviders` - Classes providing spots by accessing the APIs of other services
+* `/alertproviders` - Classes providing alerts by accessing the APIs of other services
+* `/solarconditionsproviders` - Classes providing solar and propagation by accessing the APIs of other services
+* `/server` - Classes for running Spothole's own web server
+
+*Templates*
+
+* `/templates` - Templates used for constructing Spothole's user-targeted HTML pages
+
+*HTML/JS/CSS front-end code*
+
+* `/webassets` - Root for static files served by the web server
+* `/webassets/apidocs` - Contains the OpenAPI spec (`openapi.yml`)
+* `/webassets/css` - CSS files used by the web front-end
+* `/webassets/img` - image files used by the web front-end
+* `/webassets/js` - JavaScript used by the web front-end
+* `/webassets/vendor` - Third-party libraries (CSS, JS, fonts and images)
+
+*Miscellaneous*
+
+* `/` - Main script (`spothole.py`), pip `requirements.txt`, config, README, etc.
+* `/images` - Image sources
+* `/datafiles` - Local data sources (differentiated from the majority of data files which are loaded from URLs and
+  cached in `/cache`)
+* `/cache` - Directory where static-ish data downloaded from the internet is cached to avoid rapid re-requests, and
+  where spot/alert data is cached so that it survives a software restart. Created on first run.
+
+### Extending the server
+
+Spothole is designed to be easily extensible. If you want to write your own spot provider, for example, simply add a
+module to the `spotproviders` package containing your class. (Currently, in order to be loaded correctly, the module (
+file) name should be the same as the class name, but lower case.)
+
+Your class should extend "SpotProvider"; if it operates by polling an HTTP Server on a timer, it can instead extend "
+HTTPSpotProvider" where some of the work is done for you.
+
+The class will need to implement a constructor that takes in the `provider_config` and provides it to the superclass
+constructor, while also taking any other config parameters it needs.
+
+If you're extending the base `SpotProvider` class, you will need to implement `start()` and `stop()` methods that start
+and stop a separate thread which handles the provider's processing needs. The thread should call `submit()` or
+`submit_batch()` when it has one or more spots to report.
+
+If you're extending the `HTTPSpotProvider` class, you will need to provide a URI to query and an interval to the
+superclass constructor. You'll then need to implement the `http_response_to_spots()` method which is called when new
+data is retrieved. Your implementation should then call `submit()` or `submit_batch()` when it has one or more spots to
+report.
+
+When constructing spots, use the comments in the Spot class and the existing implementations as an example. All
+parameters are optional, but you will at least want to provide a `time` (which must be timezone-aware) and a `dx_call`.
+
+Finally, simply add the appropriate config to the `spot_providers` section of `config.yml`, and your provider should be
+instantiated on startup.
+
+The same approach as above is also used for alert providers.
 
 ## Thanks
 
@@ -57,14 +524,17 @@ my knowledge, created by HA8TKS for his CQ and ITU zone layers for Leaflet. `/da
 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
-`/static/img/flags/` directory.
+`/webassets/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 `/static/vendor/` directory. These files are subject to
+A number of third-party libraries are self-hosted in the `/webassets/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
 their own licences and are not covered by the overall licence declared in the `LICENSE` file.
 
 Particular thanks go to country-files.com for providing country lookup data for amateur radio, to K0SWE

alertproviders/alert_provider.py

@@ -8,10 +8,10 @@ from core.config import MAX_ALERT_AGE
 class AlertProvider:
     """Generic alert provider class. Subclasses of this query the individual APIs for alerts."""
 
-    def __init__(self, name, provider_config):
+    def __init__(self, provider_config):
         """Constructor"""
 
-        self.name = name
+        self.name = provider_config["name"]
         self.enabled = provider_config["enabled"]
         self.last_update_time = datetime.min.replace(tzinfo=pytz.UTC)
         self.status = "Not Started" if self.enabled else "Disabled"

alertproviders/bota.py

@@ -15,7 +15,7 @@ class BOTA(HTTPAlertProvider):
     ALERTS_URL = "https://www.beachesontheair.com/"
 
     def __init__(self, provider_config):
-        super().__init__("BOTA", provider_config, self.ALERTS_URL, self.POLL_INTERVAL_SEC)
+        super().__init__(provider_config, self.ALERTS_URL, self.POLL_INTERVAL_SEC)
 
     def _http_response_to_alerts(self, http_response):
         new_alerts = []

alertproviders/http_alert_provider.py

@@ -4,7 +4,6 @@ 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
@@ -14,8 +13,8 @@ class HTTPAlertProvider(AlertProvider):
     """Generic alert provider class for providers that request data via HTTP(S). Just for convenience to avoid code
     duplication. Subclasses of this query the individual APIs for data."""
 
-    def __init__(self, name, provider_config, url, poll_interval):
-        super().__init__(name, provider_config)
+    def __init__(self, provider_config, url, poll_interval):
+        super().__init__(provider_config)
         self._url = url
         self._poll_interval = poll_interval
         self._thread = None
@@ -42,25 +41,16 @@ 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))
-            # Check response code was good
-            if http_response.ok:
-                # Pass off to the subclass for processing
-                new_alerts = self._http_response_to_alerts(http_response)
-                # Submit the new alerts for processing. There might not be any alerts for the less popular programs.
-                if new_alerts:
-                    self._submit_batch(new_alerts)
+            # Pass off to the subclass for processing
+            new_alerts = self._http_response_to_alerts(http_response)
+            # Submit the new alerts for processing. There might not be any alerts for the less popular programs.
+            if new_alerts:
+                self._submit_batch(new_alerts)
 
-                self.status = "OK"
-                self.last_update_time = datetime.now(pytz.UTC)
-                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.")
+            self.status = "OK"
+            self.last_update_time = datetime.now(pytz.UTC)
+            logging.debug("Received data from " + self.name + " alert 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/ng3k.py

@@ -18,7 +18,7 @@ class NG3K(HTTPAlertProvider):
     AS_CALL_PATTERN = re.compile("as ([a-z0-9/]+)", re.IGNORECASE)
 
     def __init__(self, provider_config):
-        super().__init__("NG3K", provider_config, self.ALERTS_URL, self.POLL_INTERVAL_SEC)
+        super().__init__(provider_config, self.ALERTS_URL, self.POLL_INTERVAL_SEC)
 
     def _http_response_to_alerts(self, http_response):
         new_alerts = []

alertproviders/parksnpeaks.py

@@ -15,7 +15,7 @@ class ParksNPeaks(HTTPAlertProvider):
     ALERTS_URL = "https://parksnpeaks.org/api/ALERTS/"
 
     def __init__(self, provider_config):
-        super().__init__("ParksNPeaks", provider_config, self.ALERTS_URL, self.POLL_INTERVAL_SEC)
+        super().__init__(provider_config, self.ALERTS_URL, self.POLL_INTERVAL_SEC)
 
     def _http_response_to_alerts(self, http_response):
         new_alerts = []

alertproviders/pota.py

@@ -14,7 +14,7 @@ class POTA(HTTPAlertProvider):
     ALERTS_URL = "https://api.pota.app/activation"
 
     def __init__(self, provider_config):
-        super().__init__("POTA", provider_config, self.ALERTS_URL, self.POLL_INTERVAL_SEC)
+        super().__init__(provider_config, self.ALERTS_URL, self.POLL_INTERVAL_SEC)
 
     def _http_response_to_alerts(self, http_response):
         new_alerts = []

alertproviders/sota.py

@@ -14,7 +14,7 @@ class SOTA(HTTPAlertProvider):
     ALERTS_URL = "https://api-db2.sota.org.uk/api/alerts/365/all/all"
 
     def __init__(self, provider_config):
-        super().__init__("SOTA", provider_config, self.ALERTS_URL, self.POLL_INTERVAL_SEC)
+        super().__init__(provider_config, self.ALERTS_URL, self.POLL_INTERVAL_SEC)
 
     def _http_response_to_alerts(self, http_response):
         new_alerts = []

alertproviders/wota.py

@@ -18,7 +18,7 @@ class WOTA(HTTPAlertProvider):
     RSS_DATE_TIME_FORMAT = "%a, %d %b %Y %H:%M:%S %z"
 
     def __init__(self, provider_config):
-        super().__init__("WOTA", provider_config, self.ALERTS_URL, self.POLL_INTERVAL_SEC)
+        super().__init__(provider_config, self.ALERTS_URL, self.POLL_INTERVAL_SEC)
 
     def _http_response_to_alerts(self, http_response):
         new_alerts = []

alertproviders/wwff.py

@@ -14,7 +14,7 @@ class WWFF(HTTPAlertProvider):
     ALERTS_URL = "https://spots.wwff.co/static/agendas.json"
 
     def __init__(self, provider_config):
-        super().__init__("WWFF", provider_config, self.ALERTS_URL, self.POLL_INTERVAL_SEC)
+        super().__init__(provider_config, self.ALERTS_URL, self.POLL_INTERVAL_SEC)
 
     def _http_response_to_alerts(self, http_response):
         new_alerts = []

config-example.yml

@@ -19,55 +19,66 @@ base-url: "http://localhost:8080"
 
 # Spot providers to use. This is an example set, tailor it to your liking by commenting and uncommenting.
 # RBN and APRS-IS are supported but have such a high data rate, you probably don't want them enabled.
-# Each provider needs a class and an enabled/disabled state. Some require more config such as hostnames/IP
+# Each provider needs a class, a name, and an enabled/disabled state. Some require more config such as hostnames/IP
 # addresses and ports. You can duplicate them if you like, e.g. to support several DX clusters. RBN uses two ports, 7000
 # for CW/RTTY and 7001 for FT8, so if you want both, you need two entries, as shown below.
 # Feel free to write your own provider classes! There are details in the README.
 spot-providers:
   - class: "POTA"
+    name: "POTA"
     enabled: true
 
   - class: "SOTA"
+    name: "SOTA"
     enabled: true
 
   - class: "WWFF"
+    name: "WWFF"
     enabled: true
 
   - class: "WWBOTA"
+    name: "WWBOTA"
     enabled: true
 
   - class: "GMA"
+    name: "GMA"
     enabled: true
     # GMA requires an API key to fetch spots. After creating an account on cqgma.org, email support and request one.
     api-key: ""
 
   - class: "HEMA"
+    name: "HEMA"
     enabled: true
 
   - class: "ParksNPeaks"
+    name: "ParksNPeaks"
     enabled: true
 
   - class: "ZLOTA"
+    name: "ZLOTA"
     enabled: true
 
   - class: "WOTA"
+    name: "WOTA"
     enabled: true
 
   - class: "LLOTA"
+    name: "LLOTA"
     enabled: true
 
   - class: "Towers"
+    name: "Towers"
     enabled: true
 
   - class: "Tiles"
+    name: "Tiles"
     enabled: true
 
   - class: "APRSIS"
+    name: "APRS-IS"
     enabled: false
 
   - class: "DXCluster"
-    # Clusters have a "name" property in case you want to say which cluster node the data is from, or connect to
-    # several clusters and name them separately.
     name: "HRD Cluster"
     enabled: true
     host: "hrd.wa9pie.net"
@@ -88,12 +99,18 @@ spot-providers:
     enabled: false
     host: "w3lpl.net"
     port: 7373
+    # Prompt the cluster node gives when asking for a callsign to log in. Varies between cluster node software.
     login_prompt: "Please enter your call:"
+    # Callsign Spothole will use to log into this cluster. Ensure the SSID (e.g. -99) is different to any personal
+    # connection you might make to this cluster node.
     login_callsign: "N0CALL-99"
+    # Whether to allow RBN spots that come via this cluster. If you don't want RBN spots or you are making a separate
+    # connection to RBN directly, leave this as False. If you want RBN spots from this cluster, set this to True. (Make
+    # sure you aren't also separately connecting to RBN directly, otherwise you may get duplicate spots.) Note that not
+    # all clusters sent RBN spots anyway.
     allow_rbn_spots: false
 
   - class: "RBN"
-  - # RBN sources have a "name" property in case you want to differentiate between the CW/RTTY and FT8 sources.
     name: "RBN CW/RTTY"
     enabled: false
     port: 7000
@@ -110,12 +127,11 @@ spot-providers:
     enabled-by-default-in-web-ui: false
 
   - class: "UKPacketNet"
+    name: "UK Packet Radio Net"
     enabled: false
     enabled-by-default-in-web-ui: false
 
   - class: "XOTA"
-    # xOTA sources have a "name" property so you can define what programme it is for, since xOTA is generic software
-    # for running "something-on-the-air" programmes.
     name: "39C3 TOTA"
     enabled: false
     url: "wss://39c3.totawatch.de/api/spot/live"
@@ -136,40 +152,51 @@ spot-providers:
 # Alert providers to use. Same setup as the spot providers list above.
 alert-providers:
   - class: "POTA"
+    name: "POTA"
     enabled: true
 
   - class: "SOTA"
+    name: "SOTA"
     enabled: true
 
   - class: "WWFF"
+    name: "WWFF"
     enabled: true
 
   - class: "ParksNPeaks"
+    name: "ParksNPeaks"
     enabled: true
 
   - class: "WOTA"
+    name: "WOTA"
     enabled: true
 
   - class: "BOTA"
+    name: "BOTA"
     enabled: true
 
   - class: "NG3K"
+    name: "NG3K"
     enabled: true
 
 
 # Solar condition providers to use. These poll external APIs for solar propagation data (SFI, A/K indices, band
-# conditions, etc.) and make it available via the /api/v1/solar endpoint.
+# conditions, etc.) and make it available via the /api/v2/solar endpoint.
 solar-condition-providers:
   - class: "HamQSL"
+    name: "HamQSL"
     enabled: true
 
   - class: "NOAA3dayForecast"
+    name: "NOAA 3-day Forecast"
     enabled: true
 
   - class: "GIROIonosonde"
+    name: "GIRO Ionosonde Data"
     enabled: true
 
   - class: "KC2GProp"
+    name: "KC2G Propagation Data"
     enabled: true
 
 # Maximum time to keep spots and alerts in the system before deleting them. By default, one hour for spots and one week
@@ -184,13 +211,19 @@ clublog-api-key: ""
 # Allow submitting spots to the Spothole API?
 allow-spotting: true
 
-# 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
+# Allow upstream submission of spots to external providers (POTA, SOTA, etc.) via the API?
+# Requires allow-spotting to also be true. Set to false to only accept spots into the local
+# Spothole database, without forwarding them to any external service.
+allow-upstream-spotting: true
 
-# 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
+# Google reCAPTCHA v2 keys for CAPTCHA protection on upstream spot submission. Both keys must be set to enable CAPTCHA.
+# Leave both empty to disable CAPTCHA (e.g. for a private/trusted server) or if allow-spotting is false, in which case
+# they will do nothing. Note that with CAPTCHA enabled, this will prevent third-party clients submitting spots through
+# Spothole unless the clients are web-based, use the same site key, have their domains enabled in your reCAPTCHA config,
+# and of course their user solves the CAPTCHA.
+# You can sign up for reCAPTCHA at https://www.google.com/recaptcha/
+recaptcha-site-key: ""
+recaptcha-secret-key: ""
 
 # Options for the web UI.
 web-ui-options:

core/cache_utils.py

@@ -8,11 +8,8 @@ from requests_cache import CachedSession
 # of time has passed. This is used throughout Spothole to cache data that does not change
 # rapidly. The ThreadSafeSession construct here protects it against some multithreading
 # contention weirdness we sometimes used to see on startup where the cache was hammered
-# 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))
+# pretty hard.
+_session = CachedSession("cache/semi_static_url_data_cache", expire_after=timedelta(days=30))
 _lock = threading.Lock()
 
 

core/config.py

@@ -14,22 +14,26 @@ with open("config.yml") as f:
     config = yaml.safe_load(f)
 logging.info("Loaded config.")
 
-BASE_URL = config["base-url"]
-MAX_SPOT_AGE = config["max-spot-age-sec"]
-MAX_ALERT_AGE = config["max-alert-age-sec"]
-SERVER_OWNER_CALLSIGN = config["server-owner-callsign"]
-WEB_SERVER_PORT = config["web-server-port"]
-ALLOW_SPOTTING = config["allow-spotting"]
-WEB_UI_OPTIONS = config["web-ui-options"]
+BASE_URL = config.get("base-url", "http://localhost:8080")
+MAX_SPOT_AGE = config.get("max-spot-age-sec", 3600)
+MAX_ALERT_AGE = config.get("max-alert-age-sec", 604800)
+SERVER_OWNER_CALLSIGN = config.get("server-owner-callsign", "N0CALL")
+WEB_SERVER_PORT = config.get("web-server-port", 8080)
+ALLOW_SPOTTING = config.get("allow-spotting", True)
+ALLOW_UPSTREAM_SPOTTING = config.get("allow-upstream-spotting", True)
+WEB_UI_OPTIONS = config.get("web-ui-options", {})
 API_ONLY_MODE = config.get("api-only-mode", False)
-LOG_LEVEL = config.get("log-level", "INFO")
-LOG_WEB_REQUESTS = config.get("log-web-requests", False)
+RECAPTCHA_SECRET_KEY = config.get("recaptcha-secret-key", "")
+RECAPTCHA_SITE_KEY = config.get("recaptcha-site-key", "")
 
 # For ease of config, each spot provider owns its own config about whether it should be enabled by default in the web UI
 # but for consistency we provide this to the front-end in web-ui-options because it has no impact outside of the web UI.
 WEB_UI_OPTIONS["spot-providers-enabled-by-default"] = [p["name"] for p in config["spot-providers"] if p["enabled"] and (
         "enabled-by-default-in-web-ui" not in p or p["enabled-by-default-in-web-ui"])]
 # If spotting to this server is enabled, "API" is another valid spot source even though it does not come from
-# one of our proviers. We set that to also be enabled by default.
+# one of our proviers. We set that to also be enabled by default. We can also include the reCaptcha site key so the UI
+# can access it.
 if ALLOW_SPOTTING:
     WEB_UI_OPTIONS["spot-providers-enabled-by-default"].append("API")
+    WEB_UI_OPTIONS["recaptcha-site-key"] = RECAPTCHA_SITE_KEY
+WEB_UI_OPTIONS["allow-upstream-spotting"] = ALLOW_SPOTTING and ALLOW_UPSTREAM_SPOTTING

core/constants.py

@@ -3,7 +3,7 @@ from data.band import Band
 from data.sig import SIG
 
 # General software
-SOFTWARE_VERSION = "1.5"
+SOFTWARE_VERSION = "1.4-pre"
 
 # HTTP headers used for spot providers that use HTTP
 HTTP_HEADERS = {"User-Agent": "Spothole v" + SOFTWARE_VERSION + " (operated by " + SERVER_OWNER_CALLSIGN + ")"}
@@ -11,7 +11,7 @@ HAMQTH_PRG = ("Spothole v" + SOFTWARE_VERSION + " operated by " + SERVER_OWNER_C
 
 # Special Interest Groups
 SIGS = [
-    SIG(name="POTA", comment_names=["POTA"], description="Parks on the Air", ref_regex=r"[A-Z]{2}\-\d{4,5}"),
+    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", comment_names=["SOTA"], description="Summits on the Air", ref_regex=r"[A-Z0-9]{1,3}\/[A-Z]{2}\-\d{3}"),
     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", comment_names=["GMA"], description="Global Mountain Activity", ref_regex=r"[A-Z0-9]{1,3}\/[A-Z]{2}\-\d{3}"),
@@ -27,8 +27,8 @@ SIGS = [
     SIG(name="WOTA", comment_names=["WOTA"], description="Wainwrights on the Air", ref_regex=r"[A-Z]{3}-[0-9]{2}"),
     SIG(name="BOTA", comment_names=[], description="Beaches on the Air"),
     SIG(name="KRMNPA", comment_names=["KRMNPA"], description="Keith Roget Memorial National Parks Award"),
-    SIG(name="LLOTA", comment_names=["LLOTA"], description="Lagos y Lagunas on the Air", ref_regex=r"LL[A-Z]{2}\-\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="LLOTA", comment_names=["LLOTA"], description="Lagos y Lagunas on the Air", ref_regex=r"[A-Z]{2}\-\d{4}"),
+    SIG(name="Towers", comment_names=["TOTA"], description="Towers on the Air", ref_regex=r"[A-Z]{2}R\-\d{4}"),
     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", comment_names=["WAB"], description="Worked All Britain", ref_regex=r"[A-Z]{1,2}[0-9]{2}"),
     SIG(name="WAI", comment_names=["WAI"], description="Worked All Ireland", ref_regex=r"[A-Z][0-9]{2}"),
@@ -38,10 +38,12 @@ SIGS = [
 
 # Modes. Note "DIGI" and "DIGITAL" are also supported but are normalised into "DATA".
 CW_MODES = ["CW"]
-PHONE_MODES = ["PHONE", "SSB", "USB", "LSB", "AM", "FM", "DV", "DMR", "DSTAR", "C4FM", "M17"]
+PHONE_MODES = ["PHONE", "SSB", "USB", "LSB", "AM", "FM", "DV", "DMR", "DSTAR", "C4FM", "FUSION", "M17"]
 DATA_MODES = ["DATA", "FT8", "FT4", "RTTY", "SSTV", "JS8", "HELL", "PSK", "OLIVIA", "PKT", "MSK144"]
 ALL_MODES = CW_MODES + PHONE_MODES + DATA_MODES
 MODE_TYPES = ["CW", "PHONE", "DATA"]
+SSB_SUB_MODES = ["USB", "LSB"]
+DV_SUB_MODES = ["DMR", "DSTAR", "C4FM", "FUSION", "M17"]
 
 # Mode aliases. Sometimes we get spots with a mode described in a different way that is effectively the same as a mode
 # we already know, or we want to normalise things for consistency. The lookup table for this is here. Incoming spots
@@ -102,6 +104,5 @@ PROPAGATION_MODES = {
     "AU": "Aurora",
     "MS": "Meteor scatter",
     "RS": "Rain scatter",
-    "AS": "Aircraft scatter",
-    "SAT": "Satellite"
+    "AS": "Aircraft scatter"
 }

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,21 +143,13 @@ 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)
+                                                      headers=HTTP_HEADERS).text
 
-            if response.ok:
-                with open(self._country_files_cty_plist_download_location, "w") as f:
-                    f.write(response.text)
-                    f.flush()
-                    return True
-            else:
-                logging.warning(f"HTTP {response.status_code} when downloading Country-files.com cty.plist.")
-                return False
+            with open(self._country_files_cty_plist_download_location, "w") as f:
+                f.write(response)
+                f.flush()
+                return True
 
-        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
@@ -169,21 +161,13 @@ 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)
+                headers=HTTP_HEADERS).text
 
-            if response.ok:
-                with open(self._dxcc_json_download_location, "w") as f:
-                    f.write(response.text)
-                    f.flush()
-                    return True
-            else:
-                logging.warning(f"HTTP {response.status_code} when downloading dxcc.json.")
-                return False
+            with open(self._dxcc_json_download_location, "w") as f:
+                f.write(response)
+                f.flush()
+                return True
 
-        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
@@ -506,47 +490,25 @@ class LookupHelper:
 
         # Try the call as given, then fall back to the base call (strips /P, /M etc.)
         calls_to_try = [call]
-        try:
-            home_call = callinfo.Callinfo.get_homecall(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)
+        home_call = callinfo.Callinfo.get_homecall(call)
+        if home_call != call:
+            calls_to_try.append(home_call)
 
         for lookup_call in calls_to_try:
             try:
-                response = SEMI_STATIC_URL_DATA_CACHE.get(
+                lookup_response = requests.get(
                     self._qrz_base_url + "?s=" + session_key + "&callsign=" + urllib.parse.quote_plus(lookup_call),
-                    headers=HTTP_HEADERS, timeout=10)
-                if response.ok:
-                    qrz_response = xmltodict.parse(response.content).get("QRZDatabase", {})
-                    if qrz_response:
-                        if "Callsign" in qrz_response:
-                            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)
-
+                    headers=HTTP_HEADERS, timeout=10).content
+                raw = xmltodict.parse(lookup_response).get("QRZDatabase", {}).get("Callsign")
+                if raw:
+                    data = _normalize_qrz_data(raw)
+                    self._qrz_callsign_data_cache.add(call, data, expire=604800)  # 1 week in seconds
+                    return data
             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 callsign %s using QRZ", lookup_call, exc_info=True)
-                continue
+                logging.error("Exception when looking up QRZ data")
+                return None
 
         # 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
@@ -584,36 +546,23 @@ class LookupHelper:
 
         # Try the call as given, then fall back to the base call (strips /P, /M etc.)
         calls_to_try = [call]
-        try:
-            home_call = callinfo.Callinfo.get_homecall(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)
+        home_call = callinfo.Callinfo.get_homecall(call)
+        if home_call != call:
+            calls_to_try.append(home_call)
 
         for lookup_call in calls_to_try:
             try:
-                response = SEMI_STATIC_URL_DATA_CACHE.get(
+                lookup_data = 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)
-                if response.ok:
-                    data = xmltodict.parse(response.content)["HamQTH"]["search"]
-                    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)
-
+                        lookup_call) + "&prg=" + HAMQTH_PRG, headers=HTTP_HEADERS).content
+                data = xmltodict.parse(lookup_data)["HamQTH"]["search"]
+                self._hamqth_callsign_data_cache.add(call, data, expire=604800)  # 1 week in seconds
+                return data
             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 callsign %s using HamQTH", lookup_call, exc_info=True)
-                continue
+                logging.error("Exception when looking up HamQTH data")
+                return None
 
         # 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,7 +2,6 @@ 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
@@ -12,14 +11,6 @@ from core.geo_utils import wab_wai_square_to_lat_lon
 # 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):
@@ -54,136 +45,92 @@ def populate_sig_ref_info(sig_ref):
     try:
         if sig.upper() == "POTA":
             response = SEMI_STATIC_URL_DATA_CACHE.get("https://api.pota.app/park/" + ref_id, headers=HTTP_HEADERS)
-            if response.ok:
-                data = response.json()
-                if data:
-                    fullname = str(data["name"]) if "name" in data else None
-                    if fullname and "parktypeDesc" in data and data["parktypeDesc"] != "":
-                        fullname = fullname + " " + data["parktypeDesc"]
-                    sig_ref.name = fullname
-                    sig_ref.url = "https://pota.app/#/park/" + ref_id
-                    sig_ref.grid = data["grid6"] if "grid6" in data else None
-                    sig_ref.latitude = data["latitude"] if "latitude" in data else None
-                    sig_ref.longitude = data["longitude"] if "longitude" in data else None
-                elif not response.from_cache:
-                    logging.warning("Malformed response looking up %s ref %s", sig, ref_id)
-            elif not response.from_cache:
+            if not response.ok:
                 logging.warning("HTTP %d looking up %s ref %s", response.status_code, sig, ref_id)
-
+            data = response.json() if response.ok else None
+            if data:
+                fullname = str(data["name"]) if "name" in data else None
+                if fullname and "parktypeDesc" in data and data["parktypeDesc"] != "":
+                    fullname = fullname + " " + data["parktypeDesc"]
+                sig_ref.name = fullname
+                sig_ref.url = "https://pota.app/#/park/" + ref_id
+                sig_ref.grid = data["grid6"] if "grid6" in data else None
+                sig_ref.latitude = data["latitude"] if "latitude" in data else None
+                sig_ref.longitude = data["longitude"] if "longitude" in data else None
         elif sig.upper() == "SOTA":
             response = SEMI_STATIC_URL_DATA_CACHE.get("https://api-db2.sota.org.uk/api/summits/" + ref_id,
                                                       headers=HTTP_HEADERS)
-            if response.ok:
-                data = response.json()
-                if data:
-                    sig_ref.name = data["name"] if "name" in data else None
-                    sig_ref.url = "https://www.sotadata.org.uk/en/summit/" + ref_id
-                    sig_ref.grid = data["locator"] if "locator" in data else None
-                    sig_ref.latitude = data["latitude"] if "latitude" in data else None
-                    sig_ref.longitude = data["longitude"] if "longitude" in data else None
-                    sig_ref.activation_score = data["points"] if "points" in data else None
-                elif not response.from_cache:
-                    logging.warning("Malformed response looking up %s ref %s", sig, ref_id)
-            elif not response.from_cache:
+            if not response.ok:
                 logging.warning("HTTP %d looking up %s ref %s", response.status_code, sig, ref_id)
-
+            data = response.json() if response.ok else None
+            if data:
+                sig_ref.name = data["name"] if "name" in data else None
+                sig_ref.url = "https://www.sotadata.org.uk/en/summit/" + ref_id
+                sig_ref.grid = data["locator"] if "locator" in data else None
+                sig_ref.latitude = data["latitude"] if "latitude" in data else None
+                sig_ref.longitude = data["longitude"] if "longitude" in data else None
+                sig_ref.activation_score = data["points"] if "points" in data else None
         elif sig.upper() == "WWBOTA":
             response = SEMI_STATIC_URL_DATA_CACHE.get("https://api.wwbota.org/bunkers/" + ref_id,
                                                       headers=HTTP_HEADERS)
-            if response.ok:
-                data = response.json()
-                if data:
-                    sig_ref.name = data["name"] if "name" in data else None
-                    sig_ref.url = "https://bunkerwiki.org/?s=" + ref_id if ref_id.startswith("B/G") else None
-                    sig_ref.grid = data["locator"] if "locator" in data else None
-                    sig_ref.latitude = data["lat"] if "lat" in data else None
-                    sig_ref.longitude = data["long"] if "long" in data else None
-                elif not response.from_cache:
-                    logging.warning("Malformed response looking up %s ref %s", sig, ref_id)
-            elif not response.from_cache:
+            if not response.ok:
                 logging.warning("HTTP %d looking up %s ref %s", response.status_code, sig, ref_id)
-
+            data = response.json() if response.ok else None
+            if data:
+                sig_ref.name = data["name"] if "name" in data else None
+                sig_ref.url = "https://bunkerwiki.org/?s=" + ref_id if ref_id.startswith("B/G") else None
+                sig_ref.grid = data["locator"] if "locator" in data else None
+                sig_ref.latitude = data["lat"] if "lat" in data else None
+                sig_ref.longitude = data["long"] if "long" in data else None
         elif sig.upper() == "GMA" or sig.upper() == "ARLHS" or sig.upper() == "ILLW" or sig.upper() == "WCA" or sig.upper() == "MOTA" or sig.upper() == "IOTA":
             response = SEMI_STATIC_URL_DATA_CACHE.get("https://www.cqgma.org/api/ref/?" + ref_id,
                                                       headers=HTTP_HEADERS)
-            if response.ok:
-                data = response.json()
-                if data:
-                    sig_ref.name = data["name"] if "name" in data else None
-                    sig_ref.url = "https://www.cqgma.org/zinfo.php?ref=" + ref_id
-                    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:
+            if not response.ok:
                 logging.warning("HTTP %d looking up %s ref %s", response.status_code, sig, ref_id)
-
+            data = response.json() if response.ok else None
+            if data:
+                sig_ref.name = data["name"] if "name" in data else None
+                sig_ref.url = "https://www.cqgma.org/zinfo.php?ref=" + ref_id
+                sig_ref.grid = data["locator"] if "locator" in data else None
+                sig_ref.latitude = data["latitude"] if "latitude" in data else None
+                sig_ref.longitude = data["longitude"] if "longitude" in data else None
         elif sig.upper() == "WWFF":
-            response = SEMI_STATIC_URL_DATA_CACHE.get("https://wwff.co/wwff-data/wwff_directory.csv",
-                                                      headers=HTTP_HEADERS)
-            if response.ok:
-                global _WWFF_INDEX_CACHE
-                if not bool(_WWFF_INDEX_CACHE) or not response.from_cache:
-                    # New data from WWFF, update our internal map
-                    _WWFF_INDEX_CACHE = {row["reference"]: row for row in
-                                         csv.DictReader(response.content.decode().splitlines())}
-                row = _WWFF_INDEX_CACHE.get(ref_id)
-                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)
-
+            wwff_response = SEMI_STATIC_URL_DATA_CACHE.get("https://wwff.co/wwff-data/wwff_directory.csv",
+                                                           headers=HTTP_HEADERS)
+            if not wwff_response.ok:
+                logging.warning("HTTP %d looking up %s ref %s", wwff_response.status_code, sig, ref_id)
+                return sig_ref
+            wwff_index = {row["reference"]: row for row in csv.DictReader(wwff_response.content.decode().splitlines())}
+            row = wwff_index.get(ref_id)
+            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 sig.upper() == "SIOTA":
-            response = SEMI_STATIC_URL_DATA_CACHE.get("https://www.silosontheair.com/data/silos.csv",
-                                                      headers=HTTP_HEADERS)
-            if response.ok:
-                global _SIOTA_INDEX_CACHE
-                if not bool(_SIOTA_INDEX_CACHE) or not response.from_cache:
-                    # New data from SIOTA, update our internal map
-                    _SIOTA_INDEX_CACHE = {row["SILO_CODE"]: row for row in
-                                          csv.DictReader(response.content.decode().splitlines())}
-                row = _SIOTA_INDEX_CACHE.get(ref_id)
-                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)
-
+            siota_response = SEMI_STATIC_URL_DATA_CACHE.get("https://www.silosontheair.com/data/silos.csv",
+                                                            headers=HTTP_HEADERS)
+            if not siota_response.ok:
+                logging.warning("HTTP %d looking up %s ref %s", siota_response.status_code, sig, ref_id)
+                return sig_ref
+            siota_index = {row["SILO_CODE"]: row for row in
+                           csv.DictReader(siota_response.content.decode().splitlines())}
+            row = siota_index.get(ref_id)
+            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 sig.upper() == "WOTA":
             response = SEMI_STATIC_URL_DATA_CACHE.get("https://www.wota.org.uk/mapping/data/summits.json",
                                                       headers=HTTP_HEADERS)
-            if response.ok:
-                data = response.json()
-                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:
+            if not response.ok:
+                logging.warning("HTTP %d looking up %s ref %s", response.status_code, sig, ref_id)
+            data = response.json() if response.ok else None
+            if data:
+                for feature in data.get("features", []):
+                    if feature["properties"]["wotaId"] == ref_id:
                         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
@@ -194,68 +141,48 @@ 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]
-                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)
-
+                        break
         elif sig.upper() == "ZLOTA":
             response = SEMI_STATIC_URL_DATA_CACHE.get("https://ontheair.nz/assets/assets.json", headers=HTTP_HEADERS)
-            if response.ok:
-                data = response.json()
-                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:
+            if not response.ok:
+                logging.warning("HTTP %d looking up %s ref %s", response.status_code, sig, ref_id)
+            data = response.json() if response.ok else None
+            if isinstance(data, list):
+                for asset in data:
+                    if asset["code"] == ref_id:
                         sig_ref.name = asset["name"]
-                        sig_ref.url = "https://ontheair.nz/assets/" + ref_id.replace("/", "_")
+                        sig_ref.url = "https://ontheair.nz/assets/ZLI_OT-030" + ref_id.replace("/", "_")
                         try:
                             sig_ref.grid = latlong_to_locator(asset["y"], asset["x"], 6)
                         except:
                             logging.debug("Invalid lat/lon received for reference")
                             sig_ref.latitude = asset["y"]
                             sig_ref.longitude = asset["x"]
-                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)
-
+                        break
         elif sig.upper() == "BOTA":
             if not sig_ref.name:
                 sig_ref.name = sig_ref.id
             sig_ref.url = "https://www.beachesontheair.com/beaches/" + sig_ref.name.lower().replace(" ", "-")
-
         elif sig.upper() == "LLOTA":
             response = SEMI_STATIC_URL_DATA_CACHE.get("https://llota.app/api/public/references",
                                                       headers=HTTP_HEADERS)
-            if response.ok:
-                data = response.json()
-                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:
+            if not response.ok:
+                logging.warning("HTTP %d looking up %s ref %s", response.status_code, sig, ref_id)
+            data = response.json() if response.ok else None
+            if isinstance(data, list):
+                for ref in data:
+                    if ref["reference_code"] == ref_id:
                         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]
-                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)
-
+                        break
         elif sig.upper() == "WWTOTA":
             if not sig_ref.name:
                 sig_ref.name = sig_ref.id
             sig_ref.url = "https://wwtota.com/seznam/karta_rozhledny.php?ref=" + 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:
@@ -266,7 +193,6 @@ 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:
@@ -276,31 +202,21 @@ def populate_sig_ref_info(sig_ref):
                     sig_ref.latitude = ll[0]
                     sig_ref.longitude = ll[1]
                 except:
-                    logging.warning("Invalid lat/lon received for WAB/WAI reference")
-
+                    logging.debug("Invalid lat/lon received for reference")
         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
+                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)
+                        logging.debug("Invalid lat/lon received for reference")
     except Exception:
-        logging.error("Exception when looking up sig_ref info for " + sig + " ref " + ref_id, exc_info=True)
+        logging.warning("Failed to look up sig_ref info for " + sig + " ref " + ref_id, exc_info=True)
     return sig_ref
 
 

core/utils.py

@@ -1,11 +1,8 @@
-import simplejson
-
-
-def safe_json_dumps(obj):
-    """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 serialize_everything(obj):
+    """Convert objects to serialisable things. Used by JSON serialiser as a default when it encounters unserializable things.
+    Just converts objects to dict. Try to avoid doing anything clever here when serialising spots, because we also need
+    to receive spots without complex handling."""
+    return obj.__dict__
 
 
 def empty_queue(q):

data/lookup_credentials.py

@@ -12,15 +12,15 @@ class LookupCredentials:
     hamqth_session_id: str = ""  # alternative to username/password
 
 
-def extract_credentials(query_params):
-    """Build a LookupCredentials from HTTP query params; returns None if no usable credentials are present."""
+def extract_credentials(headers):
+    """Build a LookupCredentials from HTTP request headers; returns None if no usable credentials are present."""
     creds = LookupCredentials(
-        qrz_username=query_params.get("qrz_username", ""),
-        qrz_password=query_params.get("qrz_password", ""),
-        qrz_session_key=query_params.get("qrz_session_key", ""),
-        hamqth_username=query_params.get("hamqth_username", ""),
-        hamqth_password=query_params.get("hamqth_password", ""),
-        hamqth_session_id=query_params.get("hamqth_session_id", ""),
+        qrz_username=headers.get("X-QRZ-Username", ""),
+        qrz_password=headers.get("X-QRZ-Password", ""),
+        qrz_session_key=headers.get("X-QRZ-Session-Key", ""),
+        hamqth_username=headers.get("X-HamQTH-Username", ""),
+        hamqth_password=headers.get("X-HamQTH-Password", ""),
+        hamqth_session_id=headers.get("X-HamQTH-Session-ID", ""),
     )
     has_qrz = creds.qrz_session_key or (creds.qrz_username and creds.qrz_password)
     has_hamqth = creds.hamqth_session_id or (creds.hamqth_username and creds.hamqth_password)

data/spot.py

@@ -133,17 +133,6 @@ 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"""
 
@@ -323,20 +312,7 @@ class Spot:
                         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: %s", mode_tag)
-
-        # Parse "de_grid -> dx_grid" structures from the comment
-        if self.comment:
-            grid_mode_grid_match = re.search(
-                r'\b([A-Ra-r]{2}\d{2}(?:[A-Xa-x]{2}(?:\d{2})?)?)\s*->\s*([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.dx_grid:
-                    self.dx_grid = grid_mode_grid_match.group(1).upper()
-                    self.dx_location_source = "SPOT"
-                if not self.de_grid:
-                    self.de_grid = grid_mode_grid_match.group(2).upper()
+                        logging.info("Seen a new propagation mode tag not yet in the system: {}", mode_tag)
 
         # DX Grid to lat/lon and vice versa in case one is missing
         if self.dx_grid and not self.dx_latitude:

docs/clients.md

@@ -1,39 +0,0 @@
-## Writing your own client
-
-One of the key strengths of Spothole is that the API is well-defined and open to anyone to use. This means you can build
-your own software that uses data from Spothole.
-
-As well as the main API endpoints to fetch spots and alerts, with various possible query parameters, there are also
-Server-Sent Events (SSE) API endpoints to receive a live feed, plus various utility lookup endpoints for things like
-callsign and park data.
-
-Various approaches exist to writing your own client, but in general:
-
-* Refer to the API docs. These are built on an OpenAPI definition file (`/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/v1/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 "alerts"/"upcoming"
-  page simply query the main spot API on a timer, whereas the spots, map and bands pages combine this approach with
-  using the Server-Sent Events (SSE) endpoint to update live.
-* Let me know if you get stuck, I'm happy to help.
-
-Please don't hammer the API with an unnecessarily high request rate. For example, Spothole only queries the POTA API
-once every two minutes, so if your client is interested in POTA data there's no need to poll Spothole any more often
-than that.
-
-If you absolutely must be informed within seconds of a spot arriving in Spothole, please use the SSE endpoints instead,
-e.g. `https://spothole.app/api/v1/spots/stream`.
-
-If you want to handle different types of spot or alert differently within your client, please consider making a single
-request to the Spothole API to retrieve all the data, then filtering on your side. For example, call
-`https://spothole.app/api/v1/spots?sig=POTA,SOTA` rather than making two separate calls to
-`https://spothole.app/api/v1/spots?sig=POTA` and `https://spothole.app/api/v1/spots?sig=SOTA`.
-
-Remember, here at Spothole Inc. we offer an industry-standard "five nines" uptime on our server, with our own unique
-twist: we don't tell you which side of the decimal point the nines start! (Translation: This is a hobby project.
-`spothole.app` runs on the same server as my blog and other stuff. It might go down without warning. By all means base
-your own project on data from the main server if you like, but if you want any control over reliability and downtime,
-please run your own copy instead.)

docs/docker.md

@@ -1,150 +0,0 @@
-## Running using Docker
-
-Spothole comes with a Docker configuration to make it easy to run it in a containerised environment. To set it up using
-Docker, the easiest way is to use a Docker Compose file. Create a new directory such as `/opt/docker/spothole` and
-create a `compose.yaml` file inside it with the following contents:
-
-```yaml
-services:
-  spothole:
-    container_name: spothole
-    build:
-      context: https://git.ianrenton.com/ian/spothole.git#main
-    restart: unless-stopped
-    ports:
-      - "8080:8080"
-    volumes:
-      - ./config.yml:/app/config.yml
-      - ./cache:/app/cache
-```
-
-You can replace `#main` with any other branch or tag reference, for example `#1.5` to pin the build to tagged version
-1.5.
-
-Save the file. You will still need to create a copy of `config-example.yml` and name it `config.yml`, though with the
-Docker setup nothing has actually been downloaded yet, so you will have to copy the example from the repository some
-other way, e.g. [from the repo in a web browser](https://git.ianrenton.com/ian/spothole/src/branch/main/config-example.yml).
-
-With that in place, run `docker compose up` and you should be good to go. To detach, press `d` or run the command with
-the `-d` flag.
-
-### nginx Reverse Proxy with Docker
-
-In a containerised setup, it's typical to run an nginx reverse proxy in one container, alongside certbot for renewal
-of HTTPS certificates, and then applications like Spothole in a separate container. In this case, there are a couple of
-variations of the docker compose file above, and the nginx reverse proxy configuration covered [here](./nginx.md), that
-you will want to make.
-
-1. A port mapping is no longer required in the docker compose file; nginx will access into the docker container directly
-   on e.g. `http://spothole:8080`
-2. Spothole and nginx will need to be on the same docker network.
-
-So your `compose.yaml` might look like this:
-
-```yaml
-services:
-  spothole:
-    container_name: spothole
-    build:
-      context: https://git.ianrenton.com/ian/spothole.git#main
-    restart: unless-stopped
-    networks:
-      - docker-network
-    volumes:
-      - ./config.yml:/app/config.yml
-      - ./cache:/app/cache
-
-networks:
-  docker-network:
-    external: true
-```
-
-In your nginx site configuration, you'll want to refer to the Spothole container directly, and drop the block that
-allows nginx to access static files directly, as these will be inaccessible in another container. So you may end up
-with something like:
-
-```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/acme-challenge/ {
-        root /var/www/certbot;
-    }
-    
-    # SSE endpoints
-    location ~ ^/api/v1/(spots|alerts)/stream/? {
-        proxy_pass http://spothole:8080;
-        
-        # Remove buffering, remove caching, add suitable timeouts for SSE API calls
-        proxy_buffering off;
-        proxy_cache off;
-        proxy_read_timeout 24h;
-        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; 
-    }
-
-    # Other API endpoints
-    location /api/ {
-        proxy_pass http://spothole:8080;
-        
-        # Remove buffering, remove caching, add suitable timeouts for API calls
-        proxy_buffering off;
-        proxy_cache off;
-        proxy_read_timeout 30s;
-        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;
-    }
-
-    # Templated pages and static assets
-    location / {
-        proxy_pass http://spothole:8080;
-        proxy_read_timeout 30s;
-        add_header Cache-Control "no-cache, must-revalidate" always;
-    }
-    
-    listen 443 ssl;
-    listen [::]:443 ssl;
-
-    ssl_certificate /etc/letsencrypt/live/spothole.app/fullchain.pem;
-    ssl_certificate_key /etc/letsencrypt/live/spothole.app/privkey.pem;
-    include /etc/letsencrypt/options-ssl-nginx.conf;
-    ssl_dhparam /etc/letsencrypt/ssl-dhparams.pem;
-}
-
-
-server {
-    if ($host = spothole.app) {
-        return 301 https://$host$request_uri;
-    }
-
-    server_name spothole.app;
-    listen 80;
-    listen [::]:80;
-    return 404;
-}
-```
-
-If desired, you could even change the port on which Spothole runs from 8080 to a plain 80, in which case your
-`proxy_pass` statements could drop the `:8080` suffix. Since Spothole is in a container, it can serve HTTP on port 80
-if desired, because it doesn't conflict with the host system.

docs/embedding.md

@@ -1,41 +0,0 @@
-## Embedding Spothole in another website
-
-You can embed Spothole's web interface in another website, e.g. for use as part of a ham radio custom dashboard.
-
-URL parameters can be used to trigger an "embedded" mode which hides the headers, footers and settings. In this mode,
-you provide configuration for the various filter and display options via additional URL parameters. Any settings that
-the user has set for Spothole are ignored. This is so that the embedding site can select, for example, their choice of
-dark mode or SIG filters, which will not impact how Spothole appears when the user accesses it directly. Effectively, it
-becomes separate to their normal Spothole settings.
-
-Setting `embedded` to true is important for the rest of the settings to be applied; otherwise, the user's defaults will
-be used in preference to the URL params.
-
-These are supplied with the URL to the page you want to embed, for example for an embedded version of the band map in
-dark mode, use `https://spothole.app/bands?embedded=true&dark-mode=true`. For an embedded version of the main spots/home
-page in the system light/dark mode, use `https://spothole.app/?embedded=true`. For dark mode showing 70cm TOTA spots
-only, use `https://spothole.app/?embedded=true&dark-mode=true&sig=TOTA&band=70cm`. Providing no URL params causes the
-page to be loaded in the normal way it would when accessed directly in the user's browser.
-
-The supported parameters are as follows. Generally these match the equivalent parameters in the real Spothole API, where
-a mapping exists.
-
-| Name             | Allowed Values          | Default | Example                 | Description                                                                                                                                                           |
-|------------------|-------------------------|---------|-------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `embedded`       | `true`, `false`         | `false` | `?embedded=true`        | Enables embedded mode.                                                                                                                                                |
-| `color-scheme`   | `light`, `dark`, `auto` | `auto`  | `?color-scheme=dark`    | Forces light or dark mode in preference to the operating system default.                                                                                              |
-| `time-zone`      | `UTC`, `local`          | `UTC`   | `?time-zone=local`      | Sets times to be in UTC or local time.                                                                                                                                |
-| `limit`          | 10, 25, 50, 100         | 50      | `?limit=50`             | Sets the number of spots that will be displayed on the main spots page                                                                                                |
-| `limit`          | 25, 50, 100, 200, 500   | 100     | `?limit=100`            | Sets the number of alerts that will be displayed on the alerts page                                                                                                   |
-| `max_age`        | 300, 600, 1800, 3600    | 1800    | `?max_age=1800`         | Sets the maximum age of spots displayed on the map and bands pages, in seconds.                                                                                       |
-| `band`           | Comma-separated list    | (all)   | `?band=20m,40m`         | Sets the list of bands that will be shown on the spots, bands and map pages. Available options match the labels of the buttons in the standard web interface.         |
-| `sig`            | Comma-separated list    | (all)   | `?sig=POTA,SOTA,NO_SIG` | Sets the list of SIGs that will be shown on the spots, bands and map pages. Available options match the labels of the buttons in the standard web interface.          |
-| `source`         | Comma-separated list    | (all)   | `?source=Cluster`       | Sets the list of sources that will be shown on any spot or alert pages. Available options match the labels of the buttons in the standard web interface.              |
-| `mode_type`      | Comma-separated list    | (all)   | `?mode_type=PHONE,CW`   | Sets the list of mode types that will be shown on the spots, bands and map pages. Available options match the labels of the buttons in the standard web interface.    |
-| `dx_continent`   | Comma-separated list    | (all)   | `?dx_continent=NA,SA`   | Sets the list of DX Continents that will be shown on any spot or alert pages. Available options match the labels of the buttons in the standard web interface.        |
-| `de_continent`   | Comma-separated list    | (all)   | `?de_continent=EU`      | Sets the list of DE Continents that will be shown on the spots, bands and map pages. Available options match the labels of the buttons in the standard web interface. |
-| `map-center-lat` | Numeric (decimal)       | (auto)  | `?map-center-lat=51.5`  | Sets the initial latitude of the map centre on the map page. If omitted, the map auto-fits to the loaded spots.                                                       |
-| `map-center-lon` | Numeric (decimal)       | (auto)  | `?map-center-lon=-0.1`  | Sets the initial longitude of the map centre on the map page. If omitted, the map auto-fits to the loaded spots.                                                      |
-| `map-zoom`       | Numeric (integer)       | (auto)  | `?map-zoom=6`           | Sets the initial zoom level of the map on the map page. If omitted, the map auto-fits to the loaded spots.                                                            |
-
-See the comment at the end of the next section regarding reliability and uptime of the "main" server.

docs/modifying.md

@@ -1,69 +0,0 @@
-## Modifying the source code
-
-Spothole is Public Domain licenced, so you can grab the source code and start modifying it for your own needs.
-Contributions of code back to the main repository are encouraged, but completely optional.
-
-### Code structure
-
-To navigate your way around the source code, this list may help.
-
-*Python back-end code*
-
-* `/core` - Core classes and scripts
-* `/data` - Data storage classes
-* `/spotproviders` - Classes providing spots by accessing the APIs of other services
-* `/alertproviders` - Classes providing alerts by accessing the APIs of other services
-* `/solarconditionsproviders` - Classes providing solar and propagation by accessing the APIs of other services
-* `/server` - Classes for running Spothole's own web server
-
-*Templates*
-
-* `/templates` - Templates used for constructing Spothole's user-targeted HTML pages
-
-*HTML/JS/CSS front-end code*
-
-* `/static` - Root for static files served by the web server. These are all served from a path starting `/static/`.
-* `/static/apidocs` - Contains the OpenAPI spec (`openapi.yml`)
-* `/static/css` - CSS files used by the web front-end
-* `/static/img` - image files used by the web front-end
-* `/static/js` - JavaScript used by the web front-end
-* `/static/vendor` - Third-party libraries (CSS, JS, fonts and images)
-
-*Miscellaneous*
-
-* `/` - Main script (`spothole.py`), pip `requirements.txt`, config, README, etc.
-* `/docs` - Documentation
-* `/images` - Image sources
-* `/datafiles` - Local data sources (differentiated from the majority of data files which are loaded from URLs and
-  cached in `/cache`)
-* `/cache` - Directory where static-ish data downloaded from the internet is cached to avoid rapid re-requests, and
-  where spot/alert data is cached so that it survives a software restart. Created on first run.
-
-### Extending the server
-
-Spothole is designed to be easily extensible. If you want to write your own spot provider, for example, simply add a
-module to the `spotproviders` package containing your class. (Currently, in order to be loaded correctly, the module (
-file) name should be the same as the class name, but lower case.)
-
-Your class should extend "SpotProvider"; if it operates by polling an HTTP Server on a timer, it can instead extend "
-HTTPSpotProvider" where some of the work is done for you.
-
-The class will need to implement a constructor that takes in the `provider_config` and provides it to the superclass
-constructor, while also taking any other config parameters it needs.
-
-If you're extending the base `SpotProvider` class, you will need to implement `start()` and `stop()` methods that start
-and stop a separate thread which handles the provider's processing needs. The thread should call `submit()` or
-`submit_batch()` when it has one or more spots to report.
-
-If you're extending the `HTTPSpotProvider` class, you will need to provide a URI to query and an interval to the
-superclass constructor. You'll then need to implement the `http_response_to_spots()` method which is called when new
-data is retrieved. Your implementation should then call `submit()` or `submit_batch()` when it has one or more spots to
-report.
-
-When constructing spots, use the comments in the Spot class and the existing implementations as an example. All
-parameters are optional, but you will at least want to provide a `time` (which must be timezone-aware) and a `dx_call`.
-
-Finally, simply add the appropriate config to the `spot_providers` section of `config.yml`, and your provider should be
-instantiated on startup.
-
-The same approach as above is also used for alert providers.

docs/multicluster.md

@@ -1,96 +0,0 @@
-## Multiple cluster nodes with different settings
-
-Dan, S50U has written in with his Spothole cluster settings. He is using a cluster node which provides RBN spots, and
-uses different SSIDs on his callsign to get different settings when logged into the same cluster node. For example:
-
-```
-  -
-    class: "DXCluster"
-    name: "S50CLX"
-    enabled: true
-    host: "s50clx.si"
-    port: 41112
-    login_prompt: "login: "
-    login_callsign: "callsign-10"
-```
-
-Telnet to DXSpider and log in with "callsign-10" and execute the following commands:
-
-`CLEAR/SPOTS ALL` (delete all previous filters)<br/>
-`UNSET/ANN` (stop announce messages)<br/>
-`UNSET/WCY` (stop wcy messages)<br/>
-`UNSET/WWV` (stop wwv messages)<br/>
-`SET/DX` (enable human DX spots)
-
-```
-  -
-    class: "DXCluster"
-    name: "RBN CW"
-    enabled: true
-    host: "s50clx.si"
-    port: 41112
-    login_prompt: "login: "
-    login_callsign: "callsign-11"
-    allow_rbn_spots: true
-    enabled-by-default-in-web-ui: false
-```
-
-Telnet to DXSpider and log in with "callsign-11" and execute the following commands:
-
-`CLEAR/SPOTS ALL` (delete all previous filters)<br/>
-`UNSET/ANN` (stop announce messages)<br/>
-`UNSET/WCY` (stop wcy messages)<br/>
-`UNSET/WWV` (stop wwv messages)<br/>
-`UNSET/DX` (stop human DX spots)<br/>
-`SET/SKIMMER CW` (enable CW RBN spots)
-
-```
-  -
-    class: "DXCluster"
-    name: "RBN RTTY"
-    enabled: true
-    host: "s50clx.si"
-    port: 41112
-    login_prompt: "login: "
-    login_callsign: "callsign-12"
-    allow_rbn_spots: true
-    enabled-by-default-in-web-ui: false
-```
-
-Telnet to DXSpider and log in with "callsign-12" and execute the following commands:
-
-`CLEAR/SPOTS ALL` (delete all previous filters)<br/>
-`UNSET/ANN` (stop announce messages)<br/>
-`UNSET/WCY` (stop wcy messages)<br/>
-`UNSET/WWV` (stop wwv messages)<br/>
-`UNSET/DX` (stop human DX spots)<br/>
-`SET/SKIMMER RTTY` (enable RTTY RBN spots)
-
-```
-  -
-    class: "DXCluster"
-    name: "RBN FT4/8"
-    enabled: true
-    host: "s50clx.si"
-    port: 41112
-    login_prompt: "login: "
-    login_callsign: "callsign-13"
-    allow_rbn_spots: true
-    enabled-by-default-in-web-ui: false
-```
-
-Telnet to DXSpider and log in with "callsign-13" and execute the following commands:
-
-`CLEAR/SPOTS ALL` (delete all previous filters)<br/>
-`UNSET/ANN` (stop announce messages)<br/>
-`UNSET/WCY` (stop wcy messages)<br/>
-`UNSET/WWV` (stop wwv messages)<br/>
-`UNSET/DX` (stop human DX spots)<br/>
-`SET/SKIMMER FT` (enable FT RBN spots)
-
-For each callsign-SSID, we also specify our basic information with commands:
-
-`SET/NAME Spothole10`, Spothole11... etc.<br/>
-`SET/QTH Cerkno`<br/>
-`SET/QRA JN66XD`<br/>
-`SET/HOME S50CLX`

docs/nginx.md

@@ -1,123 +0,0 @@
-## nginx Reverse Proxy configuration
-
-Web servers generally serve their pages from port 80. However, it's best not to serve Spothole's web interface directly
-on port 80, as that requires root privileges on a Linux system. It also and prevents us using HTTPS to serve a secure
-site, since Spothole itself doesn't directly support acting as an HTTPS server. The normal solution to this is to use
-a "reverse proxy" setup, where a general web server handles HTTP and HTTP requests (to port 80 & 443 respectively), then
-passes on the request to the back-end application (in this case Spothole). nginx is a common choice for this general web
-server.
-
-To set up nginx as a reverse proxy that sits in front of Spothole, first ensure it's installed e.g.
-`sudo apt install nginx`, and enabled e.g. `sudo systemd enable nginx`.
-
-Create a file at `/etc/nginx/sites-available/` called `spothole`. Give it the following contents, replacing
-`spothole.app` with the domain name on which you want to run Spothole. If you changed the port on which Spothole runs,
-update that on the "proxy_pass" line, 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/v1/(spots|alerts)/stream/? {
-        proxy_pass http://127.0.0.1:8080;
-        
-        # Remove buffering, remove caching, add suitable timeouts for SSE API calls
-        proxy_buffering off;
-        proxy_cache off;
-        proxy_read_timeout 24h;
-        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; 
-    }
-
-    # Other API endpoints
-    location /api/ {
-        proxy_pass http://127.0.0.1:8080;
-        
-        # Remove buffering, remove caching, add suitable timeouts for API calls
-        proxy_buffering off;
-        proxy_cache off;
-        proxy_read_timeout 30s;
-        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;
-    }
-
-    # Templated pages
-    location / {
-        proxy_pass http://127.0.0.1:8080;
-        proxy_read_timeout 30s;
-        add_header Cache-Control "no-cache, must-revalidate" always;
-    }
-}
-```
-
-One further change you might want to make to the file above is the `add_header Access-Control-Allow-Origin` statements.
-These are what's used on
-my own Spothole server to make sure that other third-party web-based software can get the data from my instance, and
-applies to any endpoint underneath `/api`. If you want
-*your* Spothole instance to be set up the same way, so that others can write software in JavaScript that can access it,
-leave this intact. But if you want your Spothole instance to only be usable by scripts running on the web server you
-write,
-you can remove these lines. (Note that this doesn't stop other people writing *non-web-based* software that accesses
-your
-Spothole API—the enforcement of cross-origin headers only happens within the user's browser. If you need to lock
-your
-instance down so that no-one else can access it with *any* software, that's an aspect of nginx or firewall config that
-you will need
-to find help with elsewhere.)
-
-Now, make a symbolic link to enable the site:
-
-```bash
-cd /etc/nginx/sites-enabled
-sudo ln -sf ../sites-available/spothole
-```
-
-Test that your nginx config isn't broken using `nginx -t`. If it works, restart nginx with
-`sudo systemctl restart nginx`.
-
-If you haven't already done so, set up a DNS entry to make sure requests for your domain name end up at the server
-that's running Spothole.
-
-You should now be able to access the web interface by going to the domain from your browser.
-
-Once that's working, [install certbot](https://certbot.eff.org/instructions?ws=nginx&os=snap) onto your server. Run it
-as root, and when prompted pick your domain name from the list. After a few seconds, it should successfully provision a
-certificate and modify your nginx config files automatically. You should then be able to access the site via HTTPS.

docs/running.md

@@ -1,53 +0,0 @@
-## Running your own copy
-
-If you want to run a copy of Spothole with different configuration settings than the main instance, you can download it
-and run it on your own local machine or server.
-
-You will require Python version 3.8 or later. If you encounter an error about `gdal-config` during the following
-process, you will also need `libgdal-dev` installed.
-
-To download and set up Spothole on a Debian server, run the following commands. Other operating systems will likely be
-similar.
-
-```bash
-git clone ssh://git@git.ianrenton.com/ian/spothole.git
-cd spothole
-python3 -m venv ./.venv
-source .venv/bin/activate
-pip install -r requirements.txt
-deactivate
-cp config-example.yml config.yml
-```
-
-Then edit `config.yml` in your text editor of choice to set up the software as you like it. Mostly, this will involve
-enabling or disabling the various providers of spot and alert data.
-
-By default, all outdoor programme providers are enabled, as is one cluster node and the NG3K DXpedition data. The RBN
-spot providers are turned off by default due to the volume of traffic from CW/RTTY/FT8 skimmers, and the APRS and Packet
-spot providers are off by default on the assumption that Spothole users want a spot with a human at the other end of it,
-but all can be easily re-enabled.
-
-Other parameters you will want to update include the base URL to your instance, and whether you want to serve a full
-web-based DX cluster interface or just the API endpoints for client software to use.
-
-`config.yml` has an entry for a Clublog API key. If provided, this will allow Spothole to retrieve some more information
-about DX spots. The software will work just fine without it, but you may find a few country flags etc. are less accurate
-or missing. Clublog API keys are free, but you'll need to get your own by submitting a helpdesk ticket and explaining
-what you'll use it for. The admin team are happy with the rate of requests made by my Spothole server, so unless you
-change the source code of yours to radically increase the rate of querying Clublog, I'm sure they will be fine with your
-server too.
-
-Once you're happy with the content of `config.yml`, you can proceed to running the software.
-
-To run the software this time and any future times you want to run it directly from the command line:
-
-```bash
-source .venv/bin/activate
-python3 spothole.py
-```
-
-The software can take a few seconds to start up, mostly because it is downloading an updated file to match callsigns to
-countries. This is normal, don't panic!
-
-If you see some errors on startup, check your configuration, e.g. in case you have specified a port for the web server
-that is already in use by something else.

docs/systemd.md

@@ -1,34 +0,0 @@
-## systemd configuration
-
-If you want Spothole to run automatically on startup on a Linux distribution that uses `systemd`, follow the
-instructions here. For distros that don't use `systemd`, or Windows/OSX/etc., you can find generic instructions for your
-OS online.
-
-Create a file at `/etc/systemd/system/spothole.service`. Give it the following content, adjusting for the user you want
-to run it as and the directory in which you have installed it:
-
-```
-[Unit]
-Description=Spothole
-After=syslog.target network.target
-
-[Service]
-Type=simple
-User=spothole
-WorkingDirectory=/home/spothole/spothole
-ExecStart=/home/spothole/spothole/.venv/bin/python /home/spothole/spothole/spothole.py --serve-in-foreground
-Restart=on-abort
-
-[Install]
-WantedBy=multi-user.target
-```
-
-Run the following:
-
-```bash
-sudo systemctl daemon-reload
-sudo systemctl enable spothole
-sudo systemctl start spothole
-```
-
-Check the service has started up correctly with `sudo journalctl -u spothole -f`.

requirements.txt

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

server/handlers/api/addspot.py

@@ -1,33 +1,42 @@
+import json
 import logging
 import re
+import threading
 from datetime import datetime
 from typing import Any
 
 import pytz
+import requests
 import tornado
 from tornado import httputil
 from tornado.web import Application
 
-from core.config import ALLOW_SPOTTING, MAX_SPOT_AGE
+from core.config import ALLOW_SPOTTING, ALLOW_UPSTREAM_SPOTTING, MAX_SPOT_AGE, RECAPTCHA_SECRET_KEY
 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 safe_json_dumps
+from core.utils import serialize_everything
+from data.sig_ref import SIGRef
 from data.spot import Spot
+from spotproviders.spot_provider import SpotProvider
+
+RECAPTCHA_VERIFY_URL = "https://www.google.com/recaptcha/api/siteverify"
 
 
 class APISpotHandler(tornado.web.RequestHandler):
-    """API request handler for /api/v1/spot (POST)"""
+    """API request handler for /api/v2/spot (POST)"""
 
     def __init__(self, application: "Application", request: httputil.HTTPServerRequest, **kwargs: Any):
         self._spots = None
         self._web_server_metrics = None
+        self._spot_providers = None
         super().__init__(application, request, **kwargs)
 
-    def initialize(self, spots, web_server_metrics):
+    def initialize(self, spots, web_server_metrics, spot_providers=None):
         self._spots = spots
         self._web_server_metrics = web_server_metrics
+        self._spot_providers = spot_providers or []
 
     def post(self):
         try:
@@ -40,7 +49,8 @@ class APISpotHandler(tornado.web.RequestHandler):
             # Reject if not allowed
             if not ALLOW_SPOTTING:
                 self.set_status(401)
-                self.write(safe_json_dumps("Error - this server does not allow new spots to be added via the API."))
+                self.write(json.dumps("Error - this server does not allow new spots to be added via the API.",
+                                      default=serialize_everything))
                 self.set_header("Cache-Control", "no-store")
                 self.set_header("Content-Type", "application/json")
                 return
@@ -48,7 +58,8 @@ 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(safe_json_dumps("Error - request Content-Type must be application/json"))
+                self.write(
+                    json.dumps("Error - request Content-Type must be application/json", default=serialize_everything))
                 self.set_header("Cache-Control", "no-store")
                 self.set_header("Content-Type", "application/json")
                 return
@@ -57,19 +68,58 @@ class APISpotHandler(tornado.web.RequestHandler):
             post_data = self.request.body
             if not post_data:
                 self.set_status(422)
-                self.write(safe_json_dumps("Error - request body is empty"))
+                self.write(json.dumps("Error - request body is empty", default=serialize_everything))
                 self.set_header("Cache-Control", "no-store")
                 self.set_header("Content-Type", "application/json")
                 return
 
-            # Read in the request body as JSON then convert to a Spot object
-            json_spot = tornado.escape.json_decode(post_data)
-            spot = Spot(**json_spot)
+            # Read in the request body as JSON
+            json_body = tornado.escape.json_decode(post_data)
+
+            # Extract the "spot" and "handling" sub-objects from the request body
+            spot_data = json_body.get("spot", {})
+            handling = json_body.get("handling", {})
+
+            # Extract individual parameters that say how this spot should be handled by the server
+            submit_upstream = handling.get("submit_upstream", False)
+            upstream_provider_name = handling.get("upstream_provider", None)
+            upstream_credentials = handling.get("upstream_credentials", {})
+            captcha_token = handling.get("captcha_token", None)
+
+            # Verify CAPTCHA if required
+            if RECAPTCHA_SECRET_KEY:
+                if not captcha_token:
+                    self.set_status(422)
+                    self.write(json.dumps("Error - CAPTCHA token is required for spot submission.",
+                                          default=serialize_everything))
+                    self.set_header("Cache-Control", "no-store")
+                    self.set_header("Content-Type", "application/json")
+                    return
+                if not self._verify_recaptcha(captcha_token):
+                    self.set_status(422)
+                    self.write(json.dumps("Error - CAPTCHA verification failed.",
+                                          default=serialize_everything))
+                    self.set_header("Cache-Control", "no-store")
+                    self.set_header("Content-Type", "application/json")
+                    return
+
+            # 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(safe_json_dumps("Error - 'time', 'dx_call', 'freq' and 'de_call' must be provided as a minimum."))
+                self.write(json.dumps("Error - 'time', 'dx_call', 'freq' and 'de_call' must be provided as a minimum.",
+                                      default=serialize_everything))
                 self.set_header("Cache-Control", "no-store")
                 self.set_header("Content-Type", "application/json")
                 return
@@ -77,13 +127,15 @@ 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(safe_json_dumps("Error - '" + spot.dx_call + "' does not look like a valid callsign."))
+                self.write(json.dumps("Error - '" + spot.dx_call + "' does not look like a valid callsign.",
+                                      default=serialize_everything))
                 self.set_header("Cache-Control", "no-store")
                 self.set_header("Content-Type", "application/json")
                 return
             if not re.match(r"^[A-Za-z0-9/\-]*$", spot.de_call):
                 self.set_status(422)
-                self.write(safe_json_dumps("Error - '" + spot.de_call + "' does not look like a valid callsign."))
+                self.write(json.dumps("Error - '" + spot.de_call + "' does not look like a valid callsign.",
+                                      default=serialize_everything))
                 self.set_header("Cache-Control", "no-store")
                 self.set_header("Content-Type", "application/json")
                 return
@@ -91,7 +143,8 @@ 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(safe_json_dumps("Error - Frequency of " + str(spot.freq / 1000.0) + "kHz is not in a known band."))
+                self.write(json.dumps("Error - Frequency of " + str(spot.freq / 1000.0) + "kHz is not in a known band.",
+                                      default=serialize_everything))
                 self.set_header("Cache-Control", "no-store")
                 self.set_header("Content-Type", "application/json")
                 return
@@ -101,7 +154,8 @@ 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(safe_json_dumps("Error - '" + spot.dx_grid + "' does not look like a valid Maidenhead grid."))
+                self.write(json.dumps("Error - '" + spot.dx_grid + "' does not look like a valid Maidenhead grid.",
+                                      default=serialize_everything))
                 self.set_header("Cache-Control", "no-store")
                 self.set_header("Content-Type", "application/json")
                 return
@@ -110,25 +164,112 @@ 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(safe_json_dumps(
-                    "Error - '" + spot.sig_refs[0].id + "' does not look like a valid reference for " + spot.sig + "."))
+                self.write(json.dumps(
+                    "Error - '" + spot.sig_refs[0].id + "' does not look like a valid reference for " + spot.sig + ".",
+                    default=serialize_everything))
                 self.set_header("Cache-Control", "no-store")
                 self.set_header("Content-Type", "application/json")
                 return
 
-            # infer missing data, and add it to our database.
-            spot.source = "API"
-            spot.infer_missing()
-            self._spots.add(spot.id, spot, expire=MAX_SPOT_AGE)
+            # Reject upstream submission if not permitted
+            if submit_upstream and not ALLOW_UPSTREAM_SPOTTING:
+                self.set_status(403)
+                self.write(json.dumps("Error - this server does not allow upstream spot submission.",
+                                      default=serialize_everything))
+                self.set_header("Cache-Control", "no-store")
+                self.set_header("Content-Type", "application/json")
+                return
 
-            self.write(safe_json_dumps("OK"))
-            self.set_status(201)
+            # Validate upstream submission requirements
+            if submit_upstream and upstream_provider_name:
+                if not spot.sig:
+                    self.set_status(422)
+                    self.write(json.dumps("Error - a SIG must be selected to submit upstream.",
+                                          default=serialize_everything))
+                    self.set_header("Cache-Control", "no-store")
+                    self.set_header("Content-Type", "application/json")
+                    return
+                if not spot.sig_refs and upstream_provider_name != "Tiles":
+                    self.set_status(422)
+                    self.write(json.dumps("Error - a SIG reference is required to submit upstream.",
+                                          default=serialize_everything))
+                    self.set_header("Cache-Control", "no-store")
+                    self.set_header("Content-Type", "application/json")
+                    return
+                if not spot.dx_grid and upstream_provider_name == "Tiles":
+                    self.set_status(422)
+                    self.write(json.dumps("Error - a grid reference is required to submit upstream to Tiles on the Air.",
+                                          default=serialize_everything))
+                    self.set_header("Cache-Control", "no-store")
+                    self.set_header("Content-Type", "application/json")
+                    return
+                if not spot.mode and upstream_provider_name == "Tiles":
+                    self.set_status(422)
+                    self.write(json.dumps("Error - a mode is required to submit upstream to Tiles on the Air.",
+                                          default=serialize_everything))
+                    self.set_header("Cache-Control", "no-store")
+                    self.set_header("Content-Type", "application/json")
+                    return
+
+            # Submit upstream if requested
+            upstream_warning = None
+            if submit_upstream and upstream_provider_name:
+                provider = self._find_provider(upstream_provider_name, spot.sig)
+                if provider:
+                    try:
+                        # Submit spot to the upstream provider
+                        provider.submit_spot(spot, upstream_credentials)
+                        # Trigger a re-poll after 1 second so the spot appears quickly
+                        threading.Timer(1.0, provider.force_poll).start()
+                    except NotImplementedError as e:
+                        upstream_warning = str(e)
+                    except Exception as e:
+                        logging.warning("Failed to submit spot upstream to " + upstream_provider_name + ": " + str(e))
+                        upstream_warning = "Spot was saved locally but upstream submission to " + upstream_provider_name + " failed: " + str(
+                            e)
+                else:
+                    upstream_warning = "No enabled provider named '" + upstream_provider_name + "' supports upstream submission for " + spot.sig + " spots."
+
+            # If we successfully submitted the spot upstream, don't add it direct to Spothole, otherwise it will be a
+            # duplicate with what immediately comes back from the API. But if we weren't asked to send it upstream, or
+            # we were but it failed, we should still add it to our database anyway.
+            if not submit_upstream or upstream_warning:
+                spot.infer_missing()
+                self._spots.add(spot.id, spot, expire=MAX_SPOT_AGE)
+
+            if upstream_warning:
+                self.write(json.dumps("Warning - " + upstream_warning, default=serialize_everything))
+                self.set_status(201)
+            else:
+                self.write(json.dumps("OK", default=serialize_everything))
+                self.set_status(201)
             self.set_header("Cache-Control", "no-store")
             self.set_header("Content-Type", "application/json")
 
         except Exception as e:
-            logging.error("Exception when handling client request to add spot API: %s", e, exc_info=True)
-            self.write(safe_json_dumps("Error - an internal server error occurred."))
+            logging.error(e)
+            self.write(json.dumps("Error - an internal server error occurred.", default=serialize_everything))
             self.set_status(500)
             self.set_header("Cache-Control", "no-store")
             self.set_header("Content-Type", "application/json")
+
+    def _find_provider(self, provider_name, sig) -> SpotProvider | None:
+        """Find an enabled provider by name that can submit spots for the given SIG."""
+
+        for p in self._spot_providers:
+            if p.enabled and p.name == provider_name and p.can_submit_spot(sig):
+                return p
+        return None
+
+    @staticmethod
+    def _verify_recaptcha(token):
+        """Verify a Google reCAPTCHA v2 token. Returns True if valid."""
+
+        try:
+            response = requests.post(RECAPTCHA_VERIFY_URL,
+                                     data={"secret": RECAPTCHA_SECRET_KEY, "response": token},
+                                     timeout=(5, 10))
+            return response.ok and response.json().get("success", False)
+        except Exception as e:
+            logging.warning("reCAPTCHA verification request failed: " + str(e))
+            return False

server/handlers/api/alerts.py

@@ -1,4 +1,5 @@
 import copy
+import json
 import logging
 from datetime import datetime
 from queue import Queue
@@ -11,7 +12,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, empty_queue
+from core.utils import serialize_everything, empty_queue
 from data.lookup_credentials import extract_credentials
 
 SSE_HANDLER_MAX_QUEUE_SIZE = 100
@@ -19,7 +20,7 @@ SSE_HANDLER_QUEUE_CHECK_INTERVAL = 5000
 
 
 class APIAlertsHandler(tornado.web.RequestHandler):
-    """API request handler for /api/v1/alerts"""
+    """API request handler for /api/v2/alerts"""
 
     def __init__(self, application: "Application", request: httputil.HTTPServerRequest, **kwargs: Any):
         self._alerts = None
@@ -52,25 +53,26 @@ class APIAlertsHandler(tornado.web.RequestHandler):
             query_params = {k: v[0].decode("utf-8") for k, v in self.request.arguments.items()}
 
             # Fetch all alerts matching the query, then optionally enrich with online data
-            credentials = extract_credentials(query_params)
+            credentials = extract_credentials(self.request.headers)
             data = get_alert_list_with_filters(self._alerts, query_params)
             if credentials:
                 data = self._enrich(data, credentials)
-            self.write(safe_json_dumps(data))
+            self.write(json.dumps(data, default=serialize_everything))
             self.set_status(200)
         except ValueError as e:
-            self.write(safe_json_dumps("Bad request - " + str(e)))
+            logging.error(e)
+            self.write(json.dumps("Bad request - " + str(e), default=serialize_everything))
             self.set_status(400)
         except Exception as e:
-            logging.error("Exception when handling client request to alerts API: %s", e, exc_info=True)
-            self.write(safe_json_dumps("Error - an internal server error occurred."))
+            logging.error(e)
+            self.write(json.dumps("Error - an internal server error occurred.", default=serialize_everything))
             self.set_status(500)
         self.set_header("Cache-Control", "no-store")
         self.set_header("Content-Type", "application/json")
 
 
 class APIAlertsStreamHandler(tornado_eventsource.handler.EventSourceHandler):
-    """API request handler for /api/v1/alerts/stream"""
+    """API request handler for /api/v2/alerts/stream"""
 
     def __init__(self, application, request, **kwargs: Any):
         self._sse_alert_queues = None
@@ -102,7 +104,7 @@ class APIAlertsStreamHandler(tornado_eventsource.handler.EventSourceHandler):
             # request.arguments contains lists for each param key because technically the client can supply multiple,
             # reduce that to just the first entry, and convert bytes to string
             self._query_params = {k: v[0].decode("utf-8") for k, v in self.request.arguments.items()}
-            self._credentials = extract_credentials(self._query_params)
+            self._credentials = extract_credentials(self.request.headers)
 
             # Create a alert queue and add it to the web server's list. The web server will fill this when alerts arrive
             self._alert_queue = Queue(maxsize=SSE_HANDLER_MAX_QUEUE_SIZE)
@@ -148,7 +150,7 @@ class APIAlertsStreamHandler(tornado_eventsource.handler.EventSourceHandler):
                             if self._credentials:
                                 alert = copy.deepcopy(alert)
                                 alert.infer_missing(self._credentials)
-                            self.write_message(msg=safe_json_dumps(alert))
+                            self.write_message(msg=json.dumps(alert, default=serialize_everything))
 
                 else:
                     # Send a keepalive comment if the queue was empty

server/handlers/api/dxstats.py

@@ -1,5 +1,4 @@
 import json
-import logging
 from collections import Counter
 from datetime import datetime, timedelta
 from typing import Any
@@ -10,7 +9,6 @@ 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"]
@@ -19,7 +17,7 @@ BANDS_SET = frozenset(BANDS)
 
 
 class APIDxStatsHandler(tornado.web.RequestHandler):
-    """API request handler for /api/v1/dxstats"""
+    """API request handler for /api/v2/dxstats"""
 
     def __init__(self, application: "Application", request: httputil.HTTPServerRequest, **kwargs: Any):
         self._spots = None
@@ -31,35 +29,29 @@ class APIDxStatsHandler(tornado.web.RequestHandler):
         self._web_server_metrics = web_server_metrics
 
     def get(self):
-        try:
-            self._web_server_metrics["last_api_access_time"] = datetime.now(pytz.UTC)
-            self._web_server_metrics["api_access_counter"] += 1
-            self._web_server_metrics["status"] = "OK"
-            api_requests_counter.inc()
+        self._web_server_metrics["last_api_access_time"] = datetime.now(pytz.UTC)
+        self._web_server_metrics["api_access_counter"] += 1
+        self._web_server_metrics["status"] = "OK"
+        api_requests_counter.inc()
 
-            one_hour_ago = (datetime.now(pytz.UTC) - timedelta(hours=1)).timestamp()
-            counts = Counter()
+        one_hour_ago = (datetime.now(pytz.UTC) - timedelta(hours=1)).timestamp()
+        counts = Counter()
 
-            for key in self._spots.iterkeys():
-                spot = self._spots.get(key)
-                if spot is None:
-                    continue
-                if not spot.time or spot.time < one_hour_ago:
-                    continue
-                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
+        for key in self._spots.iterkeys():
+            spot = self._spots.get(key)
+            if spot is None:
+                continue
+            if not spot.time or spot.time < one_hour_ago:
+                continue
+            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
 
-            result = {
-                de: {dx: {band: counts[de, dx, band] for band in BANDS} for dx in CONTINENTS}
-                for de in CONTINENTS
-            }
+        result = {
+            de: {dx: {band: counts[de, dx, band] for band in BANDS} for dx in CONTINENTS}
+            for de in CONTINENTS
+        }
 
-            self.write(json.dumps(result))
-            self.set_status(200)
-            self.set_header("Cache-Control", "no-store")
-            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)
+        self.write(json.dumps(result))
+        self.set_status(200)
+        self.set_header("Cache-Control", "no-store")
+        self.set_header("Content-Type", "application/json")

server/handlers/api/lookups.py

@@ -1,3 +1,4 @@
+import json
 import logging
 import re
 from datetime import datetime
@@ -12,14 +13,14 @@ 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 safe_json_dumps
+from core.utils import serialize_everything
 from data.lookup_credentials import extract_credentials
 from data.sig_ref import SIGRef
 from data.spot import Spot
 
 
 class APILookupCallHandler(tornado.web.RequestHandler):
-    """API request handler for /api/v1/lookup/call"""
+    """API request handler for /api/v2/lookup/call"""
 
     def __init__(self, application: "Application", request: httputil.HTTPServerRequest, **kwargs: Any):
         self._web_server_metrics = None
@@ -46,7 +47,7 @@ class APILookupCallHandler(tornado.web.RequestHandler):
                 if re.match(r"^[A-Z0-9/\-]*$", call):
                     # Take the callsign, make a "fake spot" so we can run infer_missing() on it, then repack the
                     # resulting data in the correct way for the API response.
-                    credentials = extract_credentials(query_params)
+                    credentials = extract_credentials(self.request.headers)
                     fake_spot = Spot(dx_call=call)
                     fake_spot.infer_missing(credentials)
                     data = {
@@ -64,18 +65,19 @@ class APILookupCallHandler(tornado.web.RequestHandler):
                         "longitude": fake_spot.dx_longitude,
                         "location_source": fake_spot.dx_location_source
                     }
-                    self.write(safe_json_dumps(data))
+                    self.write(json.dumps(data, default=serialize_everything))
 
                 else:
-                    self.write(safe_json_dumps("Error - '" + call + "' does not look like a valid callsign."))
+                    self.write(json.dumps("Error - '" + call + "' does not look like a valid callsign.",
+                                          default=serialize_everything))
                     self.set_status(422)
             else:
-                self.write(safe_json_dumps("Error - call must be provided"))
+                self.write(json.dumps("Error - call must be provided", default=serialize_everything))
                 self.set_status(422)
 
         except Exception as e:
-            logging.error("Exception when handling client request to call lookup API: %s", e, exc_info=True)
-            self.write(safe_json_dumps("Error - an internal server error occurred."))
+            logging.error(e)
+            self.write(json.dumps("Error - an internal server error occurred.", default=serialize_everything))
             self.set_status(500)
 
         self.set_header("Cache-Control", "no-store")
@@ -83,7 +85,7 @@ class APILookupCallHandler(tornado.web.RequestHandler):
 
 
 class APILookupSIGRefHandler(tornado.web.RequestHandler):
-    """API request handler for /api/v1/lookup/sigref"""
+    """API request handler for /api/v2/lookup/sigref"""
 
     def __init__(self, application: "Application", request: httputil.HTTPServerRequest, **kwargs: Any):
         self._web_server_metrics = None
@@ -112,22 +114,24 @@ class APILookupSIGRefHandler(tornado.web.RequestHandler):
                 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(safe_json_dumps(data))
+                        self.write(json.dumps(data, default=serialize_everything))
 
                     else:
-                        self.write(safe_json_dumps(
-                                "Error - '" + ref_id + "' does not look like a valid reference ID for " + sig + "."))
+                        self.write(
+                            json.dumps(
+                                "Error - '" + ref_id + "' does not look like a valid reference ID for " + sig + ".",
+                                default=serialize_everything))
                         self.set_status(422)
                 else:
-                    self.write(safe_json_dumps("Error - sig '" + sig + "' is not known."))
+                    self.write(json.dumps("Error - sig '" + sig + "' is not known.", default=serialize_everything))
                     self.set_status(422)
             else:
-                self.write(safe_json_dumps("Error - sig and id must be provided"))
+                self.write(json.dumps("Error - sig and id must be provided", default=serialize_everything))
                 self.set_status(422)
 
         except Exception as e:
-            logging.error("Exception when handling client request to sig ref lookup API: %s", e, exc_info=True)
-            self.write(safe_json_dumps("Error - an internal server error occurred."))
+            logging.error(e)
+            self.write(json.dumps("Error - an internal server error occurred.", default=serialize_everything))
             self.set_status(500)
 
         self.set_header("Cache-Control", "no-store")
@@ -135,7 +139,7 @@ class APILookupSIGRefHandler(tornado.web.RequestHandler):
 
 
 class APILookupGridHandler(tornado.web.RequestHandler):
-    """API request handler for /api/v1/lookup/grid"""
+    """API request handler for /api/v2/lookup/grid"""
 
     def __init__(self, application: "Application", request: httputil.HTTPServerRequest, **kwargs: Any):
         self._web_server_metrics = None
@@ -181,15 +185,15 @@ class APILookupGridHandler(tornado.web.RequestHandler):
                             "latitude": lat + lat_cell_size,
                             "longitude": lon + lon_cell_size,
                         }}
-                    self.write(safe_json_dumps(response))
+                    self.write(json.dumps(response, default=serialize_everything))
 
             else:
-                self.write(safe_json_dumps("Error - grid must be provided"))
+                self.write(json.dumps("Error - grid must be provided", default=serialize_everything))
                 self.set_status(422)
 
         except Exception as e:
-            logging.error("Exception when handling client request to grid ref lookup API: %s", e, exc_info=True)
-            self.write(safe_json_dumps("Error - an internal server error occurred."))
+            logging.error(e)
+            self.write(json.dumps("Error - an internal server error occurred.", default=serialize_everything))
             self.set_status(500)
 
         self.set_header("Cache-Control", "no-store")

server/handlers/api/options.py

@@ -1,4 +1,4 @@
-import logging
+import json
 from datetime import datetime
 from typing import Any
 
@@ -10,53 +10,63 @@ 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 safe_json_dumps
+from core.utils import serialize_everything
 
 
 class APIOptionsHandler(tornado.web.RequestHandler):
-    """API request handler for /api/v1/options"""
+    """API request handler for /api/v2/options"""
 
     def __init__(self, application: "Application", request: httputil.HTTPServerRequest, **kwargs: Any):
         self._status_data = None
         self._web_server_metrics = None
+        self._spot_providers = None
         super().__init__(application, request, **kwargs)
 
-    def initialize(self, status_data, web_server_metrics):
+    def initialize(self, status_data, web_server_metrics, spot_providers=None):
         self._status_data = status_data
         self._web_server_metrics = web_server_metrics
+        self._spot_providers = spot_providers or []
 
     def get(self):
-        try:
-            # Metrics
-            self._web_server_metrics["last_api_access_time"] = datetime.now(pytz.UTC)
-            self._web_server_metrics["api_access_counter"] += 1
-            self._web_server_metrics["status"] = "OK"
-            api_requests_counter.inc()
+        # Metrics
+        self._web_server_metrics["last_api_access_time"] = datetime.now(pytz.UTC)
+        self._web_server_metrics["api_access_counter"] += 1
+        self._web_server_metrics["status"] = "OK"
+        api_requests_counter.inc()
 
-            options = {"bands": BANDS,
-                       "modes": ALL_MODES,
-                       "mode_types": MODE_TYPES,
-                       "sigs": SIGS,
-                       # Spot/alert sources are filtered for only ones that are enabled in config, no point letting the user toggle things that aren't even available.
-                       "spot_sources": list(
-                           map(lambda p: p["name"], filter(lambda p: p["enabled"], self._status_data["spot_providers"]))),
-                       "alert_sources": list(
-                           map(lambda p: p["name"], filter(lambda p: p["enabled"], self._status_data["alert_providers"]))),
-                       "continents": CONTINENTS,
-                       "propagation_modes": list(PROPAGATION_MODES.values()),
-                       "max_spot_age": MAX_SPOT_AGE,
-                       "spot_allowed": ALLOW_SPOTTING}
-            # If spotting to this server is enabled, "API" is another valid spot source even though it does not come from
-            # one of our proviers.
-            if ALLOW_SPOTTING:
-                options["spot_sources"].append("API")
+        # 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):
+                    spot_submit_providers.setdefault(sig.name, []).append(provider.name)
 
-            self.write(safe_json_dumps(options))
-            self.set_status(200)
-            self.set_header("Cache-Control", "no-store")
-            self.set_header("Content-Type", "application/json")
+        # Spot/alert sources are filtered for only ones that are enabled in config, no point letting the user toggle
+        # things that aren't even available.
+        spot_sources: list = list(
+            map(lambda p: p["name"], filter(lambda p: p["enabled"], self._status_data["spot_providers"])))
+        alert_sources = list(
+            map(lambda p: p["name"], filter(lambda p: p["enabled"], self._status_data["alert_providers"])))
+        # 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:
+            spot_sources.append("API")
 
-        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)
+        options = {"bands": BANDS,
+                   "modes": ALL_MODES,
+                   "mode_types": MODE_TYPES,
+                   "sigs": SIGS,
+                   "spot_sources": spot_sources,
+                   "alert_sources": alert_sources,
+                   "continents": CONTINENTS,
+                   "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.set_status(200)
+        self.set_header("Cache-Control", "no-store")
+        self.set_header("Content-Type", "application/json")

server/handlers/api/solar_conditions.py

@@ -1,4 +1,3 @@
-import logging
 from datetime import datetime
 from typing import Any
 
@@ -8,11 +7,10 @@ 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):
-    """API request handler for /api/v1/solar"""
+    """API request handler for /api/v2/solar"""
 
     def __init__(self, application: "Application", request: httputil.HTTPServerRequest, **kwargs: Any):
         self._solar_conditions = None
@@ -24,19 +22,13 @@ class APISolarConditionsHandler(tornado.web.RequestHandler):
         self._web_server_metrics = web_server_metrics
 
     def get(self):
-        try:
-            # Metrics
-            self._web_server_metrics["last_api_access_time"] = datetime.now(pytz.UTC)
-            self._web_server_metrics["api_access_counter"] += 1
-            self._web_server_metrics["status"] = "OK"
-            api_requests_counter.inc()
+        # Metrics
+        self._web_server_metrics["last_api_access_time"] = datetime.now(pytz.UTC)
+        self._web_server_metrics["api_access_counter"] += 1
+        self._web_server_metrics["status"] = "OK"
+        api_requests_counter.inc()
 
-            self.write(self._solar_conditions.to_json())
-            self.set_status(200)
-            self.set_header("Cache-Control", "no-store")
-            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)
+        self.write(self._solar_conditions.to_json())
+        self.set_status(200)
+        self.set_header("Cache-Control", "no-store")
+        self.set_header("Content-Type", "application/json")

server/handlers/api/spots.py

@@ -1,4 +1,5 @@
 import copy
+import json
 import logging
 from datetime import datetime, timedelta
 from queue import Queue
@@ -11,7 +12,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, empty_queue
+from core.utils import serialize_everything, empty_queue
 from data.lookup_credentials import extract_credentials
 
 SSE_HANDLER_MAX_QUEUE_SIZE = 1000
@@ -19,7 +20,7 @@ SSE_HANDLER_QUEUE_CHECK_INTERVAL = 5000
 
 
 class APISpotsHandler(tornado.web.RequestHandler):
-    """API request handler for /api/v1/spots"""
+    """API request handler for /api/v2/spots"""
 
     def __init__(self, application: "Application", request: httputil.HTTPServerRequest, **kwargs: Any):
         self._spots = None
@@ -52,25 +53,26 @@ class APISpotsHandler(tornado.web.RequestHandler):
             query_params = {k: v[0].decode("utf-8") for k, v in self.request.arguments.items()}
 
             # Fetch all spots matching the query, then optionally enrich with online data
-            credentials = extract_credentials(query_params)
+            credentials = extract_credentials(self.request.headers)
             data = get_spot_list_with_filters(self._spots, query_params)
             if credentials:
                 data = self._enrich(data, credentials)
-            self.write(safe_json_dumps(data))
+            self.write(json.dumps(data, default=serialize_everything))
             self.set_status(200)
         except ValueError as e:
-            self.write(safe_json_dumps("Bad request - " + str(e)))
+            logging.error(e)
+            self.write(json.dumps("Bad request - " + str(e), default=serialize_everything))
             self.set_status(400)
         except Exception as e:
-            logging.error("Excedption when handling client request to spots API: %s", e, exc_info=True)
-            self.write(safe_json_dumps("Error - an internal server error occurred."))
+            logging.error(e)
+            self.write(json.dumps("Error - an internal server error occurred.", default=serialize_everything))
             self.set_status(500)
         self.set_header("Cache-Control", "no-store")
         self.set_header("Content-Type", "application/json")
 
 
 class APISpotsStreamHandler(tornado_eventsource.handler.EventSourceHandler):
-    """API request handler for /api/v1/spots/stream"""
+    """API request handler for /api/v2/spots/stream"""
 
     def __init__(self, application, request, **kwargs: Any):
         self._sse_spot_queues = None
@@ -104,7 +106,7 @@ class APISpotsStreamHandler(tornado_eventsource.handler.EventSourceHandler):
             # request.arguments contains lists for each param key because technically the client can supply multiple,
             # reduce that to just the first entry, and convert bytes to string
             self._query_params = {k: v[0].decode("utf-8") for k, v in self.request.arguments.items()}
-            self._credentials = extract_credentials(self._query_params)
+            self._credentials = extract_credentials(self.request.headers)
 
             # Create a spot queue and add it to the web server's list. The web server will fill this when spots arrive
             self._spot_queue = Queue(maxsize=SSE_HANDLER_MAX_QUEUE_SIZE)
@@ -150,7 +152,7 @@ class APISpotsStreamHandler(tornado_eventsource.handler.EventSourceHandler):
                             if self._credentials:
                                 spot = copy.deepcopy(spot)
                                 spot.infer_missing(self._credentials)
-                            self.write_message(msg=safe_json_dumps(spot))
+                            self.write_message(msg=json.dumps(spot, default=serialize_everything))
 
                 else:
                     # Send a keepalive comment if the queue was empty

server/handlers/api/status.py

@@ -1,4 +1,4 @@
-import logging
+import json
 from datetime import datetime
 from typing import Any
 
@@ -8,11 +8,11 @@ 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
+from core.utils import serialize_everything
 
 
 class APIStatusHandler(tornado.web.RequestHandler):
-    """API request handler for /api/v1/status"""
+    """API request handler for /api/v2/status"""
 
     def __init__(self, application: "Application", request: httputil.HTTPServerRequest, **kwargs: Any):
         self._status_data = None
@@ -24,19 +24,13 @@ class APIStatusHandler(tornado.web.RequestHandler):
         self._web_server_metrics = web_server_metrics
 
     def get(self):
-        try:
-            # Metrics
-            self._web_server_metrics["last_api_access_time"] = datetime.now(pytz.UTC)
-            self._web_server_metrics["api_access_counter"] += 1
-            self._web_server_metrics["status"] = "OK"
-            api_requests_counter.inc()
+        # Metrics
+        self._web_server_metrics["last_api_access_time"] = datetime.now(pytz.UTC)
+        self._web_server_metrics["api_access_counter"] += 1
+        self._web_server_metrics["status"] = "OK"
+        api_requests_counter.inc()
 
-            self.write(safe_json_dumps(self._status_data))
-            self.set_status(200)
-            self.set_header("Cache-Control", "no-store")
-            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)
+        self.write(json.dumps(self._status_data, default=serialize_everything))
+        self.set_status(200)
+        self.set_header("Cache-Control", "no-store")
+        self.set_header("Content-Type", "application/json")

server/handlers/api/v1_compatability.py

@@ -0,0 +1,31 @@
+import json
+
+import tornado
+
+from core.utils import serialize_everything
+
+
+class V1GoneHandler(tornado.web.RequestHandler):
+    """Returns 410 Gone with a message for any endpoints in the old API that have breaking changes in the new one or
+    have been retired."""
+
+    def post(self):
+        self.set_status(410)
+        self.write(json.dumps(
+            "This API endpoint has a breaking change or has been removed in the current version of the Spothole API. Please see /apidocs for details of the current API version and the endpoints available.",
+            default=serialize_everything
+        ))
+        self.set_header("Cache-Control", "no-store")
+        self.set_header("Content-Type", "application/json")
+
+
+class V1RedirectHandler(tornado.web.RequestHandler):
+    """Returns 308 Permanent Redirect from any path in the old API to the new one, where there were no breaking changes."""
+
+    def get(self, path):
+        new_url = "/api/v2/" + path
+        if self.request.query:
+            new_url += "?" + self.request.query
+        self.set_status(308)
+        self.set_header("Location", new_url)
+        self.finish()

server/handlers/manifesthandler.py

@@ -1,11 +0,0 @@
-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,9 +5,10 @@ import os
 import tornado
 from tornado.web import StaticFileHandler
 
-from core.config import ALLOW_SPOTTING, WEB_SERVER_PORT, API_ONLY_MODE, LOG_WEB_REQUESTS, BASE_URL
+from core.config import ALLOW_SPOTTING, WEB_SERVER_PORT, API_ONLY_MODE
 from core.utils import empty_queue
 from server.handlers.api.addspot import APISpotHandler
+from server.handlers.api.v1_compatability import V1RedirectHandler, V1GoneHandler
 from server.handlers.api.alerts import APIAlertsHandler, APIAlertsStreamHandler
 from server.handlers.api.dxstats import APIDxStatsHandler
 from server.handlers.api.lookups import APILookupCallHandler, APILookupSIGRefHandler, APILookupGridHandler
@@ -15,7 +16,6 @@ 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
 
@@ -25,7 +25,7 @@ _HERE = os.path.dirname(__file__ or "")
 class WebServer:
     """Provides the public-facing web server."""
 
-    def __init__(self, spots, alerts, solar_conditions, status_data):
+    def __init__(self, spots, alerts, solar_conditions, status_data, spot_providers=None):
         """Constructor"""
 
         self._spots = spots
@@ -34,6 +34,7 @@ class WebServer:
         self._sse_spot_queues = []
         self._sse_alert_queues = []
         self._status_data = status_data
+        self._spot_providers = spot_providers or []
         self._port = WEB_SERVER_PORT
         self._api_only_mode = API_ONLY_MODE
         self._shutdown_event = asyncio.Event()
@@ -64,20 +65,29 @@ class WebServer:
 
         # API endpoints are always enabled
         api_routes = [
-            (r"/api/v1/spots", APISpotsHandler, {"spots": self._spots, **handler_opts}),
-            (r"/api/v1/alerts", APIAlertsHandler, {"alerts": self._alerts, **handler_opts}),
-            (r"/api/v1/spots/stream", APISpotsStreamHandler,
+            (r"/api/v2/spots", APISpotsHandler, {"spots": self._spots, **handler_opts}),
+            (r"/api/v2/alerts", APIAlertsHandler, {"alerts": self._alerts, **handler_opts}),
+            (r"/api/v2/spots/stream", APISpotsStreamHandler,
              {"sse_spot_queues": self._sse_spot_queues, **handler_opts}),
-            (r"/api/v1/alerts/stream", APIAlertsStreamHandler,
+            (r"/api/v2/alerts/stream", APIAlertsStreamHandler,
              {"sse_alert_queues": self._sse_alert_queues, **handler_opts}),
-            (r"/api/v1/solar", APISolarConditionsHandler, {"solar_conditions": self._solar_conditions, **handler_opts}),
-            (r"/api/v1/dxstats", APIDxStatsHandler, {"spots": self._spots, **handler_opts}),
-            (r"/api/v1/options", APIOptionsHandler, {"status_data": self._status_data, **handler_opts}),
-            (r"/api/v1/status", APIStatusHandler, {"status_data": self._status_data, **handler_opts}),
-            (r"/api/v1/lookup/call", APILookupCallHandler, {**handler_opts}),
-            (r"/api/v1/lookup/sigref", APILookupSIGRefHandler, {**handler_opts}),
-            (r"/api/v1/lookup/grid", APILookupGridHandler, {**handler_opts}),
-            (r"/api/v1/spot", APISpotHandler, {"spots": self._spots, **handler_opts}),
+            (r"/api/v2/solar", APISolarConditionsHandler, {"solar_conditions": self._solar_conditions, **handler_opts}),
+            (r"/api/v2/dxstats", APIDxStatsHandler, {"spots": self._spots, **handler_opts}),
+            (r"/api/v2/options", APIOptionsHandler,
+             {"status_data": self._status_data, "spot_providers": self._spot_providers, **handler_opts}),
+            (r"/api/v2/status", APIStatusHandler, {"status_data": self._status_data, **handler_opts}),
+            (r"/api/v2/lookup/call", APILookupCallHandler, {**handler_opts}),
+            (r"/api/v2/lookup/sigref", APILookupSIGRefHandler, {**handler_opts}),
+            (r"/api/v2/lookup/grid", APILookupGridHandler, {**handler_opts}),
+            (r"/api/v2/spot", APISpotHandler,
+             {"spots": self._spots, "spot_providers": self._spot_providers, **handler_opts}),
+        ]
+
+        # v1 API redirects. Most v1 enpoints are unchanged in v2, and get an HTTP 308 redirect to the v2 API. The ones
+        # that have the actual breaking changes get a bespoke handler.
+        v1_compat_routes = [
+            (r"/api/v1/spot", V1GoneHandler),
+            (r"/api/v1/(.*)", V1RedirectHandler),
         ]
 
         # If in API-only mode, serve a basic homepage; in normal mode, serve the usual UI routes
@@ -100,25 +110,19 @@ class WebServer:
             if ALLOW_SPOTTING:
                 ui_routes += [(r"/add-spot", PageTemplateHandler, {"template_name": "add_spot", **handler_opts})]
 
-        # API docs, Prometheus metrics, webapp manifest and static assets are always available regardless of API-only
-        # mode.
+        # API docs, Prometheus metrics, and finally static assets are always available regardless of API-only mode.
         misc_routes = [
             (r"/apidocs", PageTemplateHandler, {"template_name": "apidocs", **handler_opts}),
             (r"/metrics", PrometheusMetricsHandler),
-            (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")})
+            (r"/(.*)", StaticFileHandler, {"path": os.path.join(_HERE, "../webassets")})
         ]
 
-        app = tornado.web.Application(api_routes + ui_routes + misc_routes,
+        app = tornado.web.Application(api_routes + v1_compat_routes + ui_routes + misc_routes,
                                       template_path=os.path.join(_HERE, "../templates"),
                                       log_function=request_log,
                                       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):
@@ -172,22 +176,20 @@ class WebServer:
         pass
 
 def request_log(handler):
-    """Custom log function to provide more data about requests when enabled, and to provide the ability to turn off
-    web request logging altogetether."""
+    """Custom log function to provide more data about requests."""
 
-    if LOG_WEB_REQUESTS:
-        if handler.get_status() < 500:
-            log_method = logging.info
-        else:
-            log_method = logging.warning
+    if handler.get_status() < 500:
+        log_method = logging.info
+    else:
+        log_method = logging.warning
 
-        request = handler.request
-        client_ip = request.remote_ip
-        referrer = request.headers.get("Referer", "-")
-        user_agent = request.headers.get("User-Agent", "-")
+    request = handler.request
+    client_ip = request.remote_ip
+    referrer = request.headers.get("Referer", "-")
+    user_agent = request.headers.get("User-Agent", "-")
 
-        log_method(
-            f'{client_ip} - "{request.method} {request.uri}" '
-            f'{handler.get_status()} {request.request_time():.2f}ms | '
-            f'Ref: {referrer} | UA: {user_agent}'
-        )
+    log_method(
+        f'{client_ip} - "{request.method} {request.uri}" '
+        f'{handler.get_status()} {request.request_time():.2f}ms | '
+        f'Ref: {referrer} | UA: {user_agent}'
+    )

solarconditionsproviders/giroionosonde.py

@@ -5,7 +5,6 @@ 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
@@ -30,7 +29,7 @@ class GIROIonosonde(SolarConditionsProvider):
     data, but is less reliable and often offline."""
 
     def __init__(self, provider_config):
-        super().__init__("GIRO Ionosonde Data", provider_config)
+        super().__init__(provider_config)
         self._stations = self._load_stations()
         self._thread = None
         self._stop_event = Event()
@@ -128,18 +127,10 @@ 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}"
-        try:
-            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.")
+        response = requests.get(url, headers=HTTP_HEADERS, timeout=(5, 15))
+        if response.status_code != 200:
             return None, None, None
+        return self._parse_all(response.text)
 
     @staticmethod
     def _parse_all(text):

solarconditionsproviders/hamqsl.py

@@ -15,9 +15,13 @@ class HamQSL(HTTPSolarConditionsProvider):
     Provides solar flux index, geomagnetic indices, and HF/VHF propagation condition summaries."""
 
     def __init__(self, provider_config):
-        super().__init__("HamQSL", provider_config, URL, POLL_INTERVAL)
+        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,7 +4,6 @@ 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
@@ -14,8 +13,8 @@ class HTTPSolarConditionsProvider(SolarConditionsProvider):
     """Generic solar conditions provider for providers that request data via HTTP(S). Subclasses implement
     _http_response_to_solar_conditions() to parse the specific API response format."""
 
-    def __init__(self, name, provider_config, url, poll_interval):
-        super().__init__(name, provider_config)
+    def __init__(self, provider_config, url, poll_interval):
+        super().__init__(provider_config)
         self._url = url
         self._poll_interval = poll_interval
         self._thread = None
@@ -40,22 +39,13 @@ class HTTPSolarConditionsProvider(SolarConditionsProvider):
         try:
             logging.debug("Polling " + self.name + " solar conditions API...")
             http_response = requests.get(self._url, headers=HTTP_HEADERS, timeout=(5, 30))
-            # Check response code was good
-            if http_response.ok:
-                new_data = self._http_response_to_solar_conditions(http_response)
-                self.update_data(new_data)
+            new_data = self._http_response_to_solar_conditions(http_response)
+            self.update_data(new_data)
 
-                self.status = "OK"
-                self.last_update_time = datetime.now(pytz.UTC)
-                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.")
+            self.status = "OK"
+            self.last_update_time = datetime.now(pytz.UTC)
+            logging.debug("Received data from " + 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,7 +4,6 @@ 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
@@ -24,7 +23,7 @@ class KC2GProp(SolarConditionsProvider):
     online, but has fewer stations and does not provide LUF data."""
 
     def __init__(self, provider_config):
-        super().__init__("KC2G Propagation Data", provider_config)
+        super().__init__(provider_config)
         self._thread = None
         self._stop_event = Event()
 
@@ -45,9 +44,9 @@ class KC2GProp(SolarConditionsProvider):
     def _poll(self):
         try:
             logging.debug("Polling KC2G ionosonde data...")
-            http_response = requests.get(KC2G_URL, headers=HTTP_HEADERS, timeout=(5, 30))
-            if not http_response.ok:
-                logging.warning(f"HTTP {http_response.status_code} when calling KG2G ionosonde API.")
+            response = requests.get(KC2G_URL, headers=HTTP_HEADERS, timeout=(5, 30))
+            if response.status_code != 200:
+                logging.warning(f"KC2G ionosonde API returned HTTP {response.status_code}")
                 return
 
             now = datetime.now(timezone.utc)
@@ -58,7 +57,7 @@ class KC2GProp(SolarConditionsProvider):
             ionosonde_data = dict(self._solar_conditions.ionosonde_data or {})
             updated_count = 0
 
-            for reading in http_response.json():
+            for reading in response.json():
                 station = reading.get("station", {})
                 ursi = station.get("code")
                 name = station.get("name")
@@ -116,10 +115,6 @@ 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

@@ -13,7 +13,7 @@ class NOAA3dayForecast(HTTPSolarConditionsProvider):
     corresponding fields in the solar conditions object.."""
 
     def __init__(self, provider_config):
-        super().__init__("NOAA 3-day Forecast", provider_config, URL, POLL_INTERVAL)
+        super().__init__(provider_config, URL, POLL_INTERVAL)
 
     @staticmethod
     def _parse_percentage_table(lines, section_header, year):
@@ -80,6 +80,10 @@ 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

solarconditionsproviders/solar_conditions_provider.py

@@ -7,11 +7,11 @@ class SolarConditionsProvider:
     """Generic solar conditions provider class. Subclasses of this query individual APIs for space weather and
      propagation data."""
 
-    def __init__(self, name, provider_config):
+    def __init__(self, provider_config):
         """Constructor"""
 
         self._solar_conditions_cache = None
-        self.name = name
+        self.name = provider_config["name"]
         self.enabled = provider_config["enabled"]
         self.last_update_time = datetime.min.replace(tzinfo=pytz.UTC)
         self.status = "Not Started" if self.enabled else "Disabled"

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, LOG_LEVEL
+from core.config import config, SERVER_OWNER_CALLSIGN
 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(LOG_LEVEL)
+    root.setLevel(logging.INFO)
     handler = logging.StreamHandler(sys.stdout)
-    handler.setLevel(LOG_LEVEL)
+    handler.setLevel(logging.INFO)
     formatter = logging.Formatter("%(levelname)s : %(message)s")
     handler.setFormatter(formatter)
     root.handlers.clear()
@@ -102,18 +102,21 @@ if __name__ == '__main__':
     # Set up lookup helper
     lookup_helper.start()
 
-    # Set up web server
-    web_server = WebServer(spots=spots, alerts=alerts, solar_conditions=solar_conditions, status_data=status_data)
-
-    # Fetch, set up and start spot providers
+    # Create spot providers
     for entry in config["spot-providers"]:
         spot_providers.append(get_spot_provider_from_config(entry))
+
+    # Set up web server
+    web_server = WebServer(spots=spots, alerts=alerts, solar_conditions=solar_conditions, status_data=status_data,
+                           spot_providers=spot_providers)
+
+    # Set up and start spot providers
     for p in spot_providers:
         p.setup(spots=spots, web_server=web_server)
         if p.enabled:
             p.start()
 
-    # Fetch, set up and start alert providers
+    # Create, set up and start alert providers
     for entry in config["alert-providers"]:
         alert_providers.append(get_alert_provider_from_config(entry))
     for p in alert_providers:
@@ -121,7 +124,7 @@ if __name__ == '__main__':
         if p.enabled:
             p.start()
 
-    # Fetch, set up and start solar conditions providers
+    # Create, set up and start solar conditions providers
     for entry in config.get("solar-condition-providers", []):
         solar_condition_providers.append(get_solar_conditions_provider_from_config(entry))
     for p in solar_condition_providers:

spotproviders/aprsis.py

@@ -14,7 +14,7 @@ class APRSIS(SpotProvider):
     """Spot provider for the APRS-IS."""
 
     def __init__(self, provider_config):
-        super().__init__("APRS-IS", provider_config)
+        super().__init__(provider_config)
         self._thread = Thread(target=self._connect)
         self._thread.daemon = True
         self._aprsis = None

spotproviders/dxcluster.py

@@ -26,8 +26,7 @@ class DXCluster(SpotProvider):
     def __init__(self, provider_config):
         """Constructor requires hostname and port"""
 
-        name = provider_config["name"] if "name" in provider_config else "Cluster"
-        super().__init__(name, provider_config)
+        super().__init__(provider_config)
         self._hostname = provider_config["host"]
         self._port = provider_config["port"]
         self._login_prompt = provider_config["login_prompt"] if "login_prompt" in provider_config else "login:"
@@ -60,10 +59,6 @@ class DXCluster(SpotProvider):
                     self._telnet.write((self._login_callsign + "\n").encode("latin-1"))
                     connected = True
                     logging.info("DX Cluster " + self._hostname + " connected.")
-                except ConnectionRefusedError:
-                    self.status = "Error"
-                    logging.warning("Connection refused to DX cluster " + self._hostname)
-                    sleep(300)
                 except Exception:
                     self.status = "Error"
                     logging.exception("Exception while connecting to DX Cluster Provider (" + self._hostname + ").")

spotproviders/gma.py

@@ -14,9 +14,9 @@ class GMA(HTTPSpotProvider):
     """Spot provider for General Mountain Activity"""
 
     POLL_INTERVAL_SEC = 120
-    SPOTS_URL = "https://www.gma.rocks/api/spots/25/"
+    SPOTS_URL = "https://www.cqgma.org/api/spots/25/"
     # GMA spots don't contain the details of the programme they are for, we need a separate lookup for that
-    REF_INFO_URL_ROOT = "https://www.gma.rocks/api/ref/?"
+    REF_INFO_URL_ROOT = "https://www.cqgma.org/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,
@@ -26,7 +26,7 @@ class GMA(HTTPSpotProvider):
             provider_config["enabled"] = False
             logging.warning("GMA spot provider configured but no api key was provided, this API will not be queried.")
 
-        super().__init__("GMA", provider_config, self.SPOTS_URL + "?key=" + self.api_key, self.POLL_INTERVAL_SEC)
+        super().__init__(provider_config, self.SPOTS_URL + "?key=" + self.api_key, self.POLL_INTERVAL_SEC)
 
     def _http_response_to_spots(self, http_response):
         new_spots = []
@@ -34,25 +34,23 @@ class GMA(HTTPSpotProvider):
         if "RCD" in http_response.json():
             for source_spot in http_response.json()["RCD"]:
                 # Convert to our spot format
-                # Seen GMA spots with no (or empty) lat/lon
-                lat = float(source_spot["LAT"]) if (source_spot["LAT"] and source_spot["LAT"] != "") else None
-                lon = float(source_spot["LON"]) if (source_spot["LON"] and source_spot["LON"] != "") else None
-
                 spot = Spot(source=self.name,
                             dx_call=source_spot["ACTIVATOR"].upper(),
                             de_call=source_spot["SPOTTER"].upper(),
                             # Seen GMA spots with no frequency or with "QRT" in this field
                             freq=float(source_spot["QRG"]) * 1000 if (
-                                    source_spot["QRG"] != "" and source_spot["QRG"] != "QRT") 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"], latitude=lat,
-                                             longitude=lon)],
+                            sig_refs=[SIGRef(id=source_spot["REF"], sig="", name=source_spot["NAME"])],
                             time=datetime.strptime(source_spot["DATE"] + source_spot["TIME"], "%Y%m%d%H%M").replace(
                                 tzinfo=pytz.UTC).timestamp(),
-                            dx_latitude=lat,
-                            dx_longitude=lon,
+                            # 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,
+                            dx_longitude=float(source_spot["LON"]) if (
+                                    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.
@@ -60,8 +58,8 @@ class GMA(HTTPSpotProvider):
                     try:
                         ref_response = SEMI_STATIC_URL_DATA_CACHE.get(self.REF_INFO_URL_ROOT + source_spot["REF"],
                                                                       headers=HTTP_HEADERS)
-                        # Sometimes this is blank even if it's a 200 response, so handle that
-                        if ref_response.ok and ref_response.text is not None and ref_response.text != "":
+                        # Sometimes this is blank, so handle that
+                        if 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
@@ -96,17 +94,9 @@ 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 that for us.
+                                # Add to our list. Don't worry about de-duping, removing old spots etc. at this point; other code will do
+                                # that for us.
                                 new_spots.append(spot)
-
-                        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")
@@ -114,3 +104,11 @@ class GMA(HTTPSpotProvider):
             logging.warning(f"The GMA API returned an unexpected response (HTTP {http_response.status_code}).")
 
         return new_spots
+
+    def can_submit_spot(self, sig):
+        return sig == "GMA"
+
+    def submit_spot(self, spot, credentials):
+        # TODO: Implement.
+        # Spotting to GMA is documented: https://www.cqgma.org/api/doc/apigma_spot.pdf We (or the user) need a GMA account, and to send the password in plaintext(!!)
+        raise NotImplementedError("GMA upstream spot submission is not yet implemented")

spotproviders/hema.py

@@ -1,10 +1,8 @@
-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
@@ -25,7 +23,7 @@ class HEMA(HTTPSpotProvider):
     SPOTTER_COMMENT_PATTERN = re.compile("^\\((.*)\\) (.*)$")
 
     def __init__(self, provider_config):
-        super().__init__("HEMA", provider_config, self.SPOT_SEED_URL, self.POLL_INTERVAL_SEC)
+        super().__init__(provider_config, self.SPOT_SEED_URL, self.POLL_INTERVAL_SEC)
         self._spot_seed = ""
 
     def _http_response_to_spots(self, http_response):
@@ -37,40 +35,42 @@ class HEMA(HTTPSpotProvider):
         new_spots = []
         # OK, if the spot seed actually changed, now we make the real request for data.
         if spot_seed_changed:
-            try:
-                source_data = requests.get(self.SPOTS_URL, headers=HTTP_HEADERS, timeout=(5, 30))
-                source_data_items = source_data.text.split("=")
-                # Iterate through source data items.
-                for source_spot in source_data_items:
-                    spot_items = source_spot.split(";")
-                    # Any line with less than 9 items is not a proper spot line
-                    if len(spot_items) >= 9:
-                        # Fiddle with some data to extract bits we need. Freq/mode and spotter/comment come in combined fields.
-                        freq_mode_match = re.search(self.FREQ_MODE_PATTERN, spot_items[5])
-                        spotter_comment_match = re.search(self.SPOTTER_COMMENT_PATTERN, spot_items[6])
-                        if not freq_mode_match or not spotter_comment_match:
-                            continue
+            source_data = requests.get(self.SPOTS_URL, headers=HTTP_HEADERS, timeout=(5, 30))
+            source_data_items = source_data.text.split("=")
+            # Iterate through source data items.
+            for source_spot in source_data_items:
+                spot_items = source_spot.split(";")
+                # Any line with less than 9 items is not a proper spot line
+                if len(spot_items) >= 9:
+                    # Fiddle with some data to extract bits we need. Freq/mode and spotter/comment come in combined fields.
+                    freq_mode_match = re.search(self.FREQ_MODE_PATTERN, spot_items[5])
+                    spotter_comment_match = re.search(self.SPOTTER_COMMENT_PATTERN, spot_items[6])
+                    if not freq_mode_match or not spotter_comment_match:
+                        continue
 
-                        # Convert to our spot format
-                        spot = Spot(source=self.name,
-                                    dx_call=spot_items[2].upper(),
-                                    de_call=spotter_comment_match.group(1).upper(),
-                                    freq=float(freq_mode_match.group(1)) * 1000000,
-                                    mode=freq_mode_match.group(2).upper(),
-                                    comment=spotter_comment_match.group(2),
-                                    sig="HEMA",
-                                    sig_refs=[SIGRef(id=spot_items[3].upper(), sig="HEMA", name=spot_items[4],
-                                                     latitude=float(spot_items[7]), longitude=float(spot_items[8]))],
-                                    time=datetime.strptime(spot_items[0], "%d/%m/%Y %H:%M").replace(
-                                        tzinfo=pytz.UTC).timestamp(),
-                                    dx_latitude=float(spot_items[7]),
-                                    dx_longitude=float(spot_items[8]))
+                    # Convert to our spot format
+                    spot = Spot(source=self.name,
+                                dx_call=spot_items[2].upper(),
+                                de_call=spotter_comment_match.group(1).upper(),
+                                freq=float(freq_mode_match.group(1)) * 1000000,
+                                mode=freq_mode_match.group(2).upper(),
+                                comment=spotter_comment_match.group(2),
+                                sig="HEMA",
+                                sig_refs=[SIGRef(id=spot_items[3].upper(), sig="HEMA", name=spot_items[4])],
+                                time=datetime.strptime(spot_items[0], "%d/%m/%Y %H:%M").replace(
+                                    tzinfo=pytz.UTC).timestamp(),
+                                dx_latitude=float(spot_items[7]),
+                                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 that for us.
-                        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.")
+                    # Add to our list. Don't worry about de-duping, removing old spots etc. at this point; other code will do
+                    # that for us.
+                    new_spots.append(spot)
         return new_spots
+
+    def can_submit_spot(self, sig):
+        return sig == "HEMA"
+
+    def submit_spot(self, spot, credentials):
+        # TODO: Implement. Currently blocked awaiting their API team to make a change to allow us to spot with a
+        # reference and not a reference *number*.
+        raise NotImplementedError("HEMA upstream spot submission is not yet implemented")

spotproviders/http_spot_provider.py

@@ -4,8 +4,6 @@ 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
@@ -15,12 +13,13 @@ class HTTPSpotProvider(SpotProvider):
     """Generic spot provider class for providers that request data via HTTP(S). Just for convenience to avoid code
     duplication. Subclasses of this query the individual APIs for data."""
 
-    def __init__(self, name, provider_config, url, poll_interval):
-        super().__init__(name, provider_config)
+    def __init__(self, provider_config, url, poll_interval):
+        super().__init__(provider_config)
         self._url = url
         self._poll_interval = poll_interval
         self._thread = None
         self._stop_event = Event()
+        self._wakeup_event = Event()
 
     def start(self):
         # Fire off the polling thread. It will poll immediately on startup, then sleep for poll_interval between
@@ -31,11 +30,19 @@ class HTTPSpotProvider(SpotProvider):
 
     def stop(self):
         self._stop_event.set()
+        self._wakeup_event.set()
+
+    def force_poll(self):
+        """Trigger an immediate poll without waiting for the normal interval."""
+
+        self._wakeup_event.set()
 
     def _run(self):
         while True:
+            self._wakeup_event.clear()
             self._poll()
-            if self._stop_event.wait(timeout=self._poll_interval):
+            self._wakeup_event.wait(timeout=self._poll_interval)
+            if self._stop_event.is_set():
                 break
 
     def _poll(self):
@@ -43,25 +50,16 @@ 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))
-            # Check response code was good
-            if http_response.ok:
-                # Pass off to the subclass for processing
-                new_spots = self._http_response_to_spots(http_response)
-                # Submit the new spots for processing. There might not be any spots for the less popular programs.
-                if new_spots:
-                    self._submit_batch(new_spots)
+            # Pass off to the subclass for processing
+            new_spots = self._http_response_to_spots(http_response)
+            # Submit the new spots for processing. There might not be any spots for the less popular programs.
+            if new_spots:
+                self._submit_batch(new_spots)
 
-                self.status = "OK"
-                self.last_update_time = datetime.now(pytz.UTC)
-                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.")
+            self.status = "OK"
+            self.last_update_time = datetime.now(pytz.UTC)
+            logging.debug("Received data from " + 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/llota.py

@@ -12,7 +12,7 @@ class LLOTA(HTTPSpotProvider):
     SPOTS_URL = "https://llota.app/api/public/spots"
 
     def __init__(self, provider_config):
-        super().__init__("LLOTA", provider_config, self.SPOTS_URL, self.POLL_INTERVAL_SEC)
+        super().__init__(provider_config, self.SPOTS_URL, self.POLL_INTERVAL_SEC)
 
     def _http_response_to_spots(self, http_response):
         new_spots = []

spotproviders/parksnpeaks.py

@@ -3,7 +3,9 @@ import re
 from datetime import datetime
 
 import pytz
+import requests
 
+from core.constants import HTTP_HEADERS
 from data.sig_ref import SIGRef
 from data.spot import Spot
 from spotproviders.http_spot_provider import HTTPSpotProvider
@@ -14,10 +16,12 @@ class ParksNPeaks(HTTPSpotProvider):
 
     POLL_INTERVAL_SEC = 120
     SPOTS_URL = "https://www.parksnpeaks.org/api/ALL"
+    SUBMIT_URL = "https://www.parksnpeaks.org/api/SPOT/"
     SIOTA_LIST_URL = "https://www.silosontheair.com/data/silos.csv"
+    SUBMITTABLE_SIGS = ["POTA", "SOTA", "WWFF", "HEMA", "WOTA", "ZLOTA", "SIOTA", "KRMNPA"]
 
     def __init__(self, provider_config):
-        super().__init__("ParksNPeaks", provider_config, self.SPOTS_URL, self.POLL_INTERVAL_SEC)
+        super().__init__(provider_config, self.SPOTS_URL, self.POLL_INTERVAL_SEC)
 
     def _http_response_to_spots(self, http_response):
         new_spots = []
@@ -30,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(",", "").replace("+-", "")
-                                       .replace("+/-", "").strip()) * 1000000 if (source_spot["actFreq"] != "") else None,
+                            freq=float(source_spot["actFreq"].replace(",", "")) * 1000000 if (
+                                    source_spot["actFreq"] != "") else None,
                             # Seen PNP spots with empty frequency, and with comma-separated thousands digits
                             mode=source_spot["actMode"].upper(),
                             comment=source_spot["actComments"],
@@ -63,3 +67,28 @@ class ParksNPeaks(HTTPSpotProvider):
                 # Add new spot to the list
                 new_spots.append(spot)
         return new_spots
+
+    def can_submit_spot(self, sig):
+        return sig in self.SUBMITTABLE_SIGS
+
+    def submit_spot(self, spot, credentials):
+        # TODO test this works
+        user_id = credentials.get("user_id", "")
+        api_key = credentials.get("api_key", "")
+        if not user_id or not api_key:
+            raise ValueError(
+                "Parks N Peaks user ID and API key are required. Get yours from your Parks N Peaks account.")
+        sig_ref = spot.sig_refs[0].id if spot.sig_refs else ""
+        body = {
+            "actClass": spot.sig or "",
+            "actCallsign": spot.dx_call,
+            "actSite": sig_ref,
+            "mode": spot.mode or "",
+            "freq": str(spot.freq / 1000000.0),
+            "comments": spot.comment or "",
+            "userID": user_id,
+            "APIKey": api_key,
+        }
+        response = requests.post(self.SUBMIT_URL, json=body, headers=HTTP_HEADERS, timeout=(5, 30))
+        if not response.ok:
+            raise RuntimeError("Parks N Peaks API returned " + str(response.status_code) + ": " + response.text)

spotproviders/pota.py

@@ -1,7 +1,9 @@
 from datetime import datetime
 
 import pytz
+import requests
 
+from core.constants import HTTP_HEADERS
 from data.sig_ref import SIGRef
 from data.spot import Spot
 from spotproviders.http_spot_provider import HTTPSpotProvider
@@ -12,9 +14,10 @@ class POTA(HTTPSpotProvider):
 
     POLL_INTERVAL_SEC = 120
     SPOTS_URL = "https://api.pota.app/spot/activator"
+    SUBMIT_URL = "https://api.pota.app/spot"
 
     def __init__(self, provider_config):
-        super().__init__("POTA", provider_config, self.SPOTS_URL, self.POLL_INTERVAL_SEC)
+        super().__init__(provider_config, self.SPOTS_URL, self.POLL_INTERVAL_SEC)
 
     def _http_response_to_spots(self, http_response):
         new_spots = []
@@ -29,8 +32,7 @@ class POTA(HTTPSpotProvider):
                         mode=source_spot["mode"].upper(),
                         comment=source_spot["comments"],
                         sig="POTA",
-                        sig_refs=[SIGRef(id=source_spot["reference"], sig="POTA", name=source_spot["name"],
-                                         latitude=source_spot["latitude"], longitude=source_spot["longitude"])],
+                        sig_refs=[SIGRef(id=source_spot["reference"], sig="POTA", name=source_spot["name"])],
                         time=datetime.strptime(source_spot["spotTime"], "%Y-%m-%dT%H:%M:%S").replace(
                             tzinfo=pytz.UTC).timestamp(),
                         dx_grid=source_spot["grid6"],
@@ -41,3 +43,25 @@ class POTA(HTTPSpotProvider):
             # that for us.
             new_spots.append(spot)
         return new_spots
+
+    def can_submit_spot(self, sig):
+        return sig == "POTA"
+
+    def submit_spot(self, spot, credentials):
+        sig_ref = spot.sig_refs[0].id if spot.sig_refs else None
+        if sig_ref:
+            body = {
+                "activator": spot.dx_call,
+                "spotter": spot.de_call,
+                "frequency": str(spot.freq / 1000.0),
+                "mode": spot.mode or "",
+                "reference": sig_ref,
+                "comments": spot.comment or "",
+                "source": "Spothole",
+            }
+            headers = {**HTTP_HEADERS, "Content-Type": "application/json"}
+            response = requests.post(self.SUBMIT_URL, json=body, headers=headers, timeout=(5, 30))
+            if not response.ok:
+                raise RuntimeError("POTA API returned " + str(response.status_code) + ": " + response.text)
+        else:
+            raise RuntimeError("Park reference is required for submitting POTA spots.")

spotproviders/rbn.py

@@ -23,8 +23,7 @@ class RBN(SpotProvider):
     def __init__(self, provider_config):
         """Constructor requires port number."""
 
-        name = provider_config["name"] if "name" in provider_config else "RBN"
-        super().__init__(name, provider_config)
+        super().__init__(provider_config)
         self._port = provider_config["port"]
         self._telnet = None
         self._thread = Thread(target=self._handle)

spotproviders/sota.py

@@ -1,10 +1,8 @@
-import logging
 from datetime import datetime
 
 import requests
-from requests.exceptions import ConnectionError, ReadTimeout, ConnectTimeout
 
-from core.constants import HTTP_HEADERS
+from core.constants import HTTP_HEADERS, SSB_SUB_MODES, DV_SUB_MODES
 from data.sig_ref import SIGRef
 from data.spot import Spot
 from spotproviders.http_spot_provider import HTTPSpotProvider
@@ -19,9 +17,14 @@ class SOTA(HTTPSpotProvider):
     # The actual data lookup all happens after parsing and checking the epoch.
     EPOCH_URL = "https://api-db2.sota.org.uk/api/spots/epoch"
     SPOTS_URL = "https://api-db2.sota.org.uk/api/spots/60/all/all"
+    # SOTA spots don't contain lat/lon, we need a separate lookup for that
+    SUMMIT_URL_ROOT = "https://api-db2.sota.org.uk/api/summits/"
+
+    SUBMIT_URL = "https://api-db2.sota.org.uk/api/spots"
+    VALID_MODES = ["AM", "CW", "Data", "DV", "FM", "SSB"]
 
     def __init__(self, provider_config):
-        super().__init__("SOTA", provider_config, self.EPOCH_URL, self.POLL_INTERVAL_SEC)
+        super().__init__(provider_config, self.EPOCH_URL, self.POLL_INTERVAL_SEC)
         self._api_epoch = ""
 
     def _http_response_to_spots(self, http_response):
@@ -33,35 +36,69 @@ class SOTA(HTTPSpotProvider):
         new_spots = []
         # OK, if the epoch actually changed, now we make the real request for data.
         if epoch_changed:
-            try:
-                source_data = requests.get(self.SPOTS_URL, headers=HTTP_HEADERS, timeout=(5, 30)).json()
-                # Iterate through source data
-                for source_spot in source_data:
-                    # Convert to our spot format
-                    spot = Spot(source=self.name,
-                                source_id=source_spot["id"],
-                                dx_call=source_spot["activatorCallsign"].upper(),
-                                dx_name=source_spot["activatorName"],
-                                de_call=source_spot["callsign"].upper(),
-                                freq=(float(source_spot["frequency"]) * 1000000) if (
-                                        source_spot["frequency"] is not None) else None,
-                                # Seen SOTA spots with no frequency!
-                                mode=source_spot["mode"].upper(),
-                                comment=source_spot["comments"],
-                                sig="SOTA",
-                                sig_refs=[SIGRef(id=source_spot["summitCode"], sig="SOTA",
-                                                 name=source_spot["summitName"], latitude=source_spot["latitude"],
-                                                 longitude=source_spot["longitude"],
-                                                 activation_score=source_spot["points"])],
-                                dx_latitude=source_spot["latitude"],
-                                dx_longitude=source_spot["longitude"],
-                                time=datetime.fromisoformat(source_spot["timeStamp"].replace("Z", "+00:00")).timestamp())
+            source_data = requests.get(self.SPOTS_URL, headers=HTTP_HEADERS, timeout=(5, 30)).json()
+            # Iterate through source data
+            for source_spot in source_data:
+                # Convert to our spot format
+                spot = Spot(source=self.name,
+                            source_id=source_spot["id"],
+                            dx_call=source_spot["activatorCallsign"].upper(),
+                            dx_name=source_spot["activatorName"],
+                            de_call=source_spot["callsign"].upper(),
+                            freq=(float(source_spot["frequency"]) * 1000000) if (
+                                    source_spot["frequency"] is not None) else None,
+                            # Seen SOTA spots with no frequency!
+                            mode=source_spot["mode"].upper(),
+                            comment=source_spot["comments"],
+                            sig="SOTA",
+                            sig_refs=[SIGRef(id=source_spot["summitCode"], sig="SOTA", name=source_spot["summitName"],
+                                             activation_score=source_spot["points"])],
+                            time=datetime.fromisoformat(source_spot["timeStamp"].replace("Z", "+00:00")).timestamp())
 
-                    # Add to our list. Don't worry about de-duping, removing old spots etc. at this point; other code will do
-                    # that for us.
-                    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.")
+                # Add to our list. Don't worry about de-duping, removing old spots etc. at this point; other code will do
+                # that for us.
+                new_spots.append(spot)
         return new_spots
+
+    def can_submit_spot(self, sig):
+        return sig == "SOTA"
+
+    def submit_spot(self, spot, credentials):
+        # TODO test this method works
+        access_token = credentials.get("access_token", "")
+        id_token = credentials.get("id_token", "")
+        if not access_token or not id_token:
+            raise ValueError("SOTA API tokens are required. Please log into SOTA in order to spot to it.")
+        sig_ref = spot.sig_refs[0].id if spot.sig_refs else ""
+        if sig_ref:
+            # Split reference into association and summit codes
+            ref_split = sig_ref.split("/")
+
+            # Figure out a valid mode. Borrowed this from PoLo :)
+            # https://github.com/ham2k/app-polo/blob/main/src/extensions/activities/sota/SOTAPostSelfSpot.js
+            mode = spot.mode
+            if mode and mode not in self.VALID_MODES:
+                if mode in SSB_SUB_MODES:
+                    mode = "SSB"
+                elif mode in DV_SUB_MODES:
+                    mode = "DV"
+                else:
+                    mode = "Data"
+
+            body = {
+                "activatorCallsign": spot.dx_call,
+                "associationCode": ref_split[0],
+                "summitCode": ref_split[1],
+                "frequency": spot.freq / 1000000.0,
+                "mode": mode or "",
+                "callsign": spot.de_call,
+                "comments": spot.comment or "",
+                "type": "TEST"  # todo replatce with NORMAL/QRT once testing complete
+            }
+            headers = {**HTTP_HEADERS, "Authorization": "bearer " + access_token, "id_token": id_token,
+                       "Content-Type": "application/json"}
+            response = requests.post(self.SUBMIT_URL, json=body, headers=headers, timeout=(5, 30))
+            if not response.ok:
+                raise RuntimeError("SOTA API returned " + str(response.status_code) + ": " + response.text)
+        else:
+            raise RuntimeError("Summit reference is required for submitting SOTA spots.")

spotproviders/spot_provider.py

@@ -8,10 +8,10 @@ from core.config import MAX_SPOT_AGE
 class SpotProvider:
     """Generic spot provider class. Subclasses of this query the individual APIs for data."""
 
-    def __init__(self, name, provider_config):
+    def __init__(self, provider_config):
         """Constructor"""
 
-        self.name = name
+        self.name = provider_config["name"]
         self.enabled = provider_config["enabled"]
         self.last_update_time = datetime.min.replace(tzinfo=pytz.UTC)
         self.last_spot_time = datetime.min.replace(tzinfo=pytz.UTC)
@@ -68,3 +68,20 @@ class SpotProvider:
         """Stop any threads and prepare for application shutdown"""
 
         raise NotImplementedError("Subclasses must implement this method")
+
+    def can_submit_spot(self, sig):
+        """Return True if this provider supports submitting spots upstream for the given SIG."""
+
+        return False
+
+    def submit_spot(self, spot, credentials):
+        """Submit a spot upstream to this provider's API. credentials is a dict with provider-specific keys.
+        Raises an exception with a descriptive message on failure."""
+
+        raise NotImplementedError("This provider does not support spot submission")
+
+    def force_poll(self):
+        """Trigger an immediate poll without waiting for the normal interval. Default implementation here does nothing
+        because not all spot providers have a polling mechanism. Providers that do should override this method."""
+
+        return

spotproviders/sse_spot_provider.py

@@ -13,8 +13,8 @@ from spotproviders.spot_provider import SpotProvider
 class SSESpotProvider(SpotProvider):
     """Spot provider using Server-Sent Events."""
 
-    def __init__(self, name, provider_config, url):
-        super().__init__(name, provider_config)
+    def __init__(self, provider_config, url):
+        super().__init__(provider_config)
         self._url = url
         self._event_source = None
         self._thread = None

spotproviders/tiles.py

@@ -1,5 +1,8 @@
 from datetime import datetime
 
+import requests
+
+from core.constants import HTTP_HEADERS, SSB_SUB_MODES
 from data.sig_ref import SIGRef
 from data.spot import Spot
 from spotproviders.http_spot_provider import HTTPSpotProvider
@@ -10,9 +13,12 @@ class Tiles(HTTPSpotProvider):
 
     POLL_INTERVAL_SEC = 120
     SPOTS_URL = "https://icneuzxitdqtofutxbla.supabase.co/functions/v1/spots?active_hours=24"
+    SUBMIT_URL = "https://icneuzxitdqtofutxbla.supabase.co/functions/v1/self-spot"
+    VALID_MODES = ["SSB", "CW", "FT8", "FT4", "FM", "DMR", "D-STAR", "M17", "AX.25", "JS8Call", "PSK31", "Olivia",
+                   "VarAC", "Other"]
 
     def __init__(self, provider_config):
-        super().__init__("Tiles", provider_config, self.SPOTS_URL, self.POLL_INTERVAL_SEC)
+        super().__init__(provider_config, self.SPOTS_URL, self.POLL_INTERVAL_SEC)
 
     def _http_response_to_spots(self, http_response):
         new_spots = []
@@ -31,8 +37,7 @@ class Tiles(HTTPSpotProvider):
                         # Tiles spots can include POTA & SOTA references, but ignore those on the basis that we will get them separately from the POTA/SOTA providers anyway.
                         # Just take the grid reference itself as the single Tiles SIG reference.
                         sig_refs=[SIGRef(id=source_spot["maidenhead_grid"], sig="Tiles",
-                                         name=source_spot["maidenhead_grid"], latitude=source_spot["latitude"],
-                                         longitude=source_spot["longitude"])],
+                                         name=source_spot["maidenhead_grid"])],
                         time=datetime.fromisoformat(source_spot["created_at"].replace("Z", "+00:00")).timestamp(),
                         dx_grid=source_spot["maidenhead_grid"],
                         dx_latitude=source_spot["latitude"],
@@ -43,6 +48,49 @@ class Tiles(HTTPSpotProvider):
             new_spots.append(spot)
         return new_spots
 
+    def can_submit_spot(self, sig):
+        return sig == "Tiles"
+
+    def submit_spot(self, spot, credentials):
+        # Tiles on the air currently only supports *self* spots
+        if spot.dx_call == spot.de_call:
+
+            # Figure out a valid mode. Borrowed this from PoLo :)
+            # https://github.com/ham2k/app-polo/blob/main/src/extensions/activities/sota/SOTAPostSelfSpot.js
+            if spot.mode:
+                mode = spot.mode
+                if mode not in self.VALID_MODES:
+                    if mode in SSB_SUB_MODES:
+                        mode = "SSB"
+                    elif mode == "OLIVIA":
+                        mode = "Olivia"
+                    elif mode == "JS8":
+                        mode = "JS8Call"
+                    else:
+                        mode = "Other"
+
+                body = {
+                    "call_sign": spot.dx_call,
+                    "frequency": str(spot.freq / 1000000.0),
+                    "mode": mode or "",
+                    "grid": spot.dx_grid or "",
+                    "comment": spot.comment or "",
+                    "lat": spot.dx_latitude or None,
+                    "lon": spot.dx_longitude or None,
+                    "qrt": spot.qrt or False,
+                    "pin": credentials.get("offline_spot_gateway_pin", "")
+                }
+                headers = {**HTTP_HEADERS, "Content-Type": "application/json"}
+                response = requests.post(self.SUBMIT_URL, json=body, headers=headers, timeout=(5, 30))
+                if not response.ok:
+                    raise RuntimeError(
+                        "Tiles on the Air API returned " + str(response.status_code) + ": " + response.text)
+            else:
+                raise RuntimeError("The Tiles on the Air API requires a mode to be set.")
+        else:
+            raise RuntimeError(
+                "The Tiles on the Air API only supports self-spots, the DX call and spotter call must match.")
+
 
 # Utility function to keep the first decimal point in a given string but remove any others. Used to parse Tiles'
 # strange frequency format where we can sometimes have e.g. "14.123.5".

spotproviders/towers.py

@@ -13,7 +13,7 @@ class Towers(HTTPSpotProvider):
     SPOTS_URL = "https://wwtota.com/api/cluster_live.php"
 
     def __init__(self, provider_config):
-        super().__init__("Towers", provider_config, self.SPOTS_URL, self.POLL_INTERVAL_SEC)
+        super().__init__(provider_config, self.SPOTS_URL, self.POLL_INTERVAL_SEC)
 
     def _http_response_to_spots(self, http_response):
         new_spots = []

spotproviders/ukpacketnet.py

@@ -14,7 +14,7 @@ class UKPacketNet(HTTPSpotProvider):
     SPOTS_URL = "https://nodes.ukpacketradio.network/api/nodedata"
 
     def __init__(self, provider_config):
-        super().__init__("UK Packet Net", provider_config, self.SPOTS_URL, self.POLL_INTERVAL_SEC)
+        super().__init__(provider_config, self.SPOTS_URL, self.POLL_INTERVAL_SEC)
 
     def _http_response_to_spots(self, http_response):
         new_spots = []

spotproviders/websocket_spot_provider.py

@@ -13,8 +13,8 @@ from spotproviders.spot_provider import SpotProvider
 class WebsocketSpotProvider(SpotProvider):
     """Spot provider using websockets."""
 
-    def __init__(self, name, provider_config, url):
-        super().__init__(name, provider_config)
+    def __init__(self, provider_config, url):
+        super().__init__(provider_config)
         self._url = url
         self._ws = None
         self._thread = None

spotproviders/wota.py

@@ -21,7 +21,7 @@ class WOTA(HTTPSpotProvider):
     RSS_DATE_TIME_FORMAT = "%a, %d %b %Y %H:%M:%S %z"
 
     def __init__(self, provider_config):
-        super().__init__("WOTA", provider_config, self.SPOTS_URL, self.POLL_INTERVAL_SEC)
+        super().__init__(provider_config, self.SPOTS_URL, self.POLL_INTERVAL_SEC)
 
     def _http_response_to_spots(self, http_response):
         new_spots = []
@@ -79,3 +79,10 @@ class WOTA(HTTPSpotProvider):
             except Exception as e:
                 logging.error("Exception parsing WOTA spot", e)
         return new_spots
+
+    def can_submit_spot(self, sig):
+        return sig == "WOTA"
+
+    def submit_spot(self, spot, credentials):
+        # TODO Ask M5TEA if he's happy to share how this is done from his app
+        raise NotImplementedError("WOTA upstream spot submission is not yet implemented")

spotproviders/wwbota.py

@@ -12,7 +12,7 @@ class WWBOTA(SSESpotProvider):
     SPOTS_URL = "https://api.wwbota.net/spots/"
 
     def __init__(self, provider_config):
-        super().__init__("WWBOTA", provider_config, self.SPOTS_URL)
+        super().__init__(provider_config, self.SPOTS_URL)
 
     def _sse_message_to_spot(self, message):
         source_spot = json.loads(message)
@@ -20,8 +20,7 @@ class WWBOTA(SSESpotProvider):
         # n-fer activations.
         refs = []
         for ref in source_spot["references"]:
-            sigref = SIGRef(id=ref["reference"], sig="WWBOTA", name=ref["name"], latitude=ref["lat"],
-                            longitude=ref["long"])
+            sigref = SIGRef(id=ref["reference"], sig="WWBOTA", name=ref["name"])
             refs.append(sigref)
 
         spot = Spot(source=self.name,
@@ -42,3 +41,10 @@ class WWBOTA(SSESpotProvider):
 
         # WWBOTA does support a special "Test" spot type, we need to avoid adding that.
         return spot if source_spot["type"] != "Test" else None
+
+    def can_submit_spot(self, sig):
+        return sig == "WWBOTA"
+
+    def submit_spot(self, spot, credentials):
+        # TODO: Implement. WWBOTA API docs cover this: https://api.wwbota.org/#tag/Spots/operation/create_spot_spots__post
+        raise NotImplementedError("WWBOTA upstream spot submission is not yet implemented")

spotproviders/wwff.py

@@ -14,7 +14,7 @@ class WWFF(HTTPSpotProvider):
     SPOTS_URL = "https://spots.wwff.co/static/spots.json"
 
     def __init__(self, provider_config):
-        super().__init__("WWFF", provider_config, self.SPOTS_URL, self.POLL_INTERVAL_SEC)
+        super().__init__(provider_config, self.SPOTS_URL, self.POLL_INTERVAL_SEC)
 
     def _http_response_to_spots(self, http_response):
         new_spots = []
@@ -29,8 +29,7 @@ class WWFF(HTTPSpotProvider):
                         mode=source_spot["mode"].upper(),
                         comment=source_spot["remarks"],
                         sig="WWFF",
-                        sig_refs=[SIGRef(id=source_spot["reference"], sig="WWFF", name=source_spot["reference_name"],
-                                         latitude=source_spot["latitude"], longitude=source_spot["longitude"])],
+                        sig_refs=[SIGRef(id=source_spot["reference"], sig="WWFF", name=source_spot["reference_name"])],
                         time=datetime.fromtimestamp(source_spot["spot_time"], tz=pytz.UTC).timestamp(),
                         dx_latitude=source_spot["latitude"],
                         dx_longitude=source_spot["longitude"])
@@ -39,3 +38,11 @@ class WWFF(HTTPSpotProvider):
             # that for us.
             new_spots.append(spot)
         return new_spots
+
+    def can_submit_spot(self, sig):
+        return sig == "WWFF"
+
+    def submit_spot(self, spot, credentials):
+        # TODO: Implement. Spotting to WWFF should be possible, need to look up the Spotline docs or copy approach from
+        # PoLo. Either way I think we need an API key for the app (but maybe not for the user?)
+        raise NotImplementedError("WWFF upstream spot submission is not yet implemented")

spotproviders/xota.py

@@ -21,8 +21,7 @@ class XOTA(WebsocketSpotProvider):
     SIG = None
 
     def __init__(self, provider_config):
-        name = provider_config["name"] if "name" in provider_config else "xOTA"
-        super().__init__(name, provider_config, provider_config["url"])
+        super().__init__(provider_config, provider_config["url"])
         locations_csv = str(provider_config["locations-csv"]) if "locations-csv" in provider_config else None
         self.SIG = str(provider_config["sig"]) if "sig" in provider_config else None
 

spotproviders/zlota.py

@@ -15,7 +15,7 @@ class ZLOTA(HTTPSpotProvider):
     LIST_URL = "https://ontheair.nz/assets/assets.json"
 
     def __init__(self, provider_config):
-        super().__init__("ZLOTA", provider_config, self.SPOTS_URL, self.POLL_INTERVAL_SEC)
+        super().__init__(provider_config, self.SPOTS_URL, self.POLL_INTERVAL_SEC)
 
     def _http_response_to_spots(self, http_response):
         new_spots = []
@@ -41,3 +41,10 @@ class ZLOTA(HTTPSpotProvider):
 
             new_spots.append(spot)
         return new_spots
+
+    def can_submit_spot(self, sig):
+        return sig == "ZLOTA"
+
+    def submit_spot(self, spot, credentials):
+        # TODO: Implement. Spotting to ZLOTA is supported via POST, see https://ontheair.nz/api
+        raise NotImplementedError("ZLOTA upstream spot submission is not yet implemented")

static/js/add-spot.js

@@ -1,140 +0,0 @@
-// Load server options. Once a successful callback is made from this, we can populate the choice boxes in the form and load
-// any saved values from local storage.
-function loadOptions() {
-    $.getJSON('/api/v1/options', function (jsonData) {
-        // Store options
-        options = jsonData;
-
-        // Populate modes drop-down
-        $.each(options["modes"], function (i, m) {
-            $('#mode').append($('<option>', {
-                value: m,
-                text: m
-            }));
-        });
-
-        // Populate SIG drop-down
-        $.each(options["sigs"], function (i, sig) {
-            $('#sig').append($('<option>', {
-                value: sig.name,
-                text: sig.name
-            }));
-        });
-
-        // Load settings from settings storage now all the controls are available
-        loadSettings();
-    });
-}
-
-// Method called to add a spot to the server
-function addSpot() {
-    try {
-        // Save settings (this will save "your call" for future use)
-        saveSettings();
-
-        // Unpack the user's entered values
-        const dx = $("#dx-call").val().toUpperCase();
-        const freqStr = $("#freq").val();
-        const mode = $("#mode")[0].value;
-        const sig = $("#sig")[0].value;
-        const sigRef = $("#sig-ref").val();
-        const dxGrid = $("#dx-grid").val();
-        const comment = $("#comment").val();
-        const de = $("#de-call").val().toUpperCase();
-
-        const spot = {};
-        if (dx !== "") {
-            spot["dx_call"] = dx;
-        } else {
-            showAddSpotError("A DX callsign is required in order to spot.");
-            return;
-        }
-        if (freqStr !== "") {
-            spot["freq"] = parseFloat(freqStr) * 1000;
-        } else {
-            showAddSpotError("A frequency is required in order to spot.");
-            return;
-        }
-        if (mode !== "") {
-            spot["mode"] = mode;
-        }
-        if (sig !== "") {
-            spot["sig"] = sig;
-        }
-        if (sigRef !== "") {
-            spot["sig_refs"] = [{sig: sig, id: sigRef}];
-        }
-        if (dxGrid !== "") {
-            spot["dx_grid"] = dxGrid;
-        }
-        if (comment !== "") {
-            spot["comment"] = comment;
-        }
-        if (de !== "") {
-            spot["de_call"] = de;
-        } else {
-            showAddSpotError("A spotter callsign is required in order to spot.");
-            return;
-        }
-        spot["time"] = moment.utc().valueOf() / 1000.0;
-
-        $.ajax("/api/v1/spot", {
-            data: JSON.stringify(spot),
-            contentType: 'application/json',
-            type: 'POST',
-            timeout: 10000,
-            success: async function () {
-                $("#result-good").html("<div class='alert alert-success fade show mb-0 mt-4' role='alert'><i class='fa-solid fa-check'></i> Spot submitted. Returning you to the spots list...</div>");
-                $("#result-bad").html("");
-                setTimeout(() => {
-                    $("#result-good").hide();
-                    window.location.replace("/");
-                }, 1000);
-            },
-            error: function (result) {
-                showAddSpotError(result.responseText.slice(1, -1));
-            }
-        });
-    } catch (error) {
-        showAddSpotError(error);
-    }
-    return false;
-}
-
-// Show an "add spot" error.
-function showAddSpotError(text) {
-    const div = $("<div class='alert alert-danger alert-dismissible fade show mb-0 mt-4' role='alert'></div>");
-    div.append("<i class='fa-solid fa-triangle-exclamation'></i> ");
-    div.append(document.createTextNode(text));
-    div.append("<button type='button' class='btn-close' data-bs-dismiss='alert' aria-label='Close'></button>");
-    $("#result-bad").empty().append(div);
-}
-
-// Force callsign and mode capitalisation
-$("#dx-call").change(function () {
-    $(this).val($(this).val().trim().toUpperCase());
-});
-$("#de-call").change(function () {
-    $(this).val($(this).val().trim().toUpperCase());
-});
-$("#mode").change(function () {
-    $(this).val($(this).val().trim().toUpperCase());
-});
-
-// Display the intro box, unless the user has already dismissed it once.
-function displayIntroBox() {
-    if (localStorage.getItem("add-spot-intro-box-dismissed") == null) {
-        $("#add-spot-intro-box").show();
-    }
-    $("#add-spot-intro-box-dismiss").click(function () {
-        localStorage.setItem("add-spot-intro-box-dismissed", true);
-    });
-}
-
-// Startup
-$(document).ready(function () {
-    // Load options
-    loadOptions();
-    // Display intro box
-    displayIntroBox();
-});

static/service-worker.js

@@ -1,78 +0,0 @@
-const CACHE_NAME = 'Spothole';
-const CACHE_URLS = [
-    'static/apidocs/openapi.yml',
-    'static/audio/ping.mp3',
-    'static/css/style.css',
-    'static/js/add-spot.js',
-    'static/js/alerts.js',
-    'static/js/bands.js',
-    'static/js/common.js',
-    'static/js/geo.js',
-    'static/js/map.js',
-    'static/js/spots.js',
-    'static/js/spotsbandsandmap.js',
-    'static/js/status.js',
-    'static/js/ui-ham.js',
-    'static/js/utils.js',
-    'static/img/logo.png',
-    'static/img/favicon.ico',
-    'static/img/icon-32.png',
-    'static/img/icon-192.png',
-    'static/img/icon-512.png',
-    'static/vendor/img/markers_default@2x.png',
-    'static/vendor/img/markers_shadow.png',
-    'static/vendor/img/markers_default.png',
-    'static/vendor/img/markers_shadow@2x.png',
-    'static/vendor/css/bootstrap-5.3.8.min.css',
-    'static/vendor/css/images/marker-icon.png',
-    'static/vendor/css/images/layers-2x.png',
-    'static/vendor/css/images/marker-shadow.png',
-    'static/vendor/css/images/layers.png',
-    'static/vendor/css/images/marker-icon-2x.png',
-    'static/vendor/css/leaflet-extra-markers-1.2.2.min.css',
-    'static/vendor/css/leaflet-1.9.4.min.css',
-    'static/vendor/css/fontawesome-6.7.2.min.css',
-    'static/vendor/css/solid-6.7.2.min.css',
-    'static/vendor/js/jquery-3.7.1.min.js',
-    'static/vendor/js/chart-4.4.9.umd.min.js',
-    'static/vendor/js/oms-leaflet-0.2.7.min.js',
-    'static/vendor/js/leaflet-workedallbritainireland.js',
-    'static/vendor/js/leaflet-providers-2.0.0.js',
-    'static/vendor/js/text-image-0.7.0.js',
-    'static/vendor/js/leaflet-vectorgrid-1.3.0.js',
-    'static/vendor/js/leaflet-ituzones.js',
-    'static/vendor/js/tinycolor2-1.6.0.min.js',
-    'static/vendor/js/bootstrap-5.3.8.bundle.min.js',
-    'static/vendor/js/moment-2.29.4.min.js',
-    'static/vendor/js/leaflet-cqzones.js',
-    'static/vendor/js/leaflet-extra-markers-1.2.2.min.js',
-    'static/vendor/js/leaflet-terminator-1.1.0.min.js',
-    'static/vendor/js/leaflet-1.9.4.min.js',
-    'static/vendor/js/leaflet-geodesic-2.7.2.umd.min.js',
-    'static/vendor/js/leaflet-maidenhead.js',
-    'static/vendor/webfonts/fa-solid-900.ttf',
-    'static/vendor/webfonts/fa-solid-900.woff2'
-];
-
-self.addEventListener('fetch', (event) => {
-    // Is this an asset we can cache?
-    const url = new URL(event.request.url);
-    const isCacheableRequest = CACHE_URLS.includes(url.pathname);
-
-    if (isCacheableRequest) {
-        // Open the cache
-        event.respondWith(caches.open(CACHE_NAME).then((cache) => {
-            // Go to the network first, cacheing the response
-            return fetch(event.request.url).then((fetchedResponse) => {
-                cache.put(event.request, fetchedResponse.clone());
-
-                return fetchedResponse;
-            }).catch(() => {
-                // If the network is unavailable, get from cache.
-                return cache.match(event.request.url);
-            });
-        }));
-    } else {
-        // Not a cacheable request, must be a call to the API, so no cache involved just go to the network
-    }
-});

static/vendor/js/modules/geodesy/LICENSE

@@ -1,22 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2014 Chris Veness
-With some additional code & modifications by Ian Renton, 2025
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

static/vendor/js/modules/geodesy/iegridref.js

@@ -1,326 +0,0 @@
-/* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -  */
-/* Ordnance Survey of Ireland Grid Reference funcs   (c) Chris Veness 2005-2021 & Ian Renton 2025 */
-/*                                                                                   MIT Licence  */
-/* www.movable-type.co.uk/scripts/latlong-gridref.html                                            */
-/* www.movable-type.co.uk/scripts/geodesy-library.html#IeGridRef                                  */
-/* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -  */
-
-import LatLonEllipsoidal, { Dms } from 'https://cdn.jsdelivr.net/npm/geodesy@2/latlon-ellipsoidal-datum.js';
-
-
-/**
- * Ordnance Survey of Ireland & Northern Ireland grid reference calculations, based on the
- * IeGridRef class in the geodesy library at https://github.com/chrisveness/geodesy
- */
-
-/* IeGridRef  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
-
-
-const nationalGrid = {
-    trueOrigin:  { lat: 53.5, lon: -8 },                 // true origin of Irish grid 53°30′N, 8°W
-    falseOrigin: { easting: -200e3, northing: -250e3 }, // easting & northing of false origin, metres from true origin
-    scaleFactor: 1.000035,                         // scale factor on central meridian
-    ellipsoid:   LatLonEllipsoidal.ellipsoids.Airy1830,
-};
-
-/**
- * Irish Grid References with methods to parse and convert them to latitude/longitude points.
- */
-class IeGridRef {
-
-    /**
-     * Creates an IeGridRef object.
-     *
-     * @param {number} easting - Easting in metres from OS Grid false origin.
-     * @param {number} northing - Northing in metres from OS Grid false origin.
-     *
-     * @example
-     *   import IeGridRef from '/js/geodesy/IeGridRef.js';
-     *   const gridref = new IeGridRef(651409, 313177);
-     */
-    constructor(easting, northing) {
-        this.easting = Number(easting);
-        this.northing = Number(northing);
-
-        if (isNaN(easting)  || this.easting<0  || this.easting>7000e3) throw new RangeError(`invalid easting ‘${easting}’`);
-        if (isNaN(northing) || this.northing<0 || this.northing>13000e3) throw new RangeError(`invalid northing ‘${northing}’`);
-    }
-
-
-    /**
-     * Converts ‘this’ Irish Grid Reference easting/northing coordinate to latitude/longitude
-     * (SW corner of grid square).
-     *
-     * While OS Grid References are based on OSGB-36, the Ordnance Survey have deprecated the use of
-     * OSGB-36 for latitude/longitude coordinates (in favour of WGS-84), hence this function returns
-     * WGS-84 by default, with OSGB-36 as an option. See www.ordnancesurvey.co.uk/blog/2014/12/2.
-     *
-     * Note formulation implemented here due to Thomas, Redfearn, etc is as published by OS, but is
-     * inferior to Krüger as used by e.g. Karney 2011.
-     *
-     * @param   {LatLon.datum} [datum=WGS84] - Datum to convert grid reference into.
-     * @returns {LatLon}       Latitude/longitude of supplied grid reference.
-     *
-     * @example
-     *   const gridref = new IeGridRef(651409.903, 313177.270);
-     *   const pWgs84 = gridref.toLatLon();                    // 52°39′28.723″N, 001°42′57.787″E
-     *   // to obtain (historical) OSGB36 lat/lon point:
-     *   const pOsgb = gridref.toLatLon(LatLon.datums.OSGB36); // 52°39′27.253″N, 001°43′04.518″E
-     */
-    toLatLon(datum=LatLonEllipsoidal.datums.WGS84) {
-        const { easting: E, northing: N } = this;
-
-        const { a, b } = nationalGrid.ellipsoid;            // a = 6377563.396, b = 6356256.909
-        const φ0 = nationalGrid.trueOrigin.lat.toRadians(); // latitude of true origin
-        const λ0 = nationalGrid.trueOrigin.lon.toRadians(); // longitude of true origin
-        const E0 = -nationalGrid.falseOrigin.easting;       // easting of true origin
-        const N0 = -nationalGrid.falseOrigin.northing;      // northing of true origin
-        const F0 = nationalGrid.scaleFactor;                // scale factor
-
-        const e2 = 1 - (b*b)/(a*a);                         // eccentricity squared
-        const n = (a-b)/(a+b), n2 = n*n, n3 = n*n*n;        // n, n², n³
-
-        let φ=φ0, M=0;
-        do {
-            φ = (N-N0-M)/(a*F0) + φ;
-
-            const Ma = (1 + n + (5/4)*n2 + (5/4)*n3) * (φ-φ0);
-            const Mb = (3*n + 3*n2 + (21/8)*n3) * Math.sin(φ-φ0) * Math.cos(φ+φ0);
-            const Mc = ((15/8)*n2 + (15/8)*n3) * Math.sin(2*(φ-φ0)) * Math.cos(2*(φ+φ0));
-            const Md = (35/24)*n3 * Math.sin(3*(φ-φ0)) * Math.cos(3*(φ+φ0));
-            M = b * F0 * (Ma - Mb + Mc - Md);                // meridional arc
-
-        } while (Math.abs(N-N0-M) >= 0.00001);  // ie until < 0.01mm
-
-        const cosφ = Math.cos(φ), sinφ = Math.sin(φ);
-        const ν = a*F0/Math.sqrt(1-e2*sinφ*sinφ);            // nu = transverse radius of curvature
-        const ρ = a*F0*(1-e2)/Math.pow(1-e2*sinφ*sinφ, 1.5); // rho = meridional radius of curvature
-        const η2 = ν/ρ-1;                                    // eta = ?
-
-        const tanφ = Math.tan(φ);
-        const tan2φ = tanφ*tanφ, tan4φ = tan2φ*tan2φ, tan6φ = tan4φ*tan2φ;
-        const secφ = 1/cosφ;
-        const ν3 = ν*ν*ν, ν5 = ν3*ν*ν, ν7 = ν5*ν*ν;
-        const VII = tanφ/(2*ρ*ν);
-        const VIII = tanφ/(24*ρ*ν3)*(5+3*tan2φ+η2-9*tan2φ*η2);
-        const IX = tanφ/(720*ρ*ν5)*(61+90*tan2φ+45*tan4φ);
-        const X = secφ/ν;
-        const XI = secφ/(6*ν3)*(ν/ρ+2*tan2φ);
-        const XII = secφ/(120*ν5)*(5+28*tan2φ+24*tan4φ);
-        const XIIA = secφ/(5040*ν7)*(61+662*tan2φ+1320*tan4φ+720*tan6φ);
-
-        const dE = (E-E0), dE2 = dE*dE, dE3 = dE2*dE, dE4 = dE2*dE2, dE5 = dE3*dE2, dE6 = dE4*dE2, dE7 = dE5*dE2;
-        φ = φ - VII*dE2 + VIII*dE4 - IX*dE6;
-        const λ = λ0 + X*dE - XI*dE3 + XII*dE5 - XIIA*dE7;
-
-        let point = new LatLon_IeGridRef(φ.toDegrees(), λ.toDegrees(), 0, LatLonEllipsoidal.datums.OSGB36);
-
-        if (datum != LatLonEllipsoidal.datums.OSGB36) {
-            // if point is required in datum other than OSGB36, convert it
-            point = point.convertDatum(datum);
-            // convertDatum() gives us a LatLon: convert to LatLon_IeGridRef which includes toOsGrid()
-            point = new LatLon_IeGridRef(point.lat, point.lon, point.height, point.datum);
-        }
-
-        return point;
-    }
-
-
-    /**
-     * Parses grid reference to IeGridRef object.
-     *
-     * Accepts standard grid references (eg 'G 387 148'), with or without whitespace separators, from
-     * two-digit references up to 10-digit references (1m × 1m square), or fully numeric comma-separated
-     * references in metres (eg '438700,114800').
-     *
-     * @param   {string}    gridref - Standard format OS Grid Reference.
-     * @returns {IeGridRef} Numeric version of grid reference in metres from false origin (SW corner of
-     *   supplied grid square).
-     * @throws  {Error}     Invalid grid reference.
-     *
-     * @example
-     *   const grid = IeGridRef.parse('G 51409 13177'); // grid: { easting: 651409, northing: 313177 }
-     */
-    static parse(gridref) {
-        gridref = String(gridref).trim();
-
-        // check for fully numeric comma-separated gridref format
-        let match = gridref.match(/^(\d+),\s*(\d+)$/);
-        if (match) return new IeGridRef(match[1], match[2]);
-
-        // validate format
-        match = gridref.match(/^[ABCDEFGHJKLMNOPQRSTUVWXYZ]\s*[0-9]+\s*[0-9]+$/i);
-        if (!match) throw new Error(`invalid grid reference ‘${gridref}’`);
-
-        // get numeric values of letter references, mapping A->0, B->1, C->2, etc:
-        let l1 = gridref.toUpperCase().charCodeAt(0) - 'A'.charCodeAt(0); // 100km square
-        // shuffle down letters after 'I' since 'I' is not used in grid:
-        if (l1 > 7) l1--;
-
-        // convert grid letters into 100km-square indexes from false origin (grid square SV):
-        const e100km = l1 % 5;
-        const n100km = 4 - Math.floor(l1 / 5);
-
-        // skip grid letters to get numeric (easting/northing) part of ref
-        let en = gridref.slice(1).trim().split(/\s+/);
-        // if e/n not whitespace separated, split half way
-        if (en.length == 1) en = [ en[0].slice(0, en[0].length / 2), en[0].slice(en[0].length / 2) ];
-
-        // validation
-        if (en[0].length != en[1].length) throw new Error(`invalid grid reference ‘${gridref}’`);
-
-        // standardise to 10-digit refs (metres)
-        en[0] = en[0].padEnd(5, '0');
-        en[1] = en[1].padEnd(5, '0');
-
-        const e = e100km + en[0];
-        const n = n100km + en[1];
-
-        return new IeGridRef(e, n);
-    }
-
-
-    /**
-     * Converts ‘this’ numeric grid reference to standard OS of Ireland Grid Reference.
-     *
-     * @param   {number} [digits=10] - Precision of returned grid reference (10 digits = metres);
-     *   digits=0 will return grid reference in numeric format.
-     * @returns {string} This grid reference in standard format.
-     *
-     * @example
-     *   const gridref = new IeGridRef(651409, 313177).toString(8); // 'TG 5140 1317'
-     *   const gridref = new IeGridRef(651409, 313177).toString(0); // '651409,313177'
-     */
-    toString(digits=10) {
-        if (![ 0,2,4,6,8,10,12,14,16 ].includes(Number(digits))) throw new RangeError(`invalid precision ‘${digits}’`); // eslint-disable-line comma-spacing
-
-        let { easting: e, northing: n } = this;
-
-        // use digits = 0 to return numeric format (in metres) - note northing may be >= 1e7
-        if (digits == 0) {
-            const format = { useGrouping: false,  minimumIntegerDigits: 6, maximumFractionDigits: 3 };
-            const ePad = e.toLocaleString('en', format);
-            const nPad = n.toLocaleString('en', format);
-            return `${ePad},${nPad}`;
-        }
-
-        // get the 100km-grid indices
-        const e100km = Math.floor(e / 100000), n100km = Math.floor(n / 100000);
-
-        // translate those into the numeric equivalent of the grid letters
-        let l1 = (n100km) * 5 % 25 + e100km % 5;
-        return null; // haven't done this maths yet
-
-        // compensate for skipped 'I' and calculate grid letter
-        if (l1 > 7) l1++;
-        const letter = String.fromCharCode(l1 + 'A'.charCodeAt(0));
-
-        // strip 100km-grid indices from easting & northing, and reduce precision
-        e = Math.floor((e % 100000) / Math.pow(10, 5 - digits / 2));
-        n = Math.floor((n % 100000) / Math.pow(10, 5 - digits / 2));
-
-        // pad eastings & northings with leading zeros
-        e = e.toString().padStart(digits/2, '0');
-        n = n.toString().padStart(digits/2, '0');
-
-        return `${letter} ${e} ${n}`;
-    }
-
-}
-
-
-/* LatLon_IeGridRef - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
-
-
-/**
- * Extends LatLon class with method to convert LatLon point to Irish Grid Reference.
- *
- * @extends LatLonEllipsoidal
- */
-class LatLon_IeGridRef extends LatLonEllipsoidal {
-
-    /**
-     * Converts latitude/longitude to Ordnance Survey of Ireland grid reference easting/northing coordinate.
-     *
-     * @returns {IeGridRef} Irish Grid Reference easting/northing.
-     *
-     * @example
-     *   const grid = new LatLon(52.65798, 1.71605).toOsGrid(); // TG 51409 13177
-     *   // for conversion of (historical) OSGB36 latitude/longitude point:
-     *   const grid = new LatLon(52.65798, 1.71605).toOsGrid(LatLon.datums.OSGB36);
-     */
-    toOsGrid() {
-        // if necessary convert to OSGB36 first
-        const point = this.datum == LatLonEllipsoidal.datums.OSGB36
-            ? this
-            : this.convertDatum(LatLonEllipsoidal.datums.OSGB36);
-
-        const φ = point.lat.toRadians();
-        const λ = point.lon.toRadians();
-
-        const { a, b } = nationalGrid.ellipsoid;            // a = 6377563.396, b = 6356256.909
-        const φ0 = nationalGrid.trueOrigin.lat.toRadians(); // latitude of true origin
-        const λ0 = nationalGrid.trueOrigin.lon.toRadians(); // longitude of true origin
-        const E0 = -nationalGrid.falseOrigin.easting;       // easting of true origin
-        const N0 = -nationalGrid.falseOrigin.northing;      // northing of true origin
-        const F0 = nationalGrid.scaleFactor;                // scale factor
-
-        const e2 = 1 - (b*b)/(a*a);                          // eccentricity squared
-        const n = (a-b)/(a+b), n2 = n*n, n3 = n*n*n;         // n, n², n³
-
-        const cosφ = Math.cos(φ), sinφ = Math.sin(φ);
-        const ν = a*F0/Math.sqrt(1-e2*sinφ*sinφ);            // nu = transverse radius of curvature
-        const ρ = a*F0*(1-e2)/Math.pow(1-e2*sinφ*sinφ, 1.5); // rho = meridional radius of curvature
-        const η2 = ν/ρ-1;                                    // eta = ?
-
-        const Ma = (1 + n + (5/4)*n2 + (5/4)*n3) * (φ-φ0);
-        const Mb = (3*n + 3*n2 + (21/8)*n3) * Math.sin(φ-φ0) * Math.cos(φ+φ0);
-        const Mc = ((15/8)*n2 + (15/8)*n3) * Math.sin(2*(φ-φ0)) * Math.cos(2*(φ+φ0));
-        const Md = (35/24)*n3 * Math.sin(3*(φ-φ0)) * Math.cos(3*(φ+φ0));
-        const M = b * F0 * (Ma - Mb + Mc - Md);              // meridional arc
-
-        const cos3φ = cosφ*cosφ*cosφ;
-        const cos5φ = cos3φ*cosφ*cosφ;
-        const tan2φ = Math.tan(φ)*Math.tan(φ);
-        const tan4φ = tan2φ*tan2φ;
-
-        const I = M + N0;
-        const II = (ν/2)*sinφ*cosφ;
-        const III = (ν/24)*sinφ*cos3φ*(5-tan2φ+9*η2);
-        const IIIA = (ν/720)*sinφ*cos5φ*(61-58*tan2φ+tan4φ);
-        const IV = ν*cosφ;
-        const V = (ν/6)*cos3φ*(ν/ρ-tan2φ);
-        const VI = (ν/120) * cos5φ * (5 - 18*tan2φ + tan4φ + 14*η2 - 58*tan2φ*η2);
-
-        const Δλ = λ-λ0;
-        const Δλ2 = Δλ*Δλ, Δλ3 = Δλ2*Δλ, Δλ4 = Δλ3*Δλ, Δλ5 = Δλ4*Δλ, Δλ6 = Δλ5*Δλ;
-
-        let N = I + II*Δλ2 + III*Δλ4 + IIIA*Δλ6;
-        let E = E0 + IV*Δλ + V*Δλ3 + VI*Δλ5;
-
-        N = Number(N.toFixed(3)); // round to mm precision
-        E = Number(E.toFixed(3));
-
-        try {
-            return new IeGridRef(E, N); // note: gets truncated to SW corner of 1m grid square
-        } catch (e) {
-            throw new Error(`${e.message} from (${point.lat.toFixed(6)},${point.lon.toFixed(6)}).toOsGrid()`);
-        }
-    }
-
-
-    /**
-     * Override LatLonEllipsoidal.convertDatum() with version which returns LatLon_IeGridRef.
-     */
-    convertDatum(toDatum) {
-        const osieED = super.convertDatum(toDatum); // returns LatLonEllipsoidal_Datum
-        const osieOSGR = new LatLon_IeGridRef(osieED.lat, osieED.lon, osieED.height, osieED.datum);
-        return osieOSGR;
-    }
-
-}
-
-
-/* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -  */
-
-export { IeGridRef as default, LatLon_IeGridRef as LatLon, Dms };

static/vendor/js/modules/geodesy/osgridref.js

@@ -1,348 +0,0 @@
-/* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -  */
-/* Ordnance Survey Grid Reference functions                           (c) Chris Veness 2005-2021  */
-/*                                                                                   MIT Licence  */
-/* www.movable-type.co.uk/scripts/latlong-gridref.html                                            */
-/* www.movable-type.co.uk/scripts/geodesy-library.html#osgridref                                  */
-/* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -  */
-
-import LatLonEllipsoidal, { Dms } from 'https://cdn.jsdelivr.net/npm/geodesy@2/latlon-ellipsoidal-datum.js';
-
-
-/**
- * Ordnance Survey OSGB grid references provide geocoordinate references for UK mapping purposes.
- *
- * Formulation implemented here due to Thomas, Redfearn, etc is as published by OS, but is inferior
- * to Krüger as used by e.g. Karney 2011.
- *
- * www.ordnancesurvey.co.uk/documents/resources/guide-coordinate-systems-great-britain.pdf.
- *
- * Note OSGB grid references cover Great Britain only; Ireland and the Channel Islands have their
- * own references.
- *
- * Note that these formulae are based on ellipsoidal calculations, and according to the OS are
- * accurate to about 4–5 metres – for greater accuracy, a geoid-based transformation (OSTN15) must
- * be used.
- */
-
-/*
- * Converted 2015 to work with WGS84 by default, OSGB36 as option;
- * www.ordnancesurvey.co.uk/blog/2014/12/confirmation-on-changes-to-latitude-and-longitude
- */
-
-
-/* OsGridRef  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
-
-
-const nationalGrid = {
-    trueOrigin:  { lat: 49, lon: -2 },                 // true origin of grid 49°N,2°W on OSGB36 datum
-    falseOrigin: { easting: -400e3, northing: 100e3 }, // easting & northing of false origin, metres from true origin
-    scaleFactor: 0.9996012717,                         // scale factor on central meridian
-    ellipsoid:   LatLonEllipsoidal.ellipsoids.Airy1830,
-};
-// note Irish National Grid uses t/o 53°30′N, 8°W, f/o 200kmW, 250kmS, scale factor 1.000035, on Airy 1830 Modified ellipsoid
-
-
-/**
- * OS Grid References with methods to parse and convert them to latitude/longitude points.
- */
-class OsGridRef {
-
-    /**
-     * Creates an OsGridRef object.
-     *
-     * @param {number} easting - Easting in metres from OS Grid false origin.
-     * @param {number} northing - Northing in metres from OS Grid false origin.
-     *
-     * @example
-     *   import OsGridRef from '/js/geodesy/osgridref.js';
-     *   const gridref = new OsGridRef(651409, 313177);
-     */
-    constructor(easting, northing) {
-        this.easting = Number(easting);
-        this.northing = Number(northing);
-
-        if (isNaN(easting)  || this.easting<0  || this.easting>700e3) throw new RangeError(`invalid easting ‘${easting}’`);
-        if (isNaN(northing) || this.northing<0 || this.northing>1300e3) throw new RangeError(`invalid northing ‘${northing}’`);
-    }
-
-
-    /**
-     * Converts ‘this’ Ordnance Survey Grid Reference easting/northing coordinate to latitude/longitude
-     * (SW corner of grid square).
-     *
-     * While OS Grid References are based on OSGB-36, the Ordnance Survey have deprecated the use of
-     * OSGB-36 for latitude/longitude coordinates (in favour of WGS-84), hence this function returns
-     * WGS-84 by default, with OSGB-36 as an option. See www.ordnancesurvey.co.uk/blog/2014/12/2.
-     *
-     * Note formulation implemented here due to Thomas, Redfearn, etc is as published by OS, but is
-     * inferior to Krüger as used by e.g. Karney 2011.
-     *
-     * @param   {LatLon.datum} [datum=WGS84] - Datum to convert grid reference into.
-     * @returns {LatLon}       Latitude/longitude of supplied grid reference.
-     *
-     * @example
-     *   const gridref = new OsGridRef(651409.903, 313177.270);
-     *   const pWgs84 = gridref.toLatLon();                    // 52°39′28.723″N, 001°42′57.787″E
-     *   // to obtain (historical) OSGB36 lat/lon point:
-     *   const pOsgb = gridref.toLatLon(LatLon.datums.OSGB36); // 52°39′27.253″N, 001°43′04.518″E
-     */
-    toLatLon(datum=LatLonEllipsoidal.datums.WGS84) {
-        const { easting: E, northing: N } = this;
-
-        const { a, b } = nationalGrid.ellipsoid;            // a = 6377563.396, b = 6356256.909
-        const φ0 = nationalGrid.trueOrigin.lat.toRadians(); // latitude of true origin, 49°N
-        const λ0 = nationalGrid.trueOrigin.lon.toRadians(); // longitude of true origin, 2°W
-        const E0 = -nationalGrid.falseOrigin.easting;       // easting of true origin, 400km
-        const N0 = -nationalGrid.falseOrigin.northing;      // northing of true origin, -100km
-        const F0 = nationalGrid.scaleFactor;                // 0.9996012717
-
-        const e2 = 1 - (b*b)/(a*a);                         // eccentricity squared
-        const n = (a-b)/(a+b), n2 = n*n, n3 = n*n*n;        // n, n², n³
-
-        let φ=φ0, M=0;
-        do {
-            φ = (N-N0-M)/(a*F0) + φ;
-
-            const Ma = (1 + n + (5/4)*n2 + (5/4)*n3) * (φ-φ0);
-            const Mb = (3*n + 3*n2 + (21/8)*n3) * Math.sin(φ-φ0) * Math.cos(φ+φ0);
-            const Mc = ((15/8)*n2 + (15/8)*n3) * Math.sin(2*(φ-φ0)) * Math.cos(2*(φ+φ0));
-            const Md = (35/24)*n3 * Math.sin(3*(φ-φ0)) * Math.cos(3*(φ+φ0));
-            M = b * F0 * (Ma - Mb + Mc - Md);                // meridional arc
-
-        } while (Math.abs(N-N0-M) >= 0.00001);  // ie until < 0.01mm
-
-        const cosφ = Math.cos(φ), sinφ = Math.sin(φ);
-        const ν = a*F0/Math.sqrt(1-e2*sinφ*sinφ);            // nu = transverse radius of curvature
-        const ρ = a*F0*(1-e2)/Math.pow(1-e2*sinφ*sinφ, 1.5); // rho = meridional radius of curvature
-        const η2 = ν/ρ-1;                                    // eta = ?
-
-        const tanφ = Math.tan(φ);
-        const tan2φ = tanφ*tanφ, tan4φ = tan2φ*tan2φ, tan6φ = tan4φ*tan2φ;
-        const secφ = 1/cosφ;
-        const ν3 = ν*ν*ν, ν5 = ν3*ν*ν, ν7 = ν5*ν*ν;
-        const VII = tanφ/(2*ρ*ν);
-        const VIII = tanφ/(24*ρ*ν3)*(5+3*tan2φ+η2-9*tan2φ*η2);
-        const IX = tanφ/(720*ρ*ν5)*(61+90*tan2φ+45*tan4φ);
-        const X = secφ/ν;
-        const XI = secφ/(6*ν3)*(ν/ρ+2*tan2φ);
-        const XII = secφ/(120*ν5)*(5+28*tan2φ+24*tan4φ);
-        const XIIA = secφ/(5040*ν7)*(61+662*tan2φ+1320*tan4φ+720*tan6φ);
-
-        const dE = (E-E0), dE2 = dE*dE, dE3 = dE2*dE, dE4 = dE2*dE2, dE5 = dE3*dE2, dE6 = dE4*dE2, dE7 = dE5*dE2;
-        φ = φ - VII*dE2 + VIII*dE4 - IX*dE6;
-        const λ = λ0 + X*dE - XI*dE3 + XII*dE5 - XIIA*dE7;
-
-        let point = new LatLon_OsGridRef(φ.toDegrees(), λ.toDegrees(), 0, LatLonEllipsoidal.datums.OSGB36);
-
-        if (datum != LatLonEllipsoidal.datums.OSGB36) {
-            // if point is required in datum other than OSGB36, convert it
-            point = point.convertDatum(datum);
-            // convertDatum() gives us a LatLon: convert to LatLon_OsGridRef which includes toOsGrid()
-            point = new LatLon_OsGridRef(point.lat, point.lon, point.height, point.datum);
-        }
-
-        return point;
-    }
-
-
-    /**
-     * Parses grid reference to OsGridRef object.
-     *
-     * Accepts standard grid references (eg 'SU 387 148'), with or without whitespace separators, from
-     * two-digit references up to 10-digit references (1m × 1m square), or fully numeric comma-separated
-     * references in metres (eg '438700,114800').
-     *
-     * @param   {string}    gridref - Standard format OS Grid Reference.
-     * @returns {OsGridRef} Numeric version of grid reference in metres from false origin (SW corner of
-     *   supplied grid square).
-     * @throws  {Error}     Invalid grid reference.
-     *
-     * @example
-     *   const grid = OsGridRef.parse('TG 51409 13177'); // grid: { easting: 651409, northing: 313177 }
-     */
-    static parse(gridref) {
-        gridref = String(gridref).trim();
-
-        // check for fully numeric comma-separated gridref format
-        let match = gridref.match(/^(\d+),\s*(\d+)$/);
-        if (match) return new OsGridRef(match[1], match[2]);
-
-        // validate format
-        match = gridref.match(/^[HNOST][ABCDEFGHJKLMNOPQRSTUVWXYZ]\s*[0-9]+\s*[0-9]+$/i);
-        if (!match) throw new Error(`invalid grid reference ‘${gridref}’`);
-
-        // get numeric values of letter references, mapping A->0, B->1, C->2, etc:
-        let l1 = gridref.toUpperCase().charCodeAt(0) - 'A'.charCodeAt(0); // 500km square
-        let l2 = gridref.toUpperCase().charCodeAt(1) - 'A'.charCodeAt(0); // 100km square
-        // shuffle down letters after 'I' since 'I' is not used in grid:
-        if (l1 > 7) l1--;
-        if (l2 > 7) l2--;
-
-        // convert grid letters into 100km-square indexes from false origin (grid square SV):
-        const e100km = ((l1 - 2) % 5) * 5 + (l2 % 5);
-        const n100km = (19 - Math.floor(l1 / 5) * 5) - Math.floor(l2 / 5);
-
-        // skip grid letters to get numeric (easting/northing) part of ref
-        let en = gridref.slice(2).trim().split(/\s+/);
-        // if e/n not whitespace separated, split half way
-        if (en.length == 1) en = [ en[0].slice(0, en[0].length / 2), en[0].slice(en[0].length / 2) ];
-
-        // validation
-        if (en[0].length != en[1].length) throw new Error(`invalid grid reference ‘${gridref}’`);
-
-        // standardise to 10-digit refs (metres)
-        en[0] = en[0].padEnd(5, '0');
-        en[1] = en[1].padEnd(5, '0');
-
-        const e = e100km + en[0];
-        const n = n100km + en[1];
-
-        return new OsGridRef(e, n);
-    }
-
-
-    /**
-     * Converts ‘this’ numeric grid reference to standard OS Grid Reference.
-     *
-     * @param   {number} [digits=10] - Precision of returned grid reference (10 digits = metres);
-     *   digits=0 will return grid reference in numeric format.
-     * @returns {string} This grid reference in standard format.
-     *
-     * @example
-     *   const gridref = new OsGridRef(651409, 313177).toString(8); // 'TG 5140 1317'
-     *   const gridref = new OsGridRef(651409, 313177).toString(0); // '651409,313177'
-     */
-    toString(digits=10) {
-        if (![ 0,2,4,6,8,10,12,14,16 ].includes(Number(digits))) throw new RangeError(`invalid precision ‘${digits}’`); // eslint-disable-line comma-spacing
-
-        let { easting: e, northing: n } = this;
-
-        // use digits = 0 to return numeric format (in metres) - note northing may be >= 1e7
-        if (digits == 0) {
-            const format = { useGrouping: false,  minimumIntegerDigits: 6, maximumFractionDigits: 3 };
-            const ePad = e.toLocaleString('en', format);
-            const nPad = n.toLocaleString('en', format);
-            return `${ePad},${nPad}`;
-        }
-
-        // get the 100km-grid indices
-        const e100km = Math.floor(e / 100000), n100km = Math.floor(n / 100000);
-
-        // translate those into numeric equivalents of the grid letters
-        let l1 = (19 - n100km) - (19 - n100km) % 5 + Math.floor((e100km + 10) / 5);
-        let l2 = (19 - n100km) * 5 % 25 + e100km % 5;
-
-        // compensate for skipped 'I' and build grid letter-pairs
-        if (l1 > 7) l1++;
-        if (l2 > 7) l2++;
-        const letterPair = String.fromCharCode(l1 + 'A'.charCodeAt(0), l2 + 'A'.charCodeAt(0));
-
-        // strip 100km-grid indices from easting & northing, and reduce precision
-        e = Math.floor((e % 100000) / Math.pow(10, 5 - digits / 2));
-        n = Math.floor((n % 100000) / Math.pow(10, 5 - digits / 2));
-
-        // pad eastings & northings with leading zeros
-        e = e.toString().padStart(digits/2, '0');
-        n = n.toString().padStart(digits/2, '0');
-
-        return `${letterPair} ${e} ${n}`;
-    }
-
-}
-
-
-/* LatLon_OsGridRef - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
-
-
-/**
- * Extends LatLon class with method to convert LatLon point to OS Grid Reference.
- *
- * @extends LatLonEllipsoidal
- */
-class LatLon_OsGridRef extends LatLonEllipsoidal {
-
-    /**
-     * Converts latitude/longitude to Ordnance Survey grid reference easting/northing coordinate.
-     *
-     * @returns {OsGridRef} OS Grid Reference easting/northing.
-     *
-     * @example
-     *   const grid = new LatLon(52.65798, 1.71605).toOsGrid(); // TG 51409 13177
-     *   // for conversion of (historical) OSGB36 latitude/longitude point:
-     *   const grid = new LatLon(52.65798, 1.71605).toOsGrid(LatLon.datums.OSGB36);
-     */
-    toOsGrid() {
-        // if necessary convert to OSGB36 first
-        const point = this.datum == LatLonEllipsoidal.datums.OSGB36
-            ? this
-            : this.convertDatum(LatLonEllipsoidal.datums.OSGB36);
-
-        const φ = point.lat.toRadians();
-        const λ = point.lon.toRadians();
-
-        const { a, b } = nationalGrid.ellipsoid;            // a = 6377563.396, b = 6356256.909
-        const φ0 = nationalGrid.trueOrigin.lat.toRadians(); // latitude of true origin, 49°N
-        const λ0 = nationalGrid.trueOrigin.lon.toRadians(); // longitude of true origin, 2°W
-        const E0 = -nationalGrid.falseOrigin.easting;       // easting of true origin, 400km
-        const N0 = -nationalGrid.falseOrigin.northing;      // northing of true origin, -100km
-        const F0 = nationalGrid.scaleFactor;                // 0.9996012717
-
-        const e2 = 1 - (b*b)/(a*a);                          // eccentricity squared
-        const n = (a-b)/(a+b), n2 = n*n, n3 = n*n*n;         // n, n², n³
-
-        const cosφ = Math.cos(φ), sinφ = Math.sin(φ);
-        const ν = a*F0/Math.sqrt(1-e2*sinφ*sinφ);            // nu = transverse radius of curvature
-        const ρ = a*F0*(1-e2)/Math.pow(1-e2*sinφ*sinφ, 1.5); // rho = meridional radius of curvature
-        const η2 = ν/ρ-1;                                    // eta = ?
-
-        const Ma = (1 + n + (5/4)*n2 + (5/4)*n3) * (φ-φ0);
-        const Mb = (3*n + 3*n2 + (21/8)*n3) * Math.sin(φ-φ0) * Math.cos(φ+φ0);
-        const Mc = ((15/8)*n2 + (15/8)*n3) * Math.sin(2*(φ-φ0)) * Math.cos(2*(φ+φ0));
-        const Md = (35/24)*n3 * Math.sin(3*(φ-φ0)) * Math.cos(3*(φ+φ0));
-        const M = b * F0 * (Ma - Mb + Mc - Md);              // meridional arc
-
-        const cos3φ = cosφ*cosφ*cosφ;
-        const cos5φ = cos3φ*cosφ*cosφ;
-        const tan2φ = Math.tan(φ)*Math.tan(φ);
-        const tan4φ = tan2φ*tan2φ;
-
-        const I = M + N0;
-        const II = (ν/2)*sinφ*cosφ;
-        const III = (ν/24)*sinφ*cos3φ*(5-tan2φ+9*η2);
-        const IIIA = (ν/720)*sinφ*cos5φ*(61-58*tan2φ+tan4φ);
-        const IV = ν*cosφ;
-        const V = (ν/6)*cos3φ*(ν/ρ-tan2φ);
-        const VI = (ν/120) * cos5φ * (5 - 18*tan2φ + tan4φ + 14*η2 - 58*tan2φ*η2);
-
-        const Δλ = λ-λ0;
-        const Δλ2 = Δλ*Δλ, Δλ3 = Δλ2*Δλ, Δλ4 = Δλ3*Δλ, Δλ5 = Δλ4*Δλ, Δλ6 = Δλ5*Δλ;
-
-        let N = I + II*Δλ2 + III*Δλ4 + IIIA*Δλ6;
-        let E = E0 + IV*Δλ + V*Δλ3 + VI*Δλ5;
-
-        N = Number(N.toFixed(3)); // round to mm precision
-        E = Number(E.toFixed(3));
-
-        try {
-            return new OsGridRef(E, N); // note: gets truncated to SW corner of 1m grid square
-        } catch (e) {
-            throw new Error(`${e.message} from (${point.lat.toFixed(6)},${point.lon.toFixed(6)}).toOsGrid()`);
-        }
-    }
-
-
-    /**
-     * Override LatLonEllipsoidal.convertDatum() with version which returns LatLon_OsGridRef.
-     */
-    convertDatum(toDatum) {
-        const osgbED = super.convertDatum(toDatum); // returns LatLonEllipsoidal_Datum
-        const osgbOSGR = new LatLon_OsGridRef(osgbED.lat, osgbED.lon, osgbED.height, osgbED.datum);
-        return osgbOSGR;
-    }
-
-}
-
-
-/* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -  */
-
-export { OsGridRef as default, LatLon_OsGridRef as LatLon, Dms };

static/vendor/js/modules/geodesy/utm_ci.js

@@ -1,413 +0,0 @@
-/* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -  */
-/* UTM / WGS-84 Conversion Functions                (c) Chris Veness 2014-2022 & Ian Renton 2025  */
-/*                                                                                   MIT Licence  */
-/* www.movable-type.co.uk/scripts/latlong-utm-mgrs.html                                           */
-/* www.movable-type.co.uk/scripts/geodesy-library.html#utm                                        */
-/* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -  */
-
-/* eslint-disable indent */
-
-import LatLonEllipsoidal, { Dms } from 'https://cdn.jsdelivr.net/npm/geodesy@2/latlon-ellipsoidal-datum.js';
-
-
-/**
- * The Universal Transverse Mercator (UTM) system is a 2-dimensional Cartesian coordinate system
- * providing locations on the surface of the Earth.
- *
- * UTM is a set of 60 transverse Mercator projections, normally based on the WGS-84 ellipsoid.
- * Within each zone, coordinates are represented as eastings and northings, measures in metres; e.g.
- * ‘31 N 448251 5411932’.
- *
- * This method based on Karney 2011 ‘Transverse Mercator with an accuracy of a few nanometers’,
- * building on Krüger 1912 ‘Konforme Abbildung des Erdellipsoids in der Ebene’.
- *
- * @module utm
- */
-
-
-/* Utm  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
-
-
-/**
- * UTM coordinates, with functions to parse them and convert them to LatLon points.
- */
-class Utm {
-
-    /**
-     * Creates a Utm coordinate object comprising zone, hemisphere, easting, northing on a given
-     * datum (normally WGS84).
-     *
-     * @param  {number}        zone - UTM 6° longitudinal zone (1..60 covering 180°W..180°E).
-     * @param  {string}        hemisphere - N for northern hemisphere, S for southern hemisphere.
-     * @param  {number}        easting - Easting in metres from false easting (-500km from central meridian).
-     * @param  {number}        northing - Northing in metres from equator (N) or from false northing -10,000km (S).
-     * @param  {LatLon.datums} [datum=WGS84] - Datum UTM coordinate is based on.
-     * @param  {number}        [convergence=null] - Meridian convergence (bearing of grid north
-     *                         clockwise from true north), in degrees.
-     * @param  {number}        [scale=null] - Grid scale factor.
-     * @params {boolean=true}  verifyEN - Check easting/northing is within 'normal' values (may be
-     *                         suppressed for extended coherent coordinates or alternative datums
-     *                         e.g. ED50 (epsg.io/23029).
-     * @throws {TypeError} Invalid UTM coordinate.
-     *
-     * @example
-     *   import Utm from '/js/geodesy/utm.js';
-     *   const utmCoord = new Utm(31, 'N', 448251, 5411932);
-     */
-    constructor(zone, hemisphere, easting, northing, datum=LatLonEllipsoidal.datums.WGS84, convergence=null, scale=null, verifyEN=true) {
-        if (!(1<=zone && zone<=60)) throw new RangeError(`invalid UTM zone ‘${zone}’`);
-        if (zone != parseInt(zone)) throw new RangeError(`invalid UTM zone ‘${zone}’`);
-        if (typeof hemisphere != 'string' || !hemisphere.match(/[NS]/i)) throw new RangeError(`invalid UTM hemisphere ‘${hemisphere}’`);
-        if (verifyEN) { // (rough) range-check of E/N values
-            if (!(0<=easting && easting<=1000e3)) throw new RangeError(`invalid UTM easting ‘${easting}’`);
-            if (hemisphere.toUpperCase()=='N' && !(0<=northing && northing<9329006)) throw new RangeError(`invalid UTM northing ‘${northing}’`);
-            if (hemisphere.toUpperCase()=='S' && !(1116914<northing && northing<=10000e3)) throw new RangeError(`invalid UTM northing ‘${northing}’`);
-        }
-        if (!datum || datum.ellipsoid==undefined) throw new TypeError(`unrecognised datum ‘${datum}’`);
-
-        this.zone = Number(zone);
-        this.hemisphere = hemisphere.toUpperCase();
-        this.easting = Number(easting);
-        this.northing = Number(northing);
-        this.datum = datum;
-        this.convergence = convergence===null ? null : Number(convergence);
-        this.scale = scale===null ? null : Number(scale);
-    }
-
-
-    /**
-     * Converts UTM zone/easting/northing coordinate to latitude/longitude.
-     *
-     * Implements Karney’s method, using Krüger series to order n⁶, giving results accurate to 5nm
-     * for distances up to 3900km from the central meridian.
-     *
-     * @param   {Utm} utmCoord - UTM coordinate to be converted to latitude/longitude.
-     * @returns {LatLon} Latitude/longitude of supplied grid reference.
-     *
-     * @example
-     *   const grid = new Utm(31, 'N', 448251.795, 5411932.678);
-     *   const latlong = grid.toLatLon(); // 48°51′29.52″N, 002°17′40.20″E
-     */
-    toLatLon() {
-        const { zone: z, hemisphere: h } = this;
-
-        const falseEasting = 500e3, falseNorthing = 10000e3;
-
-        const { a, f } = this.datum.ellipsoid; // WGS-84: a = 6378137, f = 1/298.257223563;
-
-        const k0 = 0.9996; // UTM scale on the central meridian
-
-        const x = this.easting - falseEasting;                            // make x ± relative to central meridian
-        const y = h=='S' ? this.northing - falseNorthing : this.northing; // make y ± relative to equator
-
-        // ---- from Karney 2011 Eq 15-22, 36:
-
-        const e = Math.sqrt(f*(2-f)); // eccentricity
-        const n = f / (2 - f);        // 3rd flattening
-        const n2 = n*n, n3 = n*n2, n4 = n*n3, n5 = n*n4, n6 = n*n5;
-
-        const A = a/(1+n) * (1 + 1/4*n2 + 1/64*n4 + 1/256*n6); // 2πA is the circumference of a meridian
-
-        const η = x / (k0*A);
-        const ξ = y / (k0*A);
-
-        const β = [ null, // note β is one-based array (6th order Krüger expressions)
-            1/2*n - 2/3*n2 + 37/96*n3 -    1/360*n4 -   81/512*n5 +    96199/604800*n6,
-                   1/48*n2 +  1/15*n3 - 437/1440*n4 +   46/105*n5 - 1118711/3870720*n6,
-                            17/480*n3 -   37/840*n4 - 209/4480*n5 +      5569/90720*n6,
-                                     4397/161280*n4 -   11/504*n5 -  830251/7257600*n6,
-                                                   4583/161280*n5 -  108847/3991680*n6,
-                                                                 20648693/638668800*n6 ];
-
-        let ξʹ = ξ;
-        for (let j=1; j<=6; j++) ξʹ -= β[j] * Math.sin(2*j*ξ) * Math.cosh(2*j*η);
-
-        let ηʹ = η;
-        for (let j=1; j<=6; j++) ηʹ -= β[j] * Math.cos(2*j*ξ) * Math.sinh(2*j*η);
-
-        const sinhηʹ = Math.sinh(ηʹ);
-        const sinξʹ = Math.sin(ξʹ), cosξʹ = Math.cos(ξʹ);
-
-        const τʹ = sinξʹ / Math.sqrt(sinhηʹ*sinhηʹ + cosξʹ*cosξʹ);
-
-        let δτi = null;
-        let τi = τʹ;
-        do {
-            const σi = Math.sinh(e*Math.atanh(e*τi/Math.sqrt(1+τi*τi)));
-            const τiʹ = τi * Math.sqrt(1+σi*σi) - σi * Math.sqrt(1+τi*τi);
-            δτi = (τʹ - τiʹ)/Math.sqrt(1+τiʹ*τiʹ)
-                * (1 + (1-e*e)*τi*τi) / ((1-e*e)*Math.sqrt(1+τi*τi));
-            τi += δτi;
-        } while (Math.abs(δτi) > 1e-12); // using IEEE 754 δτi -> 0 after 2-3 iterations
-        // note relatively large convergence test as δτi toggles on ±1.12e-16 for eg 31 N 400000 5000000
-        const τ = τi;
-
-        const φ = Math.atan(τ);
-
-        let λ = Math.atan2(sinhηʹ, cosξʹ);
-
-        // ---- convergence: Karney 2011 Eq 26, 27
-
-        let p = 1;
-        for (let j=1; j<=6; j++) p -= 2*j*β[j] * Math.cos(2*j*ξ) * Math.cosh(2*j*η);
-        let q = 0;
-        for (let j=1; j<=6; j++) q += 2*j*β[j] * Math.sin(2*j*ξ) * Math.sinh(2*j*η);
-
-        const γʹ = Math.atan(Math.tan(ξʹ) * Math.tanh(ηʹ));
-        const γʺ = Math.atan2(q, p);
-
-        const γ = γʹ + γʺ;
-
-        // ---- scale: Karney 2011 Eq 28
-
-        const sinφ = Math.sin(φ);
-        const kʹ = Math.sqrt(1 - e*e*sinφ*sinφ) * Math.sqrt(1 + τ*τ) * Math.sqrt(sinhηʹ*sinhηʹ + cosξʹ*cosξʹ);
-        const kʺ = A / a / Math.sqrt(p*p + q*q);
-
-        const k = k0 * kʹ * kʺ;
-
-        // ------------
-
-        const λ0 = ((z-1)*6 - 180 + 3).toRadians(); // longitude of central meridian
-        λ += λ0; // move λ from zonal to global coordinates
-
-        // round to reasonable precision
-        const lat = Number(φ.toDegrees().toFixed(14)); // nm precision (1nm = 10^-14°)
-        const lon = Number(λ.toDegrees().toFixed(14)); // (strictly lat rounding should be φ⋅cosφ!)
-        const convergence = Number(γ.toDegrees().toFixed(9));
-        const scale = Number(k.toFixed(12));
-
-        const latLong = new LatLon_Utm(lat, lon, 0, this.datum);
-        // ... and add the convergence and scale into the LatLon object ... wonderful JavaScript!
-        latLong.convergence = convergence;
-        latLong.scale = scale;
-
-        return latLong;
-    }
-
-    /**
-     * Parses a Channel Islands (WA/WV) grid reference.
-     */
-    static parseChannelIslandGrid(gridref) {
-        // validate format
-        let match = gridref.match(/^W[AV]\s*[0-9]+\s*[0-9]+$/i);
-        if (!match) throw new Error(`invalid grid reference ‘${gridref}’`);
-
-        // skip grid letters to get numeric (easting/northing) part of ref
-        let en = gridref.slice(2).trim().split(/\s+/);
-        // if e/n not whitespace separated, split half way
-        if (en.length == 1) en = [ en[0].slice(0, en[0].length / 2), en[0].slice(en[0].length / 2) ];
-
-        // validation
-        if (en[0].length != en[1].length) throw new Error(`invalid grid reference ‘${gridref}’`);
-
-        // standardise to 10-digit refs (metres)
-        en[0] = en[0].padEnd(5, '0');
-        en[1] = en[1].padEnd(5, '0');
-
-        let utmCoord = "30 N ";
-        const e = 5 + en[0];
-        utmCoord += e + " ";
-        if (gridref.substring(0, 2) === "WA") {
-            const n = 55 + en[1];
-            utmCoord += n;
-        } else if (gridref.substring(0, 2) === "WV") {
-            const n = 54 + en[1];
-            utmCoord += n;
-        }
-
-        return Utm.parse(utmCoord);
-    }
-
-
-    /**
-     * Parses string representation of UTM coordinate.
-     *
-     * A UTM coordinate comprises (space-separated)
-     *  - zone
-     *  - hemisphere
-     *  - easting
-     *  - northing.
-     *
-     * @param   {string} utmCoord - UTM coordinate (WGS 84).
-     * @param   {Datum}  [datum=WGS84] - Datum coordinate is defined in (default WGS 84).
-     * @returns {Utm} Parsed UTM coordinate.
-     * @throws  {TypeError} Invalid UTM coordinate.
-     *
-     * @example
-     *   const utmCoord = Utm.parse('31 N 448251 5411932');
-     *   // utmCoord: {zone: 31, hemisphere: 'N', easting: 448251, northing: 5411932 }
-     */
-    static parse(utmCoord, datum=LatLonEllipsoidal.datums.WGS84) {
-        // match separate elements (separated by whitespace)
-        utmCoord = utmCoord.trim().match(/\S+/g);
-
-        if (utmCoord==null || utmCoord.length!=4) throw new Error(`invalid UTM coordinate ‘${utmCoord}’`);
-
-        const zone = utmCoord[0], hemisphere = utmCoord[1], easting = utmCoord[2], northing = utmCoord[3];
-
-        return new this(zone, hemisphere, easting, northing, datum); // 'new this' as may return subclassed types
-    }
-
-
-    /**
-     * Returns a string representation of a UTM coordinate.
-     *
-     * To distinguish from MGRS grid zone designators, a space is left between the zone and the
-     * hemisphere.
-     *
-     * Note that UTM coordinates get rounded, not truncated (unlike MGRS grid references).
-     *
-     * @param   {number} [digits=0] - Number of digits to appear after the decimal point (3 ≡ mm).
-     * @returns {string} A string representation of the coordinate.
-     *
-     * @example
-     *   const utm = new Utm('31', 'N', 448251, 5411932).toString(4);  // 31 N 448251.0000 5411932.0000
-     */
-    toString(digits=0) {
-
-        const z = this.zone.toString().padStart(2, '0');
-        const h = this.hemisphere;
-        const e = this.easting.toFixed(digits);
-        const n = this.northing.toFixed(digits);
-
-        return `${z} ${h} ${e} ${n}`;
-    }
-
-}
-
-
-/* LatLon_Utm - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
-
-
-/**
- * Extends LatLon with method to convert LatLon points to UTM coordinates.
- *
- * @extends LatLon
- */
-class LatLon_Utm extends LatLonEllipsoidal {
-
-    /**
-     * Converts latitude/longitude to UTM coordinate.
-     *
-     * Implements Karney’s method, using Krüger series to order n⁶, giving results accurate to 5nm
-     * for distances up to 3900km from the central meridian.
-     *
-     * @param   {number} [zoneOverride] - Use specified zone rather than zone within which point lies;
-     *          note overriding the UTM zone has the potential to result in negative eastings, and
-     *          perverse results within Norway/Svalbard exceptions.
-     * @returns {Utm} UTM coordinate.
-     * @throws  {TypeError} Latitude outside UTM limits.
-     *
-     * @example
-     *   const latlong = new LatLon(48.8582, 2.2945);
-     *   const utmCoord = latlong.toUtm(); // 31 N 448252 5411933
-     */
-    toUtm(zoneOverride=undefined) {
-        if (!(-80<=this.lat && this.lat<=84)) throw new RangeError(`latitude ‘${this.lat}’ outside UTM limits`);
-
-        const falseEasting = 500e3, falseNorthing = 10000e3;
-
-        let zone = zoneOverride || Math.floor((this.lon+180)/6) + 1; // longitudinal zone
-        let λ0 = ((zone-1)*6 - 180 + 3).toRadians(); // longitude of central meridian
-
-        // ---- handle Norway/Svalbard exceptions
-        // grid zones are 8° tall; 0°N is offset 10 into latitude bands array
-        const mgrsLatBands = 'CDEFGHJKLMNPQRSTUVWXX'; // X is repeated for 80-84°N
-        const latBand = mgrsLatBands.charAt(Math.floor(this.lat/8+10));
-        // adjust zone & central meridian for Norway
-        if (zone==31 && latBand=='V' && this.lon>= 3) { zone++; λ0 += (6).toRadians(); }
-        // adjust zone & central meridian for Svalbard
-        if (zone==32 && latBand=='X' && this.lon<  9) { zone--; λ0 -= (6).toRadians(); }
-        if (zone==32 && latBand=='X' && this.lon>= 9) { zone++; λ0 += (6).toRadians(); }
-        if (zone==34 && latBand=='X' && this.lon< 21) { zone--; λ0 -= (6).toRadians(); }
-        if (zone==34 && latBand=='X' && this.lon>=21) { zone++; λ0 += (6).toRadians(); }
-        if (zone==36 && latBand=='X' && this.lon< 33) { zone--; λ0 -= (6).toRadians(); }
-        if (zone==36 && latBand=='X' && this.lon>=33) { zone++; λ0 += (6).toRadians(); }
-
-        const φ = this.lat.toRadians();      // latitude ± from equator
-        const λ = this.lon.toRadians() - λ0; // longitude ± from central meridian
-
-        // allow alternative ellipsoid to be specified
-        const ellipsoid = this.datum ? this.datum.ellipsoid : LatLonEllipsoidal.ellipsoids.WGS84;
-        const { a, f } = ellipsoid; // WGS-84: a = 6378137, f = 1/298.257223563;
-
-        const k0 = 0.9996; // UTM scale on the central meridian
-
-        // ---- easting, northing: Karney 2011 Eq 7-14, 29, 35:
-
-        const e = Math.sqrt(f*(2-f)); // eccentricity
-        const n = f / (2 - f);        // 3rd flattening
-        const n2 = n*n, n3 = n*n2, n4 = n*n3, n5 = n*n4, n6 = n*n5;
-
-        const cosλ = Math.cos(λ), sinλ = Math.sin(λ), tanλ = Math.tan(λ);
-
-        const τ = Math.tan(φ); // τ ≡ tanφ, τʹ ≡ tanφʹ; prime (ʹ) indicates angles on the conformal sphere
-        const σ = Math.sinh(e*Math.atanh(e*τ/Math.sqrt(1+τ*τ)));
-
-        const τʹ = τ*Math.sqrt(1+σ*σ) - σ*Math.sqrt(1+τ*τ);
-
-        const ξʹ = Math.atan2(τʹ, cosλ);
-        const ηʹ = Math.asinh(sinλ / Math.sqrt(τʹ*τʹ + cosλ*cosλ));
-
-        const A = a/(1+n) * (1 + 1/4*n2 + 1/64*n4 + 1/256*n6); // 2πA is the circumference of a meridian
-
-        const α = [ null, // note α is one-based array (6th order Krüger expressions)
-            1/2*n - 2/3*n2 + 5/16*n3 +   41/180*n4 -     127/288*n5 +      7891/37800*n6,
-                  13/48*n2 -  3/5*n3 + 557/1440*n4 +     281/630*n5 - 1983433/1935360*n6,
-                           61/240*n3 -  103/140*n4 + 15061/26880*n5 +   167603/181440*n6,
-                                   49561/161280*n4 -     179/168*n5 + 6601661/7257600*n6,
-                                                     34729/80640*n5 - 3418889/1995840*n6,
-                                                                  212378941/319334400*n6 ];
-
-        let ξ = ξʹ;
-        for (let j=1; j<=6; j++) ξ += α[j] * Math.sin(2*j*ξʹ) * Math.cosh(2*j*ηʹ);
-
-        let η = ηʹ;
-        for (let j=1; j<=6; j++) η += α[j] * Math.cos(2*j*ξʹ) * Math.sinh(2*j*ηʹ);
-
-        let x = k0 * A * η;
-        let y = k0 * A * ξ;
-
-        // ---- convergence: Karney 2011 Eq 23, 24
-
-        let pʹ = 1;
-        for (let j=1; j<=6; j++) pʹ += 2*j*α[j] * Math.cos(2*j*ξʹ) * Math.cosh(2*j*ηʹ);
-        let qʹ = 0;
-        for (let j=1; j<=6; j++) qʹ += 2*j*α[j] * Math.sin(2*j*ξʹ) * Math.sinh(2*j*ηʹ);
-
-        const γʹ = Math.atan(τʹ / Math.sqrt(1+τʹ*τʹ)*tanλ);
-        const γʺ = Math.atan2(qʹ, pʹ);
-
-        const γ = γʹ + γʺ;
-
-        // ---- scale: Karney 2011 Eq 25
-
-        const sinφ = Math.sin(φ);
-        const kʹ = Math.sqrt(1 - e*e*sinφ*sinφ) * Math.sqrt(1 + τ*τ) / Math.sqrt(τʹ*τʹ + cosλ*cosλ);
-        const kʺ = A / a * Math.sqrt(pʹ*pʹ + qʹ*qʹ);
-
-        const k = k0 * kʹ * kʺ;
-
-        // ------------
-
-        // shift x/y to false origins
-        x = x + falseEasting;             // make x relative to false easting
-        if (y < 0) y = y + falseNorthing; // make y in southern hemisphere relative to false northing
-
-        // round to reasonable precision
-        x = Number(x.toFixed(9)); // nm precision
-        y = Number(y.toFixed(9)); // nm precision
-        const convergence = Number(γ.toDegrees().toFixed(9));
-        const scale = Number(k.toFixed(12));
-
-        const h = this.lat>=0 ? 'N' : 'S'; // hemisphere
-
-        return new Utm(zone, h, x, y, this.datum, convergence, scale, !!zoneOverride);
-    }
-}
-
-
-/* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -  */
-
-export { Utm as default, LatLon_Utm as LatLon, Dms };

templates/about.html

@@ -117,6 +117,7 @@
         <li>Some SIGs, such as Worked all Britain (WAB), don't have their own spotting site and can <em>only</em> be
             identified through comments on spots retrieved from other sources.
         </li>
+        <li>SIGs have well-defined names, whereas the server owner may name the sources as they see fit.</li>
     </ol>
     <p>Spothole's web interface exists not just for the end user, but also as a reference implementation for the API, so
         I have chosen to demonstrate both methods of filtering.</p>
@@ -158,22 +159,13 @@
         modify it however you like, you can claim you wrote it and charge people £1000 for a copy, I don't really mind.
         (Please don't do the last one. But if you're using my code for something cool, it would be nice to hear from
         you!)</p>
-    <h2 id="accuracy" class="mt-4">Data Accuracy</h2>
+    <h2 class="mt-4">Data Accuracy</h2>
     <p>Please note that the data coming out of Spothole is only as good as the data going in. People mis-hear and make
         typos when spotting callsigns all the time. There are also plenty of cases where Spothole's data, particularly
         location data, may be inaccurate. For example, there are POTA parks that span multiple US states, countries that
         span multiple CQ zones, portable operators with no requirement to sign /P, etc. If you are doing something where
         accuracy is important, such as contesting, you should not rely on Spothole's data to fill in any gaps in your
         log.</p>
-    <p>In the Spothole user interface, under "Your Data", you can enter your credentials for QRZ.com and/or HamQTH if
-        you have them. This allows Spothole to augment its data with lookups from these services. See the following
-        section, Privacy, for details of how these are handled. If you are looking at the map and see lots of spots in
-        the geographic centre of countries, allowing these lookups will help. For QRZ.com a paid account is required to
-        look up operator locations.</p>
-    <p>IOTA in particular causes a mapping problem, firstly that there is no official set of geodata beyond the names of
-        islands. We also have no way of telling whether priority should be given to IOTA reference or e.g. QRZ lookup,
-        for example for a G callsign in EU-005 Great Britain the QRZ home address is probably more accurate, but in
-        EU-002 Aaland islands, it's more likely a DXpedition and the IOTA would be more accurate.</p>
     <h2 id="privacy" class="mt-4">Privacy</h2>
     <p>Spothole collects no data about you on a permanent basis. All spots and alerts are "timed out" and deleted from
         the system after a set interval, which by default is one hour for spots and one week for alerts.</p>

templates/add_spot.html

@@ -24,14 +24,14 @@
             </div>
         </div>
         <div class="card-body">
-            <form class="row g-3">
+            <form class="row g-3" onsubmit="return addSpot();">
                 <div class="col-auto">
                     <label for="dx-call" class="form-label">DX Call *</label>
-                    <input type="text" class="form-control input-narrow" id="dx-call" placeholder="N0CALL">
+                    <input type="text" class="form-control input-narrow" id="dx-call" placeholder="N0CALL" required>
                 </div>
                 <div class="col-auto">
                     <label for="freq" class="form-label">Frequency (kHz) *</label>
-                    <input type="text" class="form-control input-narrow" id="freq" placeholder="e.g. 14100">
+                    <input type="text" class="form-control input-narrow" id="freq" placeholder="e.g. 14100" required>
                 </div>
                 <div class="col-auto">
                     <label for="mode" class="form-label">Mode</label>
@@ -60,10 +60,10 @@
                 <div class="col-auto">
                     <label for="de-call" class="form-label">Your Call *</label>
                     <input type="text" class="form-control storeable-text input-narrow" id="de-call"
-                           placeholder="N0CALL">
+                           placeholder="N0CALL" required>
                 </div>
                 <div class="col-auto">
-                    <button type="button" class="btn btn-primary mt-2em" onclick="addSpot();">Spot</button>
+                    <button type="submit" class="btn btn-primary mt-2em">Spot</button>
                 </div>
             </form>
 
@@ -76,7 +76,7 @@
 
 </div>
 
-<script src="/static/js/add-spot.js?v=1786175023"></script>
+<script src="/js/add-spot.js?v=1782411905"></script>
 <script>$(document).ready(function () {
     $("#nav-link-add-spot").addClass("active");
 }); <!-- highlight active page in nav --></script>

templates/alerts.html

@@ -75,7 +75,7 @@
 
 </div>
 
-<script src="/static/js/alerts.js?v=1786175024"></script>
+<script src="/js/alerts.js?v=1782411905"></script>
 <script>$(document).ready(function () {
     $("#nav-link-alerts").addClass("active");
 }); <!-- highlight active page in nav --></script>

templates/api_only_home.html

@@ -1,13 +1,13 @@
 {% extends "skeleton.html" %}
 {% block head_extra %}
-<link href="/static/vendor/css/bootstrap-5.3.8.min.css" rel="stylesheet">
+<link href="/vendor/css/bootstrap-5.3.8.min.css" rel="stylesheet">
 {% end %}
 {% block body %}
 <div class="container mt-5">
     <div class="row justify-content-center">
         <div class="col-md-8">
             <div class="text-center mb-4">
-                <img src="/static/img/logo.png" width="192" height="60" alt="Spothole">
+                <img src="/img/logo.png" width="192" height="60" alt="Spothole">
             </div>
             <div class="card">
                 <div class="card-body">

templates/apidocs.html

@@ -1,5 +1,5 @@
 {% extends "skeleton.html" %}
 {% block body %}
-<redoc spec-url="/static/apidocs/openapi.yml"></redoc>
+<redoc spec-url="/apidocs/openapi.yml"></redoc>
 <script src="https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js"></script>
 {% end %}

templates/bands.html

@@ -3,7 +3,9 @@
 
 <div class="mt-3">
     <div id="settingsButtonRow" class="row mb-3">
-        <div class="col-auto me-auto pt-3"></div>
+        <div class="col-auto me-auto pt-3">
+            {% module Template("widgets/refresh-timer.html", web_ui_options=web_ui_options) %}
+        </div>
         <div class="col-auto">
             <div class="d-inline-flex gap-1">
                 {% module Template("widgets/filters-display-data-buttons.html", web_ui_options=web_ui_options) %}
@@ -75,8 +77,8 @@
 <script>
     let spotProvidersEnabledByDefault = {% raw json_encode(web_ui_options["spot-providers-enabled-by-default"]) %};
 </script>
-<script src="/static/js/spotsbandsandmap.js?v=1786175023"></script>
-<script src="/static/js/bands.js?v=1786175023"></script>
+<script src="/js/spotsbandsandmap.js?v=1782411905"></script>
+<script src="/js/bands.js?v=1782411905"></script>
 <script>$(document).ready(function () {
     $("#nav-link-bands").addClass("active");
 }); <!-- highlight active page in nav --></script>

templates/base.html

@@ -1,26 +1,26 @@
 {% extends "skeleton.html" %}
 {% block head_extra %}
-<link rel="stylesheet" href="/static/css/style.css?v=1786175023" type="text/css">
-<link href="/static/vendor/css/bootstrap-5.3.8.min.css" rel="stylesheet">
-<link href="/static/vendor/css/fontawesome-6.7.2.min.css" rel="stylesheet">
-<link href="/static/vendor/css/solid-6.7.2.min.css" rel="stylesheet">
+<link rel="stylesheet" href="/css/style.css?v=1782411905" type="text/css">
+<link href="/vendor/css/bootstrap-5.3.8.min.css" rel="stylesheet">
+<link href="/vendor/css/fontawesome-6.7.2.min.css" rel="stylesheet">
+<link href="/vendor/css/solid-6.7.2.min.css" rel="stylesheet">
 
-<script src="/static/vendor/js/jquery-3.7.1.min.js"></script>
-<script src="/static/vendor/js/moment-2.29.4.min.js"></script>
-<script src="/static/vendor/js/bootstrap-5.3.8.bundle.min.js"></script>
-<script src="/static/vendor/js/tinycolor2-1.6.0.min.js"></script>
+<script src="/vendor/js/jquery-3.7.1.min.js"></script>
+<script src="/vendor/js/moment-2.29.4.min.js"></script>
+<script src="/vendor/js/bootstrap-5.3.8.bundle.min.js"></script>
+<script src="/vendor/js/tinycolor2-1.6.0.min.js"></script>
 
-<script src="/static/js/utils.js?v=1786175023"></script>
-<script src="/static/js/ui-ham.js?v=1786175023"></script>
-<script src="/static/js/geo.js?v=1786175023"></script>
-<script src="/static/js/common.js?v=1786175023"></script>
+<script src="/js/utils.js?v=1782411905"></script>
+<script src="/js/ui-ham.js?v=1782411905"></script>
+<script src="/js/geo.js?v=1782411905"></script>
+<script src="/js/common.js?v=1782411905"></script>
 {% end %}
 {% block body %}
 <div class="container">
     <nav id="header" class="navbar navbar-expand-lg bg-body p-0 border-bottom">
         <div class="container-fluid p-0">
             <a class="navbar-brand" href="/">
-                <img src="/static/img/logo.png" class="logo" width="192" height="60" alt="Spothole">
+                <img src="/img/logo.png" class="logo" width="192" height="60" alt="Spothole">
             </a>
             <button class="navbar-toggler" type="button" data-bs-toggle="collapse"
                     data-bs-target="#navbar-toggler-content" aria-controls="navbar-toggler-content"
@@ -87,8 +87,7 @@
     </div>
 </div>
 
-<div id="embeddedModeFooter" class="text-body-secondary pt-2 px-3 pb-1">Powered by <img src="/static/img/logo.png"
-                                                                                        class="logo"
+<div id="embeddedModeFooter" class="text-body-secondary pt-2 px-3 pb-1">Powered by <img src="/img/logo.png" class="logo"
                                                                                         width="96" height="30"
                                                                                         alt="Spothole"></div>
 

templates/conditions.html

@@ -283,8 +283,8 @@
     </div>
 </div>
 
-<script src="/static/vendor/js/chart-4.4.9.umd.min.js"></script>
-<script src="/static/js/conditions.js?v=1786175023"></script>
+<script src="/vendor/js/chart-4.4.9.umd.min.js"></script>
+<script src="/js/conditions.js?v=1782411905"></script>
 <script>$(document).ready(function () {
     $("#nav-link-conditions").addClass("active");
 }); <!-- highlight active page in nav --></script>

templates/map.html

@@ -1,19 +1,6 @@
 {% extends "base.html" %}
 {% block content %}
 
-<div id="map-intro-box" class="permanently-dismissible-box mt-3">
-    <div class="alert alert-primary alert-dismissible fade show" role="alert">
-        <i class="fa-solid fa-circle-info"></i> <strong>Spothole's map</strong><br/>Spothole pulls in location data from
-        a number of sources to try and provide the best map possible. However, please don't trust them to be anything
-        other than a rough guide. In particular, if you are seeing lots of spots in the centre of a country, please
-        consider opening the "Your Data" menu and providing QRZ.com and/or HamQTH credentials so that Spothole can find
-        more accurate locations for these spots. More information can be found in the
-        <a href="/about#accuracy" class="alert-link">Data Accuracy section of the About page</a>.
-        <button type="button" id="map-intro-box-dismiss" class="btn-close" data-bs-dismiss="alert"
-                aria-label="Close"></button>
-    </div>
-</div>
-
 <div id="map">
     <div id="settingsButtonRowMap" class="mt-3 px-3">
         <div class="row mb-3">
@@ -90,26 +77,26 @@
     </div>
 </div>
 
-<link rel="stylesheet" href="/static/vendor/css/leaflet-1.9.4.min.css">
-<link rel="stylesheet" href="/static/vendor/css/leaflet-extra-markers-1.2.2.min.css">
-<script src="/static/vendor/js/leaflet-1.9.4.min.js"></script>
-<script src="/static/vendor/js/oms-leaflet-0.2.7.min.js"></script>
-<script src="/static/vendor/js/leaflet-providers-2.0.0.js"></script>
-<script src="/static/vendor/js/leaflet-extra-markers-1.2.2.min.js"></script>
-<script src="/static/vendor/js/leaflet-geodesic-2.7.2.umd.min.js"></script>
-<script src="/static/vendor/js/leaflet-vectorgrid-1.3.0.js"></script>
-<script src="/static/vendor/js/text-image-0.7.0.js"></script>
-<script src="/static/vendor/js/leaflet-terminator-1.1.0.min.js"></script>
-<script src="/static/vendor/js/leaflet-maidenhead.js"></script>
-<script src="/static/vendor/js/leaflet-ituzones.js"></script>
-<script src="/static/vendor/js/leaflet-cqzones.js"></script>
-<script src="/static/vendor/js/leaflet-workedallbritainireland.js" type="module"></script>
+<link rel="stylesheet" href="/vendor/css/leaflet-1.9.4.min.css">
+<link rel="stylesheet" href="/vendor/css/leaflet-extra-markers-1.2.2.min.css">
+<script src="/vendor/js/leaflet-1.9.4.min.js"></script>
+<script src="/vendor/js/oms-leaflet-0.2.7.min.js"></script>
+<script src="/vendor/js/leaflet-providers-2.0.0.js"></script>
+<script src="/vendor/js/leaflet-extra-markers-1.2.2.min.js"></script>
+<script src="/vendor/js/leaflet-geodesic-2.7.2.umd.min.js"></script>
+<script src="/vendor/js/leaflet-vectorgrid-1.3.0.js"></script>
+<script src="/vendor/js/text-image-0.7.0.js"></script>
+<script src="/vendor/js/leaflet-terminator-1.1.0.min.js"></script>
+<script src="/vendor/js/leaflet-maidenhead.js"></script>
+<script src="/vendor/js/leaflet-ituzones.js"></script>
+<script src="/vendor/js/leaflet-cqzones.js"></script>
+<script src="/vendor/js/leaflet-workedallbritainireland.js"></script>
 
 <script>
     let spotProvidersEnabledByDefault = {% raw json_encode(web_ui_options["spot-providers-enabled-by-default"]) %};
 </script>
-<script src="/static/js/spotsbandsandmap.js?v=1786175024"></script>
-<script src="/static/js/map.js?v=1786175024"></script>
+<script src="/js/spotsbandsandmap.js?v=1782411905"></script>
+<script src="/js/map.js?v=1782411905"></script>
 <script>$(document).ready(function () {
     $("#nav-link-map").addClass("active");
 }); <!-- highlight active page in nav --></script>

templates/skeleton.html

@@ -15,10 +15,10 @@
           content="An Amateur Radio spotting tool bringing together DX clusters and outdoor programmes, providing a universal JSON API and web interface."/>
     <meta property="og:description"
           content="An Amateur Radio spotting tool bringing together DX clusters and outdoor programmes, providing a universal JSON API and web interface."/>
-    <link rel="canonical" href="{{ baseurl }}"/>
-    <meta property="og:url" content="{{ baseurl }}"/>
-    <meta property="og:image" content="{{ baseurl }}/static/img/banner.png"/>
-    <meta property="twitter:image" content="{{ baseurl }}/static/img/banner.png"/>
+    <link rel="canonical" href="https://spothole.app/"/>
+    <meta property="og:url" content="https://spothole.app/"/>
+    <meta property="og:image" content="https://spothole.app/img/banner.png"/>
+    <meta property="twitter:image" content="https://spothole.app/img/banner.png"/>
     <meta name="twitter:card" content="summary_large_image"/>
     <meta name="author" content="Ian Renton"/>
     <meta property="og:locale" content="en_GB"/>
@@ -26,14 +26,14 @@
 
     <title>Spothole</title>
 
-    <link rel="icon" type="image/png" href="/static/img/icon-512.png">
-    <link rel="apple-touch-icon" href="/static/img/icon-512-pwa.png">
-    <link rel="alternate icon" type="image/png" href="/static/img/icon-192.png">
-    <link rel="alternate icon" type="image/png" href="/static/img/icon-32.png">
-    <link rel="alternate icon" type="image/png" href="/static/img/icon-16.png">
-    <link rel="alternate icon" type="image/x-icon" href="/static/favicon.ico">
+    <link rel="icon" type="image/png" href="/img/icon-512.png">
+    <link rel="apple-touch-icon" href="img/icon-512-pwa.png">
+    <link rel="alternate icon" type="image/png" href="/img/icon-192.png">
+    <link rel="alternate icon" type="image/png" href="/img/icon-32.png">
+    <link rel="alternate icon" type="image/png" href="/img/icon-16.png">
+    <link rel="alternate icon" type="image/x-icon" href="/favicon.ico">
 
-    <link rel="manifest" href="/manifest.webmanifest">
+    <link rel="manifest" href="manifest.webmanifest">
 
     {% block head_extra %}{% end %}
 </head>

templates/spots.html

@@ -116,8 +116,8 @@
 <script>
     let spotProvidersEnabledByDefault = {% raw json_encode(web_ui_options["spot-providers-enabled-by-default"]) %};
 </script>
-<script src="/static/js/spotsbandsandmap.js?v=1786175023"></script>
-<script src="/static/js/spots.js?v=1786175023"></script>
+<script src="/js/spotsbandsandmap.js?v=1782411905"></script>
+<script src="/js/spots.js?v=1782411905"></script>
 <script>$(document).ready(function () {
     $("#nav-link-spots").addClass("active");
 }); <!-- highlight active page in nav --></script>

templates/status.html

@@ -59,7 +59,7 @@
     </div>
 </div>
 
-<script src="/static/js/status.js?v=1786175023"></script>
+<script src="/js/status.js?v=1782411905"></script>
 <script>
     $(document).ready(function () {
         $("#nav-link-status").addClass("active");

webassets/apidocs/openapi.yml

@@ -15,6 +15,14 @@ info:
 
     ## Changelog
     
+    ### 2.0
+
+    * POST `/spot` now supports upstream submission to the spotting services associated with various SIGs.
+    * **Breaking change:** The "add spot" API has changed to enable this: instead of just posting the spot object itself as the JSON content of the POST, this has moved into a `spot` object within the structure. A new `handling` object alongside it contains the `submit_upstream`, `upstream_provider`, `upstream_credentials`, and `captcha_token` fields which control the server handling of the spot.
+    * POST `/spot` now supports Google reCaptcha and (if the site owner has set it up) now requires `captcha_token` in order to successfully submit. (This is used to lock down the submit function and prevent submission via Spothole by bots or third-party clients.)
+    * GET `/options` now returns `spot_submit_providers`, a map of SIG names to the names of providers that support upstream spot submission for that SIG. (This allows clients to present the user with options of where a new spot can be sent to.)
+    * **Breaking change:** A user's QRZ.com and HamQTH credentials are now supplied as request headers (`X-QRZ-Username`, `X-QRZ-Password`, `X-QRZ-Session-Key`, `X-HamQTH-Username`, `X-HamQTH-Password`, `X-HamQTH-Session-ID`) rather than query parameters, to keep credentials out of server logs.
+
     ### 1.4
     
     * Spots can now include a "propagation_mode" field, and the `/options` call enumerates the options that can have.
@@ -45,10 +53,10 @@ info:
   license:
     name: The Unlicense
     url: https://unlicense.org/#the-unlicense
-  version: v1.4
+  version: 2.0
 
 servers:
-  - url: https://spothole.app/api/v1
+  - url: https://spothole.app/api/v2
 
 tags:
   - name: Spots
@@ -329,7 +337,8 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/ErrorResponse'
+                type: string
+                example: "Failed"
 
 
   /lookup/sigref:
@@ -357,7 +366,8 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/ErrorResponse'
+                type: string
+                example: "Failed"
 
 
 
@@ -383,7 +393,8 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/ErrorResponse'
+                type: string
+                example: "Failed"
 
 
   /spot:
@@ -392,50 +403,53 @@ paths:
         - Spots
       summary: Add a spot
       description: >
-        Supply a new spot object, which will be added to the system. Currently, this will not be
-        reported up the chain to a cluster, POTA, SOTA etc. This may be introduced in a future version.
-        cURL example: `curl --request POST --header "Content-Type: application/json" --data
-        '{"dx_call":"M0TRT","time":1760019539, "freq":14200000, "comment":"Test spot please ignore",
-        "de_call":"M0TRT"}' https://spothole.app/api/v1/spot`
+        Supply a JSON object containing a `spot` sub-object (the spot data) and an optional `handling` sub-object
+        containing server-side instructions such as upstream submission). Check `spot_submit_providers` in the
+        `/options` response to see which SIGs and providers support upstream submission. cURL example:
+        `curl --request POST --header \"Content-Type: application/json\" --data '{\"spot\":{\"dx_call\":\"M0TRT\",\"time\":1760019539,\"freq\":14200000,\"comment\":\"Test spot please ignore\",\"de_call\":\"M0TRT\"}}' https://spothole.app/api/v2/spot`"
       operationId: spot
       requestBody:
-        description: The JSON spot object
+        description: Object containing a "spot" sub-object with the spot data, and an optional "handling" sub-object with server-side instructions of what to do with it.
         required: true
         content:
           application/json:
             schema:
-              $ref: '#/components/schemas/Spot'
+              $ref: '#/components/schemas/SpotSubmission'
       responses:
-        '200':
+        '201':
           description: Success
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/OkResponse'
+                type: string
+                example: "OK"
         '415':
           description: Incorrect Content-Type
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/ErrorResponse'
+                type: string
+                example: "Failed"
         '422':
           description: Validation error
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/ErrorResponse'
+                type: string
+                example: "Failed"
         '500':
           description: Internal server error
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/ErrorResponse'
+                type: string
+                example: "Failed"
 
 components:
   parameters:
     QrzUsername:
-      name: qrz_username
-      in: query
+      name: X-QRZ-Username
+      in: header
       description: >
         QRZ.com username for online callsign lookup, which will enrich the returned spots and alerts
         with extra data. Requires a QRZ.com XML Subscriber (paid) account. Supply together with
@@ -443,14 +457,14 @@ components:
       schema:
         type: string
     QrzPassword:
-      name: qrz_password
-      in: query
+      name: X-QRZ-Password
+      in: header
       description: QRZ.com password. Supply together with `qrz_username`.
       schema:
         type: string
     QrzSessionKey:
-      name: qrz_session_key
-      in: query
+      name: X-QRZ-Session-Key
+      in: header
       description: >
         A pre-obtained QRZ.com XML session key, as an alternative to supplying `qrz_username` and
         `qrz_password`. See https://www.qrz.com/docs/xml/current_spec.html for details on how to
@@ -458,22 +472,22 @@ components:
       schema:
         type: string
     HamqthUsername:
-      name: hamqth_username
-      in: query
+      name: X-HamQTH-Username
+      in: header
       description: >
         HamQTH username for online callsign lookup, which will enrich the returned spots and alerts
         with extra data. Supply together with `hamqth_password`, or supply `hamqth_session_id` instead.
       schema:
         type: string
     HamqthPassword:
-      name: hamqth_password
-      in: query
+      name: X-HamQTH-Password
+      in: header
       description: HamQTH password. Supply together with `hamqth_username`.
       schema:
         type: string
     HamqthSessionId:
-      name: hamqth_session_id
-      in: query
+      name: X-HamQTH-Session-ID
+      in: header
       description: >
         A pre-obtained HamQTH session ID, as an alternative to supplying `hamqth_username` and
         `hamqth_password`. See https://www.hamqth.com/developers.php for details on how to retrieve
@@ -1184,6 +1198,54 @@ components:
           $ref: "#/components/schemas/PropagationMode"
 
 
+    SpotSubmission:
+      description: >
+        Request body for POST /spot. Contains a "spot" sub-object with the spot data, and an optional
+        "handling" sub-object with server-side instructions consumed by Spothole.
+      type: object
+      required:
+        - spot
+      properties:
+        spot:
+          $ref: '#/components/schemas/Spot'
+        handling:
+          type: object
+          description: >
+            Optional server-side instructions for how to process this spot submission.
+          properties:
+            submit_upstream:
+              type: boolean
+              description: >
+                If true, forward the spot to an external upstream provider (e.g. POTA, SOTA) rather
+                than only adding it to this Spothole server. Requires `sig`, at least one `sig_refs`
+                entry, and `upstream_provider` to be set. Check `spot_submit_providers` in the
+                /options response to see which SIGs and providers support this.
+              default: false
+            upstream_provider:
+              type: string
+              description: >
+                Name of the upstream provider to submit the spot to, e.g. "POTA" or "SOTA". Must
+                match one of the provider names returned in `spot_submit_providers` for the chosen SIG.
+              example: POTA
+            upstream_credentials:
+              type: object
+              description: >
+                Provider-specific credentials required to authenticate the upstream submission.
+                The required keys depend on the provider. Credentials are used only for the upstream
+                call and are never stored by Spothole.
+              additionalProperties:
+                type: string
+              example:
+                user_id: "12345"
+                api_key: "abc123"
+            captcha_token:
+              type: string
+              description: >
+                A Google reCAPTCHA v2 response token. Required when submitting upstream if the
+                server has reCAPTCHA configured. Obtain the token by completing the reCAPTCHA
+                widget rendered on the Add Spot page.
+              example: "03AFY_a8Xq..."
+
     SpotStream:
       type: object
       description: A server-sent event containing a spot
@@ -1730,14 +1792,6 @@ components:
       items:
         $ref: '#/components/schemas/Alert'
 
-    OkResponse:
-      type: string
-      example: "OK"
-
-    ErrorResponse:
-      type: string
-      example: "Failed"
-
     DxStats:
       type: object
       description: Spot counts keyed by DE continent
@@ -1875,7 +1929,7 @@ components:
           type: integer
           description: >
             The maximum age, in seconds, of any spot before it will be deleted by the system. When
-            querying the /api/v1/spots endpoint and providing a "max_age" or "since" parameter, there
+            querying the /api/v2/spots endpoint and providing a "max_age" or "since" parameter, there
             is no point providing a number larger than this, because the system drops all spots older
             than this.
           example: 3600
@@ -1885,6 +1939,20 @@ components:
             Whether the POST /spot call, to add spots to the server directly via its API, is permitted
             on this server.
           example: true
+        spot_submit_providers:
+          type: object
+          description: >
+            A map of SIG name to a list of provider names that support upstream spot submission for that SIG.
+            If a SIG appears as a key here, the POST /spot endpoint accepts `submit_upstream: true` for
+            spots with that SIG, and will forward the spot to one of the listed providers. Omitted if no
+            providers support upstream submission.
+          additionalProperties:
+            type: array
+            items:
+              type: string
+          example:
+            POTA: [ POTA ]
+            SOTA: [ SOTA, GMA, ParksNPeaks ]
 
     CallLookup:
       type: object