mirror of
https://github.com/Schrolli91/BOSWatch.git
synced 2025-12-31 22:00:37 +01:00
8cdfef4bce
Using only SMTP via SSL can lead to errors depending on the configuration of the mail server As there is no switch in the config file (which is good so) the approach is to use SSL first and, if this fails, switch to non-SSL connection. Due to the importance of this plugin the pull request is affecting the master-branch.
203 lines
6 KiB
Python
203 lines
6 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: UTF-8 -*-
|
|
|
|
"""
|
|
eMail-Plugin to dispatch FMS-, ZVEI- and POCSAG - messages via eMail/SMTP
|
|
|
|
@author: Jens Herrmann
|
|
|
|
@requires: eMail-Configuration has to be set in the config.ini
|
|
"""
|
|
|
|
import logging # Global logger
|
|
|
|
import smtplib #for the SMTP client
|
|
from email.mime.text import MIMEText # Import the email modules we'll need
|
|
from email.utils import formatdate # need for confirm to RFC2822 standard
|
|
from email.utils import make_msgid # need for confirm to RFC2822 standard
|
|
|
|
from includes import globalVars # Global variables
|
|
|
|
from includes.helper import timeHandler # helper function
|
|
from includes.helper import configHandler # helper function
|
|
from includes.helper import wildcardHandler # helper function
|
|
|
|
##
|
|
#
|
|
# 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
|
|
"""
|
|
# nothing to do for this plugin
|
|
return
|
|
|
|
##
|
|
#
|
|
# do send mail
|
|
#
|
|
def doSendmail(server, subject, mailtext):
|
|
"""
|
|
This local function send the eMail
|
|
|
|
@type server: SMTP
|
|
@param server: An SMTP-Object that represents an open connection to an eMail-Server
|
|
@type subject: string
|
|
@param subject: Subject for the eMail
|
|
@type mailtext: string
|
|
@param mailtext: Mailtext for the eMail
|
|
|
|
@return: nothing
|
|
@exception: Exception if smtp.sendmail failed
|
|
"""
|
|
try:
|
|
msg = MIMEText(mailtext, 'plain', 'UTF-8')
|
|
msg['From'] = globalVars.config.get("eMail", "from")
|
|
msg['To'] = globalVars.config.get("eMail", "to")
|
|
msg['Subject'] = subject
|
|
msg['Date'] = formatdate()
|
|
msg['Message-Id'] = make_msgid()
|
|
msg['Priority'] = globalVars.config.get("eMail", "priority")
|
|
server.sendmail(globalVars.config.get("eMail", "from"), globalVars.config.get("eMail", "to").split(), msg.as_string())
|
|
except:
|
|
logging.error("send eMail failed")
|
|
logging.debug("send eMail failed", exc_info=True)
|
|
raise
|
|
|
|
|
|
##
|
|
#
|
|
# Main function of eMail-plugin
|
|
# will be called by the alarmHandler
|
|
#
|
|
def run(typ,freq,data):
|
|
"""
|
|
This function is the implementation of the eMail-Plugin.
|
|
It will send the data via eMail (SMTP)
|
|
|
|
The configuration for the eMail-Connection is set in the config.ini.
|
|
If an user is set, the HTTP-Request is authenticatet.
|
|
|
|
@type typ: string (FMS|ZVEI|POC)
|
|
@param typ: Typ of the dataset for sending via eMail
|
|
@type data: map of data (structure see readme.md in plugin folder)
|
|
@param data: Contains the parameter for dispatch to eMail.
|
|
@type freq: string
|
|
@keyword freq: frequency of the SDR Stick
|
|
|
|
@requires: eMail-Configuration has to be set in the config.ini
|
|
|
|
@return: nothing
|
|
"""
|
|
try:
|
|
if configHandler.checkConfig("eMail"): #read and debug the config
|
|
|
|
try:
|
|
#
|
|
# connect to SMTP-Server
|
|
#
|
|
try:
|
|
server = smtplib.SMTP_SSL(globalVars.config.get("eMail", "smtp_server"), globalVars.config.get("eMail", "smtp_port"))
|
|
except:
|
|
server = smtplib.SMTP(globalVars.config.get("eMail", "smtp_server"), globalVars.config.get("eMail", "smtp_port"))
|
|
# debug-level to shell (0=no debug|1)
|
|
server.set_debuglevel(0)
|
|
|
|
# if tls is enabled, starttls
|
|
if globalVars.config.get("eMail", "tls"):
|
|
server.starttls()
|
|
|
|
# if user is given, login
|
|
if globalVars.config.get("eMail", "user"):
|
|
server.login(globalVars.config.get("eMail", "user"), globalVars.config.get("eMail", "password"))
|
|
|
|
except:
|
|
logging.error("cannot connect to eMail")
|
|
logging.debug("cannot connect to eMail", exc_info=True)
|
|
# Without connection, plugin couldn't work
|
|
return
|
|
|
|
else:
|
|
|
|
if typ == "FMS":
|
|
logging.debug("Start FMS to eMail")
|
|
try:
|
|
# read subject-structure from config.ini
|
|
subject = globalVars.config.get("eMail", "fms_subject")
|
|
# replace wildcards with helper function
|
|
subject = wildcardHandler.replaceWildcards(subject, data)
|
|
|
|
# read mailtext-structure from config.ini
|
|
mailtext = globalVars.config.get("eMail", "fms_message")
|
|
# replace wildcards with helper function
|
|
mailtext = wildcardHandler.replaceWildcards(mailtext, data, lineBrakeAllowed=True)
|
|
|
|
# send eMail
|
|
doSendmail(server, subject, mailtext)
|
|
except:
|
|
logging.error("%s to eMail failed", typ)
|
|
logging.debug("%s to eMail failed", typ, exc_info=True)
|
|
return
|
|
|
|
elif typ == "ZVEI":
|
|
logging.debug("Start ZVEI to eMail")
|
|
try:
|
|
# read subject-structure from config.ini
|
|
subject = globalVars.config.get("eMail", "zvei_subject")
|
|
# replace wildcards with helper function
|
|
subject = wildcardHandler.replaceWildcards(subject, data)
|
|
|
|
# read mailtext-structure from config.ini
|
|
mailtext = globalVars.config.get("eMail", "zvei_message")
|
|
# replace wildcards with helper function
|
|
mailtext = wildcardHandler.replaceWildcards(mailtext, data, lineBrakeAllowed=True)
|
|
|
|
# send eMail
|
|
doSendmail(server, subject, mailtext)
|
|
except:
|
|
logging.error("%s to eMail failed", typ)
|
|
logging.debug("%s to eMail failed", typ, exc_info=True)
|
|
return
|
|
|
|
elif typ == "POC":
|
|
logging.debug("Start POC to eMail")
|
|
try:
|
|
# read subject-structure from config.ini
|
|
subject = globalVars.config.get("eMail", "poc_subject")
|
|
# replace wildcards with helper function
|
|
subject = wildcardHandler.replaceWildcards(subject, data)
|
|
|
|
# read mailtext-structure from config.ini
|
|
mailtext = globalVars.config.get("eMail", "poc_message")
|
|
# replace wildcards with helper function
|
|
mailtext = wildcardHandler.replaceWildcards(mailtext, data, lineBrakeAllowed=True)
|
|
|
|
# send eMail
|
|
doSendmail(server, subject, mailtext)
|
|
except:
|
|
logging.error("%s to eMail failed", typ)
|
|
logging.debug("%s to eMail failed", typ, exc_info=True)
|
|
return
|
|
|
|
else:
|
|
logging.warning("Invalid Typ: %s", typ)
|
|
|
|
finally:
|
|
logging.debug("close eMail-Connection")
|
|
try:
|
|
server.quit()
|
|
except:
|
|
pass
|
|
|
|
except:
|
|
# something very mysterious
|
|
logging.error("unknown error")
|
|
logging.debug("unknown error", exc_info=True)
|