airport: sudo is required

airport: allow single spaces in SSID

Author: scivision

README.md

@@ -3,7 +3,9 @@
 [![ci](https://github.com/scivision/mozilla-location-wifi/actions/workflows/ci.yml/badge.svg)](https://github.com/scivision/mozilla-location-wifi/actions/workflows/ci.yml)
 [![PyPi Download stats](http://pepy.tech/badge/mozloc)](http://pepy.tech/project/mozloc)
 
-Uses command line access to WiFi information in a short, simple Mozilla Location Services with Wifi from Python.
+Uses command line access to WiFi information via
+[Mozilla Location Services API](https://ichnaea.readthedocs.io/en/latest/api/geolocate.html?highlight=macaddress#wifi-access-point-fields)
+from Python.
 The command line programs used to access WiFi information include:
 
 * Linux: `nmcli` [NetworkManager](https://developer.gnome.org/NetworkManager/stable/nmcli.html)
@@ -12,7 +14,6 @@ The command line programs used to access WiFi information include:
 
 Note that a similar service with better accuracy is available from
 [Google](https://developers.google.com/maps/documentation/geolocation/intro).
-Let us know if you're interested.
 
 ## Install
 
@@ -38,7 +39,7 @@ python -m mozloc
 Shows `time` `lat` `lng` `accuracy` `N BSSIDs heard`.
 In urban areas, accuracy of less than 100 meters is possible.
 
-### dump raw signals
+dump raw signals, without using API:
 
 ```sh
 python -m mozloc.signal
@@ -49,7 +50,7 @@ python -m mozloc.signal
 On Windows, NetSH is used.
 You may need to disconnect from WiFi (leave WiFi enabled) to make your WiFi chipset scan and be able to get location.
 
-### convert to KML
+## convert to KML
 
 Display logged data in Google Earth or other KML viewer after converting from CSV to KML:
 

src/mozloc/airport.py

@@ -6,7 +6,7 @@
 import subprocess
 import re
 
-from .cmd import get_airport
+from .cmd import get_airport, running_as_root
 
 
 def cli_config_check() -> bool:
@@ -32,7 +32,7 @@ def cli_config_check() -> bool:
 def get_signal() -> str:
 
     try:
-        ret = subprocess.check_output([get_airport(), "-s"], text=True, timeout=30.0)
+        ret = subprocess.check_output([get_airport(), "-s"], text=True, timeout=30)
     except subprocess.CalledProcessError as err:
         logging.error(f"consider slowing scan cadence. {err}")
 
@@ -41,17 +41,31 @@ def get_signal() -> str:
 
 def parse_signal(raw: str) -> list[dict[str, T.Any]]:
 
-    pat = re.compile(r"\s*([0-9a-zA-Z\-\.]+)\s+([0-9a-f]{2}(?::[0-9a-f]{2}){5})\s+(-\d{2,3})")
+    isroot = running_as_root()
+    if not isroot:
+        raise RuntimeError("airport requires running as sudo to get BSSID")
+
+    psudo = r"\s*([0-9a-zA-Z\s\-\.]+)\s+([0-9a-f]{2}(?::[0-9a-f]{2}){5})\s+(-\d{2,3})"
+    # BSSID only present if sudo
+    # puser = r"\s*([0-9a-zA-Z\s\-\.]+)\s+(-\d{2,3})"
+    # non-sudo has no BSSID
+
+    p = psudo
+    i = 2
+
+    pat = re.compile(p)
     dat: list[dict[str, str]] = []
 
     for line in raw.split("\n"):
         mat = pat.match(line)
         if mat:
+            # Hidden SSID optout implicitly excluded by regex
             ssid = mat.group(1)
             # optout
             if ssid.endswith("_nomap"):
                 continue
-
-            dat.append({"ssid": ssid, "macAddress": mat.group(2), "signalStrength": mat.group(3)})
+            dat.append(
+                {"ssid": ssid, "macAddress": mat.group(i), "signalStrength": mat.group(i + 1)}
+            )
 
     return dat

src/mozloc/base.py

@@ -46,7 +46,7 @@ def log_wifi_loc(cadence_sec: float, mozilla_url: str, logfile: Path | None = No
             logging.warning(f"cannot locate since at least 2 BSSIDs required\n{dat}")
             sleep(cadence_sec)
             continue
-        logging.debug(dat)
+        print(dat)
 
         loc = get_loc_mozilla(dat, mozilla_url)
         if loc is None:

src/mozloc/cmd.py

@@ -1,9 +1,14 @@
 from __future__ import annotations
 
+import os
 import functools
 import shutil
 
 
+def running_as_root() -> bool:
+    return os.getuid() == 0
+
+
 @functools.cache
 def get_exe(name: str, path: str | None = None) -> str:
     if not (exe := shutil.which(name, path=path)):