Merge branch 'BOSWatch:develop' into bugfix/ISSUE-94

This commit is contained in:
Jan Speller 2022-05-21 16:46:41 +02:00 committed by GitHub
commit c75a1dba96
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
14 changed files with 533 additions and 61 deletions

137
plugin/divera.py Normal file
View file

@ -0,0 +1,137 @@
#!/usr/bin/python
# -*- coding: utf-8 -*-
"""!
____ ____ ______ __ __ __ _____
/ __ )/ __ \/ ___/ | / /___ _/ /______/ /_ |__ /
/ __ / / / /\__ \| | /| / / __ `/ __/ ___/ __ \ /_ <
/ /_/ / /_/ /___/ /| |/ |/ / /_/ / /_/ /__/ / / / ___/ /
/_____/\____//____/ |__/|__/\__,_/\__/\___/_/ /_/ /____/
German BOS Information Script
by Bastian Schroll
@file: divera.py
@date: 16.01.2022
@author: Lars Gremme
@description: Divera247 Plugin
"""
import logging
from plugin.pluginBase import PluginBase
# ###################### #
# Custom plugin includes #
import asyncio
from aiohttp import ClientSession
import urllib
# ###################### #
logging.debug("- %s loaded", __name__)
class BoswatchPlugin(PluginBase):
"""!Description of the Plugin"""
def __init__(self, config):
"""!Do not change anything here!"""
super().__init__(__name__, config) # you can access the config class on 'self.config'
def fms(self, bwPacket):
"""!Called on FMS alarm
@param bwPacket: bwPacket instance
Remove if not implemented"""
fms_data = self.config.get("fms")
apicall = urllib.parse.urlencode({
"accesskey": self.config.get("accesskey", default=""),
"vehicle_ric": self.parseWildcards(fms_data.get("vehicle", default="")),
"status_id": bwPacket.get("status"),
"status_note": bwPacket.get("directionText"),
"title": self.parseWildcards(fms_data.get("title", default="{FMS}")),
"text": self.parseWildcards(fms_data.get("message", default="{FMS}")),
"priority": fms_data.get("priority", default="false"),
})
apipath = "/api/fms"
self._makeRequests(apipath, apicall)
def pocsag(self, bwPacket):
"""!Called on POCSAG alarm
@param bwPacket: bwPacket instance
Remove if not implemented"""
poc_data = self.config.get("pocsag")
apicall = urllib.parse.urlencode({
"accesskey": self.config.get("accesskey", default=""),
"title": self.parseWildcards(poc_data.get("title", default="{RIC}({SRIC})\n{MSG}")),
"ric": self.parseWildcards(poc_data.get("ric", default="")),
"text": self.parseWildcards(poc_data.get("message", default="{MSG}")),
"priority": poc_data.get("priority", default="false"),
})
apipath = "/api/alarm"
self._makeRequests(apipath, apicall)
def zvei(self, bwPacket):
"""!Called on ZVEI alarm
@param bwPacket: bwPacket instance
Remove if not implemented"""
zvei_data = self.config.get("zvei")
apicall = urllib.parse.urlencode({
"accesskey": self.config.get("accesskey", default=""),
"title": self.parseWildcards(zvei_data.get("title", default="{TONE}")),
"ric": self.parseWildcards(zvei_data.get("ric", default="{TONE}")),
"text": self.parseWildcards(zvei_data.get("message", default="{TONE}")),
"priority": zvei_data.get("priority", default="false"),
})
apipath = "/api/alarm"
self._makeRequests(apipath, apicall)
def msg(self, bwPacket):
"""!Called on MSG packet
@param bwPacket: bwPacket instance
Remove if not implemented"""
msg_data = self.config.get("msg")
apicall = urllib.parse.urlencode({
"accesskey": self.config.get("accesskey", default=""),
"title": self.parseWildcards(msg_data.get("title", default="{MSG}")),
"ric": self.parseWildcards(msg_data.get("ric", default="")),
"text": self.parseWildcards(msg_data.get("message", default="{MSG}")),
"priority": msg_data.get("priority", default="false"),
})
apipath = "/api/alarm"
self._makeRequests(apipath, apicall)
def _makeRequests(self, apipath, apicall):
"""Parses wildcard urls and handles asynchronus requests
@param urls: array of urls"""
url = "https://www.divera247.com"
request = url + apipath + "?" + apicall
loop = asyncio.get_event_loop()
future = asyncio.ensure_future(self._asyncRequests(request))
loop.run_until_complete(future)
async def _asyncRequests(self, url):
"""Handles asynchronus requests
@param urls: array of urls to send requests to"""
tasks = []
async with ClientSession() as session:
logging.debug("Generated URL: [{}]".format(url))
task = asyncio.ensure_future(self._fetch(url, session))
tasks.append(task)
responses = asyncio.gather(*tasks)
await responses
async def _fetch(self, url, session):
"""Fetches requests
@param url: url
@param session: Clientsession instance"""
logging.debug("Post URL: [{}]".format(url))
async with session.post(url) as response:
logging.info("{} returned [{}]".format(response.url, response.status))
return await response.read()

