Added website filtering switches

Author: vmakeev

README.md

@@ -21,6 +21,7 @@ Home Assistant custom component for control Huawei mesh routers over LAN.
   - enable or disable Wi-Fi access control
   - add/remove devices from blacklist/whitelist
   - Wi-Fi access switch per client device
+- enabling and disabling access to specific sites
 - hardware and firmware version of the primary router
 - internet connection details
 - uptime of each router
@@ -77,6 +78,7 @@ Advanced settings include:
 | Enabling or disabling [Device tags](docs/device-tags.md#device-tags)                                             |  Disabled  |
 | Enabling or disabling [Devices tracking](docs/device-tracking.md#devices-tracking)                               |  Disabled  |
 | Enabling or disabling [Router-specific zones](docs/device-tracking.md#router-specific-zones)                     |  Disabled  |
+| Enabling or disabling [Website filtering switches](docs/controls.md#website-filtering)                           |  Disabled  |
 
 
 ![Options 1/2](docs/images/options_1.png)
@@ -109,6 +111,7 @@ You can attach one or more tags to each client device in order to be able to use
 * Wi-Fi TWT switch ([read more](docs/controls.md#wi-fi-6-twt-switch))
 * Wi-Fi Access Control ([read more](docs/controls.md#wi-fi-access-control))
 * Device Wi-Fi Access ([read more](docs/controls.md#device-wi-fi-access))
+* Website filtering ([read more](docs/controls.md#website-filtering))
 
 ### Selects
 * Wi-Fi access control mode ([read more](docs/controls.md#wi-fi-access-control-mode))

custom_components/huawei_mesh_router/__init__.py

@@ -13,11 +13,13 @@
 from .const import (
     DEFAULT_DEVICE_TRACKER_ZONES,
     DEFAULT_SCAN_INTERVAL,
+    DEFAULT_URL_FILTER_SWITCHES,
     DOMAIN,
     OPT_DEVICE_TRACKER,
     OPT_DEVICE_TRACKER_ZONES,
     OPT_DEVICES_TAGS,
     OPT_ROUTER_CLIENTS_SENSORS,
+    OPT_URL_FILTER_SWITCHES,
     OPT_WIFI_ACCESS_SWITCHES,
     PLATFORMS,
     STORAGE_VERSION,
@@ -158,6 +160,11 @@ async def async_migrate_entry(hass, config_entry: ConfigEntry):
         updated_options[OPT_DEVICE_TRACKER_ZONES] = DEFAULT_DEVICE_TRACKER_ZONES
         config_entry.version = 3
 
+    if config_entry.version == 3:
+        _LOGGER.debug("Migrating to version 4")
+        updated_options[OPT_URL_FILTER_SWITCHES] = DEFAULT_URL_FILTER_SWITCHES
+        config_entry.version = 4
+
     hass.config_entries.async_update_entry(
         config_entry, data=updated_data, options=updated_options
     )

custom_components/huawei_mesh_router/button.py

@@ -51,7 +51,7 @@ async def async_setup_entry(
 def _watch_for_additional_routers(
     coordinator, config_entry, async_add_entities
 ) -> None:
-    watcher: ActiveRoutersWatcher = ActiveRoutersWatcher()
+    watcher: ActiveRoutersWatcher = ActiveRoutersWatcher(coordinator)
     known_buttons: dict[MAC_ADDR, HuaweiButton] = {}
 
     @callback
@@ -65,7 +65,7 @@ def on_router_added(mac: MAC_ADDR, router: ConnectedDevice) -> None:
     @callback
     def coordinator_updated() -> None:
         """Update the status of the device."""
-        watcher.look_for_changes(coordinator, on_router_added)
+        watcher.look_for_changes(on_router_added)
 
     config_entry.async_on_unload(coordinator.async_add_listener(coordinator_updated))
     coordinator_updated()

custom_components/huawei_mesh_router/classes.py

@@ -5,7 +5,7 @@
 
 from homeassistant.backports.enum import StrEnum
 
-from .client.classes import MAC_ADDR
+from .client.classes import MAC_ADDR, HuaweiFilterItem
 
 DEVICE_TAG = str
 
@@ -36,6 +36,60 @@ class HuaweiWlanFilterMode(StrEnum):
     WHITELIST = "Whitelist"
 
 
+# ---------------------------
+#   UrlFilter
+# ---------------------------
+class UrlFilter:
+    def __init__(
+        self,
+        filter_id: str,
+        url: str,
+        enabled: bool,
+        dev_manual: bool,
+        devices: Iterable[HuaweiFilterItem],
+    ) -> None:
+        self._filter_id = filter_id
+        self._url = url
+        self._dev_manual = dev_manual
+        self._devices = list(devices)
+        self._enabled = enabled
+
+    def update_info(
+        self,
+        url: str,
+        enabled: bool,
+        dev_manual: bool,
+        devices: Iterable[HuaweiFilterItem],
+    ) -> None:
+        self._url = url
+        self._dev_manual = dev_manual
+        self._devices = list(devices)
+        self._enabled = enabled
+
+    def set_enabled(self, enabled: bool) -> None:
+        self._enabled = enabled
+
+    @property
+    def filter_id(self) -> str:
+        return self._filter_id
+
+    @property
+    def url(self) -> str:
+        return self._url
+
+    @property
+    def enabled(self) -> bool:
+        return self._enabled
+
+    @property
+    def dev_manual(self) -> bool:
+        return self._dev_manual
+
+    @property
+    def devices(self) -> Iterable[HuaweiFilterItem]:
+        return self._devices
+
+
 # ---------------------------
 #   ConnectedDevice
 # ---------------------------

custom_components/huawei_mesh_router/client/classes.py

@@ -39,6 +39,18 @@ class HuaweiFilterItem:
     name: str | None = None
 
 
+# ---------------------------
+#   HuaweiUrlFilterInfo
+# ---------------------------
+@dataclass()
+class HuaweiUrlFilterInfo:
+    filter_id: str
+    url: str
+    enabled: bool
+    dev_manual: bool
+    devices: list[HuaweiFilterItem]
+
+
 # ---------------------------
 #   HuaweiFilterItem
 # ---------------------------

custom_components/huawei_mesh_router/client/huaweiapi.py

@@ -14,20 +14,24 @@
     HuaweiConnectionInfo,
     HuaweiDeviceNode,
     HuaweiFilterInfo,
+    HuaweiFilterItem,
     HuaweiRouterInfo,
+    HuaweiUrlFilterInfo,
 )
 from .coreapi import APICALL_ERRCAT_UNAUTHORIZED, ApiCallError, HuaweiCoreApi
 
 SWITCH_NFC: Final = "nfc_switch"
 SWITCH_WIFI_80211R: Final = "wifi_80211r_switch"
 SWITCH_WIFI_TWT: Final = "wifi_twt_switch"
 SWITCH_WLAN_FILTER: Final = "wlan_filter_switch"
+SWITCH_URL_FILTER: Final = "url_filter_switch"
 
 ACTION_REBOOT: Final = "reboot_action"
 
 CONNECTED_VIA_ID_PRIMARY: Final = "primary"
 
 FEATURE_NFC: Final = "feature_nfc"
+FEATURE_URL_FILTER: Final = "feature_url_filter"
 FEATURE_WIFI_80211R: Final = "feature_wifi_80211r"
 FEATURE_WIFI_TWT: Final = "feature_wifi_twt"
 FEATURE_WLAN_FILTER: Final = "feature_wlan_filter"
@@ -43,6 +47,7 @@
 _URL_REPEATER_INFO: Final = "api/ntwk/repeaterinfo"
 _URL_WANDETECT: Final = "api/ntwk/wandetect"
 _URL_WLAN_FILTER: Final = "api/ntwk/wlanfilterenhance"
+_URL_URL_FILTER: Final = "api/ntwk/urlfilter"
 
 _STATUS_CONNECTED: Final = "Connected"
 
@@ -153,6 +158,12 @@ async def _is_device_topology_available(self) -> bool:
         data = await self._core_api.get(_URL_DEVICE_TOPOLOGY)
         return data is not None
 
+    @log_feature(FEATURE_URL_FILTER)
+    @unauthorized_as_false
+    async def _is_url_filter_available(self) -> bool:
+        data = await self._core_api.get(_URL_URL_FILTER)
+        return data is not None
+
     async def update(self) -> None:
         """Update the available features list."""
         if await self._is_nfc_available():
@@ -170,14 +181,14 @@ async def update(self) -> None:
         if await self._is_device_topology_available():
             self._available_features.add(FEATURE_DEVICE_TOPOLOGY)
 
+        if await self._is_url_filter_available():
+            self._available_features.add(FEATURE_URL_FILTER)
+
     def is_available(self, feature: str) -> bool:
         """Return true if feature is available."""
         return feature in self._available_features
 
 
-# ---------------------------
-#   HuaweiApi
-# ---------------------------
 class HuaweiApi:
     def __init__(
         self,
@@ -530,6 +541,27 @@ async def _get_filter_states(self):
                 state_5g = state
         return state_2g, state_5g
 
+    async def apply_url_filter_info(self, url_filter_info: HuaweiUrlFilterInfo) -> None:
+        actual = await self.get_url_filter_info()
+        existing_item = next((item for item in actual if item.filter_id == url_filter_info.filter_id))
+
+        action: str = "update" if existing_item else "create"
+
+        data: dict[str, Any] = {
+            "Devices": [
+                {"MACAddress": device.mac_address} for device in url_filter_info.devices
+            ],
+            "DeviceNames": [
+                {"HostName": device.name} for device in url_filter_info.devices
+            ],
+            "DevManual": url_filter_info.dev_manual,
+            "URL": url_filter_info.url,
+            "Status": 2 if url_filter_info.enabled else 0,
+            "ID": url_filter_info.filter_id,
+        }
+
+        await self._core_api.post(_URL_URL_FILTER, data, extra_data={"action": action})
+
     async def _process_access_lists(
         self,
         state: dict[str, Any],
@@ -660,3 +692,22 @@ async def get_is_repeater(self) -> bool:
         repeater_enable = data.get("RepeaterEnable", False)
 
         return isinstance(repeater_enable, bool) and repeater_enable
+
+    @staticmethod
+    def _to_url_filter_info(data: dict[str, Any]) -> HuaweiUrlFilterInfo:
+        result = HuaweiUrlFilterInfo(
+            filter_id=data["ID"],
+            url=data["URL"],
+            enabled=data.get("Status", -1) == 2,
+            dev_manual=data.get("DevManual") is True,
+            devices=[
+                HuaweiFilterItem(item[0].get("MACAddress"), item[1].get("HostName"))
+                for item in zip(data["Devices"], data["DeviceNames"])
+            ],
+        )
+
+        return result
+
+    async def get_url_filter_info(self) -> Iterable[HuaweiUrlFilterInfo]:
+        data = await self._core_api.get(_URL_URL_FILTER)
+        return [self._to_url_filter_info(item) for item in data]

custom_components/huawei_mesh_router/config_flow.py

@@ -30,6 +30,7 @@
     DEFAULT_ROUTER_CLIENTS_SENSORS,
     DEFAULT_SCAN_INTERVAL,
     DEFAULT_SSL,
+    DEFAULT_URL_FILTER_SWITCHES,
     DEFAULT_USER,
     DEFAULT_VERIFY_SSL,
     DEFAULT_WIFI_ACCESS_SWITCHES,
@@ -38,6 +39,7 @@
     OPT_DEVICE_TRACKER_ZONES,
     OPT_DEVICES_TAGS,
     OPT_ROUTER_CLIENTS_SENSORS,
+    OPT_URL_FILTER_SWITCHES,
     OPT_WIFI_ACCESS_SWITCHES,
 )
 
@@ -61,7 +63,7 @@ def configured_instances(hass):
 class HuaweiControllerConfigFlow(ConfigFlow, domain=DOMAIN):
     """HuaweiControllerConfigFlow class"""
 
-    VERSION = 3
+    VERSION = 4
 
     def __init__(self):
         """Initialize HuaweiControllerConfigFlow."""
@@ -227,6 +229,12 @@ async def async_step_features_select(self, user_input=None) -> FlowResult:
                             OPT_DEVICE_TRACKER_ZONES, DEFAULT_DEVICE_TRACKER_ZONES
                         ),
                     ): bool,
+                    vol.Required(
+                        OPT_URL_FILTER_SWITCHES,
+                        default=self.options.get(
+                            OPT_URL_FILTER_SWITCHES, DEFAULT_URL_FILTER_SWITCHES
+                        ),
+                    ): bool,
                 },
             ),
         )

custom_components/huawei_mesh_router/const.py

@@ -13,6 +13,7 @@
 DATA_KEY_SERVICES: Final = "services_count"
 
 OPT_WIFI_ACCESS_SWITCHES = "wifi_access_switches"
+OPT_URL_FILTER_SWITCHES = "url_filter_switches"
 OPT_ROUTER_CLIENTS_SENSORS = "router_clients_sensors"
 OPT_DEVICES_TAGS = "devices_tags"
 OPT_DEVICE_TRACKER = "device_tracker"
@@ -31,6 +32,7 @@
 DEFAULT_DEVICES_TAGS: Final = False
 DEFAULT_DEVICE_TRACKER: Final = False
 DEFAULT_DEVICE_TRACKER_ZONES: Final = False
+DEFAULT_URL_FILTER_SWITCHES: Final = False
 
 ATTR_MANUFACTURER: Final = "Huawei"
 PLATFORMS: Final = [

custom_components/huawei_mesh_router/manifest.json

@@ -11,6 +11,6 @@
     "@vmakeev"
   ],
   "iot_class": "local_polling",
-  "version": "0.8.5",
+  "version": "0.8.6",
   "config_flow": true
 }

custom_components/huawei_mesh_router/options.py

@@ -9,11 +9,13 @@
     DEFAULT_DEVICES_TAGS,
     DEFAULT_ROUTER_CLIENTS_SENSORS,
     DEFAULT_SCAN_INTERVAL,
+    DEFAULT_URL_FILTER_SWITCHES,
     DEFAULT_WIFI_ACCESS_SWITCHES,
     OPT_DEVICE_TRACKER,
     OPT_DEVICE_TRACKER_ZONES,
     OPT_DEVICES_TAGS,
     OPT_ROUTER_CLIENTS_SENSORS,
+    OPT_URL_FILTER_SWITCHES,
     OPT_WIFI_ACCESS_SWITCHES,
 )
 
@@ -66,6 +68,13 @@ def device_tracker_zones(self) -> bool:
             self._config_entry, OPT_DEVICE_TRACKER_ZONES, DEFAULT_DEVICE_TRACKER_ZONES
         )
 
+    @property
+    def url_filter_switches(self) -> bool:
+        """Return option 'url filter switches' value"""
+        return get_option(
+            self._config_entry, OPT_URL_FILTER_SWITCHES, DEFAULT_URL_FILTER_SWITCHES
+        )
+
     @property
     def router_clients_sensors(self) -> bool:
         """Return option 'router clients sensors' value"""

custom_components/huawei_mesh_router/select.py

@@ -69,7 +69,7 @@ def watch_for_additional_routers(
     config_entry: ConfigEntry,
     async_add_entities: AddEntitiesCallback,
 ) -> None:
-    router_watcher: ActiveRoutersWatcher = ActiveRoutersWatcher()
+    router_watcher: ActiveRoutersWatcher = ActiveRoutersWatcher(coordinator)
     known_zone_selects: dict[MAC_ADDR, HuaweiRouterZoneSelect] = {}
 
     @callback
@@ -83,7 +83,7 @@ def on_router_added(device_mac: MAC_ADDR, router: ConnectedDevice) -> None:
     @callback
     def coordinator_updated() -> None:
         """Update the status of the device."""
-        router_watcher.look_for_changes(coordinator, on_router_added)
+        router_watcher.look_for_changes(on_router_added)
 
     config_entry.async_on_unload(coordinator.async_add_listener(coordinator_updated))
     coordinator_updated()

custom_components/huawei_mesh_router/sensor.py

@@ -170,7 +170,7 @@ def watch_for_additional_routers(
     integration_options: HuaweiIntegrationOptions,
     async_add_entities: AddEntitiesCallback,
 ):
-    watcher: ActiveRoutersWatcher = ActiveRoutersWatcher()
+    watcher: ActiveRoutersWatcher = ActiveRoutersWatcher(coordinator)
     known_client_sensors: dict[MAC_ADDR, HuaweiConnectedDevicesSensor] = {}
     known_uptime_sensors: dict[MAC_ADDR, HuaweiUptimeSensor] = {}
 
@@ -227,7 +227,7 @@ def on_router_added(mac: MAC_ADDR, router: ConnectedDevice) -> None:
     @callback
     def coordinator_updated() -> None:
         """Update the status of the device."""
-        watcher.look_for_changes(coordinator, on_router_added)
+        watcher.look_for_changes(on_router_added)
 
     config_entry.async_on_unload(coordinator.async_add_listener(coordinator_updated))
     coordinator_updated()