beesure: more reliable parsing of binary content

[loctrkd.git] / loctrkd / beesure.py

diff --git a/loctrkd/beesure.py b/loctrkd/beesure.py
index baf14dbee9600eb25252f9d44ea38c80fac0890a..35682bd1028a8e0e0dcb7c7d96c356f7e1d8c8ac 100755 (executable)
--- a/loctrkd/beesure.py
+++ b/loctrkd/beesure.py
@@ -23,6 +23,12 @@ from typing import (
 from types import SimpleNamespace
 
 from .protomodule import ProtoClass
+from .common import (
+    CoordReport,
+    HintReport,
+    StatusReport,
+    Report,
+)
 
 __all__ = (
     "Stream",
@@ -33,7 +39,6 @@ __all__ = (
     "proto_handled",
     "parse_message",
     "probe_buffer",
-    "proto_name",
     "DecodeError",
     "Respond",
 )
@@ -135,6 +140,14 @@ def enframe(buffer: bytes, imei: Optional[str] = None) -> bytes:
 ### Parser/Constructor ###
 
 
+class classproperty:
+    def __init__(self, f: Callable[[Any], str]) -> None:
+        self.f = f
+
+    def __get__(self, obj: Any, owner: Any) -> str:
+        return self.f(owner)
+
+
 class DecodeError(Exception):
     def __init__(self, e: Exception, **kwargs: Any) -> None:
         super().__init__(e)
@@ -194,6 +207,7 @@ class Respond(Enum):
 
 
 class BeeSurePkt(ProtoClass):
+    BINARY = False
     RESPOND = Respond.NON  # Do not send anything back by default
     IN_KWARGS: Tuple[Tuple[str, Callable[[Any], Any], Any], ...] = ()
     OUT_KWARGS: Tuple[Tuple[str, Callable[[Any], Any], Any], ...] = ()
@@ -272,14 +286,21 @@ class BeeSurePkt(ProtoClass):
         # Overridden in subclasses, otherwise command verb only
         return ""
 
-    @property
-    def PROTO(self) -> str:
+    @classproperty
+    def PROTO(cls: "BeeSurePkt") -> str:
+        """Name of the class without possible .In / .Out suffix"""
+        proto: str
         try:
-            proto, _ = self.__class__.__name__.split(".")
+            proto, _ = cls.__name__.split(".")
         except ValueError:
-            proto = self.__class__.__name__
+            proto = cls.__name__
         return proto
 
+    @classmethod
+    def proto_name(cls) -> str:
+        """Name of the command as used externally"""
+        return PROTO_PREFIX + cls.PROTO[:16]
+
     @property
     def packed(self) -> bytes:
         data = self.encode()
@@ -313,7 +334,7 @@ class _LOC_DATA(BeeSurePkt):
                 (self, "pedometer", int),
                 (self, "tubmling_times", int),
                 (self, "device_status", lambda x: int(x, 16)),
-                (self, "base_stations_number", int),
+                (self, "gsm_cells_number", int),
                 (self, "connect_base_station_number", int),
                 (self, "mcc", int),
                 (self, "mnc", int),
@@ -323,11 +344,11 @@ class _LOC_DATA(BeeSurePkt):
             setattr(obj, attr, func(val))  # type: ignore
         rest_args = args[20:]
         # (area_id, cell_id, strength)*
-        self.base_stations = [
-            tuple(int(el) for el in rest_args[i * 3 : 3 + i * 3])
-            for i in range(self.base_stations_number)
+        self.gsm_cells: List[Tuple[int, int, int]] = [
+            tuple(int(el) for el in rest_args[i * 3 : 3 + i * 3])  # type: ignore
+            for i in range(self.gsm_cells_number)
         ]
-        rest_args = rest_args[3 * self.base_stations_number :]
+        rest_args = rest_args[3 * self.gsm_cells_number :]
         self.wifi_aps_number = int(rest_args[0])
         # (SSID, MAC, strength)*
         self.wifi_aps = [
@@ -351,10 +372,9 @@ class _LOC_DATA(BeeSurePkt):
         self.latitude = p.lat * p.nors
         self.longitude = p.lon * p.eorw
 
-    def rectified(self) -> SimpleNamespace:  # JSON-able dict
+    def rectified(self) -> Report:
         if self.gps_valid:
-            return SimpleNamespace(
-                type="location",
+            return CoordReport(
                 devtime=str(self.devtime),
                 battery_percentage=self.battery_percentage,
                 accuracy=self.positioning_accuracy,
@@ -365,13 +385,12 @@ class _LOC_DATA(BeeSurePkt):
                 longitude=self.longitude,
             )
         else:
-            return SimpleNamespace(
-                type="approximate_location",
+            return HintReport(
                 devtime=str(self.devtime),
                 battery_percentage=self.battery_percentage,
                 mcc=self.mcc,
                 mnc=self.mnc,
-                base_stations=self.base_stations,
+                gsm_cells=self.gsm_cells,
                 wifi_aps=self.wifi_aps,
             )
 
@@ -483,6 +502,7 @@ class SOS3(_SET_PHONE):
 
 
 class TK(BeeSurePkt):
+    BINARY = True
     RESPOND = Respond.INL
 
     def in_decode(self, *args: Any) -> None:
@@ -549,12 +569,6 @@ def proto_handled(proto: str) -> bool:
     return proto.startswith(PROTO_PREFIX)
 
 
-def proto_name(obj: Union[Type[BeeSurePkt], BeeSurePkt]) -> str:
-    return PROTO_PREFIX + (
-        obj.__class__.__name__ if isinstance(obj, BeeSurePkt) else obj.__name__
-    )
-
-
 def proto_of_message(packet: bytes) -> str:
     return PROTO_PREFIX + packet[20:-1].split(b",")[0].decode()
 
@@ -586,27 +600,24 @@ def probe_buffer(buffer: bytes) -> bool:
 def parse_message(packet: bytes, is_incoming: bool = True) -> BeeSurePkt:
     """From a packet (without framing bytes) derive the XXX.In object"""
     toskip, vendor, imei, datalength = _framestart(packet)
-    try:
-        splits = packet[20:-1].decode().split(",")
-        proto = splits[0] if len(splits) > 0 else ""
-        payload: Union[List[str], bytes] = splits[1:]
-    except UnicodeDecodeError:
-        bsplits = packet[20:-1].split(b",", 1)
-        if len(bsplits) == 2:
-            proto = bsplits[0].decode("ascii")
-            payload = bsplits[1]
-    if proto not in CLASSES:
-        cause: Union[DecodeError, ValueError, IndexError] = ValueError(
-            f"Proto {proto} is unknown"
-        )
+    bsplits = packet[20:-1].split(b",", 1)
+    if len(bsplits) == 2:
+        proto = bsplits[0].decode("ascii")
+        rest = bsplits[1]
     else:
+        proto = ""
+        rest = bsplits[0]
+    if proto in CLASSES:
+        cls = CLASSES[proto].In if is_incoming else CLASSES[proto].Out
+        payload = (
+            rest if cls.BINARY else rest.decode("Windows-1252").split(",")
+        )
         try:
-            if is_incoming:
-                return CLASSES[proto].In(vendor, imei, datalength, payload)
-            else:
-                return CLASSES[proto].Out(vendor, imei, datalength, payload)
+            return cls(vendor, imei, datalength, payload)
         except (DecodeError, ValueError, IndexError) as e:
-            cause = e
+            cause: Union[DecodeError, ValueError, IndexError] = e
+    else:
+        cause = ValueError(f"Proto {proto} is unknown")
     if is_incoming:
         retobj = UNKNOWN.In(vendor, imei, datalength, payload)
     else:
@@ -618,7 +629,7 @@ def parse_message(packet: bytes, is_incoming: bool = True) -> BeeSurePkt:
 
 def exposed_protos() -> List[Tuple[str, bool]]:
     return [
-        (proto_name(cls), False)
+        (cls.proto_name(), False)
         for cls in CLASSES.values()
         if hasattr(cls, "rectified")
     ]