cphipps/NetAlertX
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Notification rework v0.3

Browse Source
This commit is contained in:
Jokob-sk
2023-10-07 13:00:28 +11:00
parent eb7b7b57ab
commit 695f1593c6
18 changed files with 351 additions and 199 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
front/php/templates/language/en_us.json
View File

@@ -536,17 +536,7 @@
"WEBHOOK_SIZE_name" : "Max payload size", "WEBHOOK_SIZE_name" : "Max payload size",
"WEBHOOK_SIZE_description" : "The maximum size of the webhook payload as number of characters in the passed string. If above limit, it will be truncated and a <code>(text was truncated)</code> message is appended.", "WEBHOOK_SIZE_description" : "The maximum size of the webhook payload as number of characters in the passed string. If above limit, it will be truncated and a <code>(text was truncated)</code> message is appended.",
"WEBHOOK_SECRET_name": "HMAC Secret", "WEBHOOK_SECRET_name": "HMAC Secret",
"WEBHOOK_SECRET_description": "When set, use this secret to generate the SHA256-HMAC hex digest value of the request body, which will be passed as the <code>X-Webhook-Signature</code> header to the request. You can find more informations <a target=\"_blank\" href=\"https://github.com/jokob-sk/Pi.Alert/blob/main/docs/WEBHOOK_SECRET.md\">here</a>.", "WEBHOOK_SECRET_description": "When set, use this secret to generate the SHA256-HMAC hex digest value of the request body, which will be passed as the <code>X-Webhook-Signature</code> header to the request. You can find more informations <a target=\"_blank\" href=\"https://github.com/jokob-sk/Pi.Alert/blob/main/docs/WEBHOOK_SECRET.md\">here</a>.",
"Apprise_display_name" : "Apprise",
"Apprise_icon" : "<i class=\"fa fa-bullhorn\"></i>",
"REPORT_APPRISE_name" : "Enable Apprise",
"REPORT_APPRISE_description" : "Enable sending notifications via <a target=\"_blank\" href=\"https://hub.docker.com/r/caronc/apprise\">Apprise</a>.",
"APPRISE_HOST_name" : "Apprise host URL",
"APPRISE_HOST_description" : "Apprise host URL starting with <code>http://</code> or <code>https://</code>. (do not forget to include <code>/notify</code> at the end)",
"APPRISE_URL_name" : "Apprise notification URL",
"APPRISE_URL_description" : "Apprise notification target URL. For example for Telegram it would be <code>tgram://{bot_token}/{chat_id}</code>.",
"APPRISE_SIZE_name" : "Max payload size",
"APPRISE_SIZE_description" : "The maximum size of the apprise payload as number of characters in the passed string. If above limit, it will be truncated and a <code>(text was truncated)</code> message is appended.",
"NTFY_display_name" : "NTFY", "NTFY_display_name" : "NTFY",
"NTFY_icon" : "<i class=\"fa fa-terminal\"></i>", "NTFY_icon" : "<i class=\"fa fa-terminal\"></i>",
"REPORT_NTFY_name" : "Enable NTFY", "REPORT_NTFY_name" : "Enable NTFY",
@@ -564,9 +554,7 @@
"REPORT_PUSHSAFER_name" : "Enable Pushsafer", "REPORT_PUSHSAFER_name" : "Enable Pushsafer",
"REPORT_PUSHSAFER_description" : "Enable sending notifications via <a target=\"_blank\" href=\"https://www.pushsafer.com/\">Pushsafer</a>.", "REPORT_PUSHSAFER_description" : "Enable sending notifications via <a target=\"_blank\" href=\"https://www.pushsafer.com/\">Pushsafer</a>.",
"PUSHSAFER_TOKEN_name" : "Pushsafer token", "PUSHSAFER_TOKEN_name" : "Pushsafer token",
"PUSHSAFER_TOKEN_description" : "Your secret Pushsafer API key (token).", "PUSHSAFER_TOKEN_description" : "Your secret Pushsafer API key (token).",
"APPRISE_PAYLOAD_name" : "Payload type",
"APPRISE_PAYLOAD_description" : "Select the payoad type sent to Apprise. For example <code>html</code> works well with emails, <code>text</code> with chat apps, such as Telegram.",
"MQTT_display_name" : "MQTT", "MQTT_display_name" : "MQTT",
"MQTT_icon" : "<i class=\"fa fa-square-rss\"></i>", "MQTT_icon" : "<i class=\"fa fa-square-rss\"></i>",
"REPORT_TITLE" : "Report", "REPORT_TITLE" : "Report",

75
front/plugins/_publisher_apprise/apprise.py
View File