View file

@ -38,7 +38,7 @@ class BoswatchPlugin(PluginBase):
@param bwPacket: bwPacket instance
Remove if not implemented"""
urls = self.config.get("fms")
self.makeRequests(urls)
self._makeRequests(urls)
def pocsag(self, bwPacket):
"""!Called on POCSAG alarm
@ -46,7 +46,7 @@ class BoswatchPlugin(PluginBase):
@param bwPacket: bwPacket instance
Remove if not implemented"""
urls = self.config.get("pocsag")
self.makeRequests(urls)
self._makeRequests(urls)
def zvei(self, bwPacket):
"""!Called on ZVEI alarm
@ -54,7 +54,7 @@ class BoswatchPlugin(PluginBase):
@param bwPacket: bwPacket instance
Remove if not implemented"""
urls = self.config.get("zvei")
self.makeRequests(urls)
self._makeRequests(urls)
def msg(self, bwPacket):
"""!Called on MSG packet
@ -62,9 +62,9 @@ class BoswatchPlugin(PluginBase):
@param bwPacket: bwPacket instance
Remove if not implemented"""
urls = self.config.get("msg")
self.makeRequests(urls)
self._makeRequests(urls)
def makeRequests(self, urls):
def _makeRequests(self, urls):
"""Parses wildcard urls and handles asynchronus requests
@param urls: array of urls"""
@ -75,7 +75,7 @@ class BoswatchPlugin(PluginBase):
future = asyncio.ensure_future(self.asyncRequests(urls))
loop.run_until_complete(future)
async def asyncRequests(self, urls):
async def _asyncRequests(self, urls):
"""Handles asynchronus requests
@param urls: array of urls to send requests to"""
@ -83,13 +83,13 @@ class BoswatchPlugin(PluginBase):
async with ClientSession() as session:
for url in urls:
task = asyncio.ensure_future(self.fetch(url, session))
task = asyncio.ensure_future(self._fetch(url, session))
tasks.append(task)
responses = asyncio.gather(*tasks)
await responses
async def fetch(self, url, session):
async def _fetch(self, url, session):
"""Fetches requests
@param url: url

188
plugin/mysql.py Normal file
View file

