Removed SSID update feature

Changing SSID is now only possible if the `change_ssid` capability
is enabled

Author: rgaudin

CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+
+- WiFi config change (Profile, SSID – if capability enabled, Passphrase)
+- SSH service
+- Links to known admin services

src/adminui/context.py

@@ -20,6 +20,10 @@ class Context:
     # contentfilter_prefix: str = "contentfilter"
     # filemanager_prefix: str = "resources"
 
+    # capabilities are restrictions on an hotspot
+    # regarding edit features of the adminUI
+    can_change_ssid: bool = False
+
     wifi_ssid: str = "Kiwix Hotspot"
     wifi_passphrase: str | None = None
     wifi_profile: str = "perf"

src/adminui/setup.py

@@ -18,6 +18,11 @@ class MissingType:
 Missing = MissingType()  # single value used to check if its missing
 
 
+@dataclass
+class Capabilities:
+    change_ssid: bool = False
+
+
 @dataclass
 class ComposeData:
     """useful information read from compose.yaml"""
@@ -60,6 +65,13 @@ def get_from_compose() -> ComposeData:
     return ComposeData(tld=tld, domain=domain, kiwix_prefix=kiwix_prefix)
 
 
+def get_capabilities_from_config() -> Capabilities:
+    yaml_config = read_offspot_conf()
+    cap = yaml_config.get("capabilities", {})
+    # only SSID change ATM
+    return Capabilities(change_ssid=cap.get("change_ssid"))
+
+
 def get_wifi_conf_from_offspot_yaml() -> WifiConf:
     """read offspot.yaml for updated-not-applied changes to WiFi conf"""
     conf = WifiConf()
@@ -104,6 +116,9 @@ def prepare_context():
     # read tld, domain, prefixes from compose
     compose_data = get_from_compose()
 
+    # read capabilities
+    capabilities = get_capabilities_from_config()
+
     # read wifi conf from offspot.yaml if present
     wifi_conf = get_wifi_conf_from_offspot_yaml()
     if not wifi_conf.is_complete:
@@ -120,6 +135,7 @@ def prepare_context():
         tld=compose_data.tld,
         domain=compose_data.domain,
         kiwix_prefix=compose_data.kiwix_prefix,
+        can_change_ssid=capabilities.change_ssid,
         wifi_profile=wifi_conf.profile,
         wifi_ssid=wifi_conf.ssid,
         wifi_passphrase=wifi_conf.passphrase,

src/adminui/templates/wifi/config.html

@@ -34,7 +34,7 @@
           </div>
         </div>
 
-        <div class="row mb-3">
+        <div class="row mb-3 {% if not ctx.can_change_ssid %}d-none{% endif %}">
           <div class="col-12 col-md-2">
             <label for="ssid">SSID</label>
           </div>

src/adminui/wifi.py

@@ -90,7 +90,8 @@ def config_update(
             update_wifi_config(data=data)
             # update context
             context.wifi_profile = data.profile
-            context.wifi_ssid = data.ssid
+            if context.can_change_ssid:
+                context.wifi_ssid = data.ssid
             context.wifi_passphrase = None if data.open else data.passphrase
         except Exception as exc:
             logger.error(f"failed to record WiFi conf: {exc}")