split publishers

pialert/helper.py

@@ -157,12 +157,6 @@ def collect_lang_strings(db, json, pref):
             import_language_string(db, language_string["language_code"], pref + "_" + prop, language_string["string"])
 
 
-
-
-
-
-     
-
 #-------------------------------------------------------------------------------
 #  Creates a JSON object from a DB row
 def row_to_json(names, row):
@@ -320,3 +314,10 @@ def write_file (pPath, pText):
             pText = ""
         file.write (pText)
         file.close()
+
+#-------------------------------------------------------------------------------
+class noti_struc:
+    def __init__(self, json, text, html):
+        self.json = json
+        self.text = text
+        self.html = html        

pialert/mqtt.py

@@ -1,244 +0,0 @@
-
-import time
-import re
-from paho.mqtt import client as mqtt_client
-
-import conf
-from logger import mylog
-from database import get_all_devices, get_device_stats
-from helper import bytes_to_string, sanitize_string
-
-
-
-#-------------------------------------------------------------------------------
-# MQTT
-#-------------------------------------------------------------------------------
-
-mqtt_connected_to_broker = False
-mqtt_sensors = []
-
-#-------------------------------------------------------------------------------
-class sensor_config:
-    def __init__(self, deviceId, deviceName, sensorType, sensorName, icon):
-        self.deviceId = deviceId
-        self.deviceName = deviceName
-        self.sensorType = sensorType
-        self.sensorName = sensorName
-        self.icon = icon 
-        self.hash = str(hash(str(deviceId) + str(deviceName)+ str(sensorType)+ str(sensorName)+ str(icon)))
-
-#-------------------------------------------------------------------------------
-
-def publish_mqtt(client, topic, message):
-    status = 1
-    while status != 0:
-        result = client.publish(
-                topic=topic,
-                payload=message,
-                qos=conf.MQTT_QOS,
-                retain=True,
-            )
-
-        status = result[0]
-
-        if status != 0:            
-            mylog('info', ["Waiting to reconnect to MQTT broker"])
-            time.sleep(0.1) 
-    return True
-
-#-------------------------------------------------------------------------------
-def create_generic_device(client):  
-    
-    deviceName = 'PiAlert'
-    deviceId = 'pialert'    
-    
-    create_sensor(client, deviceId, deviceName, 'sensor', 'online', 'wifi-check')    
-    create_sensor(client, deviceId, deviceName, 'sensor', 'down', 'wifi-cancel')        
-    create_sensor(client, deviceId, deviceName, 'sensor', 'all', 'wifi')
-    create_sensor(client, deviceId, deviceName, 'sensor', 'archived', 'wifi-lock')
-    create_sensor(client, deviceId, deviceName, 'sensor', 'new', 'wifi-plus')
-    create_sensor(client, deviceId, deviceName, 'sensor', 'unknown', 'wifi-alert')
-        
-
-#-------------------------------------------------------------------------------
-def create_sensor(client, deviceId, deviceName, sensorType, sensorName, icon):    
-
-    new_sensor_config = sensor_config(deviceId, deviceName, sensorType, sensorName, icon)
-
-    # check if config already in list and if not, add it, otherwise skip
-    global mqtt_sensors, uniqueSensorCount
-
-    is_unique = True
-
-    for sensor in mqtt_sensors:
-        if sensor.hash == new_sensor_config.hash:
-            is_unique = False
-            break
-           
-    # save if unique
-    if is_unique:             
-        publish_sensor(client, new_sensor_config)        
-
-
-
-
-#-------------------------------------------------------------------------------
-def publish_sensor(client, sensorConf): 
-
-    global mqtt_sensors             
-
-    message = '{ \
-                "name":"'+ sensorConf.deviceName +' '+sensorConf.sensorName+'", \
-                "state_topic":"system-sensors/'+sensorConf.sensorType+'/'+sensorConf.deviceId+'/state", \
-                "value_template":"{{value_json.'+sensorConf.sensorName+'}}", \
-                "unique_id":"'+sensorConf.deviceId+'_sensor_'+sensorConf.sensorName+'", \
-                "device": \
-                    { \
-                        "identifiers": ["'+sensorConf.deviceId+'_sensor"], \
-                        "manufacturer": "PiAlert", \
-                        "name":"'+sensorConf.deviceName+'" \
-                    }, \
-                "icon":"mdi:'+sensorConf.icon+'" \
-                }'
-
-    topic='homeassistant/'+sensorConf.sensorType+'/'+sensorConf.deviceId+'/'+sensorConf.sensorName+'/config'
-
-    # add the sensor to the global list to keep track of succesfully added sensors
-    if publish_mqtt(client, topic, message):        
-                                     # hack - delay adding to the queue in case the process is 
-        time.sleep(conf.MQTT_DELAY_SEC)   # restarted and previous publish processes aborted 
-                                     # (it takes ~2s to update a sensor config on the broker)
-        mqtt_sensors.append(sensorConf)
-
-#-------------------------------------------------------------------------------
-def mqtt_create_client():
-    def on_disconnect(client, userdata, rc):
-        global mqtt_connected_to_broker
-        mqtt_connected_to_broker = False
-        
-        # not sure is below line is correct / necessary        
-        # client = mqtt_create_client() 
-
-    def on_connect(client, userdata, flags, rc):
-        global mqtt_connected_to_broker
-        
-        if rc == 0: 
-            mylog('verbose', ["        Connected to broker"])            
-            mqtt_connected_to_broker = True     # Signal connection 
-        else: 
-            mylog('none', ["        Connection failed"])
-            mqtt_connected_to_broker = False
-
-
-    client = mqtt_client.Client('PiAlert')   # Set Connecting Client ID    
-    client.username_pw_set(conf.MQTT_USER, conf.MQTT_PASSWORD)    
-    client.on_connect = on_connect
-    client.on_disconnect = on_disconnect
-    client.connect(conf.MQTT_BROKER, conf.MQTT_PORT)
-    client.loop_start() 
-
-    return client
-
-#-------------------------------------------------------------------------------
-def mqtt_start():    
-
-    global client, mqtt_connected_to_broker
-
-    if mqtt_connected_to_broker == False:
-        mqtt_connected_to_broker = True           
-        client = mqtt_create_client() 
-    
-    # General stats    
-
-    # Create a generic device for overal stats
-    create_generic_device(client)
-
-    # Get the data
-    row = get_device_stats()   
-
-    columns = ["online","down","all","archived","new","unknown"]
-
-    payload = ""
-
-    # Update the values 
-    for column in columns:       
-        payload += '"'+column+'": ' + str(row[column]) +','       
-
-    # Publish (warap into {} and remove last ',' from above)
-    publish_mqtt(client, "system-sensors/sensor/pialert/state",              
-            '{ \
-                '+ payload[:-1] +'\
-            }'
-        )
-
-
-    # Specific devices
-
-    # Get all devices
-    devices = get_all_devices()
-
-    sec_delay = len(devices) * int(conf.MQTT_DELAY_SEC)*5
-
-    mylog('info', ["        Estimated delay: ", (sec_delay), 's ', '(', round(sec_delay/60,1) , 'min)' ])
-
-    for device in devices:        
-
-        # Create devices in Home Assistant - send config messages
-        deviceId = 'mac_' + device["dev_MAC"].replace(" ", "").replace(":", "_").lower()
-        deviceNameDisplay = re.sub('[^a-zA-Z0-9-_\s]', '', device["dev_Name"]) 
-
-        create_sensor(client, deviceId, deviceNameDisplay, 'sensor', 'last_ip', 'ip-network')
-        create_sensor(client, deviceId, deviceNameDisplay, 'binary_sensor', 'is_present', 'wifi')
-        create_sensor(client, deviceId, deviceNameDisplay, 'sensor', 'mac_address', 'folder-key-network')
-        create_sensor(client, deviceId, deviceNameDisplay, 'sensor', 'is_new', 'bell-alert-outline')
-        create_sensor(client, deviceId, deviceNameDisplay, 'sensor', 'vendor', 'cog')
-    
-        # update device sensors in home assistant              
-
-        publish_mqtt(client, 'system-sensors/sensor/'+deviceId+'/state', 
-            '{ \
-                "last_ip": "' + device["dev_LastIP"] +'", \
-                "is_new": "' + str(device["dev_NewDevice"]) +'", \
-                "vendor": "' + sanitize_string(device["dev_Vendor"]) +'", \
-                "mac_address": "' + str(device["dev_MAC"]) +'" \
-            }'
-        ) 
-
-        publish_mqtt(client, 'system-sensors/binary_sensor/'+deviceId+'/state', 
-            '{ \
-                "is_present": "' + to_binary_sensor(str(device["dev_PresentLastScan"])) +'"\
-            }'
-        ) 
-
-        # delete device / topic
-        #  homeassistant/sensor/mac_44_ef_bf_c4_b1_af/is_present/config
-        # client.publish(
-        #     topic="homeassistant/sensor/"+deviceId+"/is_present/config",
-        #     payload="",
-        #     qos=1,
-        #     retain=True,
-        # )        
-    # time.sleep(10)
-
-
-#===============================================================================
-# Home Assistant UTILs
-#===============================================================================
-def to_binary_sensor(input):
-    # In HA a binary sensor returns ON or OFF    
-    result = "OFF"
-
-    # bytestring
-    if isinstance(input, str):
-        if input == "1":
-            result = "ON"
-    elif isinstance(input, int):
-        if input == 1:
-            result = "ON"
-    elif isinstance(input, bool):
-        if input == True:
-            result = "ON"
-    elif isinstance(input, bytes):
-        if bytes_to_string(input) == "1":
-            result = "ON"
-    return result

