Plugins 0.3 - SQL call fix and additional UI controls

back/pialert.py

@@ -3906,8 +3906,6 @@ def process_plugin_events(plugin):
     # ----------------------------
 
     # Update the Plugin_Objects    
-    
-    sql.execute ("DELETE FROM Plugins_Objects")
 
     for plugObj in pluginObjects: 
 
@@ -3915,8 +3913,10 @@ def process_plugin_events(plugin):
 
         if plugObj.status == 'new':
             createdTime = plugObj.changed        
+        
+        q = f"UPDATE Plugins_Objects set Plugin = '{plugObj.pluginPref}', DateTimeChanged = '{plugObj.changed}', Watched_Value1 = '{plugObj.watched1}', Watched_Value2 = '{plugObj.watched2}', Watched_Value3 = '{plugObj.watched3}', Watched_Value4 = '{plugObj.watched4}', Status = '{plugObj.status}', Extra = '{plugObj.extra}' WHERE 'Index' = {plugObj.index}"
 
-        sql.execute ("INSERT INTO Plugins_Objects (Plugin, Object_PrimaryID, Object_SecondaryID, DateTimeCreated, DateTimeChanged, Watched_Value1, Watched_Value2, Watched_Value3, Watched_Value4, Status, Extra, UserData) VALUES (?,?,?,?,?,?,?,?,?,?,?,?)", (plugObj.pluginPref, plugObj.primaryId , plugObj.secondaryId , createdTime, plugObj.changed , plugObj.watched1 , plugObj.watched2 , plugObj.watched3 , plugObj.watched4 , plugObj.status , plugObj.extra, plugObj.userData ))    
+        sql.execute (q)
 
     # Update the Plugins_Events with the new statuses    
     
@@ -3929,7 +3929,7 @@ def process_plugin_events(plugin):
         if plugObj.status == 'new':
             createdTime = plugObj.changed        
 
-        sql.execute ("INSERT INTO Plugins_Events (Index, Plugin, Object_PrimaryID, Object_SecondaryID, DateTimeCreated, DateTimeChanged, Watched_Value1, Watched_Value2, Watched_Value3, Watched_Value4, Status,  Extra, UserData) VALUES (?,?,?,?,?,?,?,?,?,?,?,?)", (plugObj.index, plugObj.pluginPref, plugObj.primaryId , plugObj.secondaryId , createdTime, plugObj.changed , plugObj.watched1 , plugObj.watched2 , plugObj.watched3 , plugObj.watched4 , plugObj.status , plugObj.extra, plugObj.userData ))    
+        sql.execute ("INSERT INTO Plugins_Events (Plugin, Object_PrimaryID, Object_SecondaryID, DateTimeCreated, DateTimeChanged, Watched_Value1, Watched_Value2, Watched_Value3, Watched_Value4, Status,  Extra, UserData) VALUES (?,?,?,?,?,?,?,?,?,?,?,?)", (plugObj.pluginPref, plugObj.primaryId , plugObj.secondaryId , createdTime, plugObj.changed , plugObj.watched1 , plugObj.watched2 , plugObj.watched3 , plugObj.watched4 , plugObj.status , plugObj.extra, plugObj.userData ))    
 
         commitDB()
 

front/plugins.php

@@ -38,7 +38,7 @@
 
 // -----------------------------------------------------------------------------
 // Get form control according to the column definition from config.json > database_column_definitions
