new functionality: lookUp description in a given csv-file for FMS, ZVEI and POC

you have the possibility to set a discription for every FMS, ZWEI oder RIC address
descriptions will be imported via csv-files
if enabled BOSWatch will look up the description and could be used in the plugins

eMail-plugin extended wildcards to use describtion %DESC%

includes/descriptionList.py

@@ -0,0 +1,102 @@
+#!/usr/bin/python
+# -*- coding: cp1252 -*-
+
+"""
+Function to expand the dataset with a description.
+
+@author: Jens Herrmann
+
+@requires: Configuration has to be set in the config.ini
+"""
+
+import logging # Global logger
+
+import csv
+
+from includes import globals  # Global variables
+
+##
+#
+# Local function will load the csv-file
+#
+def loadCSV(typ, idField):
+	"""
+	Local function for loading csv-file into python list
+	Structure: [id] = description
+
+	@return:    Python list of descriptions
+	@exception: Exception if loading failed
+	"""
+	resultList = {}
+	try:
+		logging.debug("-- loading %s.csv", typ)
+		with open(globals.script_path+'/csv/'+typ+'.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 integer as id
+				if row[idField].isdigit() == True:
+					resultList[row[idField]] = row['description']
+		logging.debug("-- loading csv finished")
+	except:
+		logging.exception("loading csvList for typ: %s failed", typ)
+	return resultList;
+
+##
+#
+# call this for loading the description lists
+#
+def loadDescriptionLists():
+	"""
+	Load data from the csv-files in global description list for FMS, ZVEI and POCSAG
+
+	@return:    nothing
+	@exception: Exception if loading failed
+	"""
+	try:
+		logging.debug("loading description lists")
+
+		if globals.config.getint("FMS", "idDescribed"):
+			logging.debug("- load FMS description list")
+			globals.fmsDescribtionList = loadCSV("fms", "fms")
+ 
+		if globals.config.getint("ZVEI", "idDescribed"):
+			logging.debug("- load ZVEI description list")
+			globals.zveiDescribtionList = loadCSV("zvei", "zvei")
+
+		if globals.config.getint("POC", "idDescribed"):
+			logging.debug("- load pocsag description list")
+			globals.ricDescribtionList = loadCSV("poc", "ric")
+	
+	except:
+		logging.exception("cannot load description lists")
+
+		
+##
+#
+# public function for getting a description
+#		
+def getDescription(typ, id):
+	"""
+	Get description for id.
+	Will return id if no description will be found.
+
+	@return:    description as string
+	"""
+	resultStr = id;
+	logging.debug("look up description lists")
+	try:
+		if typ == "FMS":
+			resultStr = globals.fmsDescribtionList[id]
+		elif typ == "ZVEI":
+			resultStr = globals.zveiDescribtionList[id]
+		elif typ == "POC":
+			resultStr = globals.ricDescribtionList[id]
+		else:
+			logging.warning("Invalid Typ: %s", typ)	
+	except KeyError:
+		# will be thrown when there is no description for the id
+		# -> nothing to do...
+		pass
+	return resultStr