@@ -15,7 +15,9 @@ sys.path.extend(["/home/pi/pialert/front/plugins", "/home/pi/pialert/pialert"])
import conf import conf
from plugin_helper import Plugin_Objects from plugin_helper import Plugin_Objects
from logger import mylog, append_line_to_file from logger import mylog, append_line_to_file
from helper import timeNowTZ, noti_struc from helper import timeNowTZ, noti_obj
from notification import Notification_obj
from database import DB
CUR_PATH = str(pathlib.Path(__file__).parent.resolve()) CUR_PATH = str(pathlib.Path(__file__).parent.resolve())
@@ -24,41 +26,60 @@ RESULT_FILE = os.path.join(CUR_PATH, 'last_result.log')
def main(): def main():
mylog('verbose', ['[APPRISE](publisher) In script']) mylog('verbose', ['[APPRISE](publisher) In script'])
# Check if basic config settings supplied
if check_config() == False:
mylog('none', ['[Check Config] Error: Apprise service not set up correctly. Check your pialert.conf APPRISE_* variables.'])
return
parser = argparse.ArgumentParser(description='APPRISE publisher Plugin') # Create a database connection
values = parser.parse_args() db = DB() # instance of class DB
db.open()
# parser = argparse.ArgumentParser(description='APPRISE publisher Plugin')
# values = parser.parse_args()
# Initialize the Plugin obj output file
plugin_objects = Plugin_Objects(RESULT_FILE) plugin_objects = Plugin_Objects(RESULT_FILE)
speedtest_result = send() # Create a Notification_obj instance
Notification_obj(db)
plugin_objects.add_object( # Retrieve new notifications
primaryId = 'APPRISE', new_notifications = notifications.getNew()
secondaryId = timeNowTZ(),
watched1 = speedtest_result['download_speed'], # Process the new notifications
watched2 = speedtest_result['upload_speed'], for notification in new_notifications:
watched3 = 'null',
watched4 = 'null', # Send notification
extra = 'null', result = send(notification["HTML"], notification["Text"])
foreignKey = 'null'
) # Log result
plugin_objects.add_object(
primaryId = 'APPRISE',
secondaryId = timeNowTZ(),
watched1 = notification["GUID"],
watched2 = result,
watched3 = 'null',
watched4 = 'null',
extra = 'null',
foreignKey = 'null'
)
plugin_objects.write_result_file() plugin_objects.write_result_file()
#------------------------------------------------------------------------------- #-------------------------------------------------------------------------------
def check_config(): def check_config():
if conf.APPRISE_URL == '' or conf.APPRISE_HOST == '': 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 return False
else: else:
return True return True
#------------------------------------------------------------------------------- #-------------------------------------------------------------------------------
def send(msg: noti_struc): def send(html, text):
html = msg.html
text = msg.text
payloadData = '' payloadData = ''
result = ''
# limit = 1024 * 1024 # 1MB limit (1024 bytes * 1024 bytes = 1MB) # limit = 1024 * 1024 # 1MB limit (1024 bytes * 1024 bytes = 1MB)
limit = conf.APPRISE_SIZE limit = conf.APPRISE_SIZE
@@ -66,7 +87,7 @@ def send(msg: noti_struc):
# truncate size # truncate size
if conf.APPRISE_PAYLOAD == 'html': if conf.APPRISE_PAYLOAD == 'html':
if len(msg.html) > limit: if len(msg.html) > limit:
payloadData = msg.html[:limit] + " <h1> (text was truncated)</h1>" payloadData = msg.html[:limit] + "<h1>(text was truncated)</h1>"
else: else:
payloadData = msg.html payloadData = msg.html
if conf.APPRISE_PAYLOAD == 'text': if conf.APPRISE_PAYLOAD == 'text':
@@ -88,14 +109,22 @@ def send(msg: noti_struc):
# try runnning a subprocess # 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) 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() stdout, stderr = p.communicate()
# write stdout and stderr into .log files for debugging if needed
# write stdout and stderr into .log files for debugging if needed
# Log the stdout and stderr # Log the stdout and stderr
mylog('debug', [stdout, stderr]) # TO-DO should be changed to mylog mylog('debug', [stdout, stderr])
# log result
result = stdout
except subprocess.CalledProcessError as e: except subprocess.CalledProcessError as e:
# An error occurred, handle it # An error occurred, handle it
mylog('none', [e.output]) mylog('none', [e.output])
# log result
result = e.output
return result
if __name__ == '__main__': if __name__ == '__main__':
sys.exit(main()) sys.exit(main())

213
front/plugins/_publisher_apprise/config.json
View File

