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