tomaae.homeassistant-mikrot.../custom_components/mikrotik_router/mikrotik_controller.py

956 lines
35 KiB
Python
Raw Normal View History

"""Mikrotik Controller for Mikrotik Router."""
2019-12-12 23:01:57 +01:00
import asyncio
import logging
2020-03-21 19:02:28 +03:00
from datetime import timedelta
from ipaddress import ip_address, IPv4Network
from homeassistant.core import callback
from homeassistant.helpers.dispatcher import async_dispatcher_send
from homeassistant.helpers.event import async_track_time_interval
2020-04-08 09:17:25 +02:00
from homeassistant.util.dt import utcnow
from .const import (
2019-12-02 18:13:55 +01:00
DOMAIN,
CONF_TRACK_ARP,
DEFAULT_TRACK_ARP,
CONF_SCAN_INTERVAL,
CONF_UNIT_OF_MEASUREMENT,
2019-12-02 18:13:55 +01:00
DEFAULT_SCAN_INTERVAL,
DEFAULT_TRAFFIC_TYPE,
)
2019-12-12 23:01:57 +01:00
from .exceptions import ApiEntryNotFound
2020-03-21 19:02:28 +03:00
from .helper import from_entry, parse_api
from .mikrotikapi import MikrotikAPI
2019-12-02 17:59:49 +01:00
_LOGGER = logging.getLogger(__name__)
2019-12-02 17:59:49 +01:00
# ---------------------------
# MikrotikControllerData
2019-12-02 17:59:49 +01:00
# ---------------------------
2020-03-16 04:51:41 +01:00
class MikrotikControllerData:
"""MikrotikController Class"""
2020-03-16 04:51:41 +01:00
def __init__(
self,
hass,
config_entry,
name,
host,
port,
username,
password,
use_ssl,
traffic_type,
):
"""Initialize MikrotikController."""
2019-12-02 18:13:55 +01:00
self.name = name
self.hass = hass
self.host = host
2019-12-02 18:13:55 +01:00
self.config_entry = config_entry
self.traffic_type = traffic_type
2020-03-16 04:51:41 +01:00
self.data = {
"routerboard": {},
"resource": {},
"interface": {},
"arp": {},
"arp_tmp": {},
2020-03-16 04:51:41 +01:00
"nat": {},
"fw-update": {},
"script": {},
"queue": {},
2020-04-08 09:15:26 +02:00
"dns": {},
"dhcp-server": {},
2020-04-08 10:09:31 +02:00
"dhcp-network": {},
"dhcp": {},
"host": {},
"accounting": {}
2020-03-16 04:51:41 +01:00
}
2019-12-02 18:13:55 +01:00
self.listeners = []
2019-12-12 23:01:57 +01:00
self.lock = asyncio.Lock()
2019-12-02 18:13:55 +01:00
self.api = MikrotikAPI(host, username, password, port, use_ssl)
self.nat_removed = {}
2020-03-16 04:51:41 +01:00
async_track_time_interval(
self.hass, self.force_update, self.option_scan_interval
)
async_track_time_interval(
self.hass, self.force_fwupdate_check, timedelta(hours=1)
)
def _get_traffic_type_and_div(self):
traffic_type = self.option_traffic_type
if traffic_type == "Kbps":
traffic_div = 0.001
elif traffic_type == "Mbps":
traffic_div = 0.000001
elif traffic_type == "B/s":
traffic_div = 0.125
elif traffic_type == "KB/s":
traffic_div = 0.000125
elif traffic_type == "MB/s":
traffic_div = 0.000000125
else:
traffic_type = "bps"
traffic_div = 1
return traffic_type, traffic_div
2019-12-02 19:23:09 +01:00
# ---------------------------
# force_update
# ---------------------------
@callback
2019-12-05 22:10:42 +01:00
async def force_update(self, _now=None):
"""Trigger update by timer"""
2019-12-02 18:13:55 +01:00
await self.async_update()
# ---------------------------
# force_fwupdate_check
# ---------------------------
@callback
2019-12-05 22:10:42 +01:00
async def force_fwupdate_check(self, _now=None):
"""Trigger hourly update by timer"""
await self.async_fwupdate_check()
2019-12-02 18:13:55 +01:00
# ---------------------------
# option_track_arp
# ---------------------------
@property
def option_track_arp(self):
"""Config entry option to not track ARP."""
return self.config_entry.options.get(CONF_TRACK_ARP, DEFAULT_TRACK_ARP)
2019-12-02 18:13:55 +01:00
# ---------------------------
# option_scan_interval
# ---------------------------
@property
def option_scan_interval(self):
"""Config entry option scan interval."""
2020-03-16 04:51:41 +01:00
scan_interval = self.config_entry.options.get(
CONF_SCAN_INTERVAL, DEFAULT_SCAN_INTERVAL
)
2019-12-02 18:13:55 +01:00
return timedelta(seconds=scan_interval)
# ---------------------------
# option_traffic_type
# ---------------------------
@property
def option_traffic_type(self):
"""Config entry option to not track ARP."""
2020-03-16 04:51:41 +01:00
return self.config_entry.options.get(
CONF_UNIT_OF_MEASUREMENT, DEFAULT_TRAFFIC_TYPE
)
2019-12-02 18:13:55 +01:00
# ---------------------------
# signal_update
# ---------------------------
@property
def signal_update(self):
"""Event to signal new data."""
return f"{DOMAIN}-update-{self.name}"
2019-12-02 18:13:55 +01:00
# ---------------------------
# connected
# ---------------------------
def connected(self):
"""Return connected state"""
2019-12-02 18:13:55 +01:00
return self.api.connected()
2019-12-02 18:13:55 +01:00
# ---------------------------
# hwinfo_update
# ---------------------------
async def hwinfo_update(self):
"""Update Mikrotik hardware info"""
2019-12-12 23:01:57 +01:00
try:
await asyncio.wait_for(self.lock.acquire(), timeout=10)
except:
return
await self.hass.async_add_executor_job(self.get_system_routerboard)
await self.hass.async_add_executor_job(self.get_system_resource)
self.lock.release()
2019-12-04 16:09:30 +01:00
# ---------------------------
# async_fwupdate_check
# ---------------------------
async def async_fwupdate_check(self):
"""Update Mikrotik data"""
2019-12-12 23:01:57 +01:00
await self.hass.async_add_executor_job(self.get_firmware_update)
2019-12-04 16:09:30 +01:00
async_dispatcher_send(self.hass, self.signal_update)
2019-12-02 18:13:55 +01:00
# ---------------------------
# async_update
# ---------------------------
async def async_update(self):
"""Update Mikrotik data"""
2019-12-12 23:01:57 +01:00
try:
await asyncio.wait_for(self.lock.acquire(), timeout=10)
except:
return
2020-03-16 04:51:41 +01:00
if "available" not in self.data["fw-update"]:
2019-12-04 16:09:30 +01:00
await self.async_fwupdate_check()
2019-12-12 23:01:57 +01:00
await self.hass.async_add_executor_job(self.get_interface)
2020-04-08 10:01:31 +02:00
await self.hass.async_add_executor_job(self.get_arp)
await self.hass.async_add_executor_job(self.get_dns)
await self.hass.async_add_executor_job(self.get_dhcp)
await self.hass.async_add_executor_job(self.process_host)
2019-12-12 23:01:57 +01:00
await self.hass.async_add_executor_job(self.get_interface_traffic)
await self.hass.async_add_executor_job(self.get_interface_client)
await self.hass.async_add_executor_job(self.get_nat)
await self.hass.async_add_executor_job(self.get_system_resource)
await self.hass.async_add_executor_job(self.get_script)
await self.hass.async_add_executor_job(self.get_queue)
# await self.hass.async_add_executor_job(self.get_dhcp)
await self.hass.async_add_executor_job(self.get_accounting)
2019-12-02 18:13:55 +01:00
async_dispatcher_send(self.hass, self.signal_update)
2020-04-08 09:15:26 +02:00
2019-12-12 23:01:57 +01:00
self.lock.release()
2019-12-02 18:13:55 +01:00
# ---------------------------
# async_reset
# ---------------------------
async def async_reset(self):
"""Reset dispatchers"""
2019-12-02 18:13:55 +01:00
for unsub_dispatcher in self.listeners:
unsub_dispatcher()
2019-12-02 18:13:55 +01:00
self.listeners = []
return True
2019-12-03 01:47:38 +01:00
# ---------------------------
2019-12-04 20:13:11 +01:00
# set_value
2019-12-03 01:47:38 +01:00
# ---------------------------
def set_value(self, path, param, value, mod_param, mod_value):
"""Change value using Mikrotik API"""
2019-12-03 01:47:38 +01:00
return self.api.update(path, param, value, mod_param, mod_value)
2019-12-04 20:13:11 +01:00
# ---------------------------
# run_script
# ---------------------------
def run_script(self, name):
"""Run script using Mikrotik API"""
2019-12-12 23:01:57 +01:00
try:
self.api.run_script(name)
except ApiEntryNotFound as error:
_LOGGER.error("Failed to run script: %s", error)
2019-12-02 18:13:55 +01:00
# ---------------------------
# get_interface
2019-12-02 18:13:55 +01:00
# ---------------------------
2019-12-12 23:01:57 +01:00
def get_interface(self):
"""Get all interfaces data from Mikrotik"""
2020-03-16 04:51:41 +01:00
self.data["interface"] = parse_api(
data=self.data["interface"],
source=self.api.path("/interface"),
2020-03-16 04:51:41 +01:00
key="default-name",
vals=[
2020-03-16 04:51:41 +01:00
{"name": "default-name"},
{"name": "name", "default_val": "default-name"},
{"name": "type", "default": "unknown"},
{"name": "running", "type": "bool"},
{
"name": "enabled",
"source": "disabled",
"type": "bool",
"reverse": True,
},
{"name": "port-mac-address", "source": "mac-address"},
{"name": "comment"},
{"name": "last-link-down-time"},
{"name": "last-link-up-time"},
{"name": "link-downs"},
{"name": "tx-queue-drop"},
{"name": "actual-mtu"},
],
ensure_vals=[
2020-03-16 04:51:41 +01:00
{"name": "client-ip-address"},
{"name": "client-mac-address"},
{"name": "rx-bits-per-second", "default": 0},
{"name": "tx-bits-per-second", "default": 0},
],
)
# ---------------------------
# get_interface_traffic
# ---------------------------
2019-12-12 23:01:57 +01:00
def get_interface_traffic(self):
"""Get traffic for all interfaces from Mikrotik"""
interface_list = ""
2020-03-16 04:51:41 +01:00
for uid in self.data["interface"]:
interface_list += self.data["interface"][uid]["name"] + ","
2019-12-11 15:34:35 +01:00
interface_list = interface_list[:-1]
2020-03-16 04:51:41 +01:00
self.data["interface"] = parse_api(
data=self.data["interface"],
2019-12-12 23:01:57 +01:00
source=self.api.get_traffic(interface_list),
2020-03-16 04:51:41 +01:00
key_search="name",
vals=[
2020-03-16 04:51:41 +01:00
{"name": "rx-bits-per-second", "default": 0},
{"name": "tx-bits-per-second", "default": 0},
],
)
traffic_type, traffic_div = self._get_traffic_type_and_div()
2020-03-16 04:51:41 +01:00
for uid in self.data["interface"]:
2020-03-21 19:02:28 +03:00
self.data["interface"][uid][
"rx-bits-per-second-attr"] = traffic_type
self.data["interface"][uid][
"tx-bits-per-second-attr"] = traffic_type
2020-03-16 04:51:41 +01:00
self.data["interface"][uid]["rx-bits-per-second"] = round(
self.data["interface"][uid]["rx-bits-per-second"] * traffic_div
2020-03-16 04:51:41 +01:00
)
self.data["interface"][uid]["tx-bits-per-second"] = round(
self.data["interface"][uid]["tx-bits-per-second"] * traffic_div
2020-03-16 04:51:41 +01:00
)
2020-03-11 23:25:51 +01:00
2019-12-02 18:13:55 +01:00
# ---------------------------
2019-12-05 22:29:25 +01:00
# get_interface_client
2019-12-02 18:13:55 +01:00
# ---------------------------
2019-12-12 23:01:57 +01:00
def get_interface_client(self):
"""Get ARP data from Mikrotik"""
self.data["arp_tmp"] = {}
2019-12-05 22:29:25 +01:00
# Remove data if disabled
2019-12-02 18:13:55 +01:00
if not self.option_track_arp:
2020-03-16 04:51:41 +01:00
for uid in self.data["interface"]:
self.data["interface"][uid]["client-ip-address"] = "disabled"
self.data["interface"][uid]["client-mac-address"] = "disabled"
2019-12-12 09:06:15 +01:00
return
2019-12-02 18:13:55 +01:00
mac2ip = {}
bridge_used = False
2019-12-12 23:01:57 +01:00
mac2ip, bridge_used = self.update_arp(mac2ip, bridge_used)
2019-12-05 22:29:25 +01:00
if bridge_used:
2019-12-12 23:01:57 +01:00
self.update_bridge_hosts(mac2ip)
2019-12-05 22:29:25 +01:00
# Map ARP to ifaces
2020-03-16 04:51:41 +01:00
for uid in self.data["interface"]:
if uid not in self.data["arp_tmp"]:
continue
2020-03-16 04:51:41 +01:00
self.data["interface"][uid]["client-ip-address"] = from_entry(
self.data["arp_tmp"][uid], "address"
2020-03-16 04:51:41 +01:00
)
self.data["interface"][uid]["client-mac-address"] = from_entry(
self.data["arp_tmp"][uid], "mac-address"
2020-03-16 04:51:41 +01:00
)
2019-12-05 22:29:25 +01:00
# ---------------------------
# update_arp
# ---------------------------
2019-12-12 23:01:57 +01:00
def update_arp(self, mac2ip, bridge_used):
2019-12-05 22:29:25 +01:00
"""Get list of hosts in ARP for interface client data from Mikrotik"""
data = self.api.path("/ip/arp")
if not data:
return mac2ip, bridge_used
2019-12-02 18:13:55 +01:00
for entry in data:
# Ignore invalid entries
2020-03-16 04:51:41 +01:00
if entry["invalid"]:
2019-12-02 18:13:55 +01:00
continue
2020-03-16 04:51:41 +01:00
if "interface" not in entry:
2020-03-11 23:39:43 +01:00
continue
2019-12-02 18:13:55 +01:00
# Do not add ARP detected on bridge
2020-03-16 04:51:41 +01:00
if entry["interface"] == "bridge":
2019-12-02 18:13:55 +01:00
bridge_used = True
# Build address table on bridge
2020-03-16 04:51:41 +01:00
if "mac-address" in entry and "address" in entry:
mac2ip[entry["mac-address"]] = entry["address"]
2019-12-02 18:13:55 +01:00
continue
2019-12-02 18:13:55 +01:00
# Get iface default-name from custom name
2019-12-12 23:01:57 +01:00
uid = self.get_iface_from_entry(entry)
2019-12-02 18:13:55 +01:00
if not uid:
continue
2019-12-21 08:21:17 +01:00
_LOGGER.debug("Processing entry %s, entry %s", "/ip/arp", entry)
2019-12-02 18:13:55 +01:00
# Create uid arp dict
if uid not in self.data["arp_tmp"]:
self.data["arp_tmp"][uid] = {}
2019-12-02 18:13:55 +01:00
# Add data
self.data["arp_tmp"][uid]["interface"] = uid
self.data["arp_tmp"][uid]["mac-address"] = (
from_entry(entry, "mac-address") if "mac-address" not in self.data["arp_tmp"][uid] else "multiple"
2020-03-16 04:51:41 +01:00
)
self.data["arp_tmp"][uid]["address"] = (
from_entry(entry, "address") if "address" not in self.data["arp_tmp"][uid] else "multiple"
2020-03-16 04:51:41 +01:00
)
2019-12-05 22:29:25 +01:00
return mac2ip, bridge_used
2019-12-02 18:13:55 +01:00
# ---------------------------
# update_bridge_hosts
# ---------------------------
2019-12-12 23:01:57 +01:00
def update_bridge_hosts(self, mac2ip):
2019-12-05 22:29:25 +01:00
"""Get list of hosts in bridge for interface client data from Mikrotik"""
data = self.api.path("/interface/bridge/host")
if not data:
return
2019-12-02 18:13:55 +01:00
for entry in data:
# Ignore port MAC
2020-03-16 04:51:41 +01:00
if entry["local"]:
2019-12-02 18:13:55 +01:00
continue
2019-12-02 18:13:55 +01:00
# Get iface default-name from custom name
2019-12-12 23:01:57 +01:00
uid = self.get_iface_from_entry(entry)
2019-12-02 18:13:55 +01:00
if not uid:
continue
2020-03-16 04:51:41 +01:00
_LOGGER.debug(
"Processing entry %s, entry %s", "/interface/bridge/host", entry
)
2019-12-02 18:13:55 +01:00
# Create uid arp dict
if uid not in self.data["arp_tmp"]:
self.data["arp_tmp"][uid] = {}
2019-12-02 18:13:55 +01:00
# Add data
self.data["arp_tmp"][uid]["interface"] = uid
if "mac-address" in self.data["arp_tmp"][uid]:
self.data["arp_tmp"][uid]["mac-address"] = "multiple"
self.data["arp_tmp"][uid]["address"] = "multiple"
2019-12-02 18:13:55 +01:00
else:
2020-04-08 10:01:41 +02:00
self.data["arp_tmp"][uid]["mac-address"] = from_entry(entry, "mac-address")
self.data["arp_tmp"][uid]["address"] = (
mac2ip[self.data["arp_tmp"][uid]["mac-address"]]
if self.data["arp_tmp"][uid]["mac-address"] in mac2ip
2020-03-16 04:51:41 +01:00
else ""
)
2019-12-02 19:23:09 +01:00
# ---------------------------
# get_iface_from_entry
2019-12-02 19:23:09 +01:00
# ---------------------------
2019-12-12 23:01:57 +01:00
def get_iface_from_entry(self, entry):
"""Get interface default-name using name from interface dict"""
2019-12-02 19:23:09 +01:00
uid = None
2020-03-16 04:51:41 +01:00
for ifacename in self.data["interface"]:
if self.data["interface"][ifacename]["name"] == entry["interface"]:
2019-12-11 15:34:35 +01:00
uid = ifacename
2019-12-02 19:23:09 +01:00
break
2019-12-02 19:23:09 +01:00
return uid
2019-12-03 18:29:05 +01:00
# ---------------------------
# get_nat
# ---------------------------
2019-12-12 23:01:57 +01:00
def get_nat(self):
"""Get NAT data from Mikrotik"""
2020-03-16 04:51:41 +01:00
self.data["nat"] = parse_api(
data=self.data["nat"],
source=self.api.path("/ip/firewall/nat"),
2020-03-16 04:51:41 +01:00
key=".id",
2019-12-12 09:06:15 +01:00
vals=[
2020-03-16 04:51:41 +01:00
{"name": ".id"},
{"name": "protocol", "default": "any"},
{"name": "dst-port", "default": "any"},
{"name": "in-interface", "default": "any"},
{"name": "to-addresses"},
{"name": "to-ports"},
{"name": "comment"},
{
"name": "enabled",
"source": "disabled",
"type": "bool",
"reverse": True,
},
2019-12-12 09:06:15 +01:00
],
val_proc=[
[
2020-03-16 04:51:41 +01:00
{"name": "name"},
{"action": "combine"},
{"key": "protocol"},
{"text": ":"},
{"key": "dst-port"},
2019-12-12 09:06:15 +01:00
]
2019-12-12 13:02:11 +01:00
],
2020-03-16 04:51:41 +01:00
only=[{"key": "action", "value": "dst-nat"}],
2019-12-12 09:06:15 +01:00
)
nat_uniq = {}
nat_del = {}
for uid in self.data["nat"]:
tmp_name = self.data["nat"][uid]["name"]
if tmp_name not in nat_uniq:
nat_uniq[tmp_name] = uid
else:
nat_del[uid] = 1
nat_del[nat_uniq[tmp_name]] = 1
for uid in nat_del:
if self.data["nat"][uid]["name"] not in self.nat_removed:
self.nat_removed[self.data["nat"][uid]["name"]] = 1
_LOGGER.error("Mikrotik %s duplicate NAT rule %s, entity will be unavailable.",
self.host, self.data["nat"][uid]["name"])
del self.data["nat"][uid]
2019-12-02 18:13:55 +01:00
# ---------------------------
# get_system_routerboard
# ---------------------------
2019-12-12 23:01:57 +01:00
def get_system_routerboard(self):
"""Get routerboard data from Mikrotik"""
2020-03-16 04:51:41 +01:00
self.data["routerboard"] = parse_api(
data=self.data["routerboard"],
source=self.api.path("/system/routerboard"),
2019-12-11 15:34:35 +01:00
vals=[
2020-03-16 04:51:41 +01:00
{"name": "routerboard", "type": "bool"},
{"name": "model", "default": "unknown"},
{"name": "serial-number", "default": "unknown"},
{"name": "firmware", "default": "unknown"},
],
2019-12-11 15:34:35 +01:00
)
2019-12-02 18:13:55 +01:00
# ---------------------------
# get_system_resource
# ---------------------------
2019-12-12 23:01:57 +01:00
def get_system_resource(self):
"""Get system resources data from Mikrotik"""
2020-03-16 04:51:41 +01:00
self.data["resource"] = parse_api(
data=self.data["resource"],
source=self.api.path("/system/resource"),
2019-12-11 15:34:35 +01:00
vals=[
2020-03-16 04:51:41 +01:00
{"name": "platform", "default": "unknown"},
{"name": "board-name", "default": "unknown"},
{"name": "version", "default": "unknown"},
{"name": "uptime", "default": "unknown"},
{"name": "cpu-load", "default": "unknown"},
{"name": "free-memory", "default": 0},
{"name": "total-memory", "default": 0},
{"name": "free-hdd-space", "default": 0},
{"name": "total-hdd-space", "default": 0},
],
2019-12-11 15:34:35 +01:00
)
2020-03-16 04:51:41 +01:00
if self.data["resource"]["total-memory"] > 0:
self.data["resource"]["memory-usage"] = round(
(
(
self.data["resource"]["total-memory"]
- self.data["resource"]["free-memory"]
)
/ self.data["resource"]["total-memory"]
)
* 100
)
else:
2020-03-16 04:51:41 +01:00
self.data["resource"]["memory-usage"] = "unknown"
if self.data["resource"]["total-hdd-space"] > 0:
self.data["resource"]["hdd-usage"] = round(
(
(
self.data["resource"]["total-hdd-space"]
- self.data["resource"]["free-hdd-space"]
)
/ self.data["resource"]["total-hdd-space"]
)
* 100
)
else:
2020-03-16 04:51:41 +01:00
self.data["resource"]["hdd-usage"] = "unknown"
2019-12-04 16:09:30 +01:00
# ---------------------------
# get_firmware_update
2019-12-04 16:09:30 +01:00
# ---------------------------
2019-12-12 23:01:57 +01:00
def get_firmware_update(self):
"""Check for firmware update on Mikrotik"""
2020-03-16 04:51:41 +01:00
self.data["fw-update"] = parse_api(
data=self.data["fw-update"],
source=self.api.path("/system/package/update"),
2019-12-12 13:02:11 +01:00
vals=[
2020-03-16 04:51:41 +01:00
{"name": "status"},
{"name": "channel", "default": "unknown"},
{"name": "installed-version", "default": "unknown"},
{"name": "latest-version", "default": "unknown"},
],
2019-12-12 13:02:11 +01:00
)
2020-03-16 04:51:41 +01:00
if "status" in self.data["fw-update"]:
self.data["fw-update"]["available"] = (
2020-03-21 19:02:28 +03:00
True if self.data["fw-update"][
"status"] == "New version is available"
2020-03-16 04:51:41 +01:00
else False
)
2019-12-12 13:02:11 +01:00
else:
2020-03-16 04:51:41 +01:00
self.data["fw-update"]["available"] = False
2019-12-12 13:02:11 +01:00
2019-12-04 20:13:11 +01:00
# ---------------------------
# get_script
# ---------------------------
2019-12-12 23:01:57 +01:00
def get_script(self):
"""Get list of all scripts from Mikrotik"""
2020-03-16 04:51:41 +01:00
self.data["script"] = parse_api(
data=self.data["script"],
source=self.api.path("/system/script"),
2020-03-16 04:51:41 +01:00
key="name",
2019-12-11 15:34:35 +01:00
vals=[
2020-03-16 04:51:41 +01:00
{"name": "name"},
{"name": "last-started", "default": "unknown"},
{"name": "run-count", "default": "unknown"},
],
2019-12-11 15:34:35 +01:00
)
# ---------------------------
# get_queue
# ---------------------------
def get_queue(self):
"""Get Queue data from Mikrotik"""
self.data["queue"] = parse_api(
data=self.data["queue"],
source=self.api.path("/queue/simple"),
key="name",
vals=[
{"name": ".id"},
{"name": "name", "default": "unknown"},
{"name": "target", "default": "unknown"},
{"name": "max-limit", "default": "0/0"},
{"name": "limit-at", "default": "0/0"},
{"name": "burst-limit", "default": "0/0"},
{"name": "burst-threshold", "default": "0/0"},
{"name": "burst-time", "default": "0s/0s"},
{"name": "packet-marks", "default": "none"},
{"name": "parent", "default": "none"},
{"name": "comment"},
{
"name": "enabled",
"source": "disabled",
"type": "bool",
"reverse": True,
},
]
)
traffic_type, traffic_div = self._get_traffic_type_and_div()
for uid in self.data["queue"]:
upload_max_limit_bps, download_max_limit_bps = [int(x) for x in
self.data["queue"][uid]["max-limit"].split('/')]
2020-04-05 00:38:29 +02:00
self.data["queue"][uid]["upload-max-limit"] = \
f"{round(upload_max_limit_bps * traffic_div)} {traffic_type}"
self.data["queue"][uid]["download-max-limit"] = \
f"{round(download_max_limit_bps * traffic_div)} {traffic_type}"
upload_limit_at_bps, download_limit_at_bps = [int(x) for x in
self.data["queue"][uid]["limit-at"].split('/')]
2020-04-05 00:38:29 +02:00
self.data["queue"][uid]["upload-limit-at"] = \
f"{round(upload_limit_at_bps * traffic_div)} {traffic_type}"
self.data["queue"][uid]["download-limit-at"] = \
f"{round(download_limit_at_bps * traffic_div)} {traffic_type}"
upload_burst_limit_bps, download_burst_limit_bps = [int(x) for x in
self.data["queue"][uid]["burst-limit"].split('/')]
2020-04-05 00:38:29 +02:00
self.data["queue"][uid]["upload-burst-limit"] = \
f"{round(upload_burst_limit_bps * traffic_div)} {traffic_type}"
self.data["queue"][uid]["download-burst-limit"] = \
f"{round(download_burst_limit_bps * traffic_div)} {traffic_type}"
upload_burst_threshold_bps,\
download_burst_threshold_bps = [int(x) for x in self.data["queue"][uid]["burst-threshold"].split('/')]
self.data["queue"][uid]["upload-burst-threshold"] = \
f"{round(upload_burst_threshold_bps * traffic_div)} {traffic_type}"
self.data["queue"][uid]["download-burst-threshold"] = \
f"{round(download_burst_threshold_bps * traffic_div)} {traffic_type}"
upload_burst_time, download_burst_time = self.data["queue"][uid]["burst-time"].split('/')
self.data["queue"][uid]["upload-burst-time"] = upload_burst_time
self.data["queue"][uid]["download-burst-time"] = download_burst_time
2020-04-08 10:01:09 +02:00
# ---------------------------
# get_arp
# ---------------------------
def get_arp(self):
"""Get ARP data from Mikrotik"""
self.data["arp"] = parse_api(
data=self.data["arp"],
source=self.api.path("/ip/arp"),
key="mac-address",
vals=[
{"name": "mac-address"},
{"name": "address"},
{"name": "interface"},
],
)
2020-04-08 09:15:26 +02:00
# ---------------------------
# get_dns
# ---------------------------
def get_dns(self):
"""Get static DNS data from Mikrotik"""
self.data["dns"] = parse_api(
data=self.data["dns"],
source=self.api.path("/ip/dns/static"),
key="name",
vals=[
{"name": "name"},
{"name": "address"},
],
)
# ---------------------------
# get_dhcp
# ---------------------------
def get_dhcp(self):
"""Get DHCP data from Mikrotik"""
2020-04-08 10:09:31 +02:00
self.data["dhcp-network"] = parse_api(
data=self.data["dhcp-network"],
source=self.api.path("/ip/dhcp-server/network"),
key="address",
vals=[
{"name": "address"},
{"name": "gateway", "default": ""},
{"name": "netmask", "default": ""},
{"name": "dns-server", "default": ""},
{"name": "domain", "default": ""},
],
ensure_vals=[
{"name": "address"},
{"name": "IPv4Network", "default": ""},
2020-04-08 10:09:31 +02:00
]
)
for uid, vals in self.data["dhcp-network"].items():
if vals["IPv4Network"] == "":
self.data["dhcp-network"][uid]["IPv4Network"] = IPv4Network(vals["address"])
self.data["dhcp-server"] = parse_api(
data=self.data["dhcp-server"],
source=self.api.path("/ip/dhcp-server"),
key="name",
vals=[
{"name": "name"},
{"name": "interface", "default": ""},
]
)
self.data["dhcp"] = parse_api(
data=self.data["dhcp"],
source=self.api.path("/ip/dhcp-server/lease"),
key="mac-address",
vals=[
{"name": "mac-address"},
{"name": "address", "default": "unknown"},
{"name": "host-name", "default": "unknown"},
{"name": "status", "default": "unknown"},
{"name": "last-seen", "default": "unknown"},
{"name": "server", "default": "unknown"},
{"name": "comment"},
],
ensure_vals=[
{"name": "interface"},
{"name": "available", "type": "bool", "default": False},
]
)
for uid in self.data["dhcp"]:
self.data["dhcp"][uid]["interface"] = \
self.data["dhcp-server"][self.data["dhcp"][uid]["server"]]["interface"]
# ---------------------------
# process_host
# ---------------------------
def process_host(self):
"""Get host tracking data"""
2020-04-08 09:17:25 +02:00
# Add hosts from DHCP
for uid, vals in self.data["dhcp"].items():
if uid not in self.data["host"]:
self.data["host"][uid] = {}
self.data["host"][uid]["source"] = "dhcp"
2020-04-08 10:32:02 +02:00
for key, key_data in zip(
["address", "mac-address", "interface"],
["address", "mac-address", "interface"],
):
if key not in self.data["host"][uid] or self.data["host"][uid][key] == "unknown":
self.data["host"][uid][key] = vals[key_data]
# Add hosts from ARP
for uid, vals in self.data["arp"].items():
if uid not in self.data["host"]:
self.data["host"][uid] = {}
self.data["host"][uid]["source"] = "arp"
for key, key_data in zip(
["address", "mac-address", "interface"],
["address", "mac-address", "interface"],
):
if key not in self.data["host"][uid] or self.data["host"][uid][key] == "unknown":
self.data["host"][uid][key] = vals[key_data]
2020-04-08 09:17:25 +02:00
# Process hosts
for uid, vals in self.data["host"].items():
# Add missing default values
for key, default in zip(
["address", "mac-address", "interface", "hostname", "last-seen", "available"],
["unknown", "unknown", "unknown", "unknown", False],
):
if key not in self.data["host"][uid]:
self.data["host"][uid][key] = default
# Resolve hostname
if vals["hostname"] == "unknown":
if vals["address"] != "unknown":
for dns_uid, dns_vals in self.data["dns"].items():
if dns_vals["address"] == vals["address"]:
self.data["host"][uid]["hostname"] = dns_vals["name"].split('.')[0]
break
if self.data["host"][uid]["hostname"] == "unknown" \
and uid in self.data["dhcp"] and self.data["dhcp"][uid]["comment"] != "":
self.data["host"][uid]["hostname"] = self.data["dhcp"][uid]["comment"]
elif self.data["host"][uid]["hostname"] == "unknown" \
and uid in self.data["dhcp"] and self.data["dhcp"][uid]["host-name"] != "unknown":
self.data["host"][uid]["hostname"] = self.data["dhcp"][uid]["host-name"]
elif self.data["host"][uid]["hostname"] == "unknown":
self.data["host"][uid]["hostname"] = uid
2020-04-08 10:37:24 +02:00
# Check host availability
2020-04-08 09:17:25 +02:00
if vals["address"] != "unknown" and vals["interface"] != "unknown":
self.data["host"][uid]["available"] = \
self.api.arp_ping(vals["address"], vals["interface"])
# Update last seen
if self.data["host"][uid]["available"]:
self.data["host"][uid]["last-seen"] = utcnow()
# Update interface and availability for hosts present in DHCP leases
if uid in self.data["dhcp"]:
self.data["dhcp"][uid]['interface'] = \
self.data["dhcp-server"][self.data["dhcp"][uid]['server']]["interface"]
self.data["dhcp"][uid]['available'] = \
self.api.arp_ping(self.data["dhcp"][uid]['address'], self.data["dhcp"][uid]['interface'])
def _address_part_of_local_network(self, address):
address = ip_address(address)
for vals in self.data["dhcp-network"].values():
if address in vals["IPv4Network"]:
return True
return False
def _get_accounting_uid_by_ip(self, requested_ip):
for mac, vals in self.data['accounting'].items():
if vals.get('address') is requested_ip:
return mac
return None
def get_accounting(self):
"""Get Accounting data from Mikrotik"""
# Check if accounting and account-local-traffic is enabled
accounting_enabled, local_traffic_enabled = self.api.is_accounting_and_local_traffic_enabled()
traffic_type, traffic_div = self._get_traffic_type_and_div()
# Build missing hosts from main hosts dict
for uid, vals in self.data["host"].items():
if uid not in self.data["accounting"]:
self.data["accounting"][uid] = {
'address': vals['address'],
'mac-address': vals['mac-address'],
'host-name': vals['hostname'],
'tx-rx-attr': traffic_type,
'available': False,
'local_accounting': False
}
_LOGGER.debug(f"Working with {len(self.data['accounting'])} accounting devices")
# Build temp accounting values dict with ip address as key
2020-04-05 18:32:48 +02:00
tmp_accounting_values = {}
for uid, vals in self.data['accounting'].items():
tmp_accounting_values[vals['address']] = {
2020-04-05 16:04:17 +02:00
"wan-tx": 0,
"wan-rx": 0,
"lan-tx": 0,
"lan-rx": 0
}
time_diff = self.api.take_accounting_snapshot()
if time_diff:
accounting_data = parse_api(
data={},
source=self.api.path("/ip/accounting/snapshot"),
key=".id",
vals=[
{"name": ".id"},
{"name": "src-address"},
{"name": "dst-address"},
{"name": "bytes", "default": 0},
],
)
for item in accounting_data.values():
source_ip = str(item.get('src-address')).strip()
destination_ip = str(item.get('dst-address')).strip()
bits_count = int(str(item.get('bytes')).strip()) * 8
if self._address_part_of_local_network(source_ip) and self._address_part_of_local_network(destination_ip):
# LAN TX/RX
2020-04-05 18:32:48 +02:00
if source_ip in tmp_accounting_values:
tmp_accounting_values[source_ip]['lan-tx'] += bits_count
if destination_ip in tmp_accounting_values:
tmp_accounting_values[destination_ip]['lan-rx'] += bits_count
elif self._address_part_of_local_network(source_ip) and \
not self._address_part_of_local_network(destination_ip):
# WAN TX
2020-04-05 18:32:48 +02:00
if source_ip in tmp_accounting_values:
tmp_accounting_values[source_ip]['wan-tx'] += bits_count
elif not self._address_part_of_local_network(source_ip) and \
self._address_part_of_local_network(destination_ip):
# WAN RX
2020-04-05 18:32:48 +02:00
if destination_ip in tmp_accounting_values:
tmp_accounting_values[destination_ip]['wan-rx'] += bits_count
# Calculate real throughput and transform it to appropriate unit
# Also handle availability of accounting and local_accounting from Mikrotik
for addr in tmp_accounting_values:
uid = self._get_accounting_uid_by_ip(addr)
if not uid:
_LOGGER.warning(f"Address {addr} not found in accounting data, skipping update")
continue
self.data['accounting'][uid]['tx-rx-attr'] = traffic_type
self.data['accounting'][uid]['available'] = accounting_enabled
self.data['accounting'][uid]['local_accounting'] = local_traffic_enabled
if not accounting_enabled:
# Skip calculation for WAN and LAN, accounting is disabled
continue
self.data['accounting'][uid]['wan-tx'] = round(
tmp_accounting_values[addr]['wan-tx'] / time_diff * traffic_div, 2) \
if tmp_accounting_values[addr]['wan-tx'] else 0.0
self.data['accounting'][uid]['wan-rx'] = round(
tmp_accounting_values[addr]['wan-rx'] / time_diff * traffic_div, 2) \
if tmp_accounting_values[addr]['wan-rx'] else 0.0
if not local_traffic_enabled:
# Skip calculation for LAN, LAN accounting is disabled
continue
self.data['accounting'][uid]['lan-tx'] = round(
tmp_accounting_values[addr]['lan-tx'] / time_diff * traffic_div, 2) \
if tmp_accounting_values[addr]['lan-tx'] else 0.0
self.data['accounting'][uid]['lan-rx'] = round(
tmp_accounting_values[addr]['lan-rx'] / time_diff * traffic_div, 2) \
if tmp_accounting_values[addr]['lan-rx'] else 0.0