""" Support for DD-WRT routers. For more details about this platform, please refer to the documentation at https://home-assistant.io/components/device_tracker.ddwrt/ """ import logging import re import threading from datetime import timedelta import requests import voluptuous as vol import homeassistant.helpers.config_validation as cv from homeassistant.components.device_tracker import ( DOMAIN, PLATFORM_SCHEMA, DeviceScanner) from homeassistant.const import CONF_HOST, CONF_PASSWORD, CONF_USERNAME from homeassistant.util import Throttle # Return cached results if last scan was less then this time ago. MIN_TIME_BETWEEN_SCANS = timedelta(seconds=5) _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})') PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({ vol.Required(CONF_HOST): cv.string, vol.Required(CONF_PASSWORD): cv.string, vol.Required(CONF_USERNAME): cv.string }) # pylint: disable=unused-argument def get_scanner(hass, config): """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 scanner.""" self.host = config[CONF_HOST] self.username = config[CONF_USERNAME] self.password = config[CONF_PASSWORD] self.lock = threading.Lock() self.last_results = {} self.mac2name = {} # Test the router is accessible url = 'http://{}/Status_Wireless.live.asp'.format(self.host) data = self.get_ddwrt_data(url) if not data: 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.""" with self.lock: # If not initialised and not already scanned and not found. if device not in self.mac2name: url = 'http://{}/Status_Lan.live.asp'.format(self.host) data = self.get_ddwrt_data(url) if not data: return None dhcp_leases = data.get('dhcp_leases', None) if not 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) @Throttle(MIN_TIME_BETWEEN_SCANS) def _update_info(self): """Ensure the information from the DD-WRT router is up to date. Return boolean if scanning successful. """ with self.lock: _LOGGER.info('Checking ARP') url = 'http://{}/Status_Wireless.live.asp'.format(self.host) data = self.get_ddwrt_data(url) if not data: return False self.last_results = [] active_clients = data.get('active_wireless', None) 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) except requests.exceptions.Timeout: _LOGGER.exception('Connection to the router timed out') return if response.status_code == 200: return _parse_ddwrt_response(response.text) elif response.status_code == 401: # Authentication error _LOGGER.exception( 'Failed to authenticate, ' 'please check your username and password') return else: _LOGGER.error('Invalid response from ddwrt: %s', response) def _parse_ddwrt_response(data_str): """Parse the DD-WRT data format.""" return { key: val for key, val in _DDWRT_DATA_REGEX .findall(data_str)}