mirror of
https://github.com/Schrolli91/BOSWatch.git
synced 2025-12-06 07:42:03 +01:00
remove NMA
This commit is contained in:
Bastian Schroll
parent
04ef809e51
commit
bf31a04e07
23
boswatch.py
23
boswatch.py
|
|
@ -249,29 +249,6 @@ try:
|
||||||
logging.debug("cannot set loglevel of fileHandler", exc_info=True)
|
logging.debug("cannot set loglevel of fileHandler", exc_info=True)
|
||||||
|
|
||||||
|
|
||||||
#
|
|
||||||
# Add NMA logging handler
|
|
||||||
#
|
|
||||||
try:
|
|
||||||
if configHandler.checkConfig("NMAHandler"):
|
|
||||||
# is NMAHandler enabled?
|
|
||||||
if globalVars.config.getboolean("NMAHandler", "enableHandler") == True:
|
|
||||||
# we only could do something, if an APIKey is given:
|
|
||||||
if len(globalVars.config.get("NMAHandler","APIKey")) > 0:
|
|
||||||
logging.debug("add NMA logging handler")
|
|
||||||
from includes import NMAHandler
|
|
||||||
if globalVars.config.get("NMAHandler","appName") == "":
|
|
||||||
nmaHandler = NMAHandler.NMAHandler(globalVars.config.get("NMAHandler","APIKey"))
|
|
||||||
else:
|
|
||||||
nmaHandler = NMAHandler.NMAHandler(globalVars.config.get("NMAHandler","APIKey"), globalVars.config.get("NMAHandler","appName"))
|
|
||||||
nmaHandler.setLevel(globalVars.config.getint("NMAHandler","loglevel"))
|
|
||||||
myLogger.addHandler(nmaHandler)
|
|
||||||
except:
|
|
||||||
# It's an error, but we could work without that stuff...
|
|
||||||
logging.error("cannot add NMA logging handler")
|
|
||||||
logging.debug("cannot add NMA logging handler", exc_info=True)
|
|
||||||
|
|
||||||
|
|
||||||
# initialization was fine, continue with main program...
|
# initialization was fine, continue with main program...
|
||||||
|
|
||||||
#
|
#
|
||||||
|
|
|
||||||
|
|
@ -64,22 +64,6 @@ doubleFilter_check_msg = 0
|
||||||
writeMultimonRaw = 0
|
writeMultimonRaw = 0
|
||||||
|
|
||||||
|
|
||||||
[NMAHandler]
|
|
||||||
# you can use a logging handler for sending logging records to NotifyMyAndroid
|
|
||||||
# enableHandler (0|1) will enable the NMA handler
|
|
||||||
enableHandler = 0
|
|
||||||
|
|
||||||
# loglevel for NMAHandler (see BOSWatch loglevel description)
|
|
||||||
loglevel = 50
|
|
||||||
|
|
||||||
# logging record will send to APIKey
|
|
||||||
APIKey =
|
|
||||||
|
|
||||||
# you can change the name of the application (default: BOSWatch)
|
|
||||||
# (f.e. if you use more than one instance of BOSWatch)
|
|
||||||
appName = BOSWatch
|
|
||||||
|
|
||||||
|
|
||||||
[FMS]
|
[FMS]
|
||||||
# look-up-table for adding a description
|
# look-up-table for adding a description
|
||||||
# using description (0 - off | 1 - on)
|
# using description (0 - off | 1 - on)
|
||||||
|
|
@ -177,7 +161,6 @@ eMail = 0
|
||||||
BosMon = 0
|
BosMon = 0
|
||||||
firEmergency = 0
|
firEmergency = 0
|
||||||
jsonSocket = 0
|
jsonSocket = 0
|
||||||
notifyMyAndroid = 0
|
|
||||||
SMS = 0
|
SMS = 0
|
||||||
Sms77 = 0
|
Sms77 = 0
|
||||||
FFAgent = 0
|
FFAgent = 0
|
||||||
|
|
@ -287,23 +270,6 @@ server = 192.168.0.1
|
||||||
port = 8888
|
port = 8888
|
||||||
|
|
||||||
|
|
||||||
[notifyMyAndroid]
|
|
||||||
# APIKey given from notifyMyAndroid
|
|
||||||
APIKey =
|
|
||||||
|
|
||||||
# Priority goes from -2 (lowest) to 2 (highest). The default priority is 0 (normal)
|
|
||||||
priority = 0
|
|
||||||
|
|
||||||
# You can change the name of the application (default: BOSWatch)
|
|
||||||
# (f.e. if you use more than one instance of BOSWatch)
|
|
||||||
appName = BOSWatch
|
|
||||||
|
|
||||||
# instead of a given APIKey/priority you could import them by a csv-file (0|1)
|
|
||||||
# APIKey and priority above will be ignored, if you use a csv
|
|
||||||
# configuration loaded from csv/nma.csv
|
|
||||||
usecsv = 0
|
|
||||||
|
|
||||||
|
|
||||||
[SMS]
|
[SMS]
|
||||||
# be aware that you need 'gammu' installed and running
|
# be aware that you need 'gammu' installed and running
|
||||||
# at least you need an UMTS-stick which is supported by 'gammu'
|
# at least you need an UMTS-stick which is supported by 'gammu'
|
||||||
|
|
|
||||||
|
|
@ -1,73 +0,0 @@
|
||||||
#!/usr/bin/python
|
|
||||||
# -*- coding: UTF-8 -*-
|
|
||||||
|
|
||||||
"""
|
|
||||||
Logging Handler for NotifyMyAndroid
|
|
||||||
|
|
||||||
@author: Jens Herrmann
|
|
||||||
"""
|
|
||||||
|
|
||||||
import logging
|
|
||||||
from includes.pynma import pynma
|
|
||||||
|
|
||||||
class NMAHandler(logging.Handler): # Inherit from logging.Handler
|
|
||||||
"""
|
|
||||||
Handler instances dispatch logging events to NotifyMyAndroid.
|
|
||||||
"""
|
|
||||||
|
|
||||||
def __init__(self, APIKey, application="BOSWatch", event="Logging-Handler"):
|
|
||||||
"""
|
|
||||||
Initializes the handler with NMA-specific parameters.
|
|
||||||
|
|
||||||
@param APIKey: might be a string containing 1 key or an array of keys
|
|
||||||
@param application: application name [256]
|
|
||||||
@param event: event name [1000]
|
|
||||||
"""
|
|
||||||
# run the regular Handler __init__
|
|
||||||
logging.Handler.__init__(self)
|
|
||||||
# Our custom argument
|
|
||||||
self.APIKey = APIKey
|
|
||||||
self.application = application
|
|
||||||
self.event = event
|
|
||||||
self.nma = pynma.PyNMA(self.APIKey)
|
|
||||||
|
|
||||||
|
|
||||||
def emit(self, record):
|
|
||||||
"""
|
|
||||||
Send logging record via NMA
|
|
||||||
"""
|
|
||||||
# record.message is the log message
|
|
||||||
message = record.message
|
|
||||||
|
|
||||||
# if exist, add details as NMA event:
|
|
||||||
# record.module is the module- or filename
|
|
||||||
if (len(record.module) > 0):
|
|
||||||
event = "Module: " + record.module
|
|
||||||
# record.functionName is the name of the function
|
|
||||||
# will be "<module>" if the message is not in a function
|
|
||||||
if len(record.funcName) > 0:
|
|
||||||
if not record.funcName == "<module>":
|
|
||||||
event += " - " + record.funcName + "()"
|
|
||||||
else:
|
|
||||||
# we have to set an event-text, use self.event now
|
|
||||||
event = self.event
|
|
||||||
|
|
||||||
# record.levelno is the log level
|
|
||||||
# loglevel: 10 = debug => priority: -2
|
|
||||||
# loglevel: 20 = info => priority: -1
|
|
||||||
# loglevel: 30 = warning => priority: 0
|
|
||||||
# loglevel: 40 = error => priority: 1
|
|
||||||
# loglevel: 50 = critical => priority: 2
|
|
||||||
if record.levelno >= 50:
|
|
||||||
priority = 2
|
|
||||||
elif record.levelno >= 40:
|
|
||||||
priority = 1
|
|
||||||
elif record.levelno >= 30:
|
|
||||||
priority = 0
|
|
||||||
elif record.levelno >= 20:
|
|
||||||
priority = -1
|
|
||||||
else:
|
|
||||||
priority = -2
|
|
||||||
|
|
||||||
# pynma.push(self, application="", event="", description="", url="", contenttype=None, priority=0, batch_mode=False, html=False)
|
|
||||||
self.nma.push(application=self.application, event=event, description=message, priority=priority)
|
|
||||||
|
|
@ -1,137 +0,0 @@
|
||||||
Pynma
|
|
||||||
======
|
|
||||||
|
|
||||||
Pynma is a simple python module for the [NotifyMyAndroid][nma] [API][NMA API].
|
|
||||||
|
|
||||||
[nma]: http://nma.usk.bz/
|
|
||||||
[NMA API]: http://nma.usk.bz/api.php
|
|
||||||
|
|
||||||
Credits to: Damien Degois (github.com/babs)
|
|
||||||
Refactoring: Adriano Maia (adriano@usk.bz)
|
|
||||||
|
|
||||||
[NotifyMyAndroid][nma]
|
|
||||||
---------------
|
|
||||||
NotifyMyAndroid is a Prowl-like application for the Android. Notifications can be sent from your application Android device using push. NMA has an extensive API, which allows your scripts to integrate beautifully. (source: http://nma.usk.bz/)
|
|
||||||
|
|
||||||
### How it works:
|
|
||||||
First, import the module:
|
|
||||||
|
|
||||||
import pynma
|
|
||||||
|
|
||||||
#### Keys management
|
|
||||||
|
|
||||||
Create a PyNMA simple instance:
|
|
||||||
|
|
||||||
p = pynma.PyNMA( "apikey(s)", "developerkey")
|
|
||||||
|
|
||||||
A developerkey is optional. If you'd like to add just one API key, set it as string, if you want more, just provide a list of API key strings.
|
|
||||||
|
|
||||||
p = pynma.PyNMA(['apikey1','apikey2']) # multiple API keys
|
|
||||||
p = pynma.PyNMA("apikey1","providerkey") # 1 API key with a providerkey
|
|
||||||
|
|
||||||
For more flexible usage, you can add and remove keys:
|
|
||||||
|
|
||||||
p.addkey("apikey1")
|
|
||||||
p.addkey(["apikey2","apikey3"])
|
|
||||||
|
|
||||||
Or set or change the providerkey
|
|
||||||
|
|
||||||
p.developerkey("developerkey")
|
|
||||||
|
|
||||||
#### Notification or Push or Add
|
|
||||||
|
|
||||||
p.push(application, event, description, (opt) url, (opt) priority, (opt) batch mode)
|
|
||||||
|
|
||||||
##### Application
|
|
||||||
|
|
||||||
Application is your message generating application name (limited to 256)
|
|
||||||
|
|
||||||
ex: my music player
|
|
||||||
|
|
||||||
##### Event
|
|
||||||
|
|
||||||
Event is the event name (limited to 1000)
|
|
||||||
|
|
||||||
ex: switched to next track
|
|
||||||
|
|
||||||
##### Description
|
|
||||||
|
|
||||||
The description is the payload of your message (limited to 10000 (10k))
|
|
||||||
ex:
|
|
||||||
|
|
||||||
Playing next song, Blah Blah Blah
|
|
||||||
Artist: blah blah
|
|
||||||
Album: blah blah
|
|
||||||
Track: 18/24
|
|
||||||
|
|
||||||
##### Url
|
|
||||||
|
|
||||||
The URL which should be attached to the notification.
|
|
||||||
This will trigger a redirect when on the user's device launched, and is viewable in the notification list.
|
|
||||||
|
|
||||||
##### Priority
|
|
||||||
|
|
||||||
Priority goes from -2 (lowest) to 2 (highest). the default priority is 0 (normal)
|
|
||||||
|
|
||||||
##### Batch mode
|
|
||||||
|
|
||||||
Batch mode is a boolean value to set if you'd like to push the same message to multiple API keys 5 by 5 (as the actual verion of prowl API allows you). This can reduce the number of call you make to the API which are limited.
|
|
||||||
|
|
||||||
#### Return
|
|
||||||
|
|
||||||
The push method returns a dict containing different values depending of the success of you call:
|
|
||||||
|
|
||||||
##### The call succeed
|
|
||||||
|
|
||||||
you'll have in the dict those keys:
|
|
||||||
|
|
||||||
type: success
|
|
||||||
code: the HTTP like code (200 if success)
|
|
||||||
remaining: the number of API call you can to until the reset
|
|
||||||
resetdate: number of remaining minutes till the hourly reset of your API call limit
|
|
||||||
|
|
||||||
##### The call failed
|
|
||||||
|
|
||||||
For wathever reason, you call failed, the dict key "message" will contains the erro message returned by Prowl API. You'll find those keys:
|
|
||||||
|
|
||||||
code: 400, 401, 402 or 500 (depends of the error kind)
|
|
||||||
message: API error message
|
|
||||||
|
|
||||||
For the code description, please refer to [NMA API documentation][NMA API] for more informations
|
|
||||||
|
|
||||||
##### The python module encountered an unhandled problem (mostly during parsing)
|
|
||||||
|
|
||||||
The return keys will be:
|
|
||||||
|
|
||||||
code: 600
|
|
||||||
type: pynmaerror
|
|
||||||
message: the exception message
|
|
||||||
|
|
||||||
Thanks
|
|
||||||
------
|
|
||||||
|
|
||||||
* **Cev** for URL integration and some fixes in docstring
|
|
||||||
* **ChaoticXSinZ** for UTF-8 integration and other typos
|
|
||||||
|
|
||||||
License (MIT)
|
|
||||||
-------------
|
|
||||||
|
|
||||||
Copyright (c) 2010-2011, Damien Degois.
|
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
|
||||||
in the Software without restriction, including without limitation the rights
|
|
||||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
||||||
copies of the Software, and to permit persons to whom the Software is
|
|
||||||
furnished to do so, subject to the following conditions:
|
|
||||||
|
|
||||||
The above copyright notice and this permission notice shall be included in
|
|
||||||
all copies or substantial portions of the Software.
|
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
||||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
||||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
||||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
||||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
||||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
||||||
THE SOFTWARE.
|
|
||||||
|
|
@ -1,3 +0,0 @@
|
||||||
#!/usr/bin/python
|
|
||||||
|
|
||||||
from .pynma import PyNMA
|
|
||||||
|
|
@ -1,153 +0,0 @@
|
||||||
#!/usr/bin/python
|
|
||||||
|
|
||||||
from xml.dom.minidom import parseString
|
|
||||||
|
|
||||||
try:
|
|
||||||
from http.client import HTTPSConnection
|
|
||||||
except ImportError:
|
|
||||||
from httplib import HTTPSConnection
|
|
||||||
|
|
||||||
try:
|
|
||||||
from urllib.parse import urlencode
|
|
||||||
except ImportError:
|
|
||||||
from urllib import urlencode
|
|
||||||
|
|
||||||
__version__ = "1.0"
|
|
||||||
|
|
||||||
API_SERVER = 'www.notifymyandroid.com'
|
|
||||||
ADD_PATH = '/publicapi/notify'
|
|
||||||
|
|
||||||
USER_AGENT="PyNMA/v%s"%__version__
|
|
||||||
|
|
||||||
def uniq_preserve(seq): # Dave Kirby
|
|
||||||
# Order preserving
|
|
||||||
seen = set()
|
|
||||||
return [x for x in seq if x not in seen and not seen.add(x)]
|
|
||||||
|
|
||||||
def uniq(seq):
|
|
||||||
# Not order preserving
|
|
||||||
return list({}.fromkeys(seq).keys())
|
|
||||||
|
|
||||||
class PyNMA(object):
|
|
||||||
"""PyNMA(apikey=[], developerkey=None)
|
|
||||||
takes 2 optional arguments:
|
|
||||||
- (opt) apykey: might me a string containing 1 key or an array of keys
|
|
||||||
- (opt) developerkey: where you can store your developer key
|
|
||||||
"""
|
|
||||||
|
|
||||||
def __init__(self, apikey=[], developerkey=None):
|
|
||||||
self._developerkey = None
|
|
||||||
self.developerkey(developerkey)
|
|
||||||
if apikey:
|
|
||||||
if isinstance(apikey, str):
|
|
||||||
apikey = [apikey]
|
|
||||||
self._apikey = uniq(apikey)
|
|
||||||
|
|
||||||
def addkey(self, key):
|
|
||||||
"Add a key (register ?)"
|
|
||||||
if isinstance(key, str):
|
|
||||||
if not key in self._apikey:
|
|
||||||
self._apikey.append(key)
|
|
||||||
elif isinstance(key, list):
|
|
||||||
for k in key:
|
|
||||||
if not k in self._apikey:
|
|
||||||
self._apikey.append(k)
|
|
||||||
|
|
||||||
def delkey(self, key):
|
|
||||||
"Removes a key (unregister ?)"
|
|
||||||
if isinstance(key, str):
|
|
||||||
if key in self._apikey:
|
|
||||||
self._apikey.remove(key)
|
|
||||||
elif isinstance(key, list):
|
|
||||||
for k in key:
|
|
||||||
if key in self._apikey:
|
|
||||||
self._apikey.remove(k)
|
|
||||||
|
|
||||||
def developerkey(self, developerkey):
|
|
||||||
"Sets the developer key (and check it has the good length)"
|
|
||||||
if isinstance(developerkey, str) and len(developerkey) == 48:
|
|
||||||
self._developerkey = developerkey
|
|
||||||
|
|
||||||
def pushWithAPIKey(self, apikey=[], application="", event="", description="", url="", contenttype=None, priority=0, batch_mode=False, html=False):
|
|
||||||
"""Special Funktion"""
|
|
||||||
if apikey:
|
|
||||||
if isinstance(apikey, str):
|
|
||||||
apikey = [apikey]
|
|
||||||
self._apikey = uniq(apikey)
|
|
||||||
return self.push(application, event, description, url, contenttype, priority, batch_mode, html)
|
|
||||||
|
|
||||||
def push(self, application="", event="", description="", url="", contenttype=None, priority=0, batch_mode=False, html=False):
|
|
||||||
"""Pushes a message on the registered API keys.
|
|
||||||
takes 5 arguments:
|
|
||||||
- (req) application: application name [256]
|
|
||||||
- (req) event: event name [1000]
|
|
||||||
- (req) description: description [10000]
|
|
||||||
- (opt) url: url [512]
|
|
||||||
- (opt) contenttype: Content Type (act: None (plain text) or text/html)
|
|
||||||
- (opt) priority: from -2 (lowest) to 2 (highest) (def:0)
|
|
||||||
- (opt) batch_mode: push to all keys at once (def:False)
|
|
||||||
- (opt) html: shortcut for contenttype=text/html
|
|
||||||
Warning: using batch_mode will return error only if all API keys are bad
|
|
||||||
cf: http://nma.usk.bz/api.php
|
|
||||||
"""
|
|
||||||
datas = {
|
|
||||||
'application': application[:256].encode('utf8'),
|
|
||||||
'event': event[:1024].encode('utf8'),
|
|
||||||
'description': description[:10000].encode('utf8'),
|
|
||||||
'priority': priority
|
|
||||||
}
|
|
||||||
|
|
||||||
if url:
|
|
||||||
datas['url'] = url[:512]
|
|
||||||
|
|
||||||
if contenttype == "text/html" or html == True: # Currently only accepted content type
|
|
||||||
datas['content-type'] = "text/html"
|
|
||||||
|
|
||||||
if self._developerkey:
|
|
||||||
datas['developerkey'] = self._developerkey
|
|
||||||
|
|
||||||
results = {}
|
|
||||||
|
|
||||||
if not batch_mode:
|
|
||||||
for key in self._apikey:
|
|
||||||
datas['apikey'] = key
|
|
||||||
res = self.callapi('POST', ADD_PATH, datas)
|
|
||||||
results[key] = res
|
|
||||||
else:
|
|
||||||
datas['apikey'] = ",".join(self._apikey)
|
|
||||||
res = self.callapi('POST', ADD_PATH, datas)
|
|
||||||
results[datas['apikey']] = res
|
|
||||||
return results
|
|
||||||
|
|
||||||
def callapi(self, method, path, args):
|
|
||||||
headers = { 'User-Agent': USER_AGENT }
|
|
||||||
if method == "POST":
|
|
||||||
headers['Content-type'] = "application/x-www-form-urlencoded"
|
|
||||||
http_handler = HTTPSConnection(API_SERVER)
|
|
||||||
http_handler.request(method, path, urlencode(args), headers)
|
|
||||||
resp = http_handler.getresponse()
|
|
||||||
|
|
||||||
try:
|
|
||||||
res = self._parse_reponse(resp.read())
|
|
||||||
except Exception as e:
|
|
||||||
res = {'type': "pynmaerror",
|
|
||||||
'code': 600,
|
|
||||||
'message': str(e)
|
|
||||||
}
|
|
||||||
|
|
||||||
return res
|
|
||||||
|
|
||||||
def _parse_reponse(self, response):
|
|
||||||
root = parseString(response).firstChild
|
|
||||||
for elem in root.childNodes:
|
|
||||||
if elem.nodeType == elem.TEXT_NODE: continue
|
|
||||||
if elem.tagName == 'success':
|
|
||||||
res = dict(list(elem.attributes.items()))
|
|
||||||
res['message'] = ""
|
|
||||||
res['type'] = elem.tagName
|
|
||||||
return res
|
|
||||||
if elem.tagName == 'error':
|
|
||||||
res = dict(list(elem.attributes.items()))
|
|
||||||
res['message'] = elem.firstChild.nodeValue
|
|
||||||
res['type'] = elem.tagName
|
|
||||||
return res
|
|
||||||
|
|
@ -1,301 +0,0 @@
|
||||||
#!/usr/bin/python
|
|
||||||
# -*- coding: utf-8 -*-
|
|
||||||
|
|
||||||
"""
|
|
||||||
notifyMyAndroid-Plugin to dispatch FMS-, ZVEI- and POCSAG-messages via UDP/TCP
|
|
||||||
|
|
||||||
@author: Jens Herrmann
|
|
||||||
|
|
||||||
@requires: notifyMyAndroid-Configuration has to be set in the config.ini
|
|
||||||
"""
|
|
||||||
|
|
||||||
import logging # Global logger
|
|
||||||
import csv # for loading the APIKeys
|
|
||||||
|
|
||||||
|
|
||||||
from includes import globalVars # Global variables
|
|
||||||
|
|
||||||
from includes.helper import configHandler
|
|
||||||
from includes.helper import timeHandler
|
|
||||||
from includes.helper import stringConverter
|
|
||||||
from includes.pynma import pynma
|
|
||||||
|
|
||||||
|
|
||||||
# local variables
|
|
||||||
application = "BOSWatch"
|
|
||||||
APIKey = None
|
|
||||||
remainingMsgs = None
|
|
||||||
usecsv = False
|
|
||||||
# data structures: xAPIKeyList[id][i] = (APIKey, priority, eventPrefix)
|
|
||||||
fmsAPIKeyList = {}
|
|
||||||
zveiAPIKeyList = {}
|
|
||||||
pocAPIKeyList = {}
|
|
||||||
|
|
||||||
|
|
||||||
def checkResponse(response, APIKey):
|
|
||||||
"""
|
|
||||||
Helper function to check the response of NMA
|
|
||||||
|
|
||||||
@type response: dict
|
|
||||||
@param response: Response of the pyNMA.push() method
|
|
||||||
@type data: string / array
|
|
||||||
@param data: a string containing 1 key or an array of keys
|
|
||||||
|
|
||||||
@return: nothing
|
|
||||||
"""
|
|
||||||
# local variables
|
|
||||||
global remainingMsgs
|
|
||||||
try:
|
|
||||||
#
|
|
||||||
# check HTTP-Response
|
|
||||||
#
|
|
||||||
if str(response[APIKey]['code']) == "200": #Check HTTP Response an print a Log or Error
|
|
||||||
logging.debug("NMA response: %s" , str(response[APIKey]['code']))
|
|
||||||
remainingMsgs = response[APIKey]['remaining']
|
|
||||||
if int(remainingMsgs) == 0:
|
|
||||||
logging.error("NMA remaining msgs: %s" , str(remainingMsgs))
|
|
||||||
if int(response[APIKey]['remaining']) < 20:
|
|
||||||
logging.warning("NMA remaining msgs: %s" , str(remainingMsgs))
|
|
||||||
else:
|
|
||||||
logging.debug("NMA remaining msgs: %s" , str(remainingMsgs))
|
|
||||||
else:
|
|
||||||
logging.warning("NMA response: %s - %s" , str(response[APIKey]['code']), str(response[APIKey]['message']))
|
|
||||||
except:
|
|
||||||
logging.error("cannot read pynma response")
|
|
||||||
logging.debug("cannot read pynma response", exc_info=True)
|
|
||||||
return
|
|
||||||
|
|
||||||
|
|
||||||
##
|
|
||||||
#
|
|
||||||
# onLoad (init) function of plugin
|
|
||||||
# will be called one time by the pluginLoader on start
|
|
||||||
#
|
|
||||||
def onLoad():
|
|
||||||
"""
|
|
||||||
While loading the plugins by pluginLoader.loadPlugins()
|
|
||||||
this onLoad() routine is called one time for initialize the plugin
|
|
||||||
|
|
||||||
@requires: nothing
|
|
||||||
|
|
||||||
@return: nothing
|
|
||||||
"""
|
|
||||||
# local variables
|
|
||||||
global application
|
|
||||||
global APIKey
|
|
||||||
global usecsv
|
|
||||||
|
|
||||||
# load config:
|
|
||||||
configHandler.checkConfig("notifyMyAndroid")
|
|
||||||
application = stringConverter.convertToUnicode(globalVars.config.get("notifyMyAndroid","appName"))
|
|
||||||
usecsv = globalVars.config.getboolean("notifyMyAndroid","usecsv")
|
|
||||||
|
|
||||||
# if no csv should use, we take the APIKey directly
|
|
||||||
if usecsv == False:
|
|
||||||
APIKey = globalVars.config.get("notifyMyAndroid","APIKey")
|
|
||||||
else:
|
|
||||||
# import the csv-file
|
|
||||||
try:
|
|
||||||
logging.debug("-- loading nma.csv")
|
|
||||||
with open(globalVars.script_path+'/csv/nma.csv') as csvfile:
|
|
||||||
# DictReader expected structure described in first line of csv-file
|
|
||||||
reader = csv.DictReader(csvfile)
|
|
||||||
for row in reader:
|
|
||||||
logging.debug(row)
|
|
||||||
# only import rows with an supported types
|
|
||||||
supportedTypes = ["FMS", "ZVEI", "POC"]
|
|
||||||
if row['typ'] in supportedTypes:
|
|
||||||
try:
|
|
||||||
if "FMS" in row['typ']:
|
|
||||||
# if len for id in mainList raise an KeyErrorException, we have to init it...
|
|
||||||
try:
|
|
||||||
if len(fmsAPIKeyList[row['id']]) > 0:
|
|
||||||
pass
|
|
||||||
except KeyError:
|
|
||||||
fmsAPIKeyList[row['id']] = []
|
|
||||||
# data structure: fmsAPIKeyList[fms][i] = (APIKey, priority)
|
|
||||||
fmsAPIKeyList[row['id']].append((row['APIKey'], row['priority'], row['eventPrefix']))
|
|
||||||
|
|
||||||
elif "ZVEI" in row['typ']:
|
|
||||||
# if len for id in mainList raise an KeyErrorException, we have to init it...
|
|
||||||
try:
|
|
||||||
if len(zveiAPIKeyList[row['id']]) > 0:
|
|
||||||
pass
|
|
||||||
except KeyError:
|
|
||||||
zveiAPIKeyList[row['id']] = []
|
|
||||||
# data structure: zveiAPIKeyList[zvei][i] = (APIKey, priority)
|
|
||||||
zveiAPIKeyList[row['id']].append((row['APIKey'], row['priority'], row['eventPrefix']))
|
|
||||||
|
|
||||||
elif "POC" in row['typ']:
|
|
||||||
# if len for id in mainList raise an KeyErrorException, we have to init it...
|
|
||||||
try:
|
|
||||||
if len(pocAPIKeyList[row['id']]) > 0:
|
|
||||||
pass
|
|
||||||
except KeyError:
|
|
||||||
pocAPIKeyList[row['id']] = []
|
|
||||||
# data structure: zveiAPIKeyList[ric][i] = (APIKey, priority)
|
|
||||||
pocAPIKeyList[row['id']].append((row['APIKey'], row['priority'], row['eventPrefix']))
|
|
||||||
|
|
||||||
except:
|
|
||||||
# skip entry in case of an exception
|
|
||||||
logging.debug("error in shifting...", exc_info=True)
|
|
||||||
# if row['typ'] in supportedTypes
|
|
||||||
# for row in reader:
|
|
||||||
logging.debug("-- loading csv finished")
|
|
||||||
except:
|
|
||||||
logging.error("loading csvList for nma failed")
|
|
||||||
logging.debug("loading csvList for nma failed", exc_info=True)
|
|
||||||
raise
|
|
||||||
# and if usecsv == True
|
|
||||||
return
|
|
||||||
|
|
||||||
|
|
||||||
##
|
|
||||||
#
|
|
||||||
# Main function of jsonSocket-plugin
|
|
||||||
# will be called by the alarmHandler
|
|
||||||
#
|
|
||||||
def run(typ,freq,data):
|
|
||||||
"""
|
|
||||||
This function is the implementation of the notifyMyAndroid-Plugin.
|
|
||||||
|
|
||||||
The configuration is set in the config.ini.
|
|
||||||
|
|
||||||
@type typ: string (FMS|ZVEI|POC)
|
|
||||||
@param typ: Typ of the dataset for sending via UDP/TCP
|
|
||||||
@type data: map of data (structure see readme.md in plugin folder)
|
|
||||||
@param data: Contains the parameter for dispatch to UDP.
|
|
||||||
@type freq: string
|
|
||||||
@keyword freq: frequency of the SDR Stick
|
|
||||||
|
|
||||||
@requires: notifyMyAndroid-Configuration has to be set in the config.ini
|
|
||||||
|
|
||||||
@return: nothing
|
|
||||||
"""
|
|
||||||
# local variables
|
|
||||||
|
|
||||||
try:
|
|
||||||
try:
|
|
||||||
#
|
|
||||||
# initialize to pyNMA
|
|
||||||
#
|
|
||||||
nma = pynma.PyNMA()
|
|
||||||
except:
|
|
||||||
logging.error("cannot initialize pyNMA")
|
|
||||||
logging.debug("cannot initialize pyNMA", exc_info=True)
|
|
||||||
# Without class, plugin couldn't work
|
|
||||||
return
|
|
||||||
|
|
||||||
else:
|
|
||||||
# toDo is equals for all types, so only check if typ is supported
|
|
||||||
supportedTypes = ["FMS", "ZVEI", "POC"]
|
|
||||||
if typ in supportedTypes:
|
|
||||||
logging.debug("Start %s to NMA", typ)
|
|
||||||
try:
|
|
||||||
# build event and msg
|
|
||||||
# pyNMA expect strings are not in UTF-8
|
|
||||||
event = stringConverter.convertToUnicode(data['description'])
|
|
||||||
msg = timeHandler.getDateTime(data['timestamp'])
|
|
||||||
if ("POC" in typ) and (len(data['msg']) > 0):
|
|
||||||
msg += "\n" + data['msg']
|
|
||||||
msg = stringConverter.convertToUnicode(msg)
|
|
||||||
|
|
||||||
# if not using csv-import, all is simple...
|
|
||||||
if usecsv == False:
|
|
||||||
response = nma.pushWithAPIKey(APIKey, application, event, msg, priority=globalVars.config.getint("notifyMyAndroid","priority"))
|
|
||||||
checkResponse(response, APIKey)
|
|
||||||
else:
|
|
||||||
if "FMS" in typ:
|
|
||||||
# lets look for fms in fmsAPIKeyList
|
|
||||||
xID = data['fms']
|
|
||||||
try:
|
|
||||||
# data structure: fmsAPIKeyList[xID][i] = (xAPIKey, xPriority, xEventPrefix)
|
|
||||||
for i in range(len(fmsAPIKeyList[xID])):
|
|
||||||
xEvent = event
|
|
||||||
(xAPIKey, xPriority, xEventPrefix) = fmsAPIKeyList[xID][i]
|
|
||||||
if len(xEventPrefix) > 0:
|
|
||||||
xEvent = xEventPrefix + ": " + xEvent
|
|
||||||
response = nma.pushWithAPIKey(xAPIKey, application, xEvent, msg, priority=xPriority)
|
|
||||||
checkResponse(response, xAPIKey)
|
|
||||||
except KeyError:
|
|
||||||
# nothing found
|
|
||||||
pass
|
|
||||||
|
|
||||||
elif "ZVEI" in typ:
|
|
||||||
# lets look for zvei in zveiAPIKeyList
|
|
||||||
xID = data['zvei']
|
|
||||||
try:
|
|
||||||
# data structure: zveiAPIKeyList[xID][i] = (xAPIKey, xPriority, xEventPrefix)
|
|
||||||
for i in range(len(zveiAPIKeyList[xID])):
|
|
||||||
xEvent = event
|
|
||||||
(xAPIKey, xPriority, xEventPrefix) = zveiAPIKeyList[xID][i]
|
|
||||||
if len(xEventPrefix) > 0:
|
|
||||||
xEvent = xEventPrefix + ": " + xEvent
|
|
||||||
response = nma.pushWithAPIKey(xAPIKey, application, xEvent, msg, priority=xPriority)
|
|
||||||
checkResponse(response, xAPIKey)
|
|
||||||
except KeyError:
|
|
||||||
# nothing found
|
|
||||||
pass
|
|
||||||
|
|
||||||
elif "POC" in typ:
|
|
||||||
xID = ""
|
|
||||||
# 1. lets look for ric+functionChar in pocAPIKeyList
|
|
||||||
try:
|
|
||||||
xID = data['ric'] + data['functionChar']
|
|
||||||
# data structure: pocAPIKeyList[xID][i] = (xAPIKey, xPriority, xEventPrefix)
|
|
||||||
for i in range(len(pocAPIKeyList[xID])):
|
|
||||||
xEvent = event
|
|
||||||
(xAPIKey, xPriority, xEventPrefix) = pocAPIKeyList[xID][i]
|
|
||||||
if len(xEventPrefix) > 0:
|
|
||||||
xEvent = xEventPrefix + ": " + xEvent
|
|
||||||
response = nma.pushWithAPIKey(xAPIKey, application, xEvent, msg, priority=xPriority)
|
|
||||||
checkResponse(response, xAPIKey)
|
|
||||||
except KeyError:
|
|
||||||
# nothing found
|
|
||||||
pass
|
|
||||||
# 2. lets look for ric* in pocAPIKeyList
|
|
||||||
try:
|
|
||||||
xID = data['ric'] + "*"
|
|
||||||
# data structure: pocAPIKeyList[xID][i] = (xAPIKey, xPriority, xEventPrefix)
|
|
||||||
for i in range(len(pocAPIKeyList[xID])):
|
|
||||||
xEvent = event
|
|
||||||
(xAPIKey, xPriority, xEventPrefix) = pocAPIKeyList[xID][i]
|
|
||||||
if len(xEventPrefix) > 0:
|
|
||||||
xEvent = xEventPrefix + ": " + xEvent
|
|
||||||
response = nma.pushWithAPIKey(xAPIKey, application, xEvent, msg, priority=xPriority)
|
|
||||||
checkResponse(response, xAPIKey)
|
|
||||||
except KeyError:
|
|
||||||
# nothing found
|
|
||||||
pass
|
|
||||||
# 3. lets look for ric prefixes in pocAPIKeyList
|
|
||||||
for prefixLength in reversed(range(6)):
|
|
||||||
ricPrefix = data['ric'][:prefixLength]
|
|
||||||
#fill the ric with stars
|
|
||||||
ricPrefix = ricPrefix.ljust(8,'*')
|
|
||||||
try:
|
|
||||||
xID = ricPrefix
|
|
||||||
# data structure: pocAPIKeyList[xID][i] = (xAPIKey, xPriority, xEventPrefix)
|
|
||||||
for i in range(len(pocAPIKeyList[xID])):
|
|
||||||
xEvent = event
|
|
||||||
(xAPIKey, xPriority, xEventPrefix) = pocAPIKeyList[xID][i]
|
|
||||||
if len(xEventPrefix) > 0:
|
|
||||||
xEvent = xEventPrefix + ": " + xEvent
|
|
||||||
response = nma.pushWithAPIKey(xAPIKey, application, xEvent, msg, priority=xPriority)
|
|
||||||
checkResponse(response, xAPIKey)
|
|
||||||
except KeyError:
|
|
||||||
# nothing found
|
|
||||||
pass
|
|
||||||
|
|
||||||
# end if "POC" in typ
|
|
||||||
# end if usecsv == True
|
|
||||||
except:
|
|
||||||
logging.error("%s to NMA failed", typ)
|
|
||||||
logging.debug("%s to NMA failed", typ, exc_info=True)
|
|
||||||
return
|
|
||||||
else:
|
|
||||||
logging.warning("Invalid Typ: %s", typ)
|
|
||||||
|
|
||||||
except:
|
|
||||||
# something very mysterious
|
|
||||||
logging.error("unknown error")
|
|
||||||
logging.debug("unknown error", exc_info=True)
|
|
||||||
Loading…
Reference in a new issue