-function getFormControl(index, dbColumnDef, value) {    
+function getFormControl(dbColumnDef, value, index) {    
 
     result = ''
 
@@ -47,8 +47,13 @@ function getFormControl(index, dbColumnDef, value) {
         case 'label':
             result = `<span>${value}<span>`;
             break;
-        case 'text':
+        case 'textboxsave':
-            result = `<span><input type="text" value="${value}" id="${dbColumnDef.column}_${index}" name="${dbColumnDef.column}"><span>`;
+            result =    `<span class="form-group">
+                            <div class="input-group">
+                                <input class="form-control" type="text" value="${value}" id="${dbColumnDef.column}_${index}" name="${dbColumnDef.column}">
+                                <span class="input-group-addon"><i class="fa fa-save pointer" onclick="alert('${dbColumnDef.column}_${index}');"></i></span>
+                            </div>
+                        <span>`;
             break;
         case 'url':
             result = `<span><a href="${value}" target="_blank">${value}</a><span>`;
@@ -66,7 +71,7 @@ function getFormControl(index, dbColumnDef, value) {
             $.each(dbColumnDef.options, function(index, obj) {
                 if(value == obj.equals)
                 {
-                    result = `<span>${obj.replacement}</span>`
+                    result = `<span title="${value}">${obj.replacement}</span>`
                 }
             });
             break;
@@ -203,7 +208,7 @@ function generateTabs()
                 for(j=0;j<colDefinitions.length;j++) 
                 {   
                     
-                    clm += '<td>'+ getFormControl(i, colDefinitions[j], pluginObjects[i][colDefinitions[j].column]) +'</td>'
+                    clm += '<td>'+ getFormControl(colDefinitions[j], pluginObjects[i][colDefinitions[j].column], pluginObjects[i]["Index"]) +'</td>'
                 }                   
                 obRows += '<tr>' + clm + '</tr>'
             }            

front/plugins/README.md

@@ -234,343 +234,4 @@ Example:
 
 ## Full Example
 
-```json
+Check the [website_monitor WEBMON) config.json](https://github.com/jokob-sk/Pi.Alert/blob/main/front/plugins/website_monitor/config.json) file for details.  
-{
-    "code_name": "website_monitor",
-    "unique_prefix": "WEBMON",
-    "localized": ["display_name", "description", "icon"],
-    "display_name" : [{
-        "language_code":"en_us",
-        "string" : "Website monitor"
-    }],
-    "icon":[{
-        "language_code":"en_us",
-        "string" : "<i class=\"fa-solid fa-globe\"></i>"
-    }],     
-    "description": [{
-        "language_code":"en_us",
-        "string" : "This plugin is to monitor status changes of different services or websites."
-    }],
-    "params" : [{
-        "name"  : "macs",
-        "type"  : "sql",
-        "value" : "SELECT dev_MAC from DEVICES"
-    },
-    {
-        "name"  : "urls",
-        "type"  : "setting",
-        "value" : "WEBMON_urls_to_check"
-    },
-    {
-        "name"  : "internet_ip",
-        "type"  : "setting",
-        "value" : "WEBMON_SQL_internet_ip"
-    }],  
-    "database_column_definitions":
-    [          
-        {
-            "column": "Index",
-            "show": false,
-            "type": "label",            
-            "default_value":"",
-            "options": [],
-            "localized": ["name"],
-            "name":[{
-                "language_code":"en_us",
-                "string" : "N/A"
-                }]
-        } ,
-        {
-            "column": "Plugin",
-            "show": false,
-            "type": "label",            
-            "default_value":"",
-            "options": [],
-            "localized": ["name"],
-            "name":[{
-                "language_code":"en_us",
-                "string" : "N/A"
-                }]
-        },
-        {
-            "column": "Object_PrimaryID",
-            "show": true,
-            "type": "text",            
-            "default_value":"",
-            "options": [],
-            "localized": ["name"],
-            "name":[{
-                "language_code":"en_us",
-                "string" : "Monitored URL"
-                }]
-        },
-        {
-            "column": "Object_SecondaryD",
-            "show": false,
-            "type": "label",            
-            "default_value":"",
-            "options": [],
-            "localized": ["name"],
-            "name":[{
-                "language_code":"en_us",
-                "string" : "N/A"
-                }]
-        } ,
-        {
-            "column": "DateTimeCreated",
-            "show": true,
-            "type": "text",            
-            "default_value":"",
-            "options": [],
-            "localized": ["name"],
-            "name":[{
-                "language_code":"en_us",
-                "string" : "Created"
-                }]
-        },
-        {
-            "column": "DateTimeChanged",
-            "show": true,
-            "type": "text",            
-            "default_value":"",
-            "options": [],
-            "localized": ["name"],
-            "name":[{
-                "language_code":"en_us",
-                "string" : "Changed"
-                }]
-        },
-        {
-            "column": "Watched_Value1",
-            "show": true,
-            "type": "text",            
-            "default_value":"",
-            "options": [],
-            "localized": ["name"],
-            "name":[{
-                "language_code":"en_us",
-                "string" : "Status code"
-                }]
-        },
-        {
-            "column": "Watched_Value2",
-            "show": true,
-            "type": "text",            
-            "default_value":"",
-            "options": [],
-            "localized": ["name"],
-            "name":[{
-                "language_code":"en_us",
-                "string" : "Latency"
-                }]
-        },
-        {
-            "column": "Watched_Value3",
-            "show": false,
-            "type": "label",            
-            "default_value":"",
-            "options": [],
-            "localized": ["name"],
-            "name":[{
-                "language_code":"en_us",
-                "string" : "N/A"
-                }]
-        } ,
-        {
-            "column": "Watched_Value4",
-            "show": false,
-            "type": "label",            
-            "default_value":"",
-            "options": [],
-            "localized": ["name"],
-            "name":[{
-                "language_code":"en_us",
-                "string" : "N/A"
-                }]
-        } ,       
-        {
-            "column": "UserData",
-            "show": true,
-            "type": "text",            
-            "default_value":"",
-            "options": [],
-            "localized": ["name"],
-            "name":[{
-                "language_code":"en_us",
-                "string" : "Comments"
-                }]
-        },        
-        {
-            "column": "Status",
-            "show": true,
-            "type": "equals",            
-            "default_value":"",
-            "options": [],
-            "localized": ["name"],
-            "name":[{
-                "language_code":"en_us",
-                "string" : "Status"
-                }]
-        },        
-        {
-            "column": "Extra",
-            "show": false,
-            "type": "label",            
-            "default_value":"",
-            "options": [],
-            "localized": ["name"],
-            "name":[{
-                "language_code":"en_us",
-                "string" : "Extra"
-                }]
-        }            
-    ],
-    "settings":[
-        {
-            "function": "RUN",            
-            "type": "selecttext",            
-            "default_value":"disabled",
-            "options": ["disabled", "once", "schedule", "always_after_scan", "on_new_device"],
-            "localized": ["name", "description"],
-            "name" :[{
-                "language_code":"en_us",
-                "string" : "When to run"
-            }],
-            "description": [{
-                "language_code":"en_us",
-                "string" : "Enable a regular scan of your services. 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=\"#WEBMON_RUN_TIMEOUT\"><code>WEBMON_RUN_TIMEOUT</code> setting</a>."
-            }]
-        },
-        {
-            "function": "CMD",
-            "type": "text",
-            "default_value":"python3 /home/pi/pialert/front/plugins/website_monitor/script.py urls={urls}",
-            "options": [],
-            "localized": ["name", "description"],
-            "name" : [{
-                "language_code":"en_us",
-                "string" : "Command"
-            }],
-            "description": [{
-                "language_code":"en_us",
-                "string" : "Command to run"
-            }]
-        },
-        {
-            "function": "RUN_SCHD",
-            "type": "text",
-            "default_value":"0 2 * * *",
-            "options": [],
-            "localized": ["name", "description"],
-            "name" : [{
-                "language_code":"en_us",
-                "string" : "Schedule"
-            }],
-            "description": [{
-                "language_code":"en_us",
-                "string" : "Only enabled if you select <code>schedule</code> in the <a href=\"#WEBMON_RUN\"><code>WEBMON_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."
-            }]
-        },
-        {
-            "function": "API_SQL",
-            "type": "text",
-            "default_value":"SELECT * FROM plugin_website_monitor",
-            "options": [],
-            "localized": ["name", "description"],
-            "name" : [{
-                "language_code":"en_us",
-                "string" : "API endpoint"
-            }],
-            "description": [{
-                "language_code":"en_us",
-                "string" : "You can specify a custom SQL query which will generate a JSON file and then expose it via the <a href=\"/api/plugin_website_monitor.json\" target=\"_blank\"><code>plugin_website_monitor.json</code> file endpoint</a>."
-            }]            
-        },
-        {
-            "function": "RUN_TIMEOUT",
-            "type": "integer",
-            "default_value":5,
-            "options": [],
-            "localized": ["name", "description"],
-            "name" : [{
-                "language_code":"en_us",
-                "string" : "Run timeout"
-            },
-            {
-                "language_code":"de_de",
-                "string" : "Wartezeit"
-            }],
-            "description": [{
-                "language_code":"en_us",
-                "string" : "Maximum time in seconds to wait for a Website monitor check to finish for any url."
-            }]
-        },
-        {
-            "function": "WATCH",
-            "type": "multiselect",
-            "default_value":["Watched_Value1"],
-            "options": ["Watched_Value1","Watched_Value2","Watched_Value3","Watched_Value4"],
-            "localized": ["name", "description"],
-            "name" :[{
-                "language_code":"en_us",
-                "string" : "Watched"
-            }] ,
-            "description":[{
-                "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 response status code (e.g.: 200, 404)</li><li><code>Watched_Value2</code> is Latency (not recommended)</li><li><code>Watched_Value3</code> unused </li><li><code>Watched_Value4</code> unused </li></ul>"
-            }] 
-        },
-        {
-            "function": "REPORT_ON",
-            "type": "multiselect",
-            "default_value":["new","watched-changed"],
-            "options": ["new","watched-changed","watched-not-changed"],
-            "localized": ["name", "description"],
-            "name" :[{
-                "language_code":"en_us",
-                "string" : "Report on"
-            }] ,
-            "description":[{
-                "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."
-            }] 
-        },
-        {
-            "function": "urls_to_check",
-            "type": "list",
-            "default_value":[],
-            "options": [],
-            "localized": ["name", "description"],
-            "name" : [{
-                "language_code":"en_us",
-                "string" : "Arguments"
-            }],
-            "description": [{
-                "language_code":"en_us",
-                "string" : "Services to watch. Enter full URL, e.g. <code>https://google.com</code>."
-            }]
-        },
-        {
-            "function": "SQL_internet_ip",
-            "type": "readonly",
-            "default_value":"SELECT dev_LastIP FROM Devices WHERE dev_MAC = 'Internet'",
-            "options": [],
-            "localized": ["name", "description"],
-            "name" : [{
-                "language_code":"en_us",
-                "string" : "Helper variable"
-            }],
-            "description": [{
-                "language_code":"en_us",
-                "string" : "Unused setting - for demonstration only. Getting the IP address of the Router / Internet. "
-            }]
-        }
-
-    ]
-}
-
-
-
-
-
-```

front/plugins/website_monitor/config.json

@@ -175,7 +175,7 @@
         {
             "column": "UserData",
             "show": true,
-            "type": "text",            
+            "type": "textboxsave",            
             "default_value":"",
             "options": [],
             "localized": ["name"],

front/settings.php

@@ -121,7 +121,7 @@ while ($row = $result -> fetchArray (SQLITE3_ASSOC)) {
             // text - textbox
             if($set['Type'] == 'text' ) 
             {
-              $input = '<input class="form-control" onChange="settingsChanged()" input" id="'.$set['Code_Name'].'" value="'.$set['Value'].'"/>';                
+              $input = '<input class="form-control" onChange="settingsChanged()" id="'.$set['Code_Name'].'" value="'.$set['Value'].'"/>';                
             } 
             // password - hidden text
             elseif ($set['Type'] == 'password')