Auto delete in-app notifications #1052

front/plugins/__template/rename_me.py

@@ -16,7 +16,8 @@ from plugin_utils import get_plugins_configs
 from logger import mylog, Logger
 from const import pluginsPath, fullDbPath, logPath
 from helper import timeNowTZ, get_setting_value 
-from notification import write_notification
+
+from messaging.in_app import write_notification
 import conf
 
 # Make sure the TIMEZONE for logging is correct

front/plugins/__test/test.py

@@ -24,7 +24,7 @@ from plugin_utils import getPluginObject
 from plugin_helper import Plugin_Objects
 from logger import mylog, Logger, append_line_to_file
 from helper import timeNowTZ, get_setting_value, bytes_to_string, sanitize_string, cleanDeviceName
-from notification import Notification_obj
+from models.notification_instance import NotificationInstance
 from database import DB, get_device_stats
 
 pluginName = 'TESTONLY'

front/plugins/_publisher_apprise/apprise.py

@@ -17,7 +17,7 @@ from const import confFileName, logPath
 from plugin_helper import Plugin_Objects
 from logger import mylog, Logger, append_line_to_file
 from helper import timeNowTZ, get_setting_value
-from notification import Notification_obj
+from models.notification_instance import NotificationInstance
 from database import DB
 from pytz import timezone
 
@@ -50,8 +50,8 @@ def main():
     # Initialize the Plugin obj output file
     plugin_objects = Plugin_Objects(RESULT_FILE)
 
-    # Create a Notification_obj instance
-    notifications = Notification_obj(db)
+    # Create a NotificationInstance instance
+    notifications = NotificationInstance(db)
 
     # Retrieve new notifications
     new_notifications = notifications.getNew()

front/plugins/_publisher_email/email_smtp.py

@@ -26,7 +26,7 @@ from const import confFileName, logPath
 from plugin_helper import Plugin_Objects
 from logger import mylog, Logger, append_line_to_file
 from helper import timeNowTZ, get_setting_value, hide_email
-from notification import Notification_obj
+from models.notification_instance import NotificationInstance
 from database import DB
 from pytz import timezone
 
@@ -59,8 +59,8 @@ def main():
     # Initialize the Plugin obj output file
     plugin_objects = Plugin_Objects(RESULT_FILE)
 
-    # Create a Notification_obj instance
-    notifications = Notification_obj(db)
+    # Create a NotificationInstance instance
+    notifications = NotificationInstance(db)
 
     # Retrieve new notifications
     new_notifications = notifications.getNew()

front/plugins/_publisher_mqtt/mqtt.py

@@ -28,7 +28,7 @@ from plugin_utils import getPluginObject
 from plugin_helper import Plugin_Objects
 from logger import mylog, Logger, append_line_to_file
 from helper import timeNowTZ, get_setting_value, bytes_to_string, sanitize_string, normalize_string
-from notification import Notification_obj
+from models.notification_instance import NotificationInstance
 from database import DB, get_device_stats
 from pytz import timezone
 

front/plugins/_publisher_ntfy/ntfy.py

@@ -20,7 +20,7 @@ from const import confFileName, logPath
 from plugin_helper import Plugin_Objects, handleEmpty
 from logger import mylog, Logger, append_line_to_file
 from helper import timeNowTZ, get_setting_value
-from notification import Notification_obj
+from models.notification_instance import NotificationInstance
 from database import DB
 from pytz import timezone
 
@@ -53,8 +53,8 @@ def main():
     # Initialize the Plugin obj output file
     plugin_objects = Plugin_Objects(RESULT_FILE)
 
-    # Create a Notification_obj instance
-    notifications = Notification_obj(db)
+    # Create a NotificationInstance instance
+    notifications = NotificationInstance(db)
 
     # Retrieve new notifications
     new_notifications = notifications.getNew()

front/plugins/_publisher_pushover/pushover.py

@@ -12,7 +12,7 @@ sys.path.extend([f"{INSTALL_PATH}/front/plugins", f"{INSTALL_PATH}/server"])
 from plugin_helper import Plugin_Objects, handleEmpty  # noqa: E402
 from logger import mylog, Logger  # noqa: E402
 from helper import timeNowTZ, get_setting_value, hide_string  # noqa: E402