@@ -1,22 +1,30 @@
{ {
"code_name": "internet_speedtest", "code_name": "_publisher_apprise",
"unique_prefix": "INTRSPD", "unique_prefix": "APPRISE",
"enabled": true, "enabled": true,
"data_source": "script", "data_source": "script",
"show_ui": true, "show_ui": true,
"localized": ["display_name", "description", "icon"], "localized": ["display_name", "description", "icon"],
"display_name" : [{ "display_name" : [
{
"language_code": "en_us", "language_code": "en_us",
"string" : "Internet speedtest" "string" : "Apprise publisher"
}], },
{
"language_code": "es_es",
"string" : "Habilitar Apprise"
}
],
"icon":[{ "icon":[{
"language_code": "en_us", "language_code": "en_us",
"string" : "<i class=\"fa-solid fa-gauge-high\"></i>" "string" : "<i class=\"fa-solid fa-bullhorn\"></i>"
}], }],
"description": [{ "description": [
{
"language_code": "en_us", "language_code": "en_us",
"string" : "A plugin to perform a scheduled internet speedtest." "string" : "A plugin to publish a notification via the Apprise gateway."
}], }
],
"params" : [], "params" : [],
"database_column_definitions": "database_column_definitions":
[ [
@@ -94,7 +102,7 @@
"localized": ["name"], "localized": ["name"],
"name":[{ "name":[{
"language_code": "en_us", "language_code": "en_us",
"string" : "Test run on" "string" : "Sent when"
}] }]
}, },
{ {
@@ -118,60 +126,26 @@
"column": "Watched_Value1", "column": "Watched_Value1",
"css_classes": "col-sm-2", "css_classes": "col-sm-2",
"show": true, "show": true,
"type": "threshold", "type": "label",
"default_value":"", "default_value":"",
"options": [ "options": [],
{
"maximum": 1,
"hexColor": "#D33115"
},
{
"maximum": 5,
"hexColor": "#792D86"
},
{
"maximum": 10,
"hexColor": "#7D862D"
},
{
"maximum": 100,
"hexColor": "#05483C"
}
],
"localized": ["name"], "localized": ["name"],
"name":[{ "name":[{
"language_code": "en_us", "language_code": "en_us",
"string" : "Download" "string" : "Notification GUID"
}] }]
}, },
{ {
"column": "Watched_Value2", "column": "Watched_Value2",
"css_classes": "col-sm-2", "css_classes": "col-sm-2",
"show": true, "show": true,
"type": "threshold", "type": "label",
"default_value":"", "default_value":"",
"options": [ "options": [],
{
"maximum": 1,
"hexColor": "#D33115"
},
{
"maximum": 5,
"hexColor": "#792D86"
},
{
"maximum": 10,
"hexColor": "#7D862D"
},
{
"maximum": 100,
"hexColor": "#05483C"
}
],
"localized": ["name"], "localized": ["name"],
"name":[{ "name":[{
"language_code": "en_us", "language_code": "en_us",
"string" : "Upload" "string" : "Result"
}] }]
}, },
{ {
@@ -283,7 +257,7 @@
"events": ["run"], "events": ["run"],
"type": "text.select", "type": "text.select",
"default_value":"disabled", "default_value":"disabled",
"options": ["disabled", "once", "schedule", "always_after_scan" ], "options": ["disabled", "on_notification" ],
"localized": ["name", "description"], "localized": ["name", "description"],
"name" :[{ "name" :[{
"language_code": "en_us", "language_code": "en_us",
@@ -293,15 +267,21 @@
"language_code": "es_es", "language_code": "es_es",
"string" : "Cuando ejecuta" "string" : "Cuando ejecuta"
}], }],
"description": [{ "description": [
{
"language_code": "en_us", "language_code": "en_us",
"string" : "Enable a regular internet speedtest. If you select <code>schedule</code> the scheduling settings from below are applied. If you select <code>once</code> the scan is run only once on start of the application (container) for the time specified in <a href=\"#INTRSPD_RUN_TIMEOUT\"><code>INTRSPD_RUN_TIMEOUT</code> setting</a>." "string" : "Enable sending notifications via <a target=\"_blank\" href=\"https://hub.docker.com/r/caronc/apprise\">Apprise</a>."
}] },
{
"language_code": "es_es",
"string" : "Habilitar el envío de notificaciones a través de <a target=\"_blank\" href=\"https://hub.docker.com/r/caronc/apprise\">Apprise</a>."
}
]
}, },
{ {
"function": "CMD", "function": "CMD",
"type": "readonly", "type": "readonly",
"default_value":"python3 /home/pi/pialert/front/plugins/internet_speedtest/script.py", "default_value":"python3 /home/pi/pialert/front/plugins/_publisher_apprise/apprise.py",
"options": [], "options": [],
"localized": ["name", "description"], "localized": ["name", "description"],
"name" : [{ "name" : [{
@@ -321,33 +301,10 @@
"string" : "Comando a ejecutar" "string" : "Comando a ejecutar"
}] }]
}, },
{
"function": "RUN_SCHD",
"type": "text",
"default_value":"*/30 * * * *",
"options": [],
"localized": ["name", "description"],
"name" : [{
"language_code": "en_us",
"string" : "Schedule"
},
{
"language_code": "es_es",
"string" : "Schedule"
}],
"description": [{
"language_code": "en_us",
"string" : "Only enabled if you select <code>schedule</code> in the <a href=\"#INTRSPD_RUN\"><code>INTRSPD_RUN</code> setting</a>. Make sure you enter the schedule in the correct cron-like format (e.g. validate at <a href=\"https://crontab.guru/\" target=\"_blank\">crontab.guru</a>). For example entering <code>0 4 * * *</code> will run the scan after 4 am in the <a onclick=\"toggleAllSettings()\" href=\"#TIMEZONE\"><code>TIMEZONE</code> you set above</a>. Will be run NEXT time the time passes."
},
{
"language_code": "es_es",
"string": "Solo habilitado si selecciona <code>schedule</code> en la configuración <a href=\"#INTRSPD_RUN\"><code>INTRSPD_RUN</code></a>. Asegúrese de ingresar el schedule en el formato similar a cron correcto (por ejemplo, valide en <a href=\"https://crontab.guru/\" target=\"_blank\">crontab.guru</a>). Por ejemplo, ingrese <code >0 4 * * *</code> ejecutará el escaneo después de las 4 am en el <a onclick=\"toggleAllSettings()\" href=\"#TIMEZONE\"><code>TIMEZONE</code> que configuró arriba </a>. Se ejecutará la PRÓXIMA vez que pase el tiempo."
}]
},
{ {
"function": "RUN_TIMEOUT", "function": "RUN_TIMEOUT",
"type": "integer", "type": "integer",
"default_value":60, "default_value": 10,
"options": [], "options": [],
"localized": ["name", "description"], "localized": ["name", "description"],
"name" : [{ "name" : [{
@@ -372,46 +329,96 @@
}] }]
}, },
{ {
"function": "WATCH", "function": "HOST",
"type": "text.multiselect", "type": "text",
"default_value":[], "default_value": "",
"options": ["Watched_Value1","Watched_Value2","Watched_Value3","Watched_Value4"], "options": [],
"localized": ["name", "description"], "localized": ["name", "description"],
"name" :[{ "name" : [{
"language_code": "en_us", "language_code": "en_us",
"string" : "Watched" "string" : "Apprise host URL"
}, },
{ {
"language_code": "es_es", "language_code": "es_es",
"string" : "Visto" "string" : "URL del host de Apprise"
}], }],
"description":[{ "description": [{
"language_code": "en_us", "language_code": "en_us",
"string" : "Send a notification if selected values change. Use <code>CTRL + Click</code> to select/deselect. <ul> <li><code>Watched_Value1</code> is Download speed (not recommended)</li><li><code>Watched_Value2</code> is Upload speed (not recommended)</li><li><code>Watched_Value3</code> unused </li><li><code>Watched_Value4</code> unused </li></ul>" "string" : "Apprise host URL starting with <code>http://</code> or <code>https://</code>. (do not forget to include <code>/notify</code> at the end)"
}] },
{
"language_code": "es_es",
"string" : "URL del host de Apprise que comienza con <code>http://</code> o <code>https://</code>. (no olvide incluir <code>/notify</code> al final)"
}]
}, },
{ {
"function": "REPORT_ON", "function": "URL",
"type": "text.multiselect", "type": "text",
"default_value":[], "default_value": "",
"options": ["new","watched-changed","watched-not-changed", "missing-in-last-scan"], "options": [],
"localized": ["name", "description"], "localized": ["name", "description"],
"name" :[{ "name" : [{
"language_code": "en_us", "language_code": "en_us",
"string" : "Report on" "string" : "Apprise notification URL"
}, },
{ {
"language_code": "es_es", "language_code": "es_es",
"string" : "Informar sobre" "string" : "URL de notificación de Apprise"
}] , }],
"description":[{ "description": [{
"language_code": "en_us", "language_code": "en_us",
"string" : "Send a notification only on these statuses. <code>new</code> means a new unique (unique combination of PrimaryId and SecondaryId) object was discovered. <code>watched-changed</code> means that selected <code>Watched_ValueN</code> columns changed." "string" : "Apprise notification target URL. For example for Telegram it would be <code>tgram://{bot_token}/{chat_id}</code>."
}, },
{ {
"language_code": "es_es", "language_code": "es_es",
"string" : "Envíe una notificación solo en estos estados. <code>new</code> significa que se descubrió un nuevo objeto único (combinación única de PrimaryId y SecondaryId). <code>watched-changed</code> significa que seleccionó <code>Watched_ValueN Las columnas </code> cambiaron." "string" : "Informar de la URL de destino de la notificación. Por ejemplo, para Telegram sería <code>tgram://{bot_token}/{chat_id}</code>."
}] }]
} },
{
"function": "PAYLOAD",
"type": "text.select",
"default_value": "html",
"options": ["html", "text"],
"localized": ["name", "description"],
"name" : [{
"language_code": "en_us",
"string" : "Payload type"
},
{
"language_code": "es_es",
"string" : "Tipo de carga"
}],
"description": [{
"language_code": "en_us",
"string" : "Select the payoad type sent to Apprise. For example <code>html</code> works well with emails, <code>text</code> with chat apps, such as Telegram."
},
{
"language_code": "es_es",
"string" : "Seleccione el tipo de carga útil enviada a Apprise. Por ejemplo, <code>html</code> funciona bien con correos electrónicos, <code>text</code> con aplicaciones de chat, como Telegram."
}]
},
{
"function": "SIZE",
"type": "integer",
"default_value": 1024,
"options": [],
"localized": ["name", "description"],
"name" : [{
"language_code": "en_us",
"string" : "Max payload size"
},
{
"language_code": "es_es",
"string" : "Tamaño máximo de carga útil"
}],
"description": [{
"language_code": "en_us",
"string" : "The maximum size of the apprise payload as number of characters in the passed string. If above limit, it will be truncated and a <code>(text was truncated)</code> message is appended."
},
{
"language_code": "es_es",
"string" : "El tamaño máximo de la carga útil de información como número de caracteres en la cadena pasada. Si supera el límite, se truncará y se agregará un mensaje <code>(text was truncated)</code>."
}]
}
] ]
} }