pialert/publishers/__init__.py

@@ -0,0 +1,8 @@
+""" Publishers for Pi.Alert """
+
+"""
+each publisher exposes:
+
+- check_config () returning True / False
+- send (message) returning True / Fasle 
+"""

pialert/publishers/apprise.py

@@ -0,0 +1,42 @@
+
+import json
+import subprocess
+import conf
+from helper import noti_struc
+from logger import logResult, mylog
+
+#-------------------------------------------------------------------------------
+def check_config():
+        if conf.APPRISE_URL == '' or conf.APPRISE_HOST == '':
+            mylog('none', ['[Check Config] Error: Apprise service not set up correctly. Check your pialert.conf APPRISE_* variables.'])
+            return False
+        else:
+            return True
+
+#-------------------------------------------------------------------------------
+def send (msg: noti_struc):
+    html = msg.html
+    text = msg.text
+
+    #Define Apprise compatible payload (https://github.com/caronc/apprise-api#stateless-solution)
+    payload = html
+
+    if conf.APPRISE_PAYLOAD == 'text':
+        payload = text
+
+    _json_payload={
+    "urls": conf.APPRISE_URL,
+    "title": "Pi.Alert Notifications",
+    "format": conf.APPRISE_PAYLOAD,
+    "body": payload
+    }
+
+    try:
+        # try runnning a subprocess
+        p = subprocess.Popen(["curl","-i","-X", "POST" ,"-H", "Content-Type:application/json" ,"-d", json.dumps(_json_payload), conf.APPRISE_HOST], stdout=subprocess.PIPE, stderr=subprocess.STDOUT)
+        stdout, stderr = p.communicate()
+        # write stdout and stderr into .log files for debugging if needed
+        logResult (stdout, stderr)      # TO-DO should be changed to mylog
+    except subprocess.CalledProcessError as e:
+        # An error occured, handle it
+        mylog('none', [e.output])

pialert/publishers/email.py

