From d195fd47f723521e1d8fcc4d38742755c5d85fae Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ab=C3=ADlio=20Costa?= <abmantis@users.noreply.github.com>
Date: Thu, 10 Aug 2017 16:01:52 +0100
Subject: [PATCH] Add new device tracker for Huawei Routers. (#8488)

* Add new device tracker for Huawei Routers.

	This was tested with the HG8247H model, used by Vodafone
	Portugal for the Fiber service.

* add to .coveragerc; remove import and space

* add comments and fix lint

* rename methods

* huawei_router: add constants to scanner class

* huawei_router: remove lock; use format() in string

* huawei_router: use tupple instead of member only class

* huawei_router: reduce min scan time

* huawei_router: lint

* huawei_router: lint

* huawei_router: add missing lines in imports

* huawei_router: correctly decode string after router firmware update

* Remove things that is done on core now
---
 .coveragerc                                   |   1 +
 .../device_tracker/huawei_router.py           | 145 ++++++++++++++++++
 2 files changed, 146 insertions(+)
 create mode 100644 homeassistant/components/device_tracker/huawei_router.py

diff --git a/.coveragerc b/.coveragerc
index 7cf0a78dc31..56ccb37d169 100644
--- a/.coveragerc
+++ b/.coveragerc
@@ -272,6 +272,7 @@ omit =
     homeassistant/components/device_tracker/cisco_ios.py
     homeassistant/components/device_tracker/fritz.py
     homeassistant/components/device_tracker/gpslogger.py
+    homeassistant/components/device_tracker/huawei_router.py
     homeassistant/components/device_tracker/icloud.py
     homeassistant/components/device_tracker/linksys_ap.py
     homeassistant/components/device_tracker/linksys_smart.py
diff --git a/homeassistant/components/device_tracker/huawei_router.py b/homeassistant/components/device_tracker/huawei_router.py
new file mode 100644
index 00000000000..b78683696cf
--- /dev/null
+++ b/homeassistant/components/device_tracker/huawei_router.py
@@ -0,0 +1,145 @@
+"""
+Support for HUAWEI routers.
+
+For more details about this platform, please refer to the documentation at
+https://home-assistant.io/components/device_tracker.huawei/
+"""
+import base64
+import logging
+import re
+from collections import namedtuple
+
+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
+
+_LOGGER = logging.getLogger(__name__)
+
+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 HUAWEI scanner."""
+    scanner = HuaweiDeviceScanner(config[DOMAIN])
+
+    return scanner
+
+
+Device = namedtuple('Device', ['name', 'ip', 'mac', 'state'])
+
+
+class HuaweiDeviceScanner(DeviceScanner):
+    """This class queries a router running HUAWEI firmware."""
+
+    ARRAY_REGEX = re.compile(r'var UserDevinfo = new Array\((.*),null\);')
+    DEVICE_REGEX = re.compile(r'new USERDevice\((.*?)\),')
+    DEVICE_ATTR_REGEX = re.compile(
+        '"(?P<Domain>.*?)","(?P<IpAddr>.*?)",'
+        '"(?P<MacAddr>.*?)","(?P<Port>.*?)",'
+        '"(?P<IpType>.*?)","(?P<DevType>.*?)",'
+        '"(?P<DevStatus>.*?)","(?P<PortType>.*?)",'
+        '"(?P<Time>.*?)","(?P<HostName>.*?)",'
+        '"(?P<IPv4Enabled>.*?)","(?P<IPv6Enabled>.*?)",'
+        '"(?P<DeviceType>.*?)"')
+    LOGIN_COOKIE = dict(Cookie='body:Language:portuguese:id=-1')
+
+    def __init__(self, config):
+        """Initialize the scanner."""
+        self.host = config[CONF_HOST]
+        self.username = config[CONF_USERNAME]
+        self.password = base64.b64encode(bytes(config[CONF_PASSWORD], 'utf-8'))
+
+        self.last_results = []
+
+    def scan_devices(self):
+        """Scan for new devices and return a list with found device IDs."""
+        self._update_info()
+        return [client.mac for client in 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 self.last_results:
+            return None
+        for client in self.last_results:
+            if client.mac == device:
+                return client.name
+        return None
+
+    def _update_info(self):
+        """Ensure the information from the router is up to date.
+
+        Return boolean if scanning successful.
+        """
+        data = self._get_data()
+        if not data:
+            return False
+
+        active_clients = [client for client in data if client.state]
+        self.last_results = active_clients
+
+        _LOGGER.debug("Active clients: " + "\n"
+                      .join((client.mac + " " + client.name)
+                            for client in active_clients))
+        return True
+
+    def _get_data(self):
+        """Get the devices' data from the router.
+
+        Returns a list with all the devices known to the router DHCP server.
+        """
+        array_regex_res = self.ARRAY_REGEX.search(self._get_devices_response())
+
+        devices = []
+        if array_regex_res:
+            device_regex_res = self.DEVICE_REGEX.findall(
+                array_regex_res.group(1))
+
+            for device in device_regex_res:
+                device_attrs_regex_res = self.DEVICE_ATTR_REGEX.search(device)
+
+                devices.append(Device(device_attrs_regex_res.group('HostName'),
+                                      device_attrs_regex_res.group('IpAddr'),
+                                      device_attrs_regex_res.group('MacAddr'),
+                                      device_attrs_regex_res.group(
+                                          'DevStatus') == "Online"))
+
+        return devices
+
+    def _get_devices_response(self):
+        """Get the raw string with the devices from the router."""
+        cnt = requests.post('http://{}/asp/GetRandCount.asp'.format(self.host))
+        cnt_str = str(cnt.content, cnt.apparent_encoding, errors='replace')
+
+        _LOGGER.debug("Loggin in")
+        cookie = requests.post('http://{}/login.cgi'.format(self.host),
+                               data=[('UserName', self.username),
+                                     ('PassWord', self.password),
+                                     ('x.X_HW_Token', cnt_str)],
+                               cookies=self.LOGIN_COOKIE)
+
+        _LOGGER.debug("Requesting lan user info update")
+        # this request is needed or else some devices' state won't be updated
+        requests.get(
+            'http://{}/html/bbsp/common/lanuserinfo.asp'.format(self.host),
+            cookies=cookie.cookies)
+
+        _LOGGER.debug("Requesting lan user info data")
+        devices = requests.get(
+            'http://{}/html/bbsp/common/GetLanUserDevInfo.asp'.format(
+                self.host),
+            cookies=cookie.cookies)
+
+        # we need to decode() using the request encoding, then encode() and
+        # decode('unicode_escape') to replace \\xXX with \xXX
+        # (i.e. \\x2d -> \x2d)
+        return devices.content.decode(devices.apparent_encoding).encode().\
+            decode('unicode_escape')