-from notification import Notification_obj  # noqa: E402
+from models.notification_instance import NotificationInstance  # noqa: E402
 from database import DB  # noqa: E402
 import conf
 from const import confFileName, logPath
@@ -49,8 +49,8 @@ def main():
     # Initialize the Plugin obj output file
     plugin_objects = Plugin_Objects(RESULT_FILE)
 
-    # Create a Notification_obj instance
-    notifications = Notification_obj(db)
+    # Create a NotificationInstance instance
+    notifications = NotificationInstance(db)
 
     # Retrieve new notifications
     new_notifications = notifications.getNew()

front/plugins/_publisher_pushsafer/pushsafer.py

@@ -20,7 +20,7 @@ from const import confFileName, logPath
 from plugin_helper import Plugin_Objects, handleEmpty
 from logger import mylog, Logger, append_line_to_file
 from helper import timeNowTZ, get_setting_value, hide_string
-from notification import Notification_obj
+from models.notification_instance import NotificationInstance
 from database import DB
 from pytz import timezone
 
@@ -53,8 +53,8 @@ def main():
     # Initialize the Plugin obj output file
     plugin_objects = Plugin_Objects(RESULT_FILE)
 
-    # Create a Notification_obj instance
-    notifications = Notification_obj(db)
+    # Create a NotificationInstance instance
+    notifications = NotificationInstance(db)
 
     # Retrieve new notifications
     new_notifications = notifications.getNew()

front/plugins/_publisher_telegram/tg.py

@@ -17,7 +17,7 @@ from const import confFileName, logPath
 from plugin_helper import Plugin_Objects
 from logger import mylog, Logger, append_line_to_file
 from helper import timeNowTZ, get_setting_value
-from notification import Notification_obj
+from models.notification_instance import NotificationInstance
 from database import DB
 from pytz import timezone
 
@@ -51,8 +51,8 @@ def main():
     # Initialize the Plugin obj output file
     plugin_objects = Plugin_Objects(RESULT_FILE)
 
-    # Create a Notification_obj instance
-    notifications = Notification_obj(db)
+    # Create a NotificationInstance instance
+    notifications = NotificationInstance(db)
 
     # Retrieve new notifications
     new_notifications = notifications.getNew()

front/plugins/_publisher_webhook/webhook.py

@@ -23,7 +23,7 @@ from const import logPath, confFileName
 from plugin_helper import Plugin_Objects, handleEmpty
 from logger import mylog, Logger, append_line_to_file
 from helper import timeNowTZ, get_setting_value, hide_string, write_file
-from notification import Notification_obj
+from models.notification_instance import NotificationInstance
 from database import DB
 from pytz import timezone
 
@@ -56,8 +56,8 @@ def main():
     # Initialize the Plugin obj output file
     plugin_objects = Plugin_Objects(RESULT_FILE)
 
-    # Create a Notification_obj instance
-    notifications = Notification_obj(db)
+    # Create a NotificationInstance instance
+    notifications = NotificationInstance(db)
 
     # Retrieve new notifications
     new_notifications = notifications.getNew()

front/plugins/avahi_scan/avahi_scan.py

@@ -16,7 +16,7 @@ from plugin_utils import get_plugins_configs
 from logger import mylog, Logger
 from const import pluginsPath, fullDbPath, logPath
 from helper import timeNowTZ, get_setting_value 
-from notification import write_notification
+from messaging.in_app import write_notification
 from database import DB
 from models.device_instance import DeviceInstance
 import conf

front/plugins/freebox/freebox.py

@@ -25,7 +25,7 @@ from plugin_utils import get_plugins_configs
 from logger import mylog, Logger
 from const import pluginsPath, fullDbPath, logPath
 from helper import timeNowTZ, get_setting_value
-from notification import write_notification
+from messaging.in_app import write_notification
 import conf
 
 # Make sure the TIMEZONE for logging is correct

front/plugins/ipneigh/ipneigh.py

@@ -19,7 +19,7 @@ from plugin_utils import get_plugins_configs
 from logger import mylog, Logger
 from const import pluginsPath, fullDbPath, logPath
 from helper import timeNowTZ, get_setting_value 
