mirror of
https://github.com/LibreQoE/LibreQoS.git
synced 2024-11-22 00:07:21 -06:00
Update integrationSplynx.py
This commit is contained in:
Robert Chacón
GitHub
parent
352bafce96
commit
35381756a0
@ -14,247 +14,243 @@ if find_ipv6_using_mikrotik() == True:
|
||||
from integrationCommon import NetworkGraph, NetworkNode, NodeType
|
||||
|
||||
def buildHeaders():
|
||||
credentials = splynx_api_key() + ':' + splynx_api_secret()
|
||||
credentials = base64.b64encode(credentials.encode()).decode()
|
||||
return {'Authorization' : "Basic %s" % credentials}
|
||||
"""
|
||||
Build authorization headers for Splynx API requests using API key and secret.
|
||||
"""
|
||||
credentials = splynx_api_key() + ':' + splynx_api_secret()
|
||||
credentials = base64.b64encode(credentials.encode()).decode()
|
||||
return {'Authorization': "Basic %s" % credentials}
|
||||
|
||||
def spylnxRequest(target, headers):
|
||||
# Sends a REST GET request to Spylnx and returns the
|
||||
# result in JSON
|
||||
url = splynx_api_url() + "/api/2.0/" + target
|
||||
r = requests.get(url, headers=headers, timeout=120)
|
||||
return r.json()
|
||||
"""
|
||||
Send a GET request to the Splynx API and return the JSON response.
|
||||
"""
|
||||
url = splynx_api_url() + "/api/2.0/" + target
|
||||
r = requests.get(url, headers=headers, timeout=120)
|
||||
return r.json()
|
||||
|
||||
def getTariffs(headers):
|
||||
data = spylnxRequest("admin/tariffs/internet", headers)
|
||||
tariff = []
|
||||
downloadForTariffID = {}
|
||||
uploadForTariffID = {}
|
||||
for tariff in data:
|
||||
tariffID = tariff['id']
|
||||
speed_download = round((int(tariff['speed_download']) / 1000))
|
||||
speed_upload = round((int(tariff['speed_upload']) / 1000))
|
||||
downloadForTariffID[tariffID] = speed_download
|
||||
uploadForTariffID[tariffID] = speed_upload
|
||||
return (tariff, downloadForTariffID, uploadForTariffID)
|
||||
|
||||
"""
|
||||
Retrieve tariff data from Splynx API and calculate download/upload speeds for each tariff.
|
||||
"""
|
||||
data = spylnxRequest("admin/tariffs/internet", headers)
|
||||
downloadForTariffID = {}
|
||||
uploadForTariffID = {}
|
||||
for tariff in data:
|
||||
tariffID = tariff['id']
|
||||
speed_download = round((int(tariff['speed_download']) / 1000))
|
||||
speed_upload = round((int(tariff['speed_upload']) / 1000))
|
||||
downloadForTariffID[tariffID] = speed_download
|
||||
uploadForTariffID[tariffID] = speed_upload
|
||||
return (data, downloadForTariffID, uploadForTariffID)
|
||||
|
||||
def buildSiteBandwidths():
|
||||
# Builds a dictionary of site bandwidths from the integrationSplynxBandwidths.csv file.
|
||||
siteBandwidth = {}
|
||||
if os.path.isfile("integrationSplynxBandwidths.csv"):
|
||||
with open('integrationSplynxBandwidths.csv') as csv_file:
|
||||
csv_reader = csv.reader(csv_file, delimiter=',')
|
||||
next(csv_reader)
|
||||
for row in csv_reader:
|
||||
name, download, upload = row
|
||||
download = int(float(download))
|
||||
upload = int(float(upload))
|
||||
siteBandwidth[name] = {"download": download, "upload": upload}
|
||||
return siteBandwidth
|
||||
"""
|
||||
Build a dictionary of site bandwidths by reading data from a CSV file.
|
||||
"""
|
||||
siteBandwidth = {}
|
||||
if os.path.isfile("integrationSplynxBandwidths.csv"):
|
||||
with open('integrationSplynxBandwidths.csv') as csv_file:
|
||||
csv_reader = csv.reader(csv_file, delimiter=',')
|
||||
next(csv_reader)
|
||||
for row in csv_reader:
|
||||
name, download, upload = row
|
||||
download = int(float(download))
|
||||
upload = int(float(upload))
|
||||
siteBandwidth[name] = {"download": download, "upload": upload}
|
||||
return siteBandwidth
|
||||
|
||||
def getCustomers(headers):
|
||||
data = spylnxRequest("admin/customers/customer", headers)
|
||||
#addressForCustomerID = {}
|
||||
#customerIDs = []
|
||||
#for customer in data:
|
||||
# customerIDs.append(customer['id'])
|
||||
# addressForCustomerID[customer['id']] = customer['street_1']
|
||||
return data
|
||||
"""
|
||||
Retrieve all customer data from Splynx API.
|
||||
"""
|
||||
return spylnxRequest("admin/customers/customer", headers)
|
||||
|
||||
def getCustomersOnline(headers):
|
||||
data = spylnxRequest("admin/customers/customers-online", headers)
|
||||
return data
|
||||
|
||||
"""
|
||||
Retrieve data of currently online customers from Splynx API.
|
||||
"""
|
||||
return spylnxRequest("admin/customers/customers-online", headers)
|
||||
|
||||
def getRouters(headers):
|
||||
data = spylnxRequest("admin/networking/routers", headers)
|
||||
routerIdList = []
|
||||
ipForRouter = {}
|
||||
nameForRouterID = {}
|
||||
for router in data:
|
||||
routerID = router['id']
|
||||
if router['id'] not in routerIdList:
|
||||
routerIdList.append(router['id'])
|
||||
ipForRouter[routerID] = router['ip']
|
||||
nameForRouterID[routerID] = router['title']
|
||||
print("Router IPs found: " + str(len(ipForRouter)))
|
||||
return (ipForRouter, nameForRouterID, routerIdList)
|
||||
"""
|
||||
Retrieve router data from Splynx API and build dictionaries for router IPs and names.
|
||||
"""
|
||||
data = spylnxRequest("admin/networking/routers", headers)
|
||||
routerIdList = []
|
||||
ipForRouter = {}
|
||||
nameForRouterID = {}
|
||||
for router in data:
|
||||
routerID = router['id']
|
||||
if router['id'] not in routerIdList:
|
||||
routerIdList.append(router['id'])
|
||||
ipForRouter[routerID] = router['ip']
|
||||
nameForRouterID[routerID] = router['title']
|
||||
print("Router IPs found: " + str(len(ipForRouter)))
|
||||
return (ipForRouter, nameForRouterID, routerIdList)
|
||||
|
||||
def getSectors(headers):
|
||||
data = spylnxRequest("admin/networking/routers-sectors", headers)
|
||||
sectorForRouter = {}
|
||||
for sector in data:
|
||||
routerID = sector['router_id']
|
||||
if routerID not in sectorForRouter:
|
||||
newList = []
|
||||
newList.append(sector)
|
||||
sectorForRouter[routerID] = newList
|
||||
else:
|
||||
newList = sectorForRouter[routerID]
|
||||
newList.append(sector)
|
||||
sectorForRouter[routerID] = newList
|
||||
|
||||
print("Router Sectors found: " + str(len(sectorForRouter)))
|
||||
return sectorForRouter
|
||||
"""
|
||||
Retrieve sector data from Splynx API and build a dictionary mapping routers to their sectors.
|
||||
"""
|
||||
data = spylnxRequest("admin/networking/routers-sectors", headers)
|
||||
sectorForRouter = {}
|
||||
for sector in data:
|
||||
routerID = sector['router_id']
|
||||
if routerID not in sectorForRouter:
|
||||
newList = []
|
||||
newList.append(sector)
|
||||
sectorForRouter[routerID] = newList
|
||||
else:
|
||||
newList = sectorForRouter[routerID]
|
||||
newList.append(sector)
|
||||
sectorForRouter[routerID] = newList
|
||||
|
||||
print("Router Sectors found: " + str(len(sectorForRouter)))
|
||||
return sectorForRouter
|
||||
|
||||
def combineAddress(json):
|
||||
# Combines address fields into a single string
|
||||
# The API docs seem to indicate that there isn't a "state" field?
|
||||
if json["street_1"]=="" and json["city"]=="" and json["zip_code"]=="":
|
||||
return str(json["id"]) + "/" + json["name"]
|
||||
else:
|
||||
return json["street_1"] + " " + json["city"] + " " + json["zip_code"]
|
||||
"""
|
||||
Combine address fields into a single string. If address fields are empty, use ID and name.
|
||||
"""
|
||||
if json["street_1"] == "" and json["city"] == "" and json["zip_code"] == "":
|
||||
return str(json["id"]) + "/" + json["name"]
|
||||
else:
|
||||
return json["street_1"] + " " + json["city"] + " " + json["zip_code"]
|
||||
|
||||
def getAllServices(headers):
|
||||
services = spylnxRequest("admin/customers/customer/0/internet-services?main_attributes%5Bstatus%5D=active", headers)
|
||||
return services
|
||||
"""
|
||||
Retrieve all active internet services from Splynx API.
|
||||
"""
|
||||
return spylnxRequest("admin/customers/customer/0/internet-services?main_attributes%5Bstatus%5D=active", headers)
|
||||
|
||||
def getAllIPs(headers):
|
||||
ipv4ByCustomerID = {}
|
||||
ipv6ByCustomerID = {}
|
||||
allIPv4 = spylnxRequest("admin/networking/ipv4-ip?main_attributes%5Bis_used%5D=1", headers)
|
||||
allIPv6 = spylnxRequest("admin/networking/ipv6-ip", headers)
|
||||
for ipv4 in allIPv4:
|
||||
if ipv4['customer_id'] not in ipv4ByCustomerID:
|
||||
ipv4ByCustomerID[ipv4['customer_id']] = []
|
||||
temp = ipv4ByCustomerID[ipv4['customer_id']]
|
||||
temp.append(ipv4['ip'])
|
||||
ipv4ByCustomerID[ipv4['customer_id']] = temp
|
||||
for ipv6 in allIPv6:
|
||||
if ipv6['is_used'] == 1:
|
||||
if ipv6['customer_id'] not in ipv6ByCustomerID:
|
||||
ipv6ByCustomerID[ipv6['customer_id']] = []
|
||||
temp = ipv6ByCustomerID[ipv6['customer_id']]
|
||||
temp.append(ipv6['ip'])
|
||||
ipv6ByCustomerID[ipv6['customer_id']] = temp
|
||||
return (ipv4ByCustomerID, ipv6ByCustomerID)
|
||||
"""
|
||||
Retrieve all used IPv4 and IPv6 addresses from Splynx API and map them to customer IDs.
|
||||
"""
|
||||
ipv4ByCustomerID = {}
|
||||
ipv6ByCustomerID = {}
|
||||
allIPv4 = spylnxRequest("admin/networking/ipv4-ip?main_attributes%5Bis_used%5D=1", headers)
|
||||
allIPv6 = spylnxRequest("admin/networking/ipv6-ip", headers)
|
||||
for ipv4 in allIPv4:
|
||||
if ipv4['customer_id'] not in ipv4ByCustomerID:
|
||||
ipv4ByCustomerID[ipv4['customer_id']] = []
|
||||
temp = ipv4ByCustomerID[ipv4['customer_id']]
|
||||
temp.append(ipv4['ip'])
|
||||
ipv4ByCustomerID[ipv4['customer_id']] = temp
|
||||
for ipv6 in allIPv6:
|
||||
if ipv6['is_used'] == 1:
|
||||
if ipv6['customer_id'] not in ipv6ByCustomerID:
|
||||
ipv6ByCustomerID[ipv6['customer_id']] = []
|
||||
temp = ipv6ByCustomerID[ipv6['customer_id']]
|
||||
temp.append(ipv6['ip'])
|
||||
ipv6ByCustomerID[ipv6['customer_id']] = temp
|
||||
return (ipv4ByCustomerID, ipv6ByCustomerID)
|
||||
|
||||
def createShaper():
|
||||
net = NetworkGraph()
|
||||
"""
|
||||
Main function to fetch data from Splynx, build the network graph, and shape devices.
|
||||
"""
|
||||
net = NetworkGraph()
|
||||
|
||||
print("Fetching data from Spylnx")
|
||||
headers = buildHeaders()
|
||||
tariff, downloadForTariffID, uploadForTariffID = getTariffs(headers)
|
||||
customers = getCustomers(headers)
|
||||
customersOnline = getCustomersOnline(headers)
|
||||
ipForRouter, nameForRouterID, routerIdList = getRouters(headers)
|
||||
sectorForRouter = getSectors(headers)
|
||||
allServices = getAllServices(headers)
|
||||
ipv4ByCustomerID, ipv6ByCustomerID = getAllIPs(headers)
|
||||
siteBandwidth = buildSiteBandwidths()
|
||||
|
||||
#Go through all online customers, create Nodes
|
||||
allParentNodes = []
|
||||
custIDtoParentNode = {}
|
||||
parentNodeIDCounter = 30000
|
||||
for customer in customersOnline:
|
||||
download = 1000
|
||||
upload = 1000
|
||||
nodeName = customer['nas_id'] + "_" + customer['call_to'] + "_" + customer['port']
|
||||
|
||||
if nodeName not in allParentNodes:
|
||||
if nodeName in siteBandwidth:
|
||||
# Use the CSV bandwidth values
|
||||
download = siteBandwidth[nodeName]["download"]
|
||||
upload = siteBandwidth[nodeName]["upload"]
|
||||
|
||||
node = NetworkNode(id=parentNodeIDCounter, displayName=nodeName, type=NodeType.site,
|
||||
parentId=None, download=download, upload=upload, address=None)
|
||||
net.addRawNode(node)
|
||||
|
||||
pnEntry = {}
|
||||
pnEntry['name'] = nodeName
|
||||
pnEntry['id'] = parentNodeIDCounter
|
||||
custIDtoParentNode[customer['customer_id']] = pnEntry
|
||||
|
||||
parentNodeIDCounter += 1
|
||||
|
||||
#customerIDtoParentNodeID = {}
|
||||
allServicesDict = {}
|
||||
for serviceItem in allServices:
|
||||
if (serviceItem['status'] == 'active'):
|
||||
if serviceItem["customer_id"] not in allServicesDict:
|
||||
allServicesDict[serviceItem["customer_id"]] = []
|
||||
temp = allServicesDict[serviceItem["customer_id"]]
|
||||
temp.append(serviceItem)
|
||||
allServicesDict[serviceItem["customer_id"]] = temp
|
||||
|
||||
#It's not very clear how a service is meant to handle multiple
|
||||
#devices on a shared tariff. Creating each service as a combined
|
||||
#entity including the customer, to be on the safe side.
|
||||
for customerJson in customers:
|
||||
if customerJson['status'] == 'active':
|
||||
if customerJson['id'] in allServicesDict:
|
||||
servicesForCustomer = allServicesDict[customerJson['id']]
|
||||
for service in servicesForCustomer:
|
||||
combinedId = "c_" + str(customerJson["id"]) + "_s_" + str(service["id"])
|
||||
tariff_id = service['tariff_id']
|
||||
|
||||
parentID = None
|
||||
if customerJson['id'] in custIDtoParentNode:
|
||||
parentID = custIDtoParentNode[customerJson['id']]['id']
|
||||
|
||||
customer = NetworkNode(
|
||||
type=NodeType.client,
|
||||
id=combinedId,
|
||||
parentId = parentID,
|
||||
displayName=customerJson["name"],
|
||||
address=combineAddress(customerJson),
|
||||
customerName=customerJson["name"],
|
||||
download=downloadForTariffID[tariff_id],
|
||||
upload=uploadForTariffID[tariff_id],
|
||||
)
|
||||
net.addRawNode(customer)
|
||||
|
||||
ipv4 = []
|
||||
ipv6 = []
|
||||
routerID = service['router_id']
|
||||
|
||||
# If not "Taking IPv4" (Router will assign IP), then use router's set IP
|
||||
taking_ipv4 = int(service['taking_ipv4'])
|
||||
if taking_ipv4 == 0:
|
||||
if routerID in ipForRouter:
|
||||
ipv4 = [ipForRouter[routerID]]
|
||||
print("Fetching data from Spylnx")
|
||||
headers = buildHeaders()
|
||||
tariff, downloadForTariffID, uploadForTariffID = getTariffs(headers)
|
||||
customers = getCustomers(headers)
|
||||
customersOnline = getCustomersOnline(headers)
|
||||
ipForRouter, nameForRouterID, routerIdList = getRouters(headers)
|
||||
sectorForRouter = getSectors(headers)
|
||||
allServices = getAllServices(headers)
|
||||
ipv4ByCustomerID, ipv6ByCustomerID = getAllIPs(headers)
|
||||
siteBandwidth = buildSiteBandwidths()
|
||||
|
||||
allParentNodes = []
|
||||
custIDtoParentNode = {}
|
||||
parentNodeIDCounter = 30000
|
||||
|
||||
# Create nodes for sites and assign bandwidth
|
||||
for customer in customersOnline:
|
||||
download = 1000
|
||||
upload = 1000
|
||||
nodeName = customer['nas_id'] + "_" + customer['call_to'] + "_" + customer['port']
|
||||
|
||||
if nodeName not in allParentNodes:
|
||||
if nodeName in siteBandwidth:
|
||||
download = siteBandwidth[nodeName]["download"]
|
||||
upload = siteBandwidth[nodeName]["upload"]
|
||||
|
||||
node = NetworkNode(id=parentNodeIDCounter, displayName=nodeName, type=NodeType.site,
|
||||
parentId=None, download=download, upload=upload, address=None)
|
||||
net.addRawNode(node)
|
||||
|
||||
pnEntry = {}
|
||||
pnEntry['name'] = nodeName
|
||||
pnEntry['id'] = parentNodeIDCounter
|
||||
custIDtoParentNode[customer['customer_id']] = pnEntry
|
||||
|
||||
parentNodeIDCounter += 1
|
||||
|
||||
elif taking_ipv4 == 1:
|
||||
ipv4 = [service['ipv4']]
|
||||
if len(ipv4) == 0:
|
||||
#Only do this if single service for a customer
|
||||
if len(servicesForCustomer) == 1:
|
||||
if customerJson['id'] in ipv4ByCustomerID:
|
||||
ipv4 = ipv4ByCustomerID[customerJson['id']]
|
||||
|
||||
# If not "Taking IPv6" (Router will assign IP), then use router's set IP
|
||||
if isinstance(service['taking_ipv6'], str):
|
||||
taking_ipv6 = int(service['taking_ipv6'])
|
||||
else:
|
||||
taking_ipv6 = service['taking_ipv6']
|
||||
if taking_ipv6 == 0:
|
||||
ipv6 = []
|
||||
elif taking_ipv6 == 1:
|
||||
ipv6 = [service['ipv6']]
|
||||
|
||||
device = NetworkNode(
|
||||
id=combinedId+"_d" + str(service["id"]),
|
||||
displayName=service["id"],
|
||||
type=NodeType.device,
|
||||
parentId=combinedId,
|
||||
mac=service["mac"],
|
||||
ipv4=ipv4,
|
||||
ipv6=ipv6
|
||||
)
|
||||
net.addRawNode(device)
|
||||
allServicesDict = {}
|
||||
for serviceItem in allServices:
|
||||
if serviceItem['status'] == 'active':
|
||||
if serviceItem["customer_id"] not in allServicesDict:
|
||||
allServicesDict[serviceItem["customer_id"]] = []
|
||||
temp = allServicesDict[serviceItem["customer_id"]]
|
||||
temp.append(serviceItem)
|
||||
allServicesDict[serviceItem["customer_id"]] = temp
|
||||
|
||||
# Create nodes for customers and their devices
|
||||
for customerJson in customers:
|
||||
if customerJson['status'] == 'active':
|
||||
if customerJson['id'] in allServicesDict:
|
||||
servicesForCustomer = allServicesDict[customerJson['id']]
|
||||
for service in servicesForCustomer:
|
||||
combinedId = "c_" + str(customerJson["id"]) + "_s_" + str(service["id"])
|
||||
tariff_id = service['tariff_id']
|
||||
|
||||
parentID = None
|
||||
if customerJson['id'] in custIDtoParentNode:
|
||||
parentID = custIDtoParentNode[customerJson['id']]['id']
|
||||
|
||||
customer = NetworkNode(
|
||||
type=NodeType.client,
|
||||
id=combinedId,
|
||||
parentId=parentID,
|
||||
displayName=customerJson["name"],
|
||||
address=combineAddress(customerJson),
|
||||
customerName=customerJson["name"],
|
||||
download=downloadForTariffID[tariff_id],
|
||||
upload=uploadForTariffID[tariff_id]
|
||||
)
|
||||
net.addRawNode(customer)
|
||||
|
||||
ipv4 = ipv4ByCustomerID.get(customerJson["id"], [])
|
||||
ipv6 = ipv6ByCustomerID.get(customerJson["id"], [])
|
||||
|
||||
device = NetworkNode(
|
||||
id=combinedId + "_d" + str(service["id"]),
|
||||
displayName=service["id"],
|
||||
type=NodeType.device,
|
||||
parentId=combinedId,
|
||||
mac=service["mac"],
|
||||
ipv4=ipv4,
|
||||
ipv6=ipv6
|
||||
)
|
||||
net.addRawNode(device)
|
||||
|
||||
net.prepareTree()
|
||||
net.plotNetworkGraph(False)
|
||||
if net.doesNetworkJsonExist():
|
||||
print("network.json already exists. Leaving in-place.")
|
||||
else:
|
||||
net.createNetworkJson()
|
||||
net.createShapedDevices()
|
||||
net.prepareTree()
|
||||
net.plotNetworkGraph(False)
|
||||
if net.doesNetworkJsonExist():
|
||||
print("network.json already exists. Leaving in-place.")
|
||||
else:
|
||||
net.createNetworkJson()
|
||||
net.createShapedDevices()
|
||||
|
||||
def importFromSplynx():
|
||||
#createNetworkJSON()
|
||||
createShaper()
|
||||
"""
|
||||
Entry point for the script to initiate the Splynx data import and shaper creation process.
|
||||
"""
|
||||
createShaper()
|
||||
|
||||
if __name__ == '__main__':
|
||||
importFromSplynx()
|
||||
importFromSplynx()
|
||||
|
||||
Loading…
Reference in New Issue
Block a user