1
front/plugins/_publisher_apprise/ignore_plugin
View File

@@ -1 +0,0 @@
This plugin will not be loaded

3
front/settings.php
View File

@@ -749,8 +749,7 @@ while ($row = $result -> fetchArray (SQLITE3_ASSOC)) {
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
// --------------------------------------------------------- // ---------------------------------------------------------
// Show last time settings have been imported // Show last time settings have been imported
// getParam("lastImportedTime", "Back_Settings_Imported", skipCache = true);
handleLoadingDialog() handleLoadingDialog()

19
pialert/__main__.py
View File

@@ -24,13 +24,13 @@ import multiprocessing
import conf import conf
from const import * from const import *
from logger import mylog from logger import mylog
from helper import filePermissions, timeNowTZ, updateState, get_setting_value, noti_struc from helper import filePermissions, timeNowTZ, updateState, get_setting_value, noti_obj
from api import update_api from api import update_api
from networkscan import process_scan from networkscan import process_scan
from initialise import importConfigs from initialise import importConfigs
from database import DB, get_all_devices from database import DB
from reporting import get_notifications from reporting import get_notifications
from notifications import Notifications from notification import Notification_obj
from plugin import run_plugin_scripts, check_and_run_user_event from plugin import run_plugin_scripts, check_and_run_user_event
@@ -154,16 +154,13 @@ def main ():
notiStructure = get_notifications(db) notiStructure = get_notifications(db)
# Write the notifications into the DB # Write the notifications into the DB
notification = Notifications(db) notification = Notification_obj(db)
hasNotification = notification.create(notiStructure.json, notiStructure.text, notiStructure.html, "")
# mylog('debug', f"[MAIN] notiStructure.text: {notiStructure.text} ") # run all enabled publisher gateways
# mylog('debug', f"[MAIN] notiStructure.json: {notiStructure.json} ") if hasNotification:
# mylog('debug', f"[MAIN] notiStructure.html: {notiStructure.html} ")
hasNotifications = notification.create(notiStructure.json, notiStructure.text, notiStructure.html, "")
if hasNotifications:
pluginsState = run_plugin_scripts(db, 'on_notification', pluginsState) pluginsState = run_plugin_scripts(db, 'on_notification', pluginsState)
notification.setAllProcessed()
# Commit SQL # Commit SQL

125
pialert/appevent.py Normal file
View File

@@ -0,0 +1,125 @@
import datetime
import json
import uuid
# PiAlert modules
import conf
import const
from const import pialertPath, logPath, apiPath
from logger import logResult, mylog, print_log
from helper import timeNowTZ
#-------------------------------------------------------------------------------
# Execution object handling
#-------------------------------------------------------------------------------
class AppEvent_obj:
def __init__(self, db):
self.db = db
# Create AppEvent table if missing
self.db.sql.execute("""CREATE TABLE IF NOT EXISTS "AppEvents" (
"Index" INTEGER,
"GUID" TEXT UNIQUE,
"DateTimeCreated" TEXT,
"ObjectType" TEXT, -- ObjectType (Plugins, Notifications, Events)
"ObjectGUID" TEXT,
"ObjectPlugin" TEXT,
"ObjectMAC" TEXT,
"ObjectIP" TEXT,
"ObjectPrimaryID" TEXT,
"ObjectSecondaryID" TEXT,
"ObjectForeignKey" TEXT,
"ObjectIndex" TEXT,
"ObjectRowID" TEXT,
"ObjectStatusColumn" TEXT, -- Status (Notifications, Plugins), eve_EventType (Events)
"ObjectStatus" TEXT, -- new_devices, down_devices, events, new, watched-changed, watched-not-changed, missing-in-last-scan, Device down, New Device, IP Changed, Connected, Disconnected, VOIDED - Disconnected, VOIDED - Connected, <missing event>
"AppEventStatus" TEXT, -- TBD "new", "used", "cleanup-next"
"Extra" TEXT,
PRIMARY KEY("Index" AUTOINCREMENT)
);
""")
self.save()
# Create a new DB entry if new notifications are available, otherwise skip
def create(self, Extra="", **kwargs):
# Check if nothing to report, end
if not any(kwargs.values()):
return False
# Continue and save into DB if notifications are available
self.GUID = str(uuid.uuid4())
self.DateTimeCreated = timeNowTZ()
self.ObjectType = "Plugins" # Modify ObjectType as needed
# Optional parameters
self.ObjectGUID = kwargs.get("ObjectGUID", "")
self.ObjectPlugin = kwargs.get("ObjectPlugin", "")
self.ObjectMAC = kwargs.get("ObjectMAC", "")
self.ObjectIP = kwargs.get("ObjectIP", "")
self.ObjectPrimaryID = kwargs.get("ObjectPrimaryID", "")
self.ObjectSecondaryID = kwargs.get("ObjectSecondaryID", "")
self.ObjectForeignKey = kwargs.get("ObjectForeignKey", "")
self.ObjectIndex = kwargs.get("ObjectIndex", "")
self.ObjectRowID = kwargs.get("ObjectRowID", "")
self.ObjectStatusColumn = kwargs.get("ObjectStatusColumn", "")
self.ObjectStatus = kwargs.get("ObjectStatus", "")
self.AppEventStatus = "new" # Modify AppEventStatus as needed
self.Extra = Extra
self.upsert()
return True
# Update the status of the entry
def updateStatus(self, newStatus):
self.ObjectStatus = newStatus
self.upsert()
def upsert(self):
self.db.sql.execute("""
INSERT OR REPLACE INTO AppEvents (
"GUID",
"DateTimeCreated",
"ObjectType",
"ObjectGUID",
"ObjectPlugin",
"ObjectMAC",
"ObjectIP",
"ObjectPrimaryID",
"ObjectSecondaryID",
"ObjectForeignKey",
"ObjectIndex",
"ObjectRowID",
"ObjectStatusColumn",
"ObjectStatus",
"AppEventStatus",
"Extra"
)
VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)
""", (
self.GUID,
self.DateTimeCreated,
self.ObjectType,
self.ObjectGUID,
self.ObjectPlugin,
self.ObjectMAC,
self.ObjectIP,
self.ObjectPrimaryID,
self.ObjectSecondaryID,
self.ObjectForeignKey,
self.ObjectIndex,
self.ObjectRowID,
self.ObjectStatusColumn,
self.ObjectStatus,
self.AppEventStatus,
self.Extra
))
self.save()
def save(self):
# Commit changes
self.db.commitDB()

11
pialert/database.py
View File

@@ -6,7 +6,7 @@ import sqlite3
from const import fullDbPath, sql_devices_stats, sql_devices_all from const import fullDbPath, sql_devices_stats, sql_devices_all
from logger import mylog from logger import mylog
from helper import json_struc, initOrSetParam, row_to_json, timeNowTZ #, updateState from helper import json_obj, initOrSetParam, row_to_json, timeNowTZ #, updateState
@@ -208,10 +208,7 @@ class DB():
"par_ID" TEXT PRIMARY KEY, "par_ID" TEXT PRIMARY KEY,
"par_Value" TEXT "par_Value" TEXT
); );
""") """)
# Initialize Parameters if unavailable
initOrSetParam(self, 'Back_App_State','Initializing')
# ------------------------------------------------------------------------- # -------------------------------------------------------------------------
# Nmap_Scan table setup DEPRECATED after 1/1/2024 # Nmap_Scan table setup DEPRECATED after 1/1/2024
@@ -384,7 +381,7 @@ class DB():
rows = self.sql.fetchall() rows = self.sql.fetchall()
except sqlite3.Error as e: except sqlite3.Error as e:
mylog('none',[ '[Database] - SQL ERROR: ', e]) mylog('none',[ '[Database] - SQL ERROR: ', e])
return None return json_obj({}, []) # return empty object
result = {"data":[]} result = {"data":[]}
for row in rows: for row in rows:
@@ -392,7 +389,7 @@ class DB():
result["data"].append(tmp) result["data"].append(tmp)
# mylog('debug',[ '[Database] - get_table_as_json - returning ', len(rows), " rows with columns: ", columnNames]) # mylog('debug',[ '[Database] - get_table_as_json - returning ', len(rows), " rows with columns: ", columnNames])
return json_struc(result, columnNames) return json_obj(result, columnNames)
#------------------------------------------------------------------------------- #-------------------------------------------------------------------------------
# referece from here: https://codereview.stackexchange.com/questions/241043/interface-class-for-sqlite-databases # referece from here: https://codereview.stackexchange.com/questions/241043/interface-class-for-sqlite-databases