-from notification import write_notification
+from messaging.in_app import write_notification
 import conf
 
 # Make sure the TIMEZONE for logging is correct

front/plugins/maintenance/config.json

@@ -243,6 +243,34 @@
           "string": "How many last <code>app.log</code> lines to keep. If <code>LOG_LEVEL</code> is set to <code>debug</code> the app generates about 10000 lines per hour, so when debugging an issue the recommended setting should cover the bug occurence timeframe. For example for a bug with a 3 day periodical appearence the value <code>1000000</code> should be sufficient. Setting this value to <code>1000000</code> generates approximatelly a 50MB <code>app.log</code> file. Set to <code>0</code> to disable log purging."
         }
       ]
+    },
+    {
+      "function": "NOTI_LENGTH",
+      "type": {
+        "dataType": "integer",
+        "elements": [
+          {
+            "elementType": "input",
+            "elementOptions": [{ "type": "number" }],
+            "transformers": []
+          }
+        ]
+      },
+      "default_value": 0,
+      "options": [],
+      "localized": ["name", "description"],
+      "name": [
+        {
+          "language_code": "en_us",
+          "string": "Notifications history"
+        }
+      ],
+      "description": [
+        {
+          "language_code": "en_us",
+          "string": "How many latest in-app Notification entries to keep. Set to <code>0</code> to disable."
+        }
+      ]
     }
   ],
 

front/plugins/maintenance/maintenance.py

@@ -19,6 +19,7 @@ from plugin_helper import Plugin_Object, Plugin_Objects, decodeBase64
 from logger import mylog, Logger, append_line_to_file
 from helper import timeNowTZ, get_setting_value
 from const import logPath, applicationPath
+from messaging.in_app import remove_old
 import conf
 from pytz import timezone
 
@@ -41,6 +42,7 @@ def main():
     mylog('verbose', [f'[{pluginName}] In script'])    
 
     MAINT_LOG_LENGTH = int(get_setting_value('MAINT_LOG_LENGTH'))
+    MAINT_NOTI_LENGTH = int(get_setting_value('MAINT_NOTI_LENGTH'))
 
     # Check if set
     if MAINT_LOG_LENGTH != 0:
@@ -63,7 +65,10 @@ def main():
             
         mylog('verbose', [f'[{pluginName}] Cleanup finished'])      
 
-      
+    # Check if set
+    if MAINT_NOTI_LENGTH != 0:
+        mylog('verbose', [f'[{pluginName}] Cleaning in-app notification history'])  
+        remove_old(MAINT_NOTI_LENGTH)
 
     return 0
 

front/plugins/nbtscan_scan/nbtscan.py

@@ -16,7 +16,7 @@ from plugin_utils import get_plugins_configs
 from logger import mylog, Logger
 from const import pluginsPath, fullDbPath, logPath
 from helper import timeNowTZ, get_setting_value 
-from notification import write_notification
+from messaging.in_app import write_notification
 from database import DB
 from models.device_instance import DeviceInstance
 import conf

front/plugins/omada_sdn_imp/omada_sdn.py

@@ -45,7 +45,7 @@ from plugin_utils import get_plugins_configs
 from logger import mylog, Logger
 from const import pluginsPath, fullDbPath, logPath
 from helper import timeNowTZ, get_setting_value
-from notification import write_notification
+from messaging.in_app import write_notification
 from pytz import timezone
 import conf
 

front/plugins/sync/sync.py

@@ -20,7 +20,7 @@ from logger import mylog, Logger
 from const import pluginsPath, fullDbPath, logPath
 from helper import timeNowTZ, get_setting_value 
 from crypto_utils import encrypt_data
-from notification import write_notification
+from messaging.in_app import write_notification
 import conf
 from pytz import timezone
 

front/plugins/wake_on_lan/wake_on_lan.py

@@ -17,7 +17,7 @@ from plugin_utils import get_plugins_configs
 from logger import mylog, Logger
 from const import pluginsPath, fullDbPath, logPath
 from helper import timeNowTZ, get_setting_value 
-from notification import write_notification
+from messaging.in_app import write_notification
 from database import DB
 from models.device_instance import DeviceInstance
 import conf