Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
fa6c3c0a55 | ||
|
|
fffd230633 | ||
|
|
3c1b1821f5 | ||
|
|
77d7fd70d9 | ||
|
|
c3bcc1190d | ||
|
|
3b5a4efb0b | ||
|
|
59fa6500eb | ||
|
|
7a34526a91 | ||
|
|
d1c4dd4e4c | ||
|
|
692fa83323 | ||
|
|
6062211bc7 | ||
|
|
ec5984ec35 | ||
|
|
2affe460a5 | ||
|
|
277e374994 | ||
|
|
8d09484425 | ||
|
|
e08a183d1b | ||
|
|
ae17839096 | ||
|
|
1e42c69b78 | ||
|
|
20966cc7cf | ||
|
|
172a31bb18 | ||
|
|
88f055384d | ||
|
|
4408203d55 | ||
|
|
af9f542740 | ||
|
|
b81f5eeb5a | ||
|
|
fd21e01c9d | ||
|
|
1afb407ca5 | ||
|
|
930d5357fe |
@@ -4,7 +4,7 @@
|
|||||||
<content url="file://$MODULE_DIR$">
|
<content url="file://$MODULE_DIR$">
|
||||||
<sourceFolder url="file://$MODULE_DIR$" isTestSource="false" />
|
<sourceFolder url="file://$MODULE_DIR$" isTestSource="false" />
|
||||||
<excludeFolder url="file://$MODULE_DIR$/.venv" />
|
<excludeFolder url="file://$MODULE_DIR$/.venv" />
|
||||||
<excludeFolder url="file://$MODULE_DIR$/webassets/vendor" />
|
<excludeFolder url="file://$MODULE_DIR$/static/vendor" />
|
||||||
</content>
|
</content>
|
||||||
<orderEntry type="jdk" jdkName="Python 3.13 virtualenv at ~/code/spothole/.venv" jdkType="Python SDK" />
|
<orderEntry type="jdk" jdkName="Python 3.13 virtualenv at ~/code/spothole/.venv" jdkType="Python SDK" />
|
||||||
<orderEntry type="sourceFolder" forTests="false" />
|
<orderEntry type="sourceFolder" forTests="false" />
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
# 
|
# 
|
||||||
|
|
||||||
Spothole is a utility to aggregate "spots" from amateur radio DX clusters and xOTA spotting sites, and provide an open
|
Spothole is a utility to aggregate "spots" from amateur radio DX clusters and xOTA spotting sites, and provide an open
|
||||||
JSON API as well as a website to browse the data.
|
JSON API as well as a website to browse the data.
|
||||||
@@ -89,10 +89,10 @@ callsign and park data.
|
|||||||
|
|
||||||
Various approaches exist to writing your own client, but in general:
|
Various approaches exist to writing your own client, but in general:
|
||||||
|
|
||||||
* Refer to the API docs. These are built on an OpenAPI definition file (`/webassets/apidocs/openapi.yml`), which you can
|
* Refer to the API docs. These are built on an OpenAPI definition file (`/static/apidocs/openapi.yml`), which you can
|
||||||
automatically use to generate a client skeleton using various software.
|
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
|
* 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.
|
`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
|
* 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.
|
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"
|
* Refer to the provided HTML/JS interface for a reference on different approaches. For example, the "alerts"/"upcoming"
|
||||||
@@ -105,12 +105,12 @@ once every two minutes, so if your client is interested in POTA data there's no
|
|||||||
than that.
|
than that.
|
||||||
|
|
||||||
If you absolutely must be informed within seconds of a spot arriving in Spothole, please use the SSE endpoints instead,
|
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`.
|
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
|
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
|
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/v2/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`.
|
`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
|
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.
|
twist: we don't tell you which side of the decimal point the nines start! (Translation: This is a hobby project.
|
||||||
@@ -346,15 +346,15 @@ server {
|
|||||||
alias /var/www/html/.well-known/;
|
alias /var/www/html/.well-known/;
|
||||||
}
|
}
|
||||||
|
|
||||||
# Load static assets directly from the Spothole webassets directory
|
# Load static assets directly from the Spothole static directory
|
||||||
location /static/ {
|
location /static/ {
|
||||||
alias /home/spothole/spothole/webassets/;
|
alias /home/spothole/spothole/static/;
|
||||||
expires 1h;
|
expires 1h;
|
||||||
add_header Cache-Control "public, max-age=3600, must-revalidate";
|
add_header Cache-Control "public, max-age=3600, must-revalidate";
|
||||||
}
|
}
|
||||||
|
|
||||||
# SSE endpoints
|
# SSE endpoints
|
||||||
location ~ ^/api/v1/(spots|alerts)/stream/? {
|
location ~ ^/api/v2/(spots|alerts)/stream/? {
|
||||||
proxy_pass http://127.0.0.1:8080;
|
proxy_pass http://127.0.0.1:8080;
|
||||||
|
|
||||||
# Remove buffering, remove caching, add suitable timeouts for SSE API calls
|
# Remove buffering, remove caching, add suitable timeouts for SSE API calls
|
||||||
@@ -452,12 +452,12 @@ To navigate your way around the source code, this list may help.
|
|||||||
|
|
||||||
*HTML/JS/CSS front-end code*
|
*HTML/JS/CSS front-end code*
|
||||||
|
|
||||||
* `/webassets` - Root for static files served by the web server. These are all served from a path starting `/static/`.
|
* `/static` - Root for static files served by the web server. These are all served from a path starting `/static/`.
|
||||||
* `/webassets/apidocs` - Contains the OpenAPI spec (`openapi.yml`)
|
* `/static/apidocs` - Contains the OpenAPI spec (`openapi.yml`)
|
||||||
* `/webassets/css` - CSS files used by the web front-end
|
* `/static/css` - CSS files used by the web front-end
|
||||||
* `/webassets/img` - image files used by the web front-end
|
* `/static/img` - image files used by the web front-end
|
||||||
* `/webassets/js` - JavaScript used by the web front-end
|
* `/static/js` - JavaScript used by the web front-end
|
||||||
* `/webassets/vendor` - Third-party libraries (CSS, JS, fonts and images)
|
* `/static/vendor` - Third-party libraries (CSS, JS, fonts and images)
|
||||||
|
|
||||||
*Miscellaneous*
|
*Miscellaneous*
|
||||||
|
|
||||||
@@ -509,13 +509,16 @@ my knowledge, created by HA8TKS for his CQ and ITU zone layers for Leaflet. `/da
|
|||||||
maps of conference centres.
|
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
|
The project contains a set of flag icons generated using the "Noto Color Emoji" font on a Debian system, in the
|
||||||
`/webassets/img/flags/` directory.
|
`/static/img/flags/` directory.
|
||||||
|
|
||||||
The software uses a number of Python libraries as listed in `requirements.txt`, and a number of JavaScript libraries.
|
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.
|
This project would not have been possible without these libraries, so many thanks to their developers.
|
||||||
|
|
||||||
### Third Party Libraries
|
### Third Party Libraries
|
||||||
|
|
||||||
|
A number of third-party libraries are self-hosted in the `/static/vendor/` directory. These files are subject to
|
||||||
|
their own licences and are not covered by the overall licence declared in the `LICENSE` file.
|
||||||
|
|
||||||
A number of third-party libraries are self-hosted in the `/webassets/vendor/` directory. These files are subject to
|
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.
|
their own licences and are not covered by the overall licence declared in the `LICENSE` file.
|
||||||
|
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ from threading import Thread, Event
|
|||||||
|
|
||||||
import pytz
|
import pytz
|
||||||
import requests
|
import requests
|
||||||
from requests.exceptions import ConnectionError
|
from requests.exceptions import ConnectionError, ReadTimeout, ConnectTimeout
|
||||||
|
|
||||||
from alertproviders.alert_provider import AlertProvider
|
from alertproviders.alert_provider import AlertProvider
|
||||||
from core.constants import HTTP_HEADERS
|
from core.constants import HTTP_HEADERS
|
||||||
@@ -59,6 +59,8 @@ class HTTPAlertProvider(AlertProvider):
|
|||||||
|
|
||||||
except ConnectionError:
|
except ConnectionError:
|
||||||
logging.warning(f"Connection error when accessing {self.name} alerts API.")
|
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:
|
except Exception:
|
||||||
self.status = "Error"
|
self.status = "Error"
|
||||||
logging.exception("Exception in HTTP JSON Alert Provider (" + self.name + ")")
|
logging.exception("Exception in HTTP JSON Alert Provider (" + self.name + ")")
|
||||||
|
|||||||
@@ -181,7 +181,7 @@ alert-providers:
|
|||||||
|
|
||||||
|
|
||||||
# Solar condition providers to use. These poll external APIs for solar propagation data (SFI, A/K indices, band
|
# 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:
|
solar-condition-providers:
|
||||||
- class: "HamQSL"
|
- class: "HamQSL"
|
||||||
name: "HamQSL"
|
name: "HamQSL"
|
||||||
@@ -211,6 +211,20 @@ clublog-api-key: ""
|
|||||||
# Allow submitting spots to the Spothole API?
|
# Allow submitting spots to the Spothole API?
|
||||||
allow-spotting: true
|
allow-spotting: true
|
||||||
|
|
||||||
|
# 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
|
||||||
|
|
||||||
|
# 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: ""
|
||||||
|
|
||||||
# Log web requests? Useful to see what your users are requesting in terms of pages and API endpoints, but will fill up
|
# 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.
|
# your log quickly on a popular server.
|
||||||
log-web-requests: false
|
log-web-requests: false
|
||||||
|
|||||||
@@ -14,14 +14,17 @@ with open("config.yml") as f:
|
|||||||
config = yaml.safe_load(f)
|
config = yaml.safe_load(f)
|
||||||
logging.info("Loaded config.")
|
logging.info("Loaded config.")
|
||||||
|
|
||||||
BASE_URL = config["base-url"]
|
BASE_URL = config.get("base-url", "http://localhost:8080")
|
||||||
MAX_SPOT_AGE = config["max-spot-age-sec"]
|
MAX_SPOT_AGE = config.get("max-spot-age-sec", 3600)
|
||||||
MAX_ALERT_AGE = config["max-alert-age-sec"]
|
MAX_ALERT_AGE = config.get("max-alert-age-sec", 604800)
|
||||||
SERVER_OWNER_CALLSIGN = config["server-owner-callsign"]
|
SERVER_OWNER_CALLSIGN = config.get("server-owner-callsign", "N0CALL")
|
||||||
WEB_SERVER_PORT = config["web-server-port"]
|
WEB_SERVER_PORT = config.get("web-server-port", 8080)
|
||||||
ALLOW_SPOTTING = config["allow-spotting"]
|
ALLOW_SPOTTING = config.get("allow-spotting", True)
|
||||||
WEB_UI_OPTIONS = config["web-ui-options"]
|
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)
|
API_ONLY_MODE = config.get("api-only-mode", False)
|
||||||
|
RECAPTCHA_SECRET_KEY = config.get("recaptcha-secret-key", "")
|
||||||
|
RECAPTCHA_SITE_KEY = config.get("recaptcha-site-key", "")
|
||||||
LOG_LEVEL = config.get("log-level", "INFO")
|
LOG_LEVEL = config.get("log-level", "INFO")
|
||||||
LOG_WEB_REQUESTS = config.get("log-web-requests", False)
|
LOG_WEB_REQUESTS = config.get("log-web-requests", False)
|
||||||
|
|
||||||
@@ -30,6 +33,9 @@ LOG_WEB_REQUESTS = config.get("log-web-requests", False)
|
|||||||
WEB_UI_OPTIONS["spot-providers-enabled-by-default"] = [p["name"] for p in config["spot-providers"] if p["enabled"] and (
|
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"])]
|
"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
|
# 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:
|
if ALLOW_SPOTTING:
|
||||||
WEB_UI_OPTIONS["spot-providers-enabled-by-default"].append("API")
|
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
|
||||||
|
|||||||
@@ -11,7 +11,7 @@ HAMQTH_PRG = ("Spothole v" + SOFTWARE_VERSION + " operated by " + SERVER_OWNER_C
|
|||||||
|
|
||||||
# Special Interest Groups
|
# Special Interest Groups
|
||||||
SIGS = [
|
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="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="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}"),
|
SIG(name="GMA", comment_names=["GMA"], description="Global Mountain Activity", ref_regex=r"[A-Z0-9]{1,3}\/[A-Z]{2}\-\d{3}"),
|
||||||
@@ -38,10 +38,12 @@ SIGS = [
|
|||||||
|
|
||||||
# Modes. Note "DIGI" and "DIGITAL" are also supported but are normalised into "DATA".
|
# Modes. Note "DIGI" and "DIGITAL" are also supported but are normalised into "DATA".
|
||||||
CW_MODES = ["CW"]
|
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"]
|
DATA_MODES = ["DATA", "FT8", "FT4", "RTTY", "SSTV", "JS8", "HELL", "PSK", "OLIVIA", "PKT", "MSK144"]
|
||||||
ALL_MODES = CW_MODES + PHONE_MODES + DATA_MODES
|
ALL_MODES = CW_MODES + PHONE_MODES + DATA_MODES
|
||||||
MODE_TYPES = ["CW", "PHONE", "DATA"]
|
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
|
# 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
|
# we already know, or we want to normalise things for consistency. The lookup table for this is here. Incoming spots
|
||||||
|
|||||||
@@ -11,7 +11,7 @@ from pyhamtools import LookupLib, Callinfo, callinfo
|
|||||||
from pyhamtools.exceptions import APIKeyMissingError
|
from pyhamtools.exceptions import APIKeyMissingError
|
||||||
from pyhamtools.frequency import freq_to_band
|
from pyhamtools.frequency import freq_to_band
|
||||||
from pyhamtools.locator import latlong_to_locator
|
from pyhamtools.locator import latlong_to_locator
|
||||||
from requests.exceptions import ConnectionError
|
from requests.exceptions import ConnectionError, ReadTimeout, ConnectTimeout
|
||||||
from requests_cache import CachedSession
|
from requests_cache import CachedSession
|
||||||
|
|
||||||
from core.cache_utils import SEMI_STATIC_URL_DATA_CACHE
|
from core.cache_utils import SEMI_STATIC_URL_DATA_CACHE
|
||||||
@@ -156,6 +156,8 @@ class LookupHelper:
|
|||||||
|
|
||||||
except ConnectionError:
|
except ConnectionError:
|
||||||
logging.warning(f"Connection error when downloading Clublog cty.xml.")
|
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:
|
except Exception as e:
|
||||||
logging.error("Exception when downloading Clublog cty.xml", e)
|
logging.error("Exception when downloading Clublog cty.xml", e)
|
||||||
return False
|
return False
|
||||||
@@ -180,6 +182,8 @@ class LookupHelper:
|
|||||||
|
|
||||||
except ConnectionError:
|
except ConnectionError:
|
||||||
logging.warning(f"Connection error when downloading dxcc.json.")
|
logging.warning(f"Connection error when downloading dxcc.json.")
|
||||||
|
except (ConnectTimeout, ReadTimeout):
|
||||||
|
logging.warning(f"Timeout when downloading dxcc.json.")
|
||||||
except Exception as e:
|
except Exception as e:
|
||||||
logging.error("Exception when downloading dxcc.json", e)
|
logging.error("Exception when downloading dxcc.json", e)
|
||||||
return False
|
return False
|
||||||
@@ -537,6 +541,9 @@ class LookupHelper:
|
|||||||
except ConnectionError:
|
except ConnectionError:
|
||||||
logging.warning(f"Connection error when looking up callsign %s using QRZ", lookup_call)
|
logging.warning(f"Connection error when looking up callsign %s using QRZ", lookup_call)
|
||||||
continue
|
continue
|
||||||
|
except (ConnectTimeout, ReadTimeout):
|
||||||
|
logging.warning(f"Timeout when looking up callsign %s using QRZ.", lookup_call)
|
||||||
|
continue
|
||||||
except Exception:
|
except Exception:
|
||||||
logging.error("Exception when looking up callsign %s using QRZ", lookup_call, exc_info=True)
|
logging.error("Exception when looking up callsign %s using QRZ", lookup_call, exc_info=True)
|
||||||
continue
|
continue
|
||||||
@@ -601,6 +608,9 @@ class LookupHelper:
|
|||||||
except ConnectionError:
|
except ConnectionError:
|
||||||
logging.warning(f"Connection error when looking up callsign %s using HamQTH", lookup_call)
|
logging.warning(f"Connection error when looking up callsign %s using HamQTH", lookup_call)
|
||||||
continue
|
continue
|
||||||
|
except (ConnectTimeout, ReadTimeout):
|
||||||
|
logging.warning(f"Timeout when looking up callsign %s using HamQTH", lookup_call)
|
||||||
|
continue
|
||||||
except Exception:
|
except Exception:
|
||||||
logging.error("Exception when looking up callsign %s using HamQTH", lookup_call, exc_info=True)
|
logging.error("Exception when looking up callsign %s using HamQTH", lookup_call, exc_info=True)
|
||||||
continue
|
continue
|
||||||
|
|||||||
@@ -2,7 +2,7 @@ import csv
|
|||||||
import logging
|
import logging
|
||||||
|
|
||||||
from pyhamtools.locator import latlong_to_locator, locator_to_latlong
|
from pyhamtools.locator import latlong_to_locator, locator_to_latlong
|
||||||
from requests.exceptions import ConnectionError
|
from requests.exceptions import ConnectionError, ReadTimeout, ConnectTimeout
|
||||||
|
|
||||||
from core.cache_utils import SEMI_STATIC_URL_DATA_CACHE
|
from core.cache_utils import SEMI_STATIC_URL_DATA_CACHE
|
||||||
from core.constants import SIGS, HTTP_HEADERS
|
from core.constants import SIGS, HTTP_HEADERS
|
||||||
@@ -12,6 +12,14 @@ from core.geo_utils import wab_wai_square_to_lat_lon
|
|||||||
# file in Spothole and load it on startup.
|
# file in Spothole and load it on startup.
|
||||||
with open("datafiles/MUNICIPIOS.csv", encoding="latin-1") as _f:
|
with open("datafiles/MUNICIPIOS.csv", encoding="latin-1") as _f:
|
||||||
_DME_INDEX = {row["COD_INE"][:5]: row for row in csv.DictReader(_f, delimiter=";")}
|
_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):
|
def get_ref_regex_for_sig(sig):
|
||||||
@@ -109,12 +117,13 @@ def populate_sig_ref_info(sig_ref):
|
|||||||
# the zeroest corner of the box, then "lat2" and "lng2" provide the other corner. We detect this
|
# 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,
|
# 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.
|
# just use the single point we have.
|
||||||
if "latitude" in data and "longitude" in data and "lat2" in data and "lng2" in data:
|
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.latitude = (float(data["latitude"]) + float(data["lat2"])) / 2.0
|
||||||
sig_ref.longitude = (float(data["longitude"]) + float(data["lng2"])) / 2.0
|
sig_ref.longitude = (float(data["longitude"]) + float(data["lng2"])) / 2.0
|
||||||
else:
|
else:
|
||||||
sig_ref.latitude = float(data["latitude"]) if "latitude" in data else None
|
sig_ref.latitude = float(data["latitude"]) if data.get("latitude") is not None else None
|
||||||
sig_ref.longitude = float(data["longitude"]) if "longitude" in data else None
|
sig_ref.longitude = float(data["longitude"]) if data.get("longitude") is not None else None
|
||||||
elif not response.from_cache:
|
elif not response.from_cache:
|
||||||
logging.warning("Malformed response looking up %s ref %s via GMA", sig, ref_id)
|
logging.warning("Malformed response looking up %s ref %s via GMA", sig, ref_id)
|
||||||
elif not response.from_cache:
|
elif not response.from_cache:
|
||||||
@@ -124,8 +133,12 @@ def populate_sig_ref_info(sig_ref):
|
|||||||
response = SEMI_STATIC_URL_DATA_CACHE.get("https://wwff.co/wwff-data/wwff_directory.csv",
|
response = SEMI_STATIC_URL_DATA_CACHE.get("https://wwff.co/wwff-data/wwff_directory.csv",
|
||||||
headers=HTTP_HEADERS)
|
headers=HTTP_HEADERS)
|
||||||
if response.ok:
|
if response.ok:
|
||||||
wwff_index = {row["reference"]: row for row in csv.DictReader(response.content.decode().splitlines())}
|
global _WWFF_INDEX_CACHE
|
||||||
row = wwff_index.get(ref_id)
|
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:
|
if row:
|
||||||
sig_ref.name = row["name"] if "name" in row else None
|
sig_ref.name = row["name"] if "name" in row else None
|
||||||
sig_ref.url = "https://wwff.co/directory/?showRef=" + ref_id
|
sig_ref.url = "https://wwff.co/directory/?showRef=" + ref_id
|
||||||
@@ -142,9 +155,12 @@ def populate_sig_ref_info(sig_ref):
|
|||||||
response = SEMI_STATIC_URL_DATA_CACHE.get("https://www.silosontheair.com/data/silos.csv",
|
response = SEMI_STATIC_URL_DATA_CACHE.get("https://www.silosontheair.com/data/silos.csv",
|
||||||
headers=HTTP_HEADERS)
|
headers=HTTP_HEADERS)
|
||||||
if response.ok:
|
if response.ok:
|
||||||
siota_index = {row["SILO_CODE"]: row for row in
|
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())}
|
csv.DictReader(response.content.decode().splitlines())}
|
||||||
row = siota_index.get(ref_id)
|
row = _SIOTA_INDEX_CACHE.get(ref_id)
|
||||||
if row:
|
if row:
|
||||||
sig_ref.name = row["NAME"] if "NAME" in row else None
|
sig_ref.name = row["NAME"] if "NAME" in row else None
|
||||||
sig_ref.grid = row["LOCATOR"] if "LOCATOR" in row else None
|
sig_ref.grid = row["LOCATOR"] if "LOCATOR" in row else None
|
||||||
@@ -161,8 +177,13 @@ def populate_sig_ref_info(sig_ref):
|
|||||||
if response.ok:
|
if response.ok:
|
||||||
data = response.json()
|
data = response.json()
|
||||||
if data:
|
if data:
|
||||||
for feature in data.get("features", []):
|
global _WOTA_INDEX_CACHE
|
||||||
if feature["properties"]["wotaId"] == ref_id:
|
if not bool(_WOTA_INDEX_CACHE) or not response.from_cache:
|
||||||
|
# New data from WOTA, update our internal map
|
||||||
|
_WOTA_INDEX_CACHE = {feature["properties"]["wotaId"]: feature for feature in
|
||||||
|
data.get("features", [])}
|
||||||
|
feature = _WOTA_INDEX_CACHE.get(ref_id)
|
||||||
|
if feature:
|
||||||
sig_ref.name = feature["properties"]["title"]
|
sig_ref.name = feature["properties"]["title"]
|
||||||
# Fudge WOTA URLs. Outlying fell (LDO) URLs don't match their ID numbers but require 214 to be
|
# Fudge WOTA URLs. Outlying fell (LDO) URLs don't match their ID numbers but require 214 to be
|
||||||
# added to them
|
# added to them
|
||||||
@@ -173,7 +194,6 @@ def populate_sig_ref_info(sig_ref):
|
|||||||
sig_ref.grid = feature["properties"]["qthLocator"]
|
sig_ref.grid = feature["properties"]["qthLocator"]
|
||||||
sig_ref.latitude = feature["geometry"]["coordinates"][1]
|
sig_ref.latitude = feature["geometry"]["coordinates"][1]
|
||||||
sig_ref.longitude = feature["geometry"]["coordinates"][0]
|
sig_ref.longitude = feature["geometry"]["coordinates"][0]
|
||||||
break
|
|
||||||
elif not response.from_cache:
|
elif not response.from_cache:
|
||||||
logging.warning("Malformed response looking up %s ref %s", sig, ref_id)
|
logging.warning("Malformed response looking up %s ref %s", sig, ref_id)
|
||||||
elif not response.from_cache:
|
elif not response.from_cache:
|
||||||
@@ -184,8 +204,12 @@ def populate_sig_ref_info(sig_ref):
|
|||||||
if response.ok:
|
if response.ok:
|
||||||
data = response.json()
|
data = response.json()
|
||||||
if isinstance(data, list):
|
if isinstance(data, list):
|
||||||
for asset in data:
|
global _ZLOTA_INDEX_CACHE
|
||||||
if asset["code"] == ref_id:
|
if not bool(_ZLOTA_INDEX_CACHE) or not response.from_cache:
|
||||||
|
# New data from ZLOTA, update our internal map
|
||||||
|
_ZLOTA_INDEX_CACHE = {asset["code"]: asset for asset in data}
|
||||||
|
asset = _ZLOTA_INDEX_CACHE.get(ref_id)
|
||||||
|
if asset:
|
||||||
sig_ref.name = asset["name"]
|
sig_ref.name = asset["name"]
|
||||||
sig_ref.url = "https://ontheair.nz/assets/" + ref_id.replace("/", "_")
|
sig_ref.url = "https://ontheair.nz/assets/" + ref_id.replace("/", "_")
|
||||||
try:
|
try:
|
||||||
@@ -194,7 +218,6 @@ def populate_sig_ref_info(sig_ref):
|
|||||||
logging.debug("Invalid lat/lon received for reference")
|
logging.debug("Invalid lat/lon received for reference")
|
||||||
sig_ref.latitude = asset["y"]
|
sig_ref.latitude = asset["y"]
|
||||||
sig_ref.longitude = asset["x"]
|
sig_ref.longitude = asset["x"]
|
||||||
break
|
|
||||||
elif not response.from_cache:
|
elif not response.from_cache:
|
||||||
logging.warning("Malformed response looking up %s ref %s", sig, ref_id)
|
logging.warning("Malformed response looking up %s ref %s", sig, ref_id)
|
||||||
elif not response.from_cache:
|
elif not response.from_cache:
|
||||||
@@ -211,15 +234,18 @@ def populate_sig_ref_info(sig_ref):
|
|||||||
if response.ok:
|
if response.ok:
|
||||||
data = response.json()
|
data = response.json()
|
||||||
if isinstance(data, list):
|
if isinstance(data, list):
|
||||||
for ref in data:
|
global _LLOTA_INDEX_CACHE
|
||||||
if ref["reference_code"] == ref_id:
|
if not bool(_LLOTA_INDEX_CACHE) or not response.from_cache:
|
||||||
|
# New data from LLOTA, update our internal map
|
||||||
|
_LLOTA_INDEX_CACHE = {ref["reference_code"]: ref for ref in data}
|
||||||
|
ref = _LLOTA_INDEX_CACHE.get(ref_id)
|
||||||
|
if ref:
|
||||||
sig_ref.name = str(ref["name"])
|
sig_ref.name = str(ref["name"])
|
||||||
sig_ref.url = "https://llota.app/list/ref/" + ref_id
|
sig_ref.url = "https://llota.app/list/ref/" + ref_id
|
||||||
sig_ref.grid = str(ref["grid_locator"])
|
sig_ref.grid = str(ref["grid_locator"])
|
||||||
ll = locator_to_latlong(sig_ref.grid)
|
ll = locator_to_latlong(sig_ref.grid)
|
||||||
sig_ref.latitude = ll[0]
|
sig_ref.latitude = ll[0]
|
||||||
sig_ref.longitude = ll[1]
|
sig_ref.longitude = ll[1]
|
||||||
break
|
|
||||||
elif not response.from_cache:
|
elif not response.from_cache:
|
||||||
logging.warning("Malformed response looking up %s ref %s", sig, ref_id)
|
logging.warning("Malformed response looking up %s ref %s", sig, ref_id)
|
||||||
elif not response.from_cache:
|
elif not response.from_cache:
|
||||||
@@ -271,6 +297,8 @@ def populate_sig_ref_info(sig_ref):
|
|||||||
|
|
||||||
except ConnectionError:
|
except ConnectionError:
|
||||||
logging.warning("Connection error when looking up sig_ref info for " + sig + " ref " + ref_id)
|
logging.warning("Connection error when looking up sig_ref info for " + sig + " ref " + ref_id)
|
||||||
|
except (ConnectTimeout, ReadTimeout):
|
||||||
|
logging.warning(f"Timeout when looking up sig_ref info for " + sig + " ref " + ref_id)
|
||||||
except Exception:
|
except Exception:
|
||||||
logging.error("Exception when looking up sig_ref info for " + sig + " ref " + ref_id, exc_info=True)
|
logging.error("Exception when looking up sig_ref info for " + sig + " ref " + ref_id, exc_info=True)
|
||||||
return sig_ref
|
return sig_ref
|
||||||
|
|||||||
@@ -12,15 +12,15 @@ class LookupCredentials:
|
|||||||
hamqth_session_id: str = "" # alternative to username/password
|
hamqth_session_id: str = "" # alternative to username/password
|
||||||
|
|
||||||
|
|
||||||
def extract_credentials(query_params):
|
def extract_credentials(headers):
|
||||||
"""Build a LookupCredentials from HTTP query params; returns None if no usable credentials are present."""
|
"""Build a LookupCredentials from HTTP request headers; returns None if no usable credentials are present."""
|
||||||
creds = LookupCredentials(
|
creds = LookupCredentials(
|
||||||
qrz_username=query_params.get("qrz_username", ""),
|
qrz_username=headers.get("X-QRZ-Username", ""),
|
||||||
qrz_password=query_params.get("qrz_password", ""),
|
qrz_password=headers.get("X-QRZ-Password", ""),
|
||||||
qrz_session_key=query_params.get("qrz_session_key", ""),
|
qrz_session_key=headers.get("X-QRZ-Session-Key", ""),
|
||||||
hamqth_username=query_params.get("hamqth_username", ""),
|
hamqth_username=headers.get("X-HamQTH-Username", ""),
|
||||||
hamqth_password=query_params.get("hamqth_password", ""),
|
hamqth_password=headers.get("X-HamQTH-Password", ""),
|
||||||
hamqth_session_id=query_params.get("hamqth_session_id", ""),
|
hamqth_session_id=headers.get("X-HamQTH-Session-ID", ""),
|
||||||
)
|
)
|
||||||
has_qrz = creds.qrz_session_key or (creds.qrz_username and creds.qrz_password)
|
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)
|
has_hamqth = creds.hamqth_session_id or (creds.hamqth_username and creds.hamqth_password)
|
||||||
|
|||||||
@@ -1,33 +1,40 @@
|
|||||||
import logging
|
import logging
|
||||||
import re
|
import re
|
||||||
|
import threading
|
||||||
from datetime import datetime
|
from datetime import datetime
|
||||||
from typing import Any
|
from typing import Any
|
||||||
|
|
||||||
import pytz
|
import pytz
|
||||||
|
import requests
|
||||||
import tornado
|
import tornado
|
||||||
from tornado import httputil
|
from tornado import httputil
|
||||||
from tornado.web import Application
|
from tornado.web import Application
|
||||||
|
|
||||||
from core.config import ALLOW_SPOTTING, 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.constants import UNKNOWN_BAND
|
||||||
from core.lookup_helper import infer_band_from_freq
|
from core.lookup_helper import infer_band_from_freq
|
||||||
from core.prometheus_metrics_handler import api_requests_counter
|
from core.prometheus_metrics_handler import api_requests_counter
|
||||||
from core.sig_utils import get_ref_regex_for_sig
|
from core.sig_utils import get_ref_regex_for_sig
|
||||||
from core.utils import safe_json_dumps
|
from core.utils import safe_json_dumps
|
||||||
from data.spot import Spot
|
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):
|
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):
|
def __init__(self, application: "Application", request: httputil.HTTPServerRequest, **kwargs: Any):
|
||||||
self._spots = None
|
self._spots = None
|
||||||
self._web_server_metrics = None
|
self._web_server_metrics = None
|
||||||
|
self._spot_providers = None
|
||||||
super().__init__(application, request, **kwargs)
|
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._spots = spots
|
||||||
self._web_server_metrics = web_server_metrics
|
self._web_server_metrics = web_server_metrics
|
||||||
|
self._spot_providers = spot_providers or []
|
||||||
|
|
||||||
def post(self):
|
def post(self):
|
||||||
try:
|
try:
|
||||||
@@ -62,9 +69,38 @@ class APISpotHandler(tornado.web.RequestHandler):
|
|||||||
self.set_header("Content-Type", "application/json")
|
self.set_header("Content-Type", "application/json")
|
||||||
return
|
return
|
||||||
|
|
||||||
# Read in the request body as JSON then convert to a Spot object
|
# Read in the request body as JSON
|
||||||
json_spot = tornado.escape.json_decode(post_data)
|
json_body = tornado.escape.json_decode(post_data)
|
||||||
spot = Spot(**json_spot)
|
|
||||||
|
# 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)
|
||||||
|
|
||||||
# Reject if no timestamp, frequency, dx_call or de_call
|
# 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:
|
if not spot.time or not spot.dx_call or not spot.freq or not spot.de_call:
|
||||||
@@ -116,11 +152,76 @@ class APISpotHandler(tornado.web.RequestHandler):
|
|||||||
self.set_header("Content-Type", "application/json")
|
self.set_header("Content-Type", "application/json")
|
||||||
return
|
return
|
||||||
|
|
||||||
# infer missing data, and add it to our database.
|
# Reject upstream submission if not permitted
|
||||||
spot.source = "API"
|
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
|
||||||
|
|
||||||
|
# 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()
|
spot.infer_missing()
|
||||||
self._spots.add(spot.id, spot, expire=MAX_SPOT_AGE)
|
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(safe_json_dumps("OK"))
|
self.write(safe_json_dumps("OK"))
|
||||||
self.set_status(201)
|
self.set_status(201)
|
||||||
self.set_header("Cache-Control", "no-store")
|
self.set_header("Cache-Control", "no-store")
|
||||||
@@ -132,3 +233,24 @@ class APISpotHandler(tornado.web.RequestHandler):
|
|||||||
self.set_status(500)
|
self.set_status(500)
|
||||||
self.set_header("Cache-Control", "no-store")
|
self.set_header("Cache-Control", "no-store")
|
||||||
self.set_header("Content-Type", "application/json")
|
self.set_header("Content-Type", "application/json")
|
||||||
|
|
||||||
|
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
|
||||||
|
|||||||
@@ -19,7 +19,7 @@ SSE_HANDLER_QUEUE_CHECK_INTERVAL = 5000
|
|||||||
|
|
||||||
|
|
||||||
class APIAlertsHandler(tornado.web.RequestHandler):
|
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):
|
def __init__(self, application: "Application", request: httputil.HTTPServerRequest, **kwargs: Any):
|
||||||
self._alerts = None
|
self._alerts = None
|
||||||
@@ -52,7 +52,7 @@ class APIAlertsHandler(tornado.web.RequestHandler):
|
|||||||
query_params = {k: v[0].decode("utf-8") for k, v in self.request.arguments.items()}
|
query_params = {k: v[0].decode("utf-8") for k, v in self.request.arguments.items()}
|
||||||
|
|
||||||
# Fetch all alerts matching the query, then optionally enrich with online data
|
# 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)
|
data = get_alert_list_with_filters(self._alerts, query_params)
|
||||||
if credentials:
|
if credentials:
|
||||||
data = self._enrich(data, credentials)
|
data = self._enrich(data, credentials)
|
||||||
@@ -70,7 +70,7 @@ class APIAlertsHandler(tornado.web.RequestHandler):
|
|||||||
|
|
||||||
|
|
||||||
class APIAlertsStreamHandler(tornado_eventsource.handler.EventSourceHandler):
|
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):
|
def __init__(self, application, request, **kwargs: Any):
|
||||||
self._sse_alert_queues = None
|
self._sse_alert_queues = None
|
||||||
@@ -102,7 +102,7 @@ class APIAlertsStreamHandler(tornado_eventsource.handler.EventSourceHandler):
|
|||||||
# request.arguments contains lists for each param key because technically the client can supply multiple,
|
# request.arguments contains lists for each param key because technically the client can supply multiple,
|
||||||
# reduce that to just the first entry, and convert bytes to string
|
# reduce that to just the first entry, and convert bytes to string
|
||||||
self._query_params = {k: v[0].decode("utf-8") for k, v in self.request.arguments.items()}
|
self._query_params = {k: v[0].decode("utf-8") for k, v in self.request.arguments.items()}
|
||||||
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
|
# Create a alert queue and add it to the web server's list. The web server will fill this when alerts arrive
|
||||||
self._alert_queue = Queue(maxsize=SSE_HANDLER_MAX_QUEUE_SIZE)
|
self._alert_queue = Queue(maxsize=SSE_HANDLER_MAX_QUEUE_SIZE)
|
||||||
|
|||||||
@@ -19,7 +19,7 @@ BANDS_SET = frozenset(BANDS)
|
|||||||
|
|
||||||
|
|
||||||
class APIDxStatsHandler(tornado.web.RequestHandler):
|
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):
|
def __init__(self, application: "Application", request: httputil.HTTPServerRequest, **kwargs: Any):
|
||||||
self._spots = None
|
self._spots = None
|
||||||
|
|||||||
@@ -19,7 +19,7 @@ from data.spot import Spot
|
|||||||
|
|
||||||
|
|
||||||
class APILookupCallHandler(tornado.web.RequestHandler):
|
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):
|
def __init__(self, application: "Application", request: httputil.HTTPServerRequest, **kwargs: Any):
|
||||||
self._web_server_metrics = None
|
self._web_server_metrics = None
|
||||||
@@ -46,7 +46,7 @@ class APILookupCallHandler(tornado.web.RequestHandler):
|
|||||||
if re.match(r"^[A-Z0-9/\-]*$", call):
|
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
|
# 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.
|
# 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 = Spot(dx_call=call)
|
||||||
fake_spot.infer_missing(credentials)
|
fake_spot.infer_missing(credentials)
|
||||||
data = {
|
data = {
|
||||||
@@ -83,7 +83,7 @@ class APILookupCallHandler(tornado.web.RequestHandler):
|
|||||||
|
|
||||||
|
|
||||||
class APILookupSIGRefHandler(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):
|
def __init__(self, application: "Application", request: httputil.HTTPServerRequest, **kwargs: Any):
|
||||||
self._web_server_metrics = None
|
self._web_server_metrics = None
|
||||||
@@ -135,7 +135,7 @@ class APILookupSIGRefHandler(tornado.web.RequestHandler):
|
|||||||
|
|
||||||
|
|
||||||
class APILookupGridHandler(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):
|
def __init__(self, application: "Application", request: httputil.HTTPServerRequest, **kwargs: Any):
|
||||||
self._web_server_metrics = None
|
self._web_server_metrics = None
|
||||||
|
|||||||
@@ -14,16 +14,18 @@ from core.utils import safe_json_dumps
|
|||||||
|
|
||||||
|
|
||||||
class APIOptionsHandler(tornado.web.RequestHandler):
|
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):
|
def __init__(self, application: "Application", request: httputil.HTTPServerRequest, **kwargs: Any):
|
||||||
self._status_data = None
|
self._status_data = None
|
||||||
self._web_server_metrics = None
|
self._web_server_metrics = None
|
||||||
|
self._spot_providers = None
|
||||||
super().__init__(application, request, **kwargs)
|
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._status_data = status_data
|
||||||
self._web_server_metrics = web_server_metrics
|
self._web_server_metrics = web_server_metrics
|
||||||
|
self._spot_providers = spot_providers or []
|
||||||
|
|
||||||
def get(self):
|
def get(self):
|
||||||
try:
|
try:
|
||||||
@@ -33,23 +35,37 @@ class APIOptionsHandler(tornado.web.RequestHandler):
|
|||||||
self._web_server_metrics["status"] = "OK"
|
self._web_server_metrics["status"] = "OK"
|
||||||
api_requests_counter.inc()
|
api_requests_counter.inc()
|
||||||
|
|
||||||
|
# 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)
|
||||||
|
|
||||||
|
# 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")
|
||||||
|
|
||||||
options = {"bands": BANDS,
|
options = {"bands": BANDS,
|
||||||
"modes": ALL_MODES,
|
"modes": ALL_MODES,
|
||||||
"mode_types": MODE_TYPES,
|
"mode_types": MODE_TYPES,
|
||||||
"sigs": SIGS,
|
"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": spot_sources,
|
||||||
"spot_sources": list(
|
"alert_sources": alert_sources,
|
||||||
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,
|
"continents": CONTINENTS,
|
||||||
"propagation_modes": list(PROPAGATION_MODES.values()),
|
"propagation_modes": list(PROPAGATION_MODES.values()),
|
||||||
"max_spot_age": MAX_SPOT_AGE,
|
"max_spot_age": MAX_SPOT_AGE,
|
||||||
"spot_allowed": ALLOW_SPOTTING}
|
"spot_allowed": ALLOW_SPOTTING,
|
||||||
# If spotting to this server is enabled, "API" is another valid spot source even though it does not come from
|
"spot_submit_providers": spot_submit_providers}
|
||||||
# one of our proviers.
|
|
||||||
if ALLOW_SPOTTING:
|
|
||||||
options["spot_sources"].append("API")
|
|
||||||
|
|
||||||
self.write(safe_json_dumps(options))
|
self.write(safe_json_dumps(options))
|
||||||
self.set_status(200)
|
self.set_status(200)
|
||||||
|
|||||||
@@ -12,7 +12,7 @@ from core.utils import safe_json_dumps
|
|||||||
|
|
||||||
|
|
||||||
class APISolarConditionsHandler(tornado.web.RequestHandler):
|
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):
|
def __init__(self, application: "Application", request: httputil.HTTPServerRequest, **kwargs: Any):
|
||||||
self._solar_conditions = None
|
self._solar_conditions = None
|
||||||
|
|||||||
@@ -19,7 +19,7 @@ SSE_HANDLER_QUEUE_CHECK_INTERVAL = 5000
|
|||||||
|
|
||||||
|
|
||||||
class APISpotsHandler(tornado.web.RequestHandler):
|
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):
|
def __init__(self, application: "Application", request: httputil.HTTPServerRequest, **kwargs: Any):
|
||||||
self._spots = None
|
self._spots = None
|
||||||
@@ -52,7 +52,7 @@ class APISpotsHandler(tornado.web.RequestHandler):
|
|||||||
query_params = {k: v[0].decode("utf-8") for k, v in self.request.arguments.items()}
|
query_params = {k: v[0].decode("utf-8") for k, v in self.request.arguments.items()}
|
||||||
|
|
||||||
# Fetch all spots matching the query, then optionally enrich with online data
|
# 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)
|
data = get_spot_list_with_filters(self._spots, query_params)
|
||||||
if credentials:
|
if credentials:
|
||||||
data = self._enrich(data, credentials)
|
data = self._enrich(data, credentials)
|
||||||
@@ -70,7 +70,7 @@ class APISpotsHandler(tornado.web.RequestHandler):
|
|||||||
|
|
||||||
|
|
||||||
class APISpotsStreamHandler(tornado_eventsource.handler.EventSourceHandler):
|
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):
|
def __init__(self, application, request, **kwargs: Any):
|
||||||
self._sse_spot_queues = None
|
self._sse_spot_queues = None
|
||||||
@@ -104,7 +104,7 @@ class APISpotsStreamHandler(tornado_eventsource.handler.EventSourceHandler):
|
|||||||
# request.arguments contains lists for each param key because technically the client can supply multiple,
|
# request.arguments contains lists for each param key because technically the client can supply multiple,
|
||||||
# reduce that to just the first entry, and convert bytes to string
|
# reduce that to just the first entry, and convert bytes to string
|
||||||
self._query_params = {k: v[0].decode("utf-8") for k, v in self.request.arguments.items()}
|
self._query_params = {k: v[0].decode("utf-8") for k, v in self.request.arguments.items()}
|
||||||
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
|
# Create a spot queue and add it to the web server's list. The web server will fill this when spots arrive
|
||||||
self._spot_queue = Queue(maxsize=SSE_HANDLER_MAX_QUEUE_SIZE)
|
self._spot_queue = Queue(maxsize=SSE_HANDLER_MAX_QUEUE_SIZE)
|
||||||
|
|||||||
@@ -12,7 +12,7 @@ from core.utils import safe_json_dumps
|
|||||||
|
|
||||||
|
|
||||||
class APIStatusHandler(tornado.web.RequestHandler):
|
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):
|
def __init__(self, application: "Application", request: httputil.HTTPServerRequest, **kwargs: Any):
|
||||||
self._status_data = None
|
self._status_data = None
|
||||||
|
|||||||
@@ -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()
|
||||||
@@ -1,16 +0,0 @@
|
|||||||
import logging
|
|
||||||
|
|
||||||
from tornado.web import StaticFileHandler, HTTPError
|
|
||||||
|
|
||||||
|
|
||||||
class QuietStaticFileHandler(StaticFileHandler):
|
|
||||||
"""Minor override of logging in StaticFileHandler to log HTTP errors at debug level instead of their usual
|
|
||||||
warning level. Without this, attacks on Spothole which try to do path traversal attacks would log exceptions
|
|
||||||
from inside Tornado, and the server logs would contain a lot of this type of content. This effectively changes
|
|
||||||
the log level of these exceptions to DEBUG so they are only logged if DEBUG level logging is enabled."""
|
|
||||||
|
|
||||||
def log_exception(self, typ, value, tb):
|
|
||||||
if isinstance(value, HTTPError):
|
|
||||||
logging.debug(value)
|
|
||||||
return
|
|
||||||
super().log_exception(typ, value, tb)
|
|
||||||
@@ -8,6 +8,7 @@ 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, LOG_WEB_REQUESTS, BASE_URL
|
||||||
from core.utils import empty_queue
|
from core.utils import empty_queue
|
||||||
from server.handlers.api.addspot import APISpotHandler
|
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.alerts import APIAlertsHandler, APIAlertsStreamHandler
|
||||||
from server.handlers.api.dxstats import APIDxStatsHandler
|
from server.handlers.api.dxstats import APIDxStatsHandler
|
||||||
from server.handlers.api.lookups import APILookupCallHandler, APILookupSIGRefHandler, APILookupGridHandler
|
from server.handlers.api.lookups import APILookupCallHandler, APILookupSIGRefHandler, APILookupGridHandler
|
||||||
@@ -18,7 +19,6 @@ from server.handlers.api.status import APIStatusHandler
|
|||||||
from server.handlers.manifesthandler import ManifestHandler
|
from server.handlers.manifesthandler import ManifestHandler
|
||||||
from server.handlers.metrics import PrometheusMetricsHandler
|
from server.handlers.metrics import PrometheusMetricsHandler
|
||||||
from server.handlers.pagetemplate import PageTemplateHandler
|
from server.handlers.pagetemplate import PageTemplateHandler
|
||||||
from server.handlers.quietstaticfilehandler import QuietStaticFileHandler
|
|
||||||
|
|
||||||
_HERE = os.path.dirname(__file__ or "")
|
_HERE = os.path.dirname(__file__ or "")
|
||||||
|
|
||||||
@@ -26,7 +26,7 @@ _HERE = os.path.dirname(__file__ or "")
|
|||||||
class WebServer:
|
class WebServer:
|
||||||
"""Provides the public-facing web server."""
|
"""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"""
|
"""Constructor"""
|
||||||
|
|
||||||
self._spots = spots
|
self._spots = spots
|
||||||
@@ -35,6 +35,7 @@ class WebServer:
|
|||||||
self._sse_spot_queues = []
|
self._sse_spot_queues = []
|
||||||
self._sse_alert_queues = []
|
self._sse_alert_queues = []
|
||||||
self._status_data = status_data
|
self._status_data = status_data
|
||||||
|
self._spot_providers = spot_providers or []
|
||||||
self._port = WEB_SERVER_PORT
|
self._port = WEB_SERVER_PORT
|
||||||
self._api_only_mode = API_ONLY_MODE
|
self._api_only_mode = API_ONLY_MODE
|
||||||
self._shutdown_event = asyncio.Event()
|
self._shutdown_event = asyncio.Event()
|
||||||
@@ -65,20 +66,29 @@ class WebServer:
|
|||||||
|
|
||||||
# API endpoints are always enabled
|
# API endpoints are always enabled
|
||||||
api_routes = [
|
api_routes = [
|
||||||
(r"/api/v1/spots", APISpotsHandler, {"spots": self._spots, **handler_opts}),
|
(r"/api/v2/spots", APISpotsHandler, {"spots": self._spots, **handler_opts}),
|
||||||
(r"/api/v1/alerts", APIAlertsHandler, {"alerts": self._alerts, **handler_opts}),
|
(r"/api/v2/alerts", APIAlertsHandler, {"alerts": self._alerts, **handler_opts}),
|
||||||
(r"/api/v1/spots/stream", APISpotsStreamHandler,
|
(r"/api/v2/spots/stream", APISpotsStreamHandler,
|
||||||
{"sse_spot_queues": self._sse_spot_queues, **handler_opts}),
|
{"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}),
|
{"sse_alert_queues": self._sse_alert_queues, **handler_opts}),
|
||||||
(r"/api/v1/solar", APISolarConditionsHandler, {"solar_conditions": self._solar_conditions, **handler_opts}),
|
(r"/api/v2/solar", APISolarConditionsHandler, {"solar_conditions": self._solar_conditions, **handler_opts}),
|
||||||
(r"/api/v1/dxstats", APIDxStatsHandler, {"spots": self._spots, **handler_opts}),
|
(r"/api/v2/dxstats", APIDxStatsHandler, {"spots": self._spots, **handler_opts}),
|
||||||
(r"/api/v1/options", APIOptionsHandler, {"status_data": self._status_data, **handler_opts}),
|
(r"/api/v2/options", APIOptionsHandler,
|
||||||
(r"/api/v1/status", APIStatusHandler, {"status_data": self._status_data, **handler_opts}),
|
{"status_data": self._status_data, "spot_providers": self._spot_providers, **handler_opts}),
|
||||||
(r"/api/v1/lookup/call", APILookupCallHandler, {**handler_opts}),
|
(r"/api/v2/status", APIStatusHandler, {"status_data": self._status_data, **handler_opts}),
|
||||||
(r"/api/v1/lookup/sigref", APILookupSIGRefHandler, {**handler_opts}),
|
(r"/api/v2/lookup/call", APILookupCallHandler, {**handler_opts}),
|
||||||
(r"/api/v1/lookup/grid", APILookupGridHandler, {**handler_opts}),
|
(r"/api/v2/lookup/sigref", APILookupSIGRefHandler, {**handler_opts}),
|
||||||
(r"/api/v1/spot", APISpotHandler, {"spots": self._spots, **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
|
# If in API-only mode, serve a basic homepage; in normal mode, serve the usual UI routes
|
||||||
@@ -101,15 +111,19 @@ class WebServer:
|
|||||||
if ALLOW_SPOTTING:
|
if ALLOW_SPOTTING:
|
||||||
ui_routes += [(r"/add-spot", PageTemplateHandler, {"template_name": "add_spot", **handler_opts})]
|
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, webapp manifest and static assets are always available regardless of API-only
|
||||||
|
# mode.
|
||||||
misc_routes = [
|
misc_routes = [
|
||||||
(r"/apidocs", PageTemplateHandler, {"template_name": "apidocs", **handler_opts}),
|
(r"/apidocs", PageTemplateHandler, {"template_name": "apidocs", **handler_opts}),
|
||||||
(r"/metrics", PrometheusMetricsHandler),
|
(r"/metrics", PrometheusMetricsHandler),
|
||||||
(r"/manifest.webmanifest", ManifestHandler),
|
(r"/manifest.webmanifest", ManifestHandler),
|
||||||
(r"/static/(.*)", QuietStaticFileHandler, {"path": os.path.join(_HERE, "../webassets")})
|
# If e.g. nginx is configured as a reverse proxy with a hard-coded path to static files, as per the README,
|
||||||
|
# this will never have to handle anything, but having it here allows Spothole to work without nginx for
|
||||||
|
# testing.
|
||||||
|
(r"/static/(.*)", StaticFileHandler, {"path": os.path.join(_HERE, "../static")})
|
||||||
]
|
]
|
||||||
|
|
||||||
app = tornado.web.Application(api_routes + ui_routes + misc_routes,
|
app = tornado.web.Application(api_routes + v1_compat_routes + ui_routes + misc_routes,
|
||||||
template_path=os.path.join(_HERE, "../templates"),
|
template_path=os.path.join(_HERE, "../templates"),
|
||||||
log_function=request_log,
|
log_function=request_log,
|
||||||
debug=False)
|
debug=False)
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ from threading import Thread, Event
|
|||||||
|
|
||||||
import pytz
|
import pytz
|
||||||
import requests
|
import requests
|
||||||
from requests.exceptions import ConnectionError
|
from requests.exceptions import ConnectionError, ReadTimeout, ConnectTimeout
|
||||||
|
|
||||||
from core.constants import HTTP_HEADERS
|
from core.constants import HTTP_HEADERS
|
||||||
from solarconditionsproviders.ionosonde_utils import compute_band_states
|
from solarconditionsproviders.ionosonde_utils import compute_band_states
|
||||||
@@ -134,6 +134,9 @@ class GIROIonosonde(SolarConditionsProvider):
|
|||||||
logging.warning(f"HTTP {http_response.status_code} when calling Giro ionosonde API.")
|
logging.warning(f"HTTP {http_response.status_code} when calling Giro ionosonde API.")
|
||||||
return None, None, None
|
return None, None, None
|
||||||
return self._parse_all(http_response.text)
|
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:
|
except ConnectionError:
|
||||||
logging.warning("Connection error when accessing Giro ionosonde API.")
|
logging.warning("Connection error when accessing Giro ionosonde API.")
|
||||||
return None, None, None
|
return None, None, None
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ from threading import Thread, Event
|
|||||||
|
|
||||||
import pytz
|
import pytz
|
||||||
import requests
|
import requests
|
||||||
from requests.exceptions import ConnectionError
|
from requests.exceptions import ConnectionError, ReadTimeout, ConnectTimeout
|
||||||
|
|
||||||
from core.constants import HTTP_HEADERS
|
from core.constants import HTTP_HEADERS
|
||||||
from solarconditionsproviders.solar_conditions_provider import SolarConditionsProvider
|
from solarconditionsproviders.solar_conditions_provider import SolarConditionsProvider
|
||||||
@@ -54,6 +54,8 @@ class HTTPSolarConditionsProvider(SolarConditionsProvider):
|
|||||||
|
|
||||||
except ConnectionError:
|
except ConnectionError:
|
||||||
logging.warning(f"Connection error when accessing {self.name} solar conditions API.")
|
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:
|
except Exception:
|
||||||
self.status = "Error"
|
self.status = "Error"
|
||||||
logging.exception("Exception in HTTP Solar Conditions Provider (" + self.name + ")")
|
logging.exception("Exception in HTTP Solar Conditions Provider (" + self.name + ")")
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ from threading import Thread, Event
|
|||||||
|
|
||||||
import pytz
|
import pytz
|
||||||
import requests
|
import requests
|
||||||
from requests.exceptions import ConnectionError
|
from requests.exceptions import ConnectionError, ReadTimeout, ConnectTimeout
|
||||||
|
|
||||||
from core.constants import HTTP_HEADERS
|
from core.constants import HTTP_HEADERS
|
||||||
from solarconditionsproviders.ionosonde_utils import compute_band_states
|
from solarconditionsproviders.ionosonde_utils import compute_band_states
|
||||||
@@ -118,6 +118,8 @@ class KC2GProp(SolarConditionsProvider):
|
|||||||
|
|
||||||
except ConnectionError:
|
except ConnectionError:
|
||||||
logging.warning("Connection error when accessing KC2G ionosonde API.")
|
logging.warning("Connection error when accessing KC2G ionosonde API.")
|
||||||
|
except (ConnectTimeout, ReadTimeout):
|
||||||
|
logging.warning(f"Timeout when accessing KC2G ionosonde API.")
|
||||||
except Exception:
|
except Exception:
|
||||||
self.status = "Error"
|
self.status = "Error"
|
||||||
logging.exception("Exception in KC2G ionosonde data provider")
|
logging.exception("Exception in KC2G ionosonde data provider")
|
||||||
|
|||||||
@@ -102,18 +102,21 @@ if __name__ == '__main__':
|
|||||||
# Set up lookup helper
|
# Set up lookup helper
|
||||||
lookup_helper.start()
|
lookup_helper.start()
|
||||||
|
|
||||||
# Set up web server
|
# Create spot providers
|
||||||
web_server = WebServer(spots=spots, alerts=alerts, solar_conditions=solar_conditions, status_data=status_data)
|
|
||||||
|
|
||||||
# Fetch, set up and start spot providers
|
|
||||||
for entry in config["spot-providers"]:
|
for entry in config["spot-providers"]:
|
||||||
spot_providers.append(get_spot_provider_from_config(entry))
|
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:
|
for p in spot_providers:
|
||||||
p.setup(spots=spots, web_server=web_server)
|
p.setup(spots=spots, web_server=web_server)
|
||||||
if p.enabled:
|
if p.enabled:
|
||||||
p.start()
|
p.start()
|
||||||
|
|
||||||
# Fetch, set up and start alert providers
|
# Create, set up and start alert providers
|
||||||
for entry in config["alert-providers"]:
|
for entry in config["alert-providers"]:
|
||||||
alert_providers.append(get_alert_provider_from_config(entry))
|
alert_providers.append(get_alert_provider_from_config(entry))
|
||||||
for p in alert_providers:
|
for p in alert_providers:
|
||||||
@@ -121,7 +124,7 @@ if __name__ == '__main__':
|
|||||||
if p.enabled:
|
if p.enabled:
|
||||||
p.start()
|
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", []):
|
for entry in config.get("solar-condition-providers", []):
|
||||||
solar_condition_providers.append(get_solar_conditions_provider_from_config(entry))
|
solar_condition_providers.append(get_solar_conditions_provider_from_config(entry))
|
||||||
for p in solar_condition_providers:
|
for p in solar_condition_providers:
|
||||||
|
|||||||
@@ -112,3 +112,11 @@ class GMA(HTTPSpotProvider):
|
|||||||
logging.warning(f"The GMA API returned an unexpected response (HTTP {http_response.status_code}).")
|
logging.warning(f"The GMA API returned an unexpected response (HTTP {http_response.status_code}).")
|
||||||
|
|
||||||
return new_spots
|
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")
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ from datetime import datetime
|
|||||||
|
|
||||||
import pytz
|
import pytz
|
||||||
import requests
|
import requests
|
||||||
from requests.exceptions import ConnectionError
|
from requests.exceptions import ConnectionError, ReadTimeout, ConnectTimeout
|
||||||
|
|
||||||
from core.constants import HTTP_HEADERS
|
from core.constants import HTTP_HEADERS
|
||||||
from data.sig_ref import SIGRef
|
from data.sig_ref import SIGRef
|
||||||
@@ -68,6 +68,16 @@ class HEMA(HTTPSpotProvider):
|
|||||||
# Add to our list. Don't worry about de-duping, removing old spots etc. at this point; other
|
# Add to our list. Don't worry about de-duping, removing old spots etc. at this point; other
|
||||||
# code will do that for us.
|
# code will do that for us.
|
||||||
new_spots.append(spot)
|
new_spots.append(spot)
|
||||||
|
except (ConnectTimeout, ReadTimeout):
|
||||||
|
logging.warning(f"Timeout when accessing HEMA spots API.")
|
||||||
except ConnectionError:
|
except ConnectionError:
|
||||||
logging.warning("Connection error when accessing HEMA spots API.")
|
logging.warning("Connection error when accessing HEMA spots API.")
|
||||||
return new_spots
|
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")
|
||||||
|
|||||||
@@ -4,7 +4,8 @@ from threading import Thread, Event
|
|||||||
|
|
||||||
import pytz
|
import pytz
|
||||||
import requests
|
import requests
|
||||||
from requests.exceptions import ConnectionError
|
from requests import ReadTimeout
|
||||||
|
from requests.exceptions import ConnectionError, ConnectTimeout
|
||||||
|
|
||||||
from core.constants import HTTP_HEADERS
|
from core.constants import HTTP_HEADERS
|
||||||
from spotproviders.spot_provider import SpotProvider
|
from spotproviders.spot_provider import SpotProvider
|
||||||
@@ -20,6 +21,7 @@ class HTTPSpotProvider(SpotProvider):
|
|||||||
self._poll_interval = poll_interval
|
self._poll_interval = poll_interval
|
||||||
self._thread = None
|
self._thread = None
|
||||||
self._stop_event = Event()
|
self._stop_event = Event()
|
||||||
|
self._wakeup_event = Event()
|
||||||
|
|
||||||
def start(self):
|
def start(self):
|
||||||
# Fire off the polling thread. It will poll immediately on startup, then sleep for poll_interval between
|
# Fire off the polling thread. It will poll immediately on startup, then sleep for poll_interval between
|
||||||
@@ -30,11 +32,19 @@ class HTTPSpotProvider(SpotProvider):
|
|||||||
|
|
||||||
def stop(self):
|
def stop(self):
|
||||||
self._stop_event.set()
|
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):
|
def _run(self):
|
||||||
while True:
|
while True:
|
||||||
|
self._wakeup_event.clear()
|
||||||
self._poll()
|
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
|
break
|
||||||
|
|
||||||
def _poll(self):
|
def _poll(self):
|
||||||
@@ -59,6 +69,8 @@ class HTTPSpotProvider(SpotProvider):
|
|||||||
|
|
||||||
except ConnectionError:
|
except ConnectionError:
|
||||||
logging.warning(f"Connection error when accessing {self.name} spots API.")
|
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:
|
except Exception:
|
||||||
self.status = "Error"
|
self.status = "Error"
|
||||||
logging.exception("Exception in HTTP JSON Spot Provider (" + self.name + ")")
|
logging.exception("Exception in HTTP JSON Spot Provider (" + self.name + ")")
|
||||||
|
|||||||
@@ -3,7 +3,9 @@ import re
|
|||||||
from datetime import datetime
|
from datetime import datetime
|
||||||
|
|
||||||
import pytz
|
import pytz
|
||||||
|
import requests
|
||||||
|
|
||||||
|
from core.constants import HTTP_HEADERS
|
||||||
from data.sig_ref import SIGRef
|
from data.sig_ref import SIGRef
|
||||||
from data.spot import Spot
|
from data.spot import Spot
|
||||||
from spotproviders.http_spot_provider import HTTPSpotProvider
|
from spotproviders.http_spot_provider import HTTPSpotProvider
|
||||||
@@ -14,7 +16,9 @@ class ParksNPeaks(HTTPSpotProvider):
|
|||||||
|
|
||||||
POLL_INTERVAL_SEC = 120
|
POLL_INTERVAL_SEC = 120
|
||||||
SPOTS_URL = "https://www.parksnpeaks.org/api/ALL"
|
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"
|
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):
|
def __init__(self, provider_config):
|
||||||
super().__init__(provider_config, self.SPOTS_URL, self.POLL_INTERVAL_SEC)
|
super().__init__(provider_config, self.SPOTS_URL, self.POLL_INTERVAL_SEC)
|
||||||
@@ -63,3 +67,28 @@ class ParksNPeaks(HTTPSpotProvider):
|
|||||||
# Add new spot to the list
|
# Add new spot to the list
|
||||||
new_spots.append(spot)
|
new_spots.append(spot)
|
||||||
return new_spots
|
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)
|
||||||
|
|||||||
@@ -1,7 +1,9 @@
|
|||||||
from datetime import datetime
|
from datetime import datetime
|
||||||
|
|
||||||
import pytz
|
import pytz
|
||||||
|
import requests
|
||||||
|
|
||||||
|
from core.constants import HTTP_HEADERS
|
||||||
from data.sig_ref import SIGRef
|
from data.sig_ref import SIGRef
|
||||||
from data.spot import Spot
|
from data.spot import Spot
|
||||||
from spotproviders.http_spot_provider import HTTPSpotProvider
|
from spotproviders.http_spot_provider import HTTPSpotProvider
|
||||||
@@ -12,6 +14,7 @@ class POTA(HTTPSpotProvider):
|
|||||||
|
|
||||||
POLL_INTERVAL_SEC = 120
|
POLL_INTERVAL_SEC = 120
|
||||||
SPOTS_URL = "https://api.pota.app/spot/activator"
|
SPOTS_URL = "https://api.pota.app/spot/activator"
|
||||||
|
SUBMIT_URL = "https://api.pota.app/spot"
|
||||||
|
|
||||||
def __init__(self, provider_config):
|
def __init__(self, provider_config):
|
||||||
super().__init__(provider_config, self.SPOTS_URL, self.POLL_INTERVAL_SEC)
|
super().__init__(provider_config, self.SPOTS_URL, self.POLL_INTERVAL_SEC)
|
||||||
@@ -40,3 +43,25 @@ class POTA(HTTPSpotProvider):
|
|||||||
# that for us.
|
# that for us.
|
||||||
new_spots.append(spot)
|
new_spots.append(spot)
|
||||||
return new_spots
|
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.")
|
||||||
|
|||||||
@@ -2,9 +2,9 @@ import logging
|
|||||||
from datetime import datetime
|
from datetime import datetime
|
||||||
|
|
||||||
import requests
|
import requests
|
||||||
from requests.exceptions import ConnectionError
|
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.sig_ref import SIGRef
|
||||||
from data.spot import Spot
|
from data.spot import Spot
|
||||||
from spotproviders.http_spot_provider import HTTPSpotProvider
|
from spotproviders.http_spot_provider import HTTPSpotProvider
|
||||||
@@ -22,6 +22,9 @@ class SOTA(HTTPSpotProvider):
|
|||||||
# SOTA spots don't contain lat/lon, we need a separate lookup for that
|
# 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/"
|
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):
|
def __init__(self, provider_config):
|
||||||
super().__init__(provider_config, self.EPOCH_URL, self.POLL_INTERVAL_SEC)
|
super().__init__(provider_config, self.EPOCH_URL, self.POLL_INTERVAL_SEC)
|
||||||
self._api_epoch = ""
|
self._api_epoch = ""
|
||||||
@@ -60,4 +63,49 @@ class SOTA(HTTPSpotProvider):
|
|||||||
new_spots.append(spot)
|
new_spots.append(spot)
|
||||||
except ConnectionError:
|
except ConnectionError:
|
||||||
logging.warning("Connection error when accessing SOTA spots API")
|
logging.warning("Connection error when accessing SOTA spots API")
|
||||||
|
except (ConnectTimeout, ReadTimeout):
|
||||||
|
logging.warning(f"Timeout when accessing SOTA spots API.")
|
||||||
return new_spots
|
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.")
|
||||||
|
|||||||
@@ -68,3 +68,20 @@ class SpotProvider:
|
|||||||
"""Stop any threads and prepare for application shutdown"""
|
"""Stop any threads and prepare for application shutdown"""
|
||||||
|
|
||||||
raise NotImplementedError("Subclasses must implement this method")
|
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
|
||||||
|
|||||||
@@ -1,5 +1,8 @@
|
|||||||
from datetime import datetime
|
from datetime import datetime
|
||||||
|
|
||||||
|
import requests
|
||||||
|
|
||||||
|
from core.constants import HTTP_HEADERS, SSB_SUB_MODES
|
||||||
from data.sig_ref import SIGRef
|
from data.sig_ref import SIGRef
|
||||||
from data.spot import Spot
|
from data.spot import Spot
|
||||||
from spotproviders.http_spot_provider import HTTPSpotProvider
|
from spotproviders.http_spot_provider import HTTPSpotProvider
|
||||||
@@ -10,6 +13,9 @@ class Tiles(HTTPSpotProvider):
|
|||||||
|
|
||||||
POLL_INTERVAL_SEC = 120
|
POLL_INTERVAL_SEC = 120
|
||||||
SPOTS_URL = "https://icneuzxitdqtofutxbla.supabase.co/functions/v1/spots?active_hours=24"
|
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):
|
def __init__(self, provider_config):
|
||||||
super().__init__(provider_config, self.SPOTS_URL, self.POLL_INTERVAL_SEC)
|
super().__init__(provider_config, self.SPOTS_URL, self.POLL_INTERVAL_SEC)
|
||||||
@@ -42,6 +48,49 @@ class Tiles(HTTPSpotProvider):
|
|||||||
new_spots.append(spot)
|
new_spots.append(spot)
|
||||||
return new_spots
|
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'
|
# 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".
|
# strange frequency format where we can sometimes have e.g. "14.123.5".
|
||||||
|
|||||||
@@ -79,3 +79,10 @@ class WOTA(HTTPSpotProvider):
|
|||||||
except Exception as e:
|
except Exception as e:
|
||||||
logging.error("Exception parsing WOTA spot", e)
|
logging.error("Exception parsing WOTA spot", e)
|
||||||
return new_spots
|
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")
|
||||||
|
|||||||
@@ -41,3 +41,10 @@ class WWBOTA(SSESpotProvider):
|
|||||||
|
|
||||||
# WWBOTA does support a special "Test" spot type, we need to avoid adding that.
|
# WWBOTA does support a special "Test" spot type, we need to avoid adding that.
|
||||||
return spot if source_spot["type"] != "Test" else None
|
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")
|
||||||
|
|||||||
@@ -38,3 +38,11 @@ class WWFF(HTTPSpotProvider):
|
|||||||
# that for us.
|
# that for us.
|
||||||
new_spots.append(spot)
|
new_spots.append(spot)
|
||||||
return new_spots
|
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")
|
||||||
|
|||||||
@@ -41,3 +41,10 @@ class ZLOTA(HTTPSpotProvider):
|
|||||||
|
|
||||||
new_spots.append(spot)
|
new_spots.append(spot)
|
||||||
return new_spots
|
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")
|
||||||
|
|||||||
@@ -15,6 +15,14 @@ info:
|
|||||||
|
|
||||||
## Changelog
|
## 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
|
### 1.4
|
||||||
|
|
||||||
* Spots can now include a "propagation_mode" field, and the `/options` call enumerates the options that can have.
|
* Spots can now include a "propagation_mode" field, and the `/options` call enumerates the options that can have.
|
||||||
@@ -45,10 +53,10 @@ info:
|
|||||||
license:
|
license:
|
||||||
name: The Unlicense
|
name: The Unlicense
|
||||||
url: https://unlicense.org/#the-unlicense
|
url: https://unlicense.org/#the-unlicense
|
||||||
version: v1.4
|
version: 2.0
|
||||||
|
|
||||||
servers:
|
servers:
|
||||||
- url: https://spothole.app/api/v1
|
- url: https://spothole.app/api/v2
|
||||||
|
|
||||||
tags:
|
tags:
|
||||||
- name: Spots
|
- name: Spots
|
||||||
@@ -329,7 +337,8 @@ paths:
|
|||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
$ref: '#/components/schemas/ErrorResponse'
|
type: string
|
||||||
|
example: "Failed"
|
||||||
|
|
||||||
|
|
||||||
/lookup/sigref:
|
/lookup/sigref:
|
||||||
@@ -357,7 +366,8 @@ paths:
|
|||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
$ref: '#/components/schemas/ErrorResponse'
|
type: string
|
||||||
|
example: "Failed"
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -383,7 +393,8 @@ paths:
|
|||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
$ref: '#/components/schemas/ErrorResponse'
|
type: string
|
||||||
|
example: "Failed"
|
||||||
|
|
||||||
|
|
||||||
/spot:
|
/spot:
|
||||||
@@ -392,50 +403,53 @@ paths:
|
|||||||
- Spots
|
- Spots
|
||||||
summary: Add a spot
|
summary: Add a spot
|
||||||
description: >
|
description: >
|
||||||
Supply a new spot object, which will be added to the system. Currently, this will not be
|
Supply a JSON object containing a `spot` sub-object (the spot data) and an optional `handling` sub-object
|
||||||
reported up the chain to a cluster, POTA, SOTA etc. This may be introduced in a future version.
|
containing server-side instructions such as upstream submission). Check `spot_submit_providers` in the
|
||||||
cURL example: `curl --request POST --header "Content-Type: application/json" --data
|
`/options` response to see which SIGs and providers support upstream submission. cURL example:
|
||||||
'{"dx_call":"M0TRT","time":1760019539, "freq":14200000, "comment":"Test spot please ignore",
|
`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`"
|
||||||
"de_call":"M0TRT"}' https://spothole.app/api/v1/spot`
|
|
||||||
operationId: spot
|
operationId: spot
|
||||||
requestBody:
|
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
|
required: true
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
$ref: '#/components/schemas/Spot'
|
$ref: '#/components/schemas/SpotSubmission'
|
||||||
responses:
|
responses:
|
||||||
'200':
|
'201':
|
||||||
description: Success
|
description: Success
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
$ref: '#/components/schemas/OkResponse'
|
type: string
|
||||||
|
example: "OK"
|
||||||
'415':
|
'415':
|
||||||
description: Incorrect Content-Type
|
description: Incorrect Content-Type
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
$ref: '#/components/schemas/ErrorResponse'
|
type: string
|
||||||
|
example: "Failed"
|
||||||
'422':
|
'422':
|
||||||
description: Validation error
|
description: Validation error
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
$ref: '#/components/schemas/ErrorResponse'
|
type: string
|
||||||
|
example: "Failed"
|
||||||
'500':
|
'500':
|
||||||
description: Internal server error
|
description: Internal server error
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
$ref: '#/components/schemas/ErrorResponse'
|
type: string
|
||||||
|
example: "Failed"
|
||||||
|
|
||||||
components:
|
components:
|
||||||
parameters:
|
parameters:
|
||||||
QrzUsername:
|
QrzUsername:
|
||||||
name: qrz_username
|
name: X-QRZ-Username
|
||||||
in: query
|
in: header
|
||||||
description: >
|
description: >
|
||||||
QRZ.com username for online callsign lookup, which will enrich the returned spots and alerts
|
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
|
with extra data. Requires a QRZ.com XML Subscriber (paid) account. Supply together with
|
||||||
@@ -443,14 +457,14 @@ components:
|
|||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
QrzPassword:
|
QrzPassword:
|
||||||
name: qrz_password
|
name: X-QRZ-Password
|
||||||
in: query
|
in: header
|
||||||
description: QRZ.com password. Supply together with `qrz_username`.
|
description: QRZ.com password. Supply together with `qrz_username`.
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
QrzSessionKey:
|
QrzSessionKey:
|
||||||
name: qrz_session_key
|
name: X-QRZ-Session-Key
|
||||||
in: query
|
in: header
|
||||||
description: >
|
description: >
|
||||||
A pre-obtained QRZ.com XML session key, as an alternative to supplying `qrz_username` and
|
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
|
`qrz_password`. See https://www.qrz.com/docs/xml/current_spec.html for details on how to
|
||||||
@@ -458,22 +472,22 @@ components:
|
|||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
HamqthUsername:
|
HamqthUsername:
|
||||||
name: hamqth_username
|
name: X-HamQTH-Username
|
||||||
in: query
|
in: header
|
||||||
description: >
|
description: >
|
||||||
HamQTH username for online callsign lookup, which will enrich the returned spots and alerts
|
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.
|
with extra data. Supply together with `hamqth_password`, or supply `hamqth_session_id` instead.
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
HamqthPassword:
|
HamqthPassword:
|
||||||
name: hamqth_password
|
name: X-HamQTH-Password
|
||||||
in: query
|
in: header
|
||||||
description: HamQTH password. Supply together with `hamqth_username`.
|
description: HamQTH password. Supply together with `hamqth_username`.
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
HamqthSessionId:
|
HamqthSessionId:
|
||||||
name: hamqth_session_id
|
name: X-HamQTH-Session-ID
|
||||||
in: query
|
in: header
|
||||||
description: >
|
description: >
|
||||||
A pre-obtained HamQTH session ID, as an alternative to supplying `hamqth_username` and
|
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
|
`hamqth_password`. See https://www.hamqth.com/developers.php for details on how to retrieve
|
||||||
@@ -1184,6 +1198,54 @@ components:
|
|||||||
$ref: "#/components/schemas/PropagationMode"
|
$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:
|
SpotStream:
|
||||||
type: object
|
type: object
|
||||||
description: A server-sent event containing a spot
|
description: A server-sent event containing a spot
|
||||||
@@ -1730,14 +1792,6 @@ components:
|
|||||||
items:
|
items:
|
||||||
$ref: '#/components/schemas/Alert'
|
$ref: '#/components/schemas/Alert'
|
||||||
|
|
||||||
OkResponse:
|
|
||||||
type: string
|
|
||||||
example: "OK"
|
|
||||||
|
|
||||||
ErrorResponse:
|
|
||||||
type: string
|
|
||||||
example: "Failed"
|
|
||||||
|
|
||||||
DxStats:
|
DxStats:
|
||||||
type: object
|
type: object
|
||||||
description: Spot counts keyed by DE continent
|
description: Spot counts keyed by DE continent
|
||||||
@@ -1875,7 +1929,7 @@ components:
|
|||||||
type: integer
|
type: integer
|
||||||
description: >
|
description: >
|
||||||
The maximum age, in seconds, of any spot before it will be deleted by the system. When
|
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
|
is no point providing a number larger than this, because the system drops all spots older
|
||||||
than this.
|
than this.
|
||||||
example: 3600
|
example: 3600
|
||||||
@@ -1885,6 +1939,20 @@ components:
|
|||||||
Whether the POST /spot call, to add spots to the server directly via its API, is permitted
|
Whether the POST /spot call, to add spots to the server directly via its API, is permitted
|
||||||
on this server.
|
on this server.
|
||||||
example: true
|
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:
|
CallLookup:
|
||||||
type: object
|
type: object
|
||||||
|
Before Width: | Height: | Size: 129 KiB After Width: | Height: | Size: 129 KiB |
|
Before Width: | Height: | Size: 125 KiB After Width: | Height: | Size: 125 KiB |
|
Before Width: | Height: | Size: 3.9 KiB After Width: | Height: | Size: 3.9 KiB |
|
Before Width: | Height: | Size: 7.0 KiB After Width: | Height: | Size: 7.0 KiB |
|
Before Width: | Height: | Size: 6.5 KiB After Width: | Height: | Size: 6.5 KiB |
|
Before Width: | Height: | Size: 348 B After Width: | Height: | Size: 348 B |
|
Before Width: | Height: | Size: 348 B After Width: | Height: | Size: 348 B |
|
Before Width: | Height: | Size: 7.2 KiB After Width: | Height: | Size: 7.2 KiB |
|
Before Width: | Height: | Size: 4.8 KiB After Width: | Height: | Size: 4.8 KiB |
|
Before Width: | Height: | Size: 14 KiB After Width: | Height: | Size: 14 KiB |
|
Before Width: | Height: | Size: 5.9 KiB After Width: | Height: | Size: 5.9 KiB |
|
Before Width: | Height: | Size: 4.1 KiB After Width: | Height: | Size: 4.1 KiB |
|
Before Width: | Height: | Size: 8.7 KiB After Width: | Height: | Size: 8.7 KiB |
|
Before Width: | Height: | Size: 4.9 KiB After Width: | Height: | Size: 4.9 KiB |
|
Before Width: | Height: | Size: 6.4 KiB After Width: | Height: | Size: 6.4 KiB |
|
Before Width: | Height: | Size: 14 KiB After Width: | Height: | Size: 14 KiB |
|
Before Width: | Height: | Size: 9.1 KiB After Width: | Height: | Size: 9.1 KiB |
|
Before Width: | Height: | Size: 4.8 KiB After Width: | Height: | Size: 4.8 KiB |
|
Before Width: | Height: | Size: 348 B After Width: | Height: | Size: 348 B |
|
Before Width: | Height: | Size: 7.3 KiB After Width: | Height: | Size: 7.3 KiB |
|
Before Width: | Height: | Size: 348 B After Width: | Height: | Size: 348 B |
|
Before Width: | Height: | Size: 4.9 KiB After Width: | Height: | Size: 4.9 KiB |
|
Before Width: | Height: | Size: 9.5 KiB After Width: | Height: | Size: 9.5 KiB |
|
Before Width: | Height: | Size: 6.5 KiB After Width: | Height: | Size: 6.5 KiB |
|
Before Width: | Height: | Size: 348 B After Width: | Height: | Size: 348 B |
|
Before Width: | Height: | Size: 9.8 KiB After Width: | Height: | Size: 9.8 KiB |
|
Before Width: | Height: | Size: 8.2 KiB After Width: | Height: | Size: 8.2 KiB |
|
Before Width: | Height: | Size: 8.9 KiB After Width: | Height: | Size: 8.9 KiB |
|
Before Width: | Height: | Size: 14 KiB After Width: | Height: | Size: 14 KiB |
|
Before Width: | Height: | Size: 7.0 KiB After Width: | Height: | Size: 7.0 KiB |
|
Before Width: | Height: | Size: 4.8 KiB After Width: | Height: | Size: 4.8 KiB |
|
Before Width: | Height: | Size: 4.4 KiB After Width: | Height: | Size: 4.4 KiB |
|
Before Width: | Height: | Size: 348 B After Width: | Height: | Size: 348 B |
|
Before Width: | Height: | Size: 348 B After Width: | Height: | Size: 348 B |
|
Before Width: | Height: | Size: 7.6 KiB After Width: | Height: | Size: 7.6 KiB |
|
Before Width: | Height: | Size: 6.4 KiB After Width: | Height: | Size: 6.4 KiB |
|
Before Width: | Height: | Size: 9.8 KiB After Width: | Height: | Size: 9.8 KiB |
|
Before Width: | Height: | Size: 7.0 KiB After Width: | Height: | Size: 7.0 KiB |
|
Before Width: | Height: | Size: 6.1 KiB After Width: | Height: | Size: 6.1 KiB |
|
Before Width: | Height: | Size: 9.3 KiB After Width: | Height: | Size: 9.3 KiB |
|
Before Width: | Height: | Size: 348 B After Width: | Height: | Size: 348 B |
|
Before Width: | Height: | Size: 8.4 KiB After Width: | Height: | Size: 8.4 KiB |
|
Before Width: | Height: | Size: 3.3 KiB After Width: | Height: | Size: 3.3 KiB |
|
Before Width: | Height: | Size: 8.4 KiB After Width: | Height: | Size: 8.4 KiB |
|
Before Width: | Height: | Size: 14 KiB After Width: | Height: | Size: 14 KiB |
|
Before Width: | Height: | Size: 348 B After Width: | Height: | Size: 348 B |
|
Before Width: | Height: | Size: 4.9 KiB After Width: | Height: | Size: 4.9 KiB |
|
Before Width: | Height: | Size: 7.4 KiB After Width: | Height: | Size: 7.4 KiB |
|
Before Width: | Height: | Size: 12 KiB After Width: | Height: | Size: 12 KiB |
|
Before Width: | Height: | Size: 6.4 KiB After Width: | Height: | Size: 6.4 KiB |
|
Before Width: | Height: | Size: 5.5 KiB After Width: | Height: | Size: 5.5 KiB |
|
Before Width: | Height: | Size: 10 KiB After Width: | Height: | Size: 10 KiB |
|
Before Width: | Height: | Size: 4.9 KiB After Width: | Height: | Size: 4.9 KiB |
|
Before Width: | Height: | Size: 5.0 KiB After Width: | Height: | Size: 5.0 KiB |
|
Before Width: | Height: | Size: 9.1 KiB After Width: | Height: | Size: 9.1 KiB |
|
Before Width: | Height: | Size: 6.1 KiB After Width: | Height: | Size: 6.1 KiB |
|
Before Width: | Height: | Size: 6.7 KiB After Width: | Height: | Size: 6.7 KiB |
|
Before Width: | Height: | Size: 4.4 KiB After Width: | Height: | Size: 4.4 KiB |
|
Before Width: | Height: | Size: 9.1 KiB After Width: | Height: | Size: 9.1 KiB |
|
Before Width: | Height: | Size: 348 B After Width: | Height: | Size: 348 B |
|
Before Width: | Height: | Size: 7.7 KiB After Width: | Height: | Size: 7.7 KiB |