BOSWatch/BW3-Core
1
0
Fork 0
mirror of https://github.com/BOSWatch/BW3-Core.git synced 2026-03-20 11:44:51 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

add RouterManager

Browse source
This commit is contained in:
Bastian Schroll 2019-03-01 20:41:13 +01:00
parent 27ca31aa8c
commit 98d2ea344b
3 changed files with 103 additions and 141 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

160
boswatch/router.py
View file

@ -1,84 +1,104 @@
class Module: #!/usr/bin/python
# -*- coding: utf-8 -*-
"""!
____ ____ ______ __ __ __ _____
/ __ )/ __ \/ ___/ | / /___ _/ /______/ /_ |__ /
/ __ / / / /\__ \| | /| / / __ `/ __/ ___/ __ \ /_ <
/ /_/ / /_/ /___/ /| |/ |/ / /_/ / /_/ /__/ / / / ___/ /
/_____/\____//____/ |__/|__/\__,_/\__/\___/_/ /_/ /____/
German BOS Information Script
by Bastian Schroll
@file: router.py
@date: 01.03.2019
@author: Bastian Schroll
@description: Class for the BOSWatch packet router
"""
import logging
import copy
import importlib
logging.debug("- %s loaded", __name__)
class _Router:
def __init__(self, name): def __init__(self, name):
self.__name = name self.__name = name
self.__route = []
logging.debug("add new router: %s", self.__name)
def run(self, bwPacket): def addRoute(self, route):
print("-- run module:", self.__name) logging.debug("[%s] add route: %s", self.__name, route)
self.__route.append(route)
def runRouter(self, bwPacket):
logging.debug("[%s] started", self.__name)
for routeCall in self.__route:
logging.debug("[%s] -> run route: %s", self.__name, routeCall)
bwPacket_tmp = routeCall(copy.deepcopy(bwPacket)) # copy bwPacket to prevent edit the original
if bwPacket_tmp is None: # returning None doesnt change the bwPacket
continue
if bwPacket_tmp is False: # returning False stops the router immediately
logging.debug("[%s] stopped", self.__name)
break
bwPacket = bwPacket_tmp
logging.debug("[%s] <- bwPacket returned: %s", self.__name, bwPacket)
logging.debug("[%s] ended", self.__name)
return bwPacket return bwPacket
@property
def name(self):
return self.__name
class Plugin: @property
def __init__(self, name): def route(self):
self.__name = name return self.__route
def run(self, bwPacket):
print("-- run plugin:", self.__name)
class Router: class RouterManager:
def __init__(self, name): def __init__(self):
self.__name = name self.__routerDict = {}
self.__modules = []
self.__endpoints = []
self.__bwPacket = None
def addModule(self, module): def __del__(self):
if type(module) is Module: del self.__routerDict
self.__modules.append(module)
else: def buildRouter(self, config):
print("not a instance of module class:", module) self.__routerDict = {} # all routers and loaded modules/plugins would be unloaded
logging.debug("build routers")
def addEndpoint(self, endpoint): # first we have to init all routers
if (type(endpoint) is Plugin) or (type(endpoint) is Router): # because a router can be a valid target and we need his reference
self.__endpoints.append(endpoint) for router in config.get("router"):
else: self.__routerDict[router.get("name")] = _Router(router.get("name"))
print("not a instance of plugin class:", endpoint)
for router in config.get("router"):
for route in router.get("route"):
if route.get("type") == "plugin":
importedFile = importlib.import_module(route.get("type") + "." + route.get("name"))
loadedClass = importedFile.BoswatchPlugin(route.get("config"))
self.__routerDict[router.get("name")].addRoute(loadedClass._run)
elif route.get("type") == "module":
importedFile = importlib.import_module(route.get("type") + "." + route.get("name"))
loadedClass = importedFile.BoswatchModule(route.get("config"))
self.__routerDict[router.get("name")].addRoute(loadedClass._run)
elif route.get("type") == "router":
self.__routerDict[router.get("name")].addRoute(self.__routerDict[route.get("name")].runRouter)
def call(self, bwPacket): def runRouter(self, routerList, bwPacket):
# bwPacket has to be copied for each router for router in routerList:
# make it possible to run more routers parallel if router in self.__routerDict:
print("call router:", self.__name) self.__routerDict[router].runRouter(bwPacket)
for module in self.__modules:
bwPacket = module.run(bwPacket)
self.__callEndpoints(bwPacket)
print("router finished:", self.__name)
def __callEndpoints(self, bwPacket): def showRouterRoute(self):
print("call endpoints:", self.__name) for name, router in self.__routerDict.items():
for endpoint in self.__endpoints: logging.debug("Route for %s", name)
if type(endpoint) is not Router: for route in router.route:
endpoint.run(bwPacket) logging.debug("- %s", route)
else:
print("> endpoint is a new router")
endpoint.call(bwPacket)
# module
double = Module("double")
descriptor = Module("descriptor")
# boswatch plugins
telegram = Plugin("telegram")
mysql = Plugin("mysql")
Router1 = Router("R1")
Router2 = Router("R2")
# Router 1 module
Router1.addModule(double)
Router1.addModule(descriptor)
Router1.addModule(double)
Router1.addModule(double)
Router1.addModule(descriptor)
# Router 1 endpoints
Router1.addEndpoint(telegram)
Router1.addEndpoint(mysql)
Router1.addEndpoint(Router2)
# Router 2 module
Router2.addModule(double)
Router2.addModule(descriptor)
# Router 2 endpoints
Router2.addEndpoint(telegram)
Router2.addEndpoint(mysql)
Router1.call("Test123")