@@ -0,0 +1,88 @@
+from email.mime.multipart import MIMEMultipart
+from email.mime.text import MIMEText
+import smtplib
+
+
+import conf
+from helper import hide_email, noti_struc
+from logger import mylog, print_log
+
+#-------------------------------------------------------------------------------
+def check_config ():
+    if conf.SMTP_SERVER == '' or conf.REPORT_FROM == '' or conf.REPORT_TO == '':
+        mylog('none', ['[Email Check Config] Error: Email service not set up correctly. Check your pialert.conf SMTP_*, REPORT_FROM and REPORT_TO variables.'])
+        return False
+    else:
+        return True
+    
+#-------------------------------------------------------------------------------
+def send (msg: noti_struc):
+
+    pText = msg.text
+    pHTML = msg.html
+    
+    mylog('debug', '[Send Email] REPORT_TO: ' + hide_email(str(conf.REPORT_TO)) + '  SMTP_USER: ' + hide_email(str(conf.SMTP_USER)))
+
+    # Compose email
+    msg = MIMEMultipart('alternative')
+    msg['Subject'] = 'Pi.Alert Report'
+    msg['From'] = conf.REPORT_FROM
+    msg['To'] = conf.REPORT_TO
+    msg.attach (MIMEText (pText, 'plain'))
+    msg.attach (MIMEText (pHTML, 'html'))
+
+    failedAt = ''
+
+    failedAt = print_log ('SMTP try')
+
+    try:
+        # Send mail
+        failedAt = print_log('Trying to open connection to ' + str(conf.SMTP_SERVER) + ':' + str(conf.SMTP_PORT))
+
+        if conf.SMTP_FORCE_SSL:
+            failedAt = print_log('SMTP_FORCE_SSL == True so using .SMTP_SSL()')
+            if conf.SMTP_PORT == 0:
+                failedAt = print_log('SMTP_PORT == 0 so sending .SMTP_SSL(SMTP_SERVER)')
+                smtp_connection = smtplib.SMTP_SSL(conf.SMTP_SERVER)
+            else:
+                failedAt = print_log('SMTP_PORT == 0 so sending .SMTP_SSL(SMTP_SERVER, SMTP_PORT)')
+                smtp_connection = smtplib.SMTP_SSL(conf.SMTP_SERVER, conf.SMTP_PORT)
+
+        else:
+            failedAt = print_log('SMTP_FORCE_SSL == False so using .SMTP()')
+            if conf.SMTP_PORT == 0:
+                failedAt = print_log('SMTP_PORT == 0 so sending .SMTP(SMTP_SERVER)')
+                smtp_connection = smtplib.SMTP (conf.SMTP_SERVER)
+            else:
+                failedAt = print_log('SMTP_PORT == 0 so sending .SMTP(SMTP_SERVER, SMTP_PORT)')
+                smtp_connection = smtplib.SMTP (conf.SMTP_SERVER, conf.SMTP_PORT)
+
+        failedAt = print_log('Setting SMTP debug level')
+
+        # Log level set to debug of the communication between SMTP server and client
+        if conf.LOG_LEVEL == 'debug':
+            smtp_connection.set_debuglevel(1)
+
+        failedAt = print_log( 'Sending .ehlo()')
+        smtp_connection.ehlo()
+
+        if not conf.SMTP_SKIP_TLS:
+            failedAt = print_log('SMTP_SKIP_TLS == False so sending .starttls()')
+            smtp_connection.starttls()
+            failedAt = print_log('SMTP_SKIP_TLS == False so sending .ehlo()')
+            smtp_connection.ehlo()
+        if not conf.SMTP_SKIP_LOGIN:
+            failedAt = print_log('SMTP_SKIP_LOGIN == False so sending .login()')
+            smtp_connection.login (conf.SMTP_USER, conf.SMTP_PASS)
+
+        failedAt = print_log('Sending .sendmail()')
+        smtp_connection.sendmail (conf.REPORT_FROM, conf.REPORT_TO, msg.as_string())
+        smtp_connection.quit()
+    except smtplib.SMTPAuthenticationError as e:
+        mylog('none', ['      ERROR: Failed at - ', failedAt])
+        mylog('none', ['      ERROR: Couldn\'t connect to the SMTP server (SMTPAuthenticationError), skipping Email (enable LOG_LEVEL=debug for more logging)'])
+    except smtplib.SMTPServerDisconnected as e:
+        mylog('none', ['      ERROR: Failed at - ', failedAt])
+        mylog('none', ['      ERROR: Couldn\'t connect to the SMTP server (SMTPServerDisconnected), skipping Email (enable LOG_LEVEL=debug for more logging)'])
+
+    mylog('debug', '[Send Email] Last executed - ' + str(failedAt))

pialert/publishers/ntfy.py

@@ -0,0 +1,36 @@
+
+import conf
+import requests
+from base64 import b64encode
+
+from logger import mylog, noti_struc
+
+#-------------------------------------------------------------------------------
+def check_config():
+    if conf.NTFY_HOST == '' or conf.NTFY_TOPIC == '':
+        mylog('none', ['[Check Config] Error: NTFY service not set up correctly. Check your pialert.conf NTFY_* variables.'])
+        return False
+    else:
+        return True
+    
+#-------------------------------------------------------------------------------
+def send  (msg: noti_struc):
+    _Text = msg.html
+    headers = {
+        "Title": "Pi.Alert Notification",
+        "Actions": "view, Open Dashboard, "+ conf.REPORT_DASHBOARD_URL,
+        "Priority": "urgent",
+        "Tags": "warning"
+    }
+    # if username and password are set generate hash and update header
+    if conf.NTFY_USER != "" and conf.NTFY_PASSWORD != "":
+	# Generate hash for basic auth
+        # usernamepassword = "{}:{}".format(conf.NTFY_USER,conf.NTFY_PASSWORD)
+        basichash = b64encode(bytes(conf.NTFY_USER + ':' + conf.NTFY_PASSWORD, "utf-8")).decode("ascii")
+
+	# add authorization header with hash
+        headers["Authorization"] = "Basic {}".format(basichash)
+
+    requests.post("{}/{}".format( conf.NTFY_HOST, conf.NTFY_TOPIC),
+    data=_Text,
+    headers=headers)

pialert/publishers/pushsafer.py