4
pialert/helper.py
View File

@@ -613,13 +613,13 @@ def initOrSetParam(db, parID, parValue):
db.commitDB() db.commitDB()
#------------------------------------------------------------------------------- #-------------------------------------------------------------------------------
class json_struc: class json_obj:
def __init__(self, jsn, columnNames): def __init__(self, jsn, columnNames):
self.json = jsn self.json = jsn
self.columnNames = columnNames self.columnNames = columnNames
#------------------------------------------------------------------------------- #-------------------------------------------------------------------------------
class noti_struc: class noti_obj:
def __init__(self, json, text, html): def __init__(self, json, text, html):
self.json = json self.json = json
self.text = text self.text = text

10
pialert/initialise.py
View File

@@ -134,13 +134,6 @@ def importConfigs (db):
conf.WEBHOOK_SIZE = ccd('WEBHOOK_SIZE', 1024 , c_d, 'Payload size', 'integer', '', 'Webhooks') conf.WEBHOOK_SIZE = ccd('WEBHOOK_SIZE', 1024 , c_d, 'Payload size', 'integer', '', 'Webhooks')
conf.WEBHOOK_SECRET = ccd('WEBHOOK_SECRET', '' , c_d, 'Secret', 'text', '', 'Webhooks') conf.WEBHOOK_SECRET = ccd('WEBHOOK_SECRET', '' , c_d, 'Secret', 'text', '', 'Webhooks')
# Apprise
conf.REPORT_APPRISE = ccd('REPORT_APPRISE', False , c_d, 'Enable Apprise', 'boolean', '', 'Apprise', ['test'])
conf.APPRISE_HOST = ccd('APPRISE_HOST', '' , c_d, 'Apprise host URL', 'text', '', 'Apprise')
conf.APPRISE_URL = ccd('APPRISE_URL', '' , c_d, 'Apprise notification URL', 'text', '', 'Apprise')
conf.APPRISE_PAYLOAD = ccd('APPRISE_PAYLOAD', 'html' , c_d, 'Payload type', 'text.select', "['html', 'text']", 'Apprise')
conf.APPRISE_SIZE = ccd('APPRISE_SIZE', 1024 , c_d, 'Payload size', 'integer', '', 'Apprise')
# NTFY # NTFY
conf.REPORT_NTFY = ccd('REPORT_NTFY', False , c_d, 'Enable NTFY', 'boolean', '', 'NTFY', ['test']) conf.REPORT_NTFY = ccd('REPORT_NTFY', False , c_d, 'Enable NTFY', 'boolean', '', 'NTFY', ['test'])
conf.NTFY_HOST = ccd('NTFY_HOST', 'https://ntfy.sh' , c_d, 'NTFY host URL', 'text', '', 'NTFY') conf.NTFY_HOST = ccd('NTFY_HOST', 'https://ntfy.sh' , c_d, 'NTFY host URL', 'text', '', 'NTFY')
@@ -261,9 +254,6 @@ def importConfigs (db):
sql.execute ("DELETE FROM Settings") sql.execute ("DELETE FROM Settings")
sql.executemany ("""INSERT INTO Settings ("Code_Name", "Display_Name", "Description", "Type", "Options", sql.executemany ("""INSERT INTO Settings ("Code_Name", "Display_Name", "Description", "Type", "Options",
"RegEx", "Value", "Group", "Events" ) VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?)""", conf.mySettingsSQLsafe) "RegEx", "Value", "Group", "Events" ) VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?)""", conf.mySettingsSQLsafe)
# Is used to display a message in the UI when old (outdated) settings are loaded
initOrSetParam(db, "Back_Settings_Imported",(round(time.time() * 1000),) )
#commitDB(sql_connection) #commitDB(sql_connection)
db.commitDB() db.commitDB()

