mirror of
https://github.com/home-assistant/core
synced 2024-09-03 08:14:07 +02:00
169 lines
5.6 KiB
Python
169 lines
5.6 KiB
Python
"""Support for DD-WRT routers."""
|
|
from __future__ import annotations
|
|
|
|
from http import HTTPStatus
|
|
import logging
|
|
import re
|
|
|
|
import requests
|
|
import voluptuous as vol
|
|
|
|
from homeassistant.components.device_tracker import (
|
|
DOMAIN,
|
|
PLATFORM_SCHEMA as PARENT_PLATFORM_SCHEMA,
|
|
DeviceScanner,
|
|
)
|
|
from homeassistant.const import (
|
|
CONF_HOST,
|
|
CONF_PASSWORD,
|
|
CONF_SSL,
|
|
CONF_USERNAME,
|
|
CONF_VERIFY_SSL,
|
|
)
|
|
from homeassistant.core import HomeAssistant
|
|
import homeassistant.helpers.config_validation as cv
|
|
from homeassistant.helpers.typing import ConfigType
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
_DDWRT_DATA_REGEX = re.compile(r"\{(\w+)::([^\}]*)\}")
|
|
_MAC_REGEX = re.compile(r"(([0-9A-Fa-f]{1,2}\:){5}[0-9A-Fa-f]{1,2})")
|
|
|
|
DEFAULT_SSL = False
|
|
DEFAULT_VERIFY_SSL = True
|
|
CONF_WIRELESS_ONLY = "wireless_only"
|
|
DEFAULT_WIRELESS_ONLY = True
|
|
|
|
PLATFORM_SCHEMA = PARENT_PLATFORM_SCHEMA.extend(
|
|
{
|
|
vol.Required(CONF_HOST): cv.string,
|
|
vol.Required(CONF_PASSWORD): cv.string,
|
|
vol.Required(CONF_USERNAME): cv.string,
|
|
vol.Optional(CONF_SSL, default=DEFAULT_SSL): cv.boolean,
|
|
vol.Optional(CONF_VERIFY_SSL, default=DEFAULT_VERIFY_SSL): cv.boolean,
|
|
vol.Optional(CONF_WIRELESS_ONLY, default=DEFAULT_WIRELESS_ONLY): cv.boolean,
|
|
}
|
|
)
|
|
|
|
|
|
def get_scanner(hass: HomeAssistant, config: ConfigType) -> DeviceScanner | None:
|
|
"""Validate the configuration and return a DD-WRT scanner."""
|
|
try:
|
|
return DdWrtDeviceScanner(config[DOMAIN])
|
|
except ConnectionError:
|
|
return None
|
|
|
|
|
|
class DdWrtDeviceScanner(DeviceScanner):
|
|
"""This class queries a wireless router running DD-WRT firmware."""
|
|
|
|
def __init__(self, config):
|
|
"""Initialize the DD-WRT scanner."""
|
|
self.protocol = "https" if config[CONF_SSL] else "http"
|
|
self.verify_ssl = config[CONF_VERIFY_SSL]
|
|
self.host = config[CONF_HOST]
|
|
self.username = config[CONF_USERNAME]
|
|
self.password = config[CONF_PASSWORD]
|
|
self.wireless_only = config[CONF_WIRELESS_ONLY]
|
|
|
|
self.last_results = {}
|
|
self.mac2name = {}
|
|
|
|
# Test the router is accessible
|
|
url = f"{self.protocol}://{self.host}/Status_Wireless.live.asp"
|
|
if not self.get_ddwrt_data(url):
|
|
raise ConnectionError("Cannot connect to DD-Wrt router")
|
|
|
|
def scan_devices(self):
|
|
"""Scan for new devices and return a list with found device IDs."""
|
|
self._update_info()
|
|
|
|
return self.last_results
|
|
|
|
def get_device_name(self, device):
|
|
"""Return the name of the given device or None if we don't know."""
|
|
# If not initialised and not already scanned and not found.
|
|
if device not in self.mac2name:
|
|
url = f"{self.protocol}://{self.host}/Status_Lan.live.asp"
|
|
|
|
if not (data := self.get_ddwrt_data(url)):
|
|
return None
|
|
|
|
if not (dhcp_leases := data.get("dhcp_leases")):
|
|
return None
|
|
|
|
# Remove leading and trailing quotes and spaces
|
|
cleaned_str = dhcp_leases.replace('"', "").replace("'", "").replace(" ", "")
|
|
elements = cleaned_str.split(",")
|
|
num_clients = int(len(elements) / 5)
|
|
self.mac2name = {}
|
|
for idx in range(0, num_clients):
|
|
# The data is a single array
|
|
# every 5 elements represents one host, the MAC
|
|
# is the third element and the name is the first.
|
|
mac_index = (idx * 5) + 2
|
|
if mac_index < len(elements):
|
|
mac = elements[mac_index]
|
|
self.mac2name[mac] = elements[idx * 5]
|
|
|
|
return self.mac2name.get(device)
|
|
|
|
def _update_info(self):
|
|
"""Ensure the information from the DD-WRT router is up to date.
|
|
|
|
Return boolean if scanning successful.
|
|
"""
|
|
_LOGGER.debug("Checking ARP")
|
|
|
|
endpoint = "Wireless" if self.wireless_only else "Lan"
|
|
url = f"{self.protocol}://{self.host}/Status_{endpoint}.live.asp"
|
|
|
|
if not (data := self.get_ddwrt_data(url)):
|
|
return False
|
|
|
|
self.last_results = []
|
|
|
|
if self.wireless_only:
|
|
active_clients = data.get("active_wireless")
|
|
else:
|
|
active_clients = data.get("arp_table")
|
|
if not active_clients:
|
|
return False
|
|
|
|
# The DD-WRT UI uses its own data format and then
|
|
# regex's out values so this is done here too
|
|
# Remove leading and trailing single quotes.
|
|
clean_str = active_clients.strip().strip("'")
|
|
elements = clean_str.split("','")
|
|
|
|
self.last_results.extend(item for item in elements if _MAC_REGEX.match(item))
|
|
|
|
return True
|
|
|
|
def get_ddwrt_data(self, url):
|
|
"""Retrieve data from DD-WRT and return parsed result."""
|
|
try:
|
|
response = requests.get(
|
|
url,
|
|
auth=(self.username, self.password),
|
|
timeout=4,
|
|
verify=self.verify_ssl,
|
|
)
|
|
except requests.exceptions.Timeout:
|
|
_LOGGER.exception("Connection to the router timed out")
|
|
return
|
|
if response.status_code == HTTPStatus.OK:
|
|
return _parse_ddwrt_response(response.text)
|
|
if response.status_code == HTTPStatus.UNAUTHORIZED:
|
|
# Authentication error
|
|
_LOGGER.exception(
|
|
"Failed to authenticate, check your username and password"
|
|
)
|
|
return
|
|
_LOGGER.error("Invalid response from DD-WRT: %s", response)
|
|
|
|
|
|
def _parse_ddwrt_response(data_str):
|
|
"""Parse the DD-WRT data format."""
|
|
return dict(_DDWRT_DATA_REGEX.findall(data_str))
|