Giant refactor to rebrand "SIG" as "Activity" anywhere that doesn't touch API or config file (which is to be addressed in a future breaking change). #147

providers/activityrefdata/pnp_kml_activity_ref_data_provider.py

@@ -0,0 +1,65 @@
+import re
+from time import sleep
+
+from fastkml import kml
+from pyhamtools.locator import latlong_to_locator
+
+from core.enums import ActivityRefType
+from data.activity_ref import ActivityRef
+from providers.activityrefdata.file_download_activity_ref_data_provider import (
+    FileDownloadActivityRefDataProvider,
+)
+
+
+class ParksNPeaksKMLActivityRefDataProvider(FileDownloadActivityRefDataProvider):
+    """Base class for activity ref data providers that use parksnpeaks.org KML POI feeds and have references that
+    use the VKFF refs rather than their own system (i.e. KRMNPA and SANPCPA)."""
+
+    REF_PATTERN = re.compile(r"VKFF-\d+")
+
+    def __init__(self, sig_name, provider_config, url, poll_interval):
+        """Set up the provider, note poll_interval is in *days*."""
+        super().__init__(sig_name, provider_config, url, poll_interval)
+
+    def _http_response_to_data(self, http_response):
+        new_data = []
+
+        k = kml.KML.from_string(http_response.content)
+
+        for document in k.features:
+            # noinspection unresolved-references
+            for folder in document.features:
+                # noinspection unresolved-references
+                for placemark in folder.features:
+                    description = placemark.description or ""
+                    match = self.REF_PATTERN.search(description)
+                    if not match:
+                        # No VKFF reference found in this placemark - skip it (e.g. non-park waypoints)
+                        continue
+                    ref_id = match.group(0)
+
+                    longitude, latitude = placemark.geometry.x, placemark.geometry.y
+
+                    ref = ActivityRef(
+                        sig=self.sig_name,
+                        id=ref_id,
+                        name=placemark.name,
+                        ref_type=ActivityRefType.PARK,
+                        url=f"https://parksnpeaks.org/getPark.php?actPark={ref_id}",
+                        latitude=latitude,
+                        longitude=longitude,
+                    )
+                    if latitude and longitude:
+                        ref.grid = latlong_to_locator(latitude, longitude, 6)
+                    new_data.append(ref)
+
+                    # Bail out if a stop has been requested, i.e. the program is shutting down - no need to
+                    # parse the rest of the data in this case
+                    if self._stop_event.is_set():
+                        return new_data
+
+                    # Very short pause. This will extend the time to handle activity refs by a few seconds but will ensure some time
+                    # is available for other threads e.g. the web server.
+                    sleep(0.001)
+
+        return new_data