1
config/server.yaml
View file

@ -14,6 +14,7 @@ server:
alarmRouter: alarmRouter:
- Router 1 - Router 1
- Test
router: router:

83
router_test.py
View file

@ -1,84 +1,25 @@
#!/usr/bin/python #!/usr/bin/python
# -*- coding: utf-8 -*- # -*- coding: utf-8 -*-
import logging
from boswatch.configYaml import ConfigYAML from boswatch.configYaml import ConfigYAML
from boswatch.packet import Packet from boswatch.packet import Packet
from boswatch.router import RouterManager
import importlib
import copy
class Router:
def __init__(self, name):
self.__name = name
self.__route = []
logging.debug("add new router: %s", self.__name)
def addRoute(self, route):
logging.debug("[%s] add route: %s", self.__name, route)
self.__route.append(route)
def call(self, bwPacket):
for call in self.__route:
logging.debug("[%s] -> run route: %s", self.__name, call)
bwPacket_tmp = call(copy.deepcopy(bwPacket)) # todo is deepcopy here right?
if bwPacket_tmp is None: # returning None doesnt change the bwPacket
continue
if bwPacket is False: # returning False stops the router immediately
logging.debug("[%s] stopped", self.__name)
break
bwPacket = bwPacket_tmp
logging.debug("[%s] <- route returned: %s", self.__name, bwPacket)
logging.debug("[%s] ended", self.__name)
return bwPacket
def showRoute(self):
logging.debug("[%s] internal route", self.__name)
for call in self.__route:
logging.debug(" - %s", call)
config = ConfigYAML() config = ConfigYAML()
config.loadConfigFile("config/server.yaml") config.loadConfigFile("config/server.yaml")
routerList = {}
for router in config.get("router"):
routerList[router.get("name")] = Router(router.get("name"))
for router in config.get("router"):
for route in router.get("route"):
if route.get("type") == "plugin":
importedFile = importlib.import_module(route.get("type") + "." + route.get("name"))
loadedClass = importedFile.BoswatchPlugin(route.get("config"))
routerList[router.get("name")].addRoute(loadedClass._run)
elif route.get("type") == "module":
importedFile = importlib.import_module(route.get("type") + "." + route.get("name"))
loadedClass = importedFile.BoswatchModule(route.get("config"))
routerList[router.get("name")].addRoute(loadedClass._run)
elif route.get("type") == "router":
routerList[router.get("name")].addRoute(routerList[route.get("name")].call)
print()
print(routerList)
print()
for router in routerList:
routerList[router].showRoute()
print()
bwPack = Packet("{'timestamp': 1551421020.9004176, 'mode': 'zvei', 'zvei': '12345'}") bwPack = Packet("{'timestamp': 1551421020.9004176, 'mode': 'zvei', 'zvei': '12345'}")
for alaRouter in config.get("alarmRouter"):
routerList[str(alaRouter)].call(bwPack) print()
routMan = RouterManager()
routMan.buildRouter(config)
print()
routMan.showRouterRoute()
routMan.runRouter(config.get("alarmRouter"), bwPack)
#exit(0) print()
exit()