@ -0,0 +1,188 @@
#!/usr/bin/python
# -*- coding: utf-8 -*-
"""!
____ ____ ______ __ __ __ _____
/ __ )/ __ \/ ___/ | / /___ _/ /______/ /_ |__ /
/ __ / / / /\__ \| | /| / / __ `/ __/ ___/ __ \ /_ <
/ /_/ / /_/ /___/ /| |/ |/ / /_/ / /_/ /__/ / / / ___/ /
/_____/\____//____/ |__/|__/\__,_/\__/\___/_/ /_/ /____/
German BOS Information Script
by Bastian Schroll
@file: mysql.py
@date: 15.02.2021
@author: Jan Speller
@description: Mysql Plugin
"""
import logging
from plugin.pluginBase import PluginBase
# ###################### #
# Custom plugin includes #
import mysql.connector
from datetime import datetime
# ###################### #
logging.debug("- %s loaded", __name__)
class BoswatchPlugin(PluginBase):
"""!Description of the Plugin"""
def __init__(self, config):
"""!Do not change anything here!"""
super().__init__(__name__, config) # you can access the config class on 'self.config'
def onLoad(self):
"""!Called by import of the plugin
Remove if not implemented"""
self.sqlInserts = {
"pocsag": "INSERT INTO boswatch (packetTimestamp, packetMode, pocsag_ric, pocsag_subric, pocsag_subricText, pocsag_message, pocsag_bitrate, serverName, serverVersion, serverBuildDate, serverBranch, clientName, clientIP, clientVersion, clientBuildDate, clientBranch, inputSource, frequency) VALUES (%s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s)",
"zvei": "INSERT INTO boswatch (packetTimestamp, packetMode, zvei_tone, serverName, serverVersion, serverBuildDate, serverBranch, clientName, clientIP, clientVersion, clientBuildDate, clientBranch, inputSource, frequency) VALUES (%s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s)",
"fms": "INSERT INTO boswatch (packetTimestamp, packetMode, fms_fms, fms_service, fms_country, fms_location, fms_vehicle, fms_status, fms_direction, fms_directionText, fms_tacticalInfo, serverName, serverVersion, serverBuildDate, serverBranch, clientName, clientIP, clientVersion, clientBuildDate, clientBranch, inputSource, frequency) VALUE (%s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s)",
"msg": "INSERT INTO boswatch (packetTimestamp, packetMode, serverName, serverVersion, serverBuildDate, serverBranch, clientName, clientIP, clientVersion, clientBuildDate, clientBranch, inputSource, frequency) VALUE (%s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s)"
}
self.connection = mysql.connector.connect(
host=self.config.get("host"),
user=self.config.get("user"),
password=self.config.get("password"),
database=self.config.get("database"),
)
self.cursor = self.connection.cursor()
self.cursor.execute("SHOW TABLES LIKE 'boswatch'")
if self.cursor.fetchone() is None:
with open('init_db.sql') as f:
for stmnt in f.read().split(';'):
self.cursor.execute(stmnt)
self.connection.commit()
self.cursor.close()
def setup(self):
"""!Called before alarm
Remove if not implemented"""
try:
self.connection.ping(reconnect=True, attempts=3, delay=2)
except mysql.connector.Error:
logging.warning("Connection was down, trying to reconnect...")
self.onLoad()
self.cursor = self.connection.cursor()
def fms(self, bwPacket):
"""!Called on FMS alarm
@param bwPacket: bwPacket instance
Remove if not implemented"""
val = (
datetime.fromtimestamp(float(bwPacket.get("timestamp"))),
bwPacket.get("mode"),
bwPacket.get("fms"),
bwPacket.get("service"),
bwPacket.get("country"),
bwPacket.get("location"),
bwPacket.get("vehicle"),
bwPacket.get("status"),
bwPacket.get("direction"),
bwPacket.get("directionText"),
bwPacket.get("tacticalInfo"),
bwPacket.get("serverName"),
bwPacket.get("serverVersion"),
bwPacket.get("serverBuildDate"),
bwPacket.get("serverBranch"),
bwPacket.get("clientName"),
bwPacket.get("clientIP"),
bwPacket.get("clientVersion"),
bwPacket.get("clientBuildDate"),
bwPacket.get("clientBranch"),
bwPacket.get("inputSource"),
bwPacket.get("frequency")
)
self.cursor.execute(self.sqlInserts.get("fms"), val)
def pocsag(self, bwPacket):
"""!Called on POCSAG alarm
@param bwPacket: bwPacket instance
Remove if not implemented"""
val = (
datetime.fromtimestamp(float(bwPacket.get("timestamp"))),
bwPacket.get("mode"),
bwPacket.get("ric"),
bwPacket.get("subric"),
bwPacket.get("subricText"),
bwPacket.get("message"),
bwPacket.get("bitrate"),
bwPacket.get("serverName"),
bwPacket.get("serverVersion"),
bwPacket.get("serverBuildDate"),
bwPacket.get("serverBranch"),
bwPacket.get("clientName"),
bwPacket.get("clientIP"),
bwPacket.get("clientVersion"),
bwPacket.get("clientBuildDate"),
bwPacket.get("clientBranch"),
bwPacket.get("inputSource"),
bwPacket.get("frequency")
)
self.cursor.execute(self.sqlInserts.get("pocsag"), val)
def zvei(self, bwPacket):
"""!Called on ZVEI alarm
@param bwPacket: bwPacket instance
Remove if not implemented"""
val = (
datetime.fromtimestamp(float(bwPacket.get("timestamp"))),
bwPacket.get("mode"),
bwPacket.get("tone"),
bwPacket.get("serverName"),
bwPacket.get("serverVersion"),
bwPacket.get("serverBuildDate"),
bwPacket.get("serverBranch"),
bwPacket.get("clientName"),
bwPacket.get("clientIP"),
bwPacket.get("clientVersion"),
bwPacket.get("clientBuildDate"),
bwPacket.get("clientBranch"),
bwPacket.get("inputSource"),
bwPacket.get("frequency")
)
self.cursor.execute(self.sqlInserts.get("pocsag"), val)
def msg(self, bwPacket):
"""!Called on MSG packet
@param bwPacket: bwPacket instance
Remove if not implemented"""
val = (
datetime.fromtimestamp(float(bwPacket.get("timestamp"))),
bwPacket.get("mode"),
bwPacket.get("serverName"),
bwPacket.get("serverVersion"),
bwPacket.get("serverBuildDate"),
bwPacket.get("serverBranch"),
bwPacket.get("clientName"),
bwPacket.get("clientIP"),
bwPacket.get("clientVersion"),
bwPacket.get("clientBuildDate"),
bwPacket.get("clientBranch"),
bwPacket.get("inputSource"),
bwPacket.get("frequency")
)
self.cursor.execute(self.sqlInserts.get("msg"), val)
def teardown(self):
"""!Called after alarm
Remove if not implemented"""
self.connection.commit()
self.cursor.close()
def onUnload(self):
"""!Called by destruction of the plugin
Remove if not implemented"""
self.connection.close()