33
pialert/notifications.py → pialert/notification.py
View File

@@ -12,7 +12,7 @@ from helper import timeNowTZ
#------------------------------------------------------------------------------- #-------------------------------------------------------------------------------
# Notification object handling # Notification object handling
#------------------------------------------------------------------------------- #-------------------------------------------------------------------------------
class Notifications: class Notification_obj:
def __init__(self, db): def __init__(self, db):
self.db = db self.db = db
@@ -35,11 +35,9 @@ class Notifications:
self.save() self.save()
# Create a new DB entry if new notiifcations available, otherwise skip # Create a new DB entry if new notiifcations available, otherwise skip
def create(self, JSON, Text, HTML, Extra=""): def create(self, JSON, Text, HTML, Extra=""):
# Check if empty JSON # Check if nothing to report, end
# _json = json.loads(JSON)
# Check if nothing to report
if JSON["internet"] == [] and JSON["new_devices"] == [] and JSON["down_devices"] == [] and JSON["events"] == [] and JSON["plugins"] == []: if JSON["internet"] == [] and JSON["new_devices"] == [] and JSON["down_devices"] == [] and JSON["events"] == [] and JSON["plugins"] == []:
self.HasNotifications = False self.HasNotifications = False
# end if nothing to report # end if nothing to report
@@ -75,6 +73,7 @@ class Notifications:
# TODO Index vs hash to minimize SQL calls, finish CRUD operations, expose via API, use API in plugins # TODO Index vs hash to minimize SQL calls, finish CRUD operations, expose via API, use API in plugins
# create or update a notification
def upsert(self): def upsert(self):
self.db.sql.execute(""" self.db.sql.execute("""
INSERT OR REPLACE INTO Notifications (GUID, DateTimeCreated, DateTimePushed, Status, JSON, Text, HTML, PublishedVia, Extra) INSERT OR REPLACE INTO Notifications (GUID, DateTimeCreated, DateTimePushed, Status, JSON, Text, HTML, PublishedVia, Extra)
@@ -83,6 +82,28 @@ class Notifications:
self.save() self.save()
# Get all with the "new" status
def getNew(self):
self.db.sql.execute("""
SELECT * FROM Notifications
WHERE Status = "new"
""")
return self.db.sql.fetchall()
# Set all to "processed" status
def setAllProcessed(self):
# Execute an SQL query to update the status of all notifications
self.db.sql.execute("""
UPDATE Notifications
SET Status = "processed"
WHERE Status = "new"
""")
self.save()
def save(self): def save(self):
# Commit changes # Commit changes
self.db.commitDB() self.db.commitDB()

2
pialert/plugin.py
View File

@@ -791,7 +791,7 @@ def handle_test(testType):
# Open json sample and get only the payload part # 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"] sample_json_payload = json.loads(get_file_content(pialertPath + '/back/webhook_json_sample.json'))[0]["body"]["attachments"][0]["text"]
sample_msg = noti_struc(sample_json_payload, sample_txt, sample_html, "test_sample") sample_msg = noti_obj(sample_json_payload, sample_txt, sample_html, "test_sample")
if testType == 'Email': if testType == 'Email':

4
pialert/publishers/apprise.py
View File

@@ -2,7 +2,7 @@
import json import json
import subprocess import subprocess
import conf import conf
from helper import noti_struc from helper import noti_obj
from logger import logResult, mylog from logger import logResult, mylog
#------------------------------------------------------------------------------- #-------------------------------------------------------------------------------
@@ -14,7 +14,7 @@ def check_config():
return True return True
#------------------------------------------------------------------------------- #-------------------------------------------------------------------------------
def send(msg: noti_struc): def send(msg: noti_obj):
html = msg.html html = msg.html
text = msg.text text = msg.text

4
pialert/publishers/email.py
View File

@@ -7,7 +7,7 @@ import smtplib
import conf import conf
import socket import socket
from helper import hide_email, noti_struc from helper import hide_email, noti_obj
from logger import mylog, print_log from logger import mylog, print_log
#------------------------------------------------------------------------------- #-------------------------------------------------------------------------------
@@ -19,7 +19,7 @@ def check_config ():
return True return True
#------------------------------------------------------------------------------- #-------------------------------------------------------------------------------
def send (msg: noti_struc): def send (msg: noti_obj):
pText = msg.text pText = msg.text
pHTML = msg.html pHTML = msg.html

4
pialert/publishers/ntfy.py
View File

@@ -4,7 +4,7 @@ import requests
from base64 import b64encode from base64 import b64encode
from logger import mylog from logger import mylog
from helper import noti_struc from helper import noti_obj
#------------------------------------------------------------------------------- #-------------------------------------------------------------------------------
def check_config(): def check_config():
@@ -15,7 +15,7 @@ def check_config():
return True return True
#------------------------------------------------------------------------------- #-------------------------------------------------------------------------------
def send (msg: noti_struc): def send (msg: noti_obj):
headers = { headers = {
"Title": "Pi.Alert Notification", "Title": "Pi.Alert Notification",

4
pialert/publishers/pushsafer.py
View File

@@ -3,7 +3,7 @@ import requests
import conf import conf
from helper import noti_struc from helper import noti_obj
from logger import mylog from logger import mylog
#------------------------------------------------------------------------------- #-------------------------------------------------------------------------------
@@ -15,7 +15,7 @@ def check_config():
return True return True
#------------------------------------------------------------------------------- #-------------------------------------------------------------------------------
def send ( msg:noti_struc ): def send ( msg:noti_obj ):
_Text = msg.text _Text = msg.text
url = 'https://www.pushsafer.com/api' url = 'https://www.pushsafer.com/api'
post_fields = { post_fields = {

4
pialert/publishers/webhook.py
View File

@@ -5,7 +5,7 @@ import hmac
import conf import conf
from const import logPath from const import logPath
from helper import noti_struc, write_file from helper import noti_obj, write_file
from logger import logResult, mylog from logger import logResult, mylog
#------------------------------------------------------------------------------- #-------------------------------------------------------------------------------
@@ -18,7 +18,7 @@ def check_config():
#------------------------------------------------------------------------------- #-------------------------------------------------------------------------------
def send (msg: noti_struc): def send (msg: noti_obj):
# limit = 1024 * 1024 # 1MB limit (1024 bytes * 1024 bytes = 1MB) # limit = 1024 * 1024 # 1MB limit (1024 bytes * 1024 bytes = 1MB)
limit = conf.WEBHOOK_SIZE limit = conf.WEBHOOK_SIZE

18
pialert/reporting.py
View File

@@ -21,7 +21,7 @@ from json2table import convert
import conf import conf
import const import const
from const import pialertPath, logPath, apiPath from const import pialertPath, logPath, apiPath
from helper import noti_struc, generate_mac_links, removeDuplicateNewLines, timeNowTZ, hide_email, updateState, get_file_content, write_file from helper import noti_obj, generate_mac_links, removeDuplicateNewLines, timeNowTZ, hide_email, updateState, get_file_content, write_file
from logger import logResult, mylog, print_log from logger import logResult, mylog, print_log
from publishers.email import (check_config as email_check_config, from publishers.email import (check_config as email_check_config,
@@ -51,7 +51,7 @@ json_final = []
def construct_notifications(db, sqlQuery, tableTitle, skipText = False, suppliedJsonStruct = None): def construct_notifications(db, sqlQuery, tableTitle, skipText = False, suppliedJsonStruct = None):
if suppliedJsonStruct is None and sqlQuery == "": if suppliedJsonStruct is None and sqlQuery == "":
return noti_struc("", "", "") return noti_obj("", "", "")
table_attributes = {"style" : "border-collapse: collapse; font-size: 12px; color:#70707", "width" : "100%", "cellspacing" : 0, "cellpadding" : "3px", "bordercolor" : "#C0C0C0", "border":"1"} table_attributes = {"style" : "border-collapse: collapse; font-size: 12px; color:#70707", "width" : "100%", "cellspacing" : 0, "cellpadding" : "3px", "bordercolor" : "#C0C0C0", "border":"1"}
headerProps = "width='120px' style='color:white; font-size: 16px;' bgcolor='#64a0d6' " headerProps = "width='120px' style='color:white; font-size: 16px;' bgcolor='#64a0d6' "
@@ -61,11 +61,11 @@ def construct_notifications(db, sqlQuery, tableTitle, skipText = False, supplied
text_line = '{}\t{}\n' text_line = '{}\t{}\n'
if suppliedJsonStruct is None: if suppliedJsonStruct is None:
json_struc = db.get_table_as_json(sqlQuery) json_obj = db.get_table_as_json(sqlQuery)
else: else:
json_struc = suppliedJsonStruct json_obj = suppliedJsonStruct
jsn = json_struc.json jsn = json_obj.json
html = "" html = ""
text = "" text = ""
@@ -78,7 +78,7 @@ def construct_notifications(db, sqlQuery, tableTitle, skipText = False, supplied
# Cleanup the generated HTML table notification # Cleanup the generated HTML table notification
html = format_table(html, "data", headerProps, tableTitle).replace('<ul>','<ul style="list-style:none;padding-left:0">').replace("<td>null</td>", "<td></td>") html = format_table(html, "data", headerProps, tableTitle).replace('<ul>','<ul style="list-style:none;padding-left:0">').replace("<td>null</td>", "<td></td>")
headers = json_struc.columnNames headers = json_obj.columnNames
# prepare text-only message # prepare text-only message
if skipText == False: if skipText == False:
@@ -95,7 +95,7 @@ def construct_notifications(db, sqlQuery, tableTitle, skipText = False, supplied
for header in headers: for header in headers:
html = format_table(html, header, thProps) html = format_table(html, header, thProps)
notiStruc = noti_struc(jsn, text, html) notiStruc = noti_obj(jsn, text, html)
if not notiStruc.json['data'] and not notiStruc.text and not notiStruc.html: if not notiStruc.json['data'] and not notiStruc.text and not notiStruc.html:
@@ -263,14 +263,14 @@ def get_notifications (db):
write_file (logPath + '/report_output.txt', final_text) write_file (logPath + '/report_output.txt', final_text)
write_file (logPath + '/report_output.html', final_html) write_file (logPath + '/report_output.html', final_html)
return noti_struc(final_json, final_text, final_html) return noti_obj(final_json, final_text, final_html)
# # Notify is something to report # # Notify is something to report
# if hasNotifications: # if hasNotifications:
# mylog('none', ['[Notification] Changes detected, sending reports']) # mylog('none', ['[Notification] Changes detected, sending reports'])
# msg = noti_struc(json_final, mail_text, mail_html) # msg = noti_obj(json_final, mail_text, mail_html)
# mylog('minimal', ['[Notification] Udating API files']) # mylog('minimal', ['[Notification] Udating API files'])
# send_api() # send_api()