plugin.mysql.BoswatchPlugin Class Reference

Description of the Plugin. More...

Public Member Functions
def	__init__ (self, config)
	Do not change anything here!
def	onLoad (self)
	Called by import of the plugin Remove if not implemented.
def	setup (self)
	Called before alarm Remove if not implemented.
def	fms (self, bwPacket)
	Called on FMS alarm.
def	pocsag (self, bwPacket)
	Called on POCSAG alarm.
def	zvei (self, bwPacket)
	Called on ZVEI alarm.
def	msg (self, bwPacket)
	Called on MSG packet.
def	teardown (self)
	Called after alarm Remove if not implemented.
def	onUnload (self)
	Called by destruction of the plugin Remove if not implemented.
Public Member Functions inherited from plugin.pluginBase.PluginBase
def	__init__ (self, pluginName, config)
	init preload some needed locals and then call onLoad() directly
def	onLoad (self)
	Called by import of the plugin can be inherited.
def	setup (self)
	Called before alarm can be inherited.
def	fms (self, bwPacket)
	Called on FMS alarm can be inherited.
def	pocsag (self, bwPacket)
	Called on POCSAG alarm can be inherited.
def	zvei (self, bwPacket)
	Called on ZVEI alarm can be inherited.
def	msg (self, bwPacket)
	Called on MSG packet can be inherited.
def	teardown (self)
	Called after alarm can be inherited.
def	onUnload (self)
	Called on shutdown of boswatch can be inherited.
def	parseWildcards (self, msg)
	Return the message with parsed wildcards.

Data Fields
	sqlInserts
	connection
	cursor
Data Fields inherited from plugin.pluginBase.PluginBase
	config

Additional Inherited Members
Protected Member Functions inherited from plugin.pluginBase.PluginBase
def	_cleanup (self)
	Cleanup routine calls onUnload() directly.
def	_run (self, bwPacket)
	start an complete running turn of an plugin.
def	_getStatistics (self)
	Returns statistical information's from last plugin run.
Protected Attributes inherited from plugin.pluginBase.PluginBase
	_pluginName
	_bwPacket
	_sumTime
	_cumTime
	_setupTime
	_alarmTime
	_teardownTime
	_runCount
	_setupErrorCount
	_alarmErrorCount
	_teardownErrorCount
Static Protected Attributes inherited from plugin.pluginBase.PluginBase
list	_pluginsActive = []

Detailed Description

Description of the Plugin.

Constructor & Destructor Documentation

__init__()

def plugin.mysql.BoswatchPlugin.__init__	(		self,
			config
	)

Do not change anything here!

Reimplemented from plugin.pluginBase.PluginBase.

    def __init__(self, config):
        r"""!Do not change anything here!"""
        super().__init__(__name__, config)  # you can access the config class on 'self.config'
 

Member Function Documentation

onLoad()

def plugin.mysql.BoswatchPlugin.onLoad

(

self

)

Called by import of the plugin Remove if not implemented.

Reimplemented from plugin.pluginBase.PluginBase.

    def onLoad(self):
        r"""!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()
 

setup()

def plugin.mysql.BoswatchPlugin.setup

(

self

)

Called before alarm Remove if not implemented.

Reimplemented from plugin.pluginBase.PluginBase.

    def setup(self):
        r"""!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()
 

fms()

def plugin.mysql.BoswatchPlugin.fms	(		self,
			bwPacket
	)

Called on FMS alarm.

    @param bwPacket: bwPacket instance
    Remove if not implemented

Reimplemented from plugin.pluginBase.PluginBase.

    def fms(self, bwPacket):
        r"""!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)
 

pocsag()

def plugin.mysql.BoswatchPlugin.pocsag	(		self,
			bwPacket
	)

Called on POCSAG alarm.

    @param bwPacket: bwPacket instance
    Remove if not implemented

Reimplemented from plugin.pluginBase.PluginBase.

    def pocsag(self, bwPacket):
        r"""!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)
 

zvei()

def plugin.mysql.BoswatchPlugin.zvei	(		self,
			bwPacket
	)

Called on ZVEI alarm.

    @param bwPacket: bwPacket instance
    Remove if not implemented

Reimplemented from plugin.pluginBase.PluginBase.

    def zvei(self, bwPacket):
        r"""!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)
 

msg()

def plugin.mysql.BoswatchPlugin.msg	(		self,
			bwPacket
	)

Called on MSG packet.

    @param bwPacket: bwPacket instance
    Remove if not implemented

Reimplemented from plugin.pluginBase.PluginBase.

    def msg(self, bwPacket):
        r"""!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)
 

teardown()

def plugin.mysql.BoswatchPlugin.teardown

(

self

)

Called after alarm Remove if not implemented.

Reimplemented from plugin.pluginBase.PluginBase.

    def teardown(self):
        r"""!Called after alarm
        Remove if not implemented"""
        self.connection.commit()
        self.cursor.close()
 

onUnload()

def plugin.mysql.BoswatchPlugin.onUnload

(

self

)

Called by destruction of the plugin Remove if not implemented.

Reimplemented from plugin.pluginBase.PluginBase.

    def onUnload(self):
        r"""!Called by destruction of the plugin
        Remove if not implemented"""
        self.connection.close()

Field Documentation

sqlInserts

plugin.mysql.BoswatchPlugin.sqlInserts

connection

plugin.mysql.BoswatchPlugin.connection

cursor

plugin.mysql.BoswatchPlugin.cursor