@@ -0,0 +1,33 @@
+
+import requests
+
+
+import conf
+from helper import  noti_struc
+from logger import mylog
+
+#-------------------------------------------------------------------------------
+def check_config():
+        if conf.PUSHSAFER_TOKEN == 'ApiKey':
+            mylog('none', ['[Check Config] Error: Pushsafer service not set up correctly. Check your pialert.conf PUSHSAFER_TOKEN variable.'])
+            return False
+        else:
+            return True
+
+#-------------------------------------------------------------------------------
+def send ( msg:noti_struc ):
+    _Text = msg.text
+    url = 'https://www.pushsafer.com/api'
+    post_fields = {
+        "t" : 'Pi.Alert Message',
+        "m" : _Text,
+        "s" : 11,
+        "v" : 3,
+        "i" : 148,
+        "c" : '#ef7f7f',
+        "d" : 'a',
+        "u" : conf.REPORT_DASHBOARD_URL,
+        "ut" : 'Open Pi.Alert',
+        "k" : conf.PUSHSAFER_TOKEN,
+        }
+    requests.post(url, data=post_fields)

pialert/publishers/webhook.py

@@ -0,0 +1,98 @@
+import json
+import subprocess
+
+import conf
+from const import logPath
+from helper import noti_struc, write_file
+from logger import logResult, mylog
+
+#-------------------------------------------------------------------------------
+def check_config():
+        if conf.WEBHOOK_URL == '':
+            mylog('none', ['[Check Config] Error: Webhook service not set up correctly. Check your pialert.conf WEBHOOK_* variables.'])
+            return False
+        else:
+            return True
+        
+#-------------------------------------------------------------------------------        
+
+def send_webhook (msg: noti_struc):
+
+    # use data type based on specified payload type
+    if conf.WEBHOOK_PAYLOAD == 'json':
+        payloadData = msg.json
+    if conf.WEBHOOK_PAYLOAD == 'html':
+        payloadData = msg.html
+    if conf.WEBHOOK_PAYLOAD == 'text':
+        payloadData = to_text(msg.json)  # TO DO can we just send msg.text?
+
+    # Define slack-compatible payload
+    _json_payload = { "text": payloadData } if conf.WEBHOOK_PAYLOAD == 'text' else {
+    "username": "Pi.Alert",
+    "text": "There are new notifications",
+    "attachments": [{
+      "title": "Pi.Alert Notifications",
+      "title_link": conf.REPORT_DASHBOARD_URL,
+      "text": payloadData
+    }]
+    }
+
+    # DEBUG - Write the json payload into a log file for debugging
+    write_file (logPath + '/webhook_payload.json', json.dumps(_json_payload))
+
+    # Using the Slack-Compatible Webhook endpoint for Discord so that the same payload can be used for both
+    if(conf.WEBHOOK_URL.startswith('https://discord.com/api/webhooks/') and not conf.WEBHOOK_URL.endswith("/slack")):
+        _WEBHOOK_URL = f"{conf.WEBHOOK_URL}/slack"
+        curlParams = ["curl","-i","-H", "Content-Type:application/json" ,"-d", json.dumps(_json_payload), _WEBHOOK_URL]
+    else:
+        _WEBHOOK_URL = conf.WEBHOOK_URL
+        curlParams = ["curl","-i","-X", conf.WEBHOOK_REQUEST_METHOD ,"-H", "Content-Type:application/json" ,"-d", json.dumps(_json_payload), _WEBHOOK_URL]
+
+    # execute CURL call
+    try:
+        # try runnning a subprocess
+        mylog('debug', '[send_webhook] curlParams: '+  curlParams)
+        p = subprocess.Popen(curlParams, stdout=subprocess.PIPE, stderr=subprocess.STDOUT)
+
+        stdout, stderr = p.communicate()
+
+        # write stdout and stderr into .log files for debugging if needed
+        logResult (stdout, stderr)     # TO-DO should be changed to mylog
+    except subprocess.CalledProcessError as e:
+        # An error occured, handle it
+        mylog('none', ['[send_webhook]', e.output])
+
+
+
+
+
+#-------------------------------------------------------------------------------
+def to_text(_json):
+    payloadData = ""
+    if len(_json['internet']) > 0 and 'internet' in conf.INCLUDED_SECTIONS:
+        payloadData += "INTERNET\n"
+        for event in _json['internet']:
+            payloadData += event[3] + ' on ' + event[2] + '. ' + event[4] + '. New address:' + event[1] + '\n'
+
+    if len(_json['new_devices']) > 0 and 'new_devices' in conf.INCLUDED_SECTIONS:
+        payloadData += "NEW DEVICES:\n"
+        for event in _json['new_devices']:
+            if event[4] is None:
+                event[4] = event[11]
+            payloadData += event[1] + ' - ' + event[4] + '\n'
+
+    if len(_json['down_devices']) > 0 and 'down_devices' in conf.INCLUDED_SECTIONS:
+        write_file (logPath + '/down_devices_example.log', _json['down_devices'])
+        payloadData += 'DOWN DEVICES:\n'
+        for event in _json['down_devices']:
+            if event[4] is None:
+                event[4] = event[11]
+            payloadData += event[1] + ' - ' + event[4] + '\n'
+
+    if len(_json['events']) > 0 and 'events' in conf.INCLUDED_SECTIONS:
+        payloadData += "EVENTS:\n"
+        for event in _json['events']:
+            if event[8] != "Internet":
+                payloadData += event[8] + " on " + event[1] + " " + event[3] + " at " + event[2] + "\n"
+
+    return payloadData

pialert/reporting.py

@@ -1,11 +1,10 @@
-from email.mime.multipart import MIMEMultipart
+
-from email.mime.text import MIMEText
 
 import datetime
 import json
-import smtplib
+
 import socket
-from base64 import b64encode
+
 import subprocess
 import requests
 from json2table import convert
@@ -13,13 +12,22 @@ from json2table import convert
 # pialert modules
 import conf
 from const import pialertPath, logPath, apiPath
-from helper import generate_mac_links, removeDuplicateNewLines, timeNow, hide_email, json_struc, updateState, get_file_content, write_file
+from helper import noti_struc, generate_mac_links, removeDuplicateNewLines, timeNow, hide_email,  updateState, get_file_content, write_file
 from logger import logResult, mylog, print_log
-from mqtt import mqtt_start
-
-
 
 
+from publishers.email import (check_config as email_check_config, 
+                              send as send_email )
+from publishers.ntfy  import (check_config as ntfy_check_config,
+                              send as send_ntfy )
+from publishers.apprise import (check_config as apprise_check_config,
+                                send as send_apprise) 
+from publishers.webhook import (check_config as webhook_check_config,
+                                send as send_webhook) 
+from publishers.pushsafer import (check_config as pushsafer_check_config,
+                                send as send_pushsafer) 
+from publishers.mqtt import (check_config as mqtt_check_config,
+                             mqtt_start )
 #===============================================================================
 # REPORTING
 #===============================================================================
@@ -28,13 +36,6 @@ from mqtt import mqtt_start
 
 json_final = []
 
-#-------------------------------------------------------------------------------
-class noti_struc:
-    def __init__(self, json, text, html):
-        self.json = json
-        self.text = text
-        self.html = html
-
 
 #-------------------------------------------------------------------------------
 def construct_notifications(db, sqlQuery, tableTitle, skipText = False, suppliedJsonStruct = None):
@@ -86,7 +87,8 @@ def construct_notifications(db, sqlQuery, tableTitle, skipText = False, supplied
 
 
 
-def send_notifications (db):
+def send_notifications (db, INCLUDED_SECTIONS = conf.INCLUDED_SECTIONS):
+
     sql = db.sql  #TO-DO
     global mail_text, mail_html, json_final, changedPorts_json_struc, partial_html, partial_txt, partial_json
 
@@ -137,7 +139,7 @@ def send_notifications (db):
     mail_text = mail_text.replace ('<SERVER_NAME>', socket.gethostname() )
     mail_html = mail_html.replace ('<SERVER_NAME>', socket.gethostname() )
 
-    if 'internet' in conf.INCLUDED_SECTIONS:
+    if 'internet' in INCLUDED_SECTIONS:
         # Compose Internet Section
         sqlQuery = """SELECT eve_MAC as MAC,  eve_IP as IP, eve_DateTime as Datetime, eve_EventType as "Event Type", eve_AdditionalInfo as "More info" FROM Events
                         WHERE eve_PendingAlertEmail = 1 AND eve_MAC = 'Internet'
@@ -151,7 +153,7 @@ def send_notifications (db):
         mail_text = mail_text.replace ('<SECTION_INTERNET>', notiStruc.text + '\n')
         mail_html = mail_html.replace ('<INTERNET_TABLE>', notiStruc.html)
 
-    if 'new_devices' in conf.INCLUDED_SECTIONS:
+    if 'new_devices' in INCLUDED_SECTIONS:
         # Compose New Devices Section
         sqlQuery = """SELECT eve_MAC as MAC, eve_DateTime as Datetime, dev_LastIP as IP, eve_EventType as "Event Type", dev_Name as "Device name", dev_Comments as Comments  FROM Events_Devices
                         WHERE eve_PendingAlertEmail = 1
@@ -166,7 +168,7 @@ def send_notifications (db):
         mail_text = mail_text.replace ('<SECTION_NEW_DEVICES>', notiStruc.text + '\n')
         mail_html = mail_html.replace ('<NEW_DEVICES_TABLE>', notiStruc.html)
 
-    if 'down_devices' in conf.INCLUDED_SECTIONS:
+    if 'down_devices' in INCLUDED_SECTIONS:
         # Compose Devices Down Section
         sqlQuery = """SELECT eve_MAC as MAC, eve_DateTime as Datetime, dev_LastIP as IP, eve_EventType as "Event Type", dev_Name as "Device name", dev_Comments as Comments  FROM Events_Devices
                         WHERE eve_PendingAlertEmail = 1
@@ -181,7 +183,7 @@ def send_notifications (db):
         mail_text = mail_text.replace ('<SECTION_DEVICES_DOWN>', notiStruc.text + '\n')
         mail_html = mail_html.replace ('<DOWN_DEVICES_TABLE>', notiStruc.html)
 
-    if 'events' in conf.INCLUDED_SECTIONS:
+    if 'events' in INCLUDED_SECTIONS:
         # Compose Events Section
         sqlQuery = """SELECT eve_MAC as MAC, eve_DateTime as Datetime, dev_LastIP as IP, eve_EventType as "Event Type", dev_Name as "Device name", dev_Comments as Comments  FROM Events_Devices
                         WHERE eve_PendingAlertEmail = 1
@@ -197,7 +199,7 @@ def send_notifications (db):
         mail_text = mail_text.replace ('<SECTION_EVENTS>', notiStruc.text + '\n')
         mail_html = mail_html.replace ('<EVENTS_TABLE>', notiStruc.html)
 
-    if 'ports' in conf.INCLUDED_SECTIONS:  
+    if 'ports' in INCLUDED_SECTIONS:
         # collect "ports" for the webhook json
         if changedPorts_json_struc is not None:
             json_ports =  changedPorts_json_struc.json["data"]
@@ -212,7 +214,7 @@ def send_notifications (db):
 
         mail_text = mail_text.replace ('<PORTS_TABLE>', portsTxt )
 
-    if 'plugins' in conf.INCLUDED_SECTIONS and conf.ENABLE_PLUGINS:  
+    if 'plugins' in INCLUDED_SECTIONS and conf.ENABLE_PLUGINS:
         # Compose Plugins Section
         sqlQuery = """SELECT Plugin, Object_PrimaryId, Object_SecondaryId, DateTimeChanged, Watched_Value1, Watched_Value2, Watched_Value3, Watched_Value4, Status from Plugins_Events"""
 
@@ -252,19 +254,21 @@ def send_notifications (db):
 
         mylog('none', ['[Notification] Changes detected, sending reports'])
 
+        msg = noti_struc(json_final, mail_text, mail_html)
+
         mylog('info', ['[Notification] Udateing API files'])
         send_api()
 
         if conf.REPORT_MAIL and check_config('email'):
             updateState(db,"Send: Email")
             mylog('info', ['[Notification] Sending report by Email'])
-            send_email (mail_text, mail_html)
+            send_email (msg )
         else :
             mylog('verbose', ['[Notification] Skip email'])
         if conf.REPORT_APPRISE and check_config('apprise'):
             updateState(db,"Send: Apprise")
             mylog('info', ['[Notification] Sending report by Apprise'])
-            send_apprise (mail_html, mail_text)
+            send_apprise (msg)
         else :
             mylog('verbose', ['[Notification] Skip Apprise'])
         if conf.REPORT_WEBHOOK and check_config('webhook'):
@@ -276,13 +280,13 @@ def send_notifications (db):
         if conf.REPORT_NTFY and check_config('ntfy'):
             updateState(db,"Send: NTFY")
             mylog('info', ['[Notification] Sending report by NTFY'])
-            send_ntfy (mail_text)
+            send_ntfy (msg)
         else :
             mylog('verbose', ['[Notification] Skip NTFY'])
         if conf.REPORT_PUSHSAFER and check_config('pushsafer'):
             updateState(db,"Send: PUSHSAFER")
             mylog('info', ['[Notification] Sending report by PUSHSAFER'])
-            send_pushsafer (mail_text)
+            send_pushsafer (msg)
         else :
             mylog('verbose', ['[Notification] Skip PUSHSAFER'])
         # Update MQTT entities
@@ -319,46 +323,46 @@ def send_notifications (db):
 def check_config(service):
 
     if service == 'email':
-        if conf.SMTP_SERVER == '' or conf.REPORT_FROM == '' or conf.REPORT_TO == '':
+        return email_check_config()
-            mylog('none', ['[Check Config] Error: Email service not set up correctly. Check your pialert.conf SMTP_*, REPORT_FROM and REPORT_TO variables.'])
+    
-            return False
+    #    if conf.SMTP_SERVER == '' or conf.REPORT_FROM == '' or conf.REPORT_TO == '':
-        else:
+    #        mylog('none', ['[Check Config] Error: Email service not set up correctly. Check your pialert.conf SMTP_*, REPORT_FROM and REPORT_TO variables.'])
-            return True   
+    #        return False
+    #    else:
+    #        return True
 
     if service == 'apprise':
-        if conf.APPRISE_URL == '' or conf.APPRISE_HOST == '':
+        return apprise_check_config()
-            mylog('none', ['[Check Config] Error: Apprise service not set up correctly. Check your pialert.conf APPRISE_* variables.'])
+    
-            return False
+    #    if conf.APPRISE_URL == '' or conf.APPRISE_HOST == '':
-        else:
+    #        mylog('none', ['[Check Config] Error: Apprise service not set up correctly. Check your pialert.conf APPRISE_* variables.'])
-            return True  
+    #        return False
+    #    else:
+    #        return True
 
     if service == 'webhook':
-        if conf.WEBHOOK_URL == '':
+        return webhook_check_config()
-            mylog('none', ['[Check Config] Error: Webhook service not set up correctly. Check your pialert.conf WEBHOOK_* variables.'])
+    
-            return False
+    #    if conf.WEBHOOK_URL == '':
-        else:
+    #        mylog('none', ['[Check Config] Error: Webhook service not set up correctly. Check your pialert.conf WEBHOOK_* variables.'])
-            return True 
+    #        return False
+    #    else:
+    #        return True
 
     if service == 'ntfy':
-        if conf.NTFY_HOST == '' or conf.NTFY_TOPIC == '':
+        return ntfy_check_config ()
-            mylog('none', ['[Check Config] Error: NTFY service not set up correctly. Check your pialert.conf NTFY_* variables.'])
+    #
-            return False
+    #    if conf.NTFY_HOST == '' or conf.NTFY_TOPIC == '':
-        else:
+    #        mylog('none', ['[Check Config] Error: NTFY service not set up correctly. Check your pialert.conf NTFY_* variables.'])
-            return True 
+    #        return False
+    #    else:
+    #        return True
 
     if service == 'pushsafer':
-        if conf.PUSHSAFER_TOKEN == 'ApiKey':
+        return pushsafer_check_config()
-            mylog('none', ['[Check Config] Error: Pushsafer service not set up correctly. Check your pialert.conf PUSHSAFER_TOKEN variable.'])
-            return False
-        else:
-            return True 
 
     if service == 'mqtt':
-        if conf.MQTT_BROKER == '' or conf.MQTT_PORT == '' or conf.MQTT_USER == '' or conf.MQTT_PASSWORD == '':
+        return mqtt_check_config()
-            mylog('none', ['[Check Config] Error: MQTT service not set up correctly. Check your pialert.conf MQTT_* variables.'])
-            return False
-        else:
-            return True 
 
 #-------------------------------------------------------------------------------
 def format_table (html, thValue, props, newThValue = ''):
@@ -404,213 +408,6 @@ def remove_tag (pText, pTag):
 #-------------------------------------------------------------------------------
 # Reporting
 #-------------------------------------------------------------------------------
-def send_email (pText, pHTML):
-
-    mylog('debug', '[Send Email] REPORT_TO: ' + hide_email(str(conf.REPORT_TO)) + '  SMTP_USER: ' + hide_email(str(conf.SMTP_USER))) 
-
-    # Compose email
-    msg = MIMEMultipart('alternative')
-    msg['Subject'] = 'Pi.Alert Report'
-    msg['From'] = conf.REPORT_FROM
-    msg['To'] = conf.REPORT_TO
-    msg.attach (MIMEText (pText, 'plain'))
-    msg.attach (MIMEText (pHTML, 'html'))
-
-    failedAt = ''
-
-    failedAt = print_log ('SMTP try')
-
-    try:
-        # Send mail
-        failedAt = print_log('Trying to open connection to ' + str(conf.SMTP_SERVER) + ':' + str(conf.SMTP_PORT))
-
-        if conf.SMTP_FORCE_SSL:
-            failedAt = print_log('SMTP_FORCE_SSL == True so using .SMTP_SSL()')
-            if conf.SMTP_PORT == 0:            
-                failedAt = print_log('SMTP_PORT == 0 so sending .SMTP_SSL(SMTP_SERVER)')
-                smtp_connection = smtplib.SMTP_SSL(conf.SMTP_SERVER)
-            else:
-                failedAt = print_log('SMTP_PORT == 0 so sending .SMTP_SSL(SMTP_SERVER, SMTP_PORT)')
-                smtp_connection = smtplib.SMTP_SSL(conf.SMTP_SERVER, conf.SMTP_PORT)
-            
-        else:
-            failedAt = print_log('SMTP_FORCE_SSL == False so using .SMTP()')
-            if conf.SMTP_PORT == 0:
-                failedAt = print_log('SMTP_PORT == 0 so sending .SMTP(SMTP_SERVER)')
-                smtp_connection = smtplib.SMTP (conf.SMTP_SERVER)
-            else:
-                failedAt = print_log('SMTP_PORT == 0 so sending .SMTP(SMTP_SERVER, SMTP_PORT)')
-                smtp_connection = smtplib.SMTP (conf.SMTP_SERVER, conf.SMTP_PORT)
-
-        failedAt = print_log('Setting SMTP debug level')
-
-        # Log level set to debug of the communication between SMTP server and client
-        if conf.LOG_LEVEL == 'debug':
-            smtp_connection.set_debuglevel(1) 
-        
-        failedAt = print_log( 'Sending .ehlo()')
-        smtp_connection.ehlo()
-
-        if not conf.SMTP_SKIP_TLS:       
-            failedAt = print_log('SMTP_SKIP_TLS == False so sending .starttls()')
-            smtp_connection.starttls()
-            failedAt = print_log('SMTP_SKIP_TLS == False so sending .ehlo()')
-            smtp_connection.ehlo()
-        if not conf.SMTP_SKIP_LOGIN:
-            failedAt = print_log('SMTP_SKIP_LOGIN == False so sending .login()')
-            smtp_connection.login (conf.SMTP_USER, conf.SMTP_PASS)
-            
-        failedAt = print_log('Sending .sendmail()')
-        smtp_connection.sendmail (conf.REPORT_FROM, conf.REPORT_TO, msg.as_string())
-        smtp_connection.quit()
-    except smtplib.SMTPAuthenticationError as e: 
-        mylog('none', ['      ERROR: Failed at - ', failedAt])
-        mylog('none', ['      ERROR: Couldn\'t connect to the SMTP server (SMTPAuthenticationError), skipping Email (enable LOG_LEVEL=debug for more logging)'])
-    except smtplib.SMTPServerDisconnected as e: 
-        mylog('none', ['      ERROR: Failed at - ', failedAt])
-        mylog('none', ['      ERROR: Couldn\'t connect to the SMTP server (SMTPServerDisconnected), skipping Email (enable LOG_LEVEL=debug for more logging)'])
-
-    mylog('debug', '[Send Email] Last executed - ' + str(failedAt))
-
-#-------------------------------------------------------------------------------
-def send_ntfy (_Text):
-    headers = {
-        "Title": "Pi.Alert Notification",
-        "Actions": "view, Open Dashboard, "+ conf.REPORT_DASHBOARD_URL,
-        "Priority": "urgent",
-        "Tags": "warning"
-    }
-    # if username and password are set generate hash and update header
-    if conf.NTFY_USER != "" and conf.NTFY_PASSWORD != "":
-	# Generate hash for basic auth
-        usernamepassword = "{}:{}".format(conf.NTFY_USER,conf.NTFY_PASSWORD)
-        basichash = b64encode(bytes(conf.NTFY_USER + ':' + conf.NTFY_PASSWORD, "utf-8")).decode("ascii")
-
-	# add authorization header with hash
-        headers["Authorization"] = "Basic {}".format(basichash)
-
-    requests.post("{}/{}".format( conf.NTFY_HOST, conf.NTFY_TOPIC),
-    data=_Text,
-    headers=headers)
-
-def send_pushsafer (_Text):
-    url = 'https://www.pushsafer.com/api'
-    post_fields = {
-        "t" : 'Pi.Alert Message',
-        "m" : _Text,
-        "s" : 11,
-        "v" : 3,
-        "i" : 148,
-        "c" : '#ef7f7f',
-        "d" : 'a',
-        "u" : conf.REPORT_DASHBOARD_URL,
-        "ut" : 'Open Pi.Alert',
-        "k" : conf.PUSHSAFER_TOKEN,
-        }
-    requests.post(url, data=post_fields)
-
-#-------------------------------------------------------------------------------
-def send_webhook (_json, _html):
-
-    # use data type based on specified payload type
-    if conf.WEBHOOK_PAYLOAD == 'json':
-        payloadData = _json        
-    if conf.WEBHOOK_PAYLOAD == 'html':
-        payloadData = _html
-    if conf.WEBHOOK_PAYLOAD == 'text':
-        payloadData = to_text(_json)
-
-    # Define slack-compatible payload
-    _json_payload = { "text": payloadData } if conf.WEBHOOK_PAYLOAD == 'text' else {
-    "username": "Pi.Alert",
-    "text": "There are new notifications",
-    "attachments": [{
-      "title": "Pi.Alert Notifications",
-      "title_link": conf.REPORT_DASHBOARD_URL,
-      "text": payloadData
-    }]
-    } 
-
-    # DEBUG - Write the json payload into a log file for debugging
-    write_file (logPath + '/webhook_payload.json', json.dumps(_json_payload))    
-
-    # Using the Slack-Compatible Webhook endpoint for Discord so that the same payload can be used for both
-    if(conf.WEBHOOK_URL.startswith('https://discord.com/api/webhooks/') and not conf.WEBHOOK_URL.endswith("/slack")):
-        _WEBHOOK_URL = f"{conf.WEBHOOK_URL}/slack"
-        curlParams = ["curl","-i","-H", "Content-Type:application/json" ,"-d", json.dumps(_json_payload), _WEBHOOK_URL]
-    else:
-        _WEBHOOK_URL = conf.WEBHOOK_URL
-        curlParams = ["curl","-i","-X", conf.WEBHOOK_REQUEST_METHOD ,"-H", "Content-Type:application/json" ,"-d", json.dumps(_json_payload), _WEBHOOK_URL]
-
-    # execute CURL call
-    try:
-        # try runnning a subprocess
-        mylog('debug', '[send_webhook] curlParams: '+  curlParams) 
-        p = subprocess.Popen(curlParams, stdout=subprocess.PIPE, stderr=subprocess.STDOUT)
-
-        stdout, stderr = p.communicate()
-
-        # write stdout and stderr into .log files for debugging if needed
-        logResult (stdout, stderr)     # TO-DO should be changed to mylog
-    except subprocess.CalledProcessError as e:
-        # An error occured, handle it
-        mylog('none', ['[send_webhook]', e.output])
-
-#-------------------------------------------------------------------------------
-def send_apprise (html, text):
-    #Define Apprise compatible payload (https://github.com/caronc/apprise-api#stateless-solution)
-    payload = html
-
-    if conf.APPRISE_PAYLOAD == 'text':
-        payload = text
-
-    _json_payload={
-    "urls": conf.APPRISE_URL,
-    "title": "Pi.Alert Notifications",    
-    "format": conf.APPRISE_PAYLOAD,
-    "body": payload    
-    }
-
-    try:
-        # try runnning a subprocess        
-        p = subprocess.Popen(["curl","-i","-X", "POST" ,"-H", "Content-Type:application/json" ,"-d", json.dumps(_json_payload), conf.APPRISE_HOST], stdout=subprocess.PIPE, stderr=subprocess.STDOUT)
-        stdout, stderr = p.communicate()
-        # write stdout and stderr into .log files for debugging if needed
-        logResult (stdout, stderr)      # TO-DO should be changed to mylog
-    except subprocess.CalledProcessError as e:
-        # An error occured, handle it
-        mylog('none', [e.output])    
-
-
-def to_text(_json):
-    payloadData = ""
-    if len(_json['internet']) > 0 and 'internet' in conf.INCLUDED_SECTIONS:
-        payloadData += "INTERNET\n"
-        for event in _json['internet']:
-            payloadData += event[3] + ' on ' + event[2] + '. ' + event[4] + '. New address:' + event[1] + '\n'
-
-    if len(_json['new_devices']) > 0 and 'new_devices' in conf.INCLUDED_SECTIONS:
-        payloadData += "NEW DEVICES:\n"
-        for event in _json['new_devices']:
-            if event[4] is None:
-                event[4] = event[11]
-            payloadData += event[1] + ' - ' + event[4] + '\n'
-
-    if len(_json['down_devices']) > 0 and 'down_devices' in conf.INCLUDED_SECTIONS:
-        write_file (logPath + '/down_devices_example.log', _json['down_devices'])
-        payloadData += 'DOWN DEVICES:\n'
-        for event in _json['down_devices']:
-            if event[4] is None:
-                event[4] = event[11]
-            payloadData += event[1] + ' - ' + event[4] + '\n'
-    
-    if len(_json['events']) > 0 and 'events' in conf.INCLUDED_SECTIONS:
-        payloadData += "EVENTS:\n"
-        for event in _json['events']:
-            if event[8] != "Internet":
-                payloadData += event[8] + " on " + event[1] + " " + event[3] + " at " + event[2] + "\n"
-
-    return payloadData
 
 #-------------------------------------------------------------------------------
 def send_api():
@@ -696,15 +493,17 @@ def handle_test(testType):
     # Open json sample and get only the payload part
     sample_json_payload = json.loads(get_file_content(pialertPath + '/back/webhook_json_sample.json'))[0]["body"]["attachments"][0]["text"]
 
-    if testType == 'REPORT_MAIL':
+    sample_msg = noti_struc(sample_json_payload, sample_txt, sample_html )
-        send_email(sample_txt, sample_html)
-    if testType == 'REPORT_WEBHOOK':
-        send_webhook (sample_json_payload, sample_txt)
-    if testType == 'REPORT_APPRISE':
-        send_apprise (sample_html, sample_txt) 
-    if testType == 'REPORT_NTFY':
-        send_ntfy (sample_txt)
-    if testType == 'REPORT_PUSHSAFER':
-        send_pushsafer (sample_txt)
 
-    mylog('info', ['[', timeNow(), '] END Test: ', testType])
+    if testType == 'REPORT_MAIL':
+        send_email(sample_msg)
+    if testType == 'REPORT_WEBHOOK':
+        send_webhook (sample_msg)
+    if testType == 'REPORT_APPRISE':
+        send_apprise (sample_msg)
+    if testType == 'REPORT_NTFY':
+        send_ntfy (sample_msg)
+    if testType == 'REPORT_PUSHSAFER':
+        send_pushsafer (sample_msg)
+
+    mylog('info', ['[Test Publishers] END Test: ', testType])

test/__init__.py

@@ -0,0 +1 @@
+""" tests for Pi.Alert """

test/test_helper.py

@@ -0,0 +1,29 @@
+import sys
+import pathlib
+
+sys.path.append(str(pathlib.Path(__file__).parent.parent.resolve()) + "/pialert/")
+
+
+import datetime
+
+from helper import timeNow, updateSubnets
+
+
+# -------------------------------------------------------------------------------
+def test_helper():
+    assert timeNow() == datetime.datetime.now().replace(microsecond=0)
+
+
+# -------------------------------------------------------------------------------
+def test_updateSubnets():
+    # test single subnet
+    subnet = "192.168.1.0/24 --interface=eth0"
+    result = updateSubnets(subnet)
+    assert type(result) is list
+    assert len(result) == 1
+
+    # test multip subnets
+    subnet = ["192.168.1.0/24 --interface=eth0", "192.168.2.0/24 --interface=eth1"]
+    result = updateSubnets(subnet)
+    assert type(result) is list
+    assert len(result) == 2