CQ/ITU zone lookups

server/handlers/api/lookups.py

@@ -5,8 +5,10 @@ from datetime import datetime
 
 import pytz
 import tornado
+from pyhamtools.locator import locator_to_latlong
 
 from core.constants import SIGS
+from core.geo_utils import lat_lon_for_grid_sw_corner_plus_size, lat_lon_to_cq_zone, lat_lon_to_itu_zone
 from core.prometheus_metrics_handler import api_requests_counter
 from core.sig_utils import get_ref_regex_for_sig, populate_sig_ref_info
 from core.utils import serialize_everything
@@ -119,3 +121,61 @@ class APILookupSIGRefHandler(tornado.web.RequestHandler):
 
         self.set_header("Cache-Control", "no-store")
         self.set_header("Content-Type", "application/json")
+
+
+
+# API request handler for /api/v1/lookup/grid
+class APILookupGridHandler(tornado.web.RequestHandler):
+    def initialize(self, web_server_metrics):
+        self.web_server_metrics = web_server_metrics
+
+    def get(self):
+        try:
+            # Metrics
+            self.web_server_metrics["last_api_access_time"] = datetime.now(pytz.UTC)
+            self.web_server_metrics["api_access_counter"] += 1
+            self.web_server_metrics["status"] = "OK"
+            api_requests_counter.inc()
+
+            # request.arguments contains lists for each param key because technically the client can supply multiple,
+            # reduce that to just the first entry, and convert bytes to string
+            query_params = {k: v[0].decode("utf-8") for k, v in self.request.arguments.items()}
+
+            # "grid" query param must exist.
+            if "grid" in query_params.keys():
+                grid = query_params.get("grid").upper()
+                lat, lon, lat_cell_size, lon_cell_size = lat_lon_for_grid_sw_corner_plus_size(grid)
+                if lat is not None and lon is not None and lat_cell_size is not None and lon_cell_size is not None:
+                    center_lat = lat + lat_cell_size / 2.0
+                    center_lon = lon + lon_cell_size / 2.0
+                    center_cq_zone = lat_lon_to_cq_zone(center_lat, center_lon)
+                    center_itu_zone = lat_lon_to_itu_zone(center_lat, center_lon)
+
+                    response = {
+                        "center" : {
+                            "latitude": center_lat,
+                            "longitude": center_lon,
+                            "cq_zone": center_cq_zone,
+                            "itu_zone": center_itu_zone
+                        },
+                        "southwest" : {
+                            "latitude": lat,
+                            "longitude": lon,
+                        },
+                        "northeast" : {
+                            "latitude": lat + lat_cell_size,
+                            "longitude": lon + lon_cell_size,
+                        }}
+                    self.write(json.dumps(response, default=serialize_everything))
+
+            else:
+                self.write(json.dumps("Error - grid must be provided", default=serialize_everything))
+                self.set_status(422)
+
+        except Exception as e:
+            logging.error(e)
+            self.write(json.dumps("Error - " + str(e), default=serialize_everything))
+            self.set_status(500)
+
+        self.set_header("Cache-Control", "no-store")
+        self.set_header("Content-Type", "application/json")

server/webserver.py

@@ -7,7 +7,7 @@ from tornado.web import StaticFileHandler
 
 from server.handlers.api.addspot import APISpotHandler
 from server.handlers.api.alerts import APIAlertsHandler, APIAlertsStreamHandler
-from server.handlers.api.lookups import APILookupCallHandler, APILookupSIGRefHandler
+from server.handlers.api.lookups import APILookupCallHandler, APILookupSIGRefHandler, APILookupGridHandler
 from server.handlers.api.options import APIOptionsHandler
 from server.handlers.api.spots import APISpotsHandler, APISpotsStreamHandler
 from server.handlers.api.status import APIStatusHandler
@@ -54,6 +54,7 @@ class WebServer:
             (r"/api/v1/status", APIStatusHandler, {"status_data": self.status_data, "web_server_metrics": self.web_server_metrics}),
             (r"/api/v1/lookup/call", APILookupCallHandler, {"web_server_metrics": self.web_server_metrics}),
             (r"/api/v1/lookup/sigref", APILookupSIGRefHandler, {"web_server_metrics": self.web_server_metrics}),
+            (r"/api/v1/lookup/grid", APILookupGridHandler, {"web_server_metrics": self.web_server_metrics}),
             (r"/api/v1/spot", APISpotHandler, {"spots": self.spots, "web_server_metrics": self.web_server_metrics}),
             # Routes for templated pages
             (r"/", PageTemplateHandler, {"template_name": "spots", "web_server_metrics": self.web_server_metrics}),