diff --git a/back/pialert.py b/back/pialert.py index 4a8d4315..419a7792 100755 --- a/back/pialert.py +++ b/back/pialert.py @@ -50,15 +50,18 @@ sql_devices_stats = "SELECT Online_Devices as online, Down_Devices as down, All sql_nmap_scan_all = "SELECT * FROM Nmap_Scan" sql_pholus_scan_all = "SELECT * FROM Pholus_Scan" sql_events_pending_alert = "SELECT * FROM Events where eve_PendingAlertEmail is not 0" +sql_settings = "SELECT * FROM Settings" #=============================================================================== # PATHS #=============================================================================== pialertPath = '/home/pi/pialert' -logPath = pialertPath + '/front/log' + confPath = "/config/pialert.conf" dbPath = '/db/pialert.db' -pluginsPath = pialertPath + '/front/plugins' + +pluginsPath = pialertPath + '/front/plugins' +logPath = pialertPath + '/front/log' fullConfPath = pialertPath + confPath fullDbPath = pialertPath + dbPath @@ -151,7 +154,7 @@ def checkPermissionsOK(): file_print('------------------------------------------------') return dbR_access and dbW_access and confR_access and confW_access - +#------------------------------------------------------------------------------- def fixPermissions(): # Try fixing access rights if needed chmodCommands = [] @@ -173,6 +176,7 @@ def fixPermissions(): checkPermissionsOK() # Initial check +#------------------------------------------------------------------------------- def initialiseFile(pathToCheck, defaultFile): # if file not readable (missing?) try to copy over the backed-up (default) one if str(os.access(pathToCheck, os.R_OK)) == "False": @@ -255,6 +259,7 @@ def commitDB (): def ccd(key, default, config, name, inputtype, options, group, events=[], desc = "", regex = ""): result = default + # use existing value if already supplied, otehrwise default value is used if key in config: result = config[key] @@ -266,10 +271,10 @@ def ccd(key, default, config, name, inputtype, options, group, events=[], desc = #------------------------------------------------------------------------------- -def importConfig (): +def importConfigs (): # Specify globals so they can be overwritten with the new config - global lastTimeImported, mySettings + global lastTimeImported, mySettings, plugins # General global ENABLE_ARPSCAN, SCAN_SUBNETS, PRINT_LOG, TIMEZONE, PIALERT_WEB_PROTECTION, PIALERT_WEB_PASSWORD, INCLUDED_SECTIONS, SCAN_CYCLE_MINUTES, DAYS_TO_KEEP_EVENTS, REPORT_DASHBOARD_URL, DIG_GET_IP_ARG, UI_LANG # Email @@ -293,7 +298,7 @@ def importConfig (): # Nmap global NMAP_ACTIVE, NMAP_TIMEOUT, NMAP_RUN, NMAP_RUN_SCHD, NMAP_ARGS # API - global ENABLE_API, API_RUN, API_RUN_SCHD, API_RUN_INTERVAL, API_CUSTOM_SQL + global API_RUN, API_RUN_SCHD, API_RUN_INTERVAL, API_CUSTOM_SQL mySettings = [] # reset settings # get config file @@ -394,53 +399,73 @@ def importConfig (): NMAP_RUN_SCHD = ccd('NMAP_RUN_SCHD', '0 2 * * *' , c_d, 'Nmap schedule', 'text', '', 'Nmap') NMAP_ARGS = ccd('NMAP_ARGS', '-p -10000' , c_d, 'Nmap custom arguments', 'text', '', 'Nmap') - # API - ENABLE_API = ccd('ENABLE_API', True , c_d, 'Enable API', 'boolean', '', 'API') + # API API_RUN = ccd('API_RUN', 'schedule' , c_d, 'API execution', 'selecttext', "['none', 'interval', 'schedule']", 'API') API_RUN_SCHD = ccd('API_RUN_SCHD', '*/3 * * * *' , c_d, 'API schedule', 'text', '', 'API') API_RUN_INTERVAL = ccd('API_RUN_INTERVAL', 10 , c_d, 'API update interval', 'integer', '', 'API') API_CUSTOM_SQL = ccd('API_CUSTOM_SQL', 'SELECT * FROM Devices WHERE dev_PresentLastScan = 0' , c_d, 'Custom endpoint', 'text', '', 'API') - #Plugins - plugins = get_plugins_configs() - - file_print('[', timeNow(), '] Plugins: Number of dynamically loaded plugins: ', len(plugins) ) - for plugin in plugins: - file_print(' ---------------------------------------------') - file_print(' Name : ', plugin.display_name ) - file_print(' Description: ', plugin.description.en_us ) - - prefix = plugin.settings_short_prefix - - for set in plugin.settings: - codeName = prefix + "_" + set.type - ccd(codeName, set.default_value , c_d, set.name.en_us, get_setting_type(set), str(set.options), prefix) - - - # Update scheduler - global tz, mySchedules + # Prepare scheduler + global tz, mySchedules, plugins # Init timezone in case it changed tz = timezone(TIMEZONE) # reset schedules - mySchedules = [] - + mySchedules = [] + # init pholus schedule pholusSchedule = Cron(PHOLUS_RUN_SCHD).schedule(start_date=datetime.datetime.now(tz)) - mySchedules.append(serviceSchedule("pholus", pholusSchedule, pholusSchedule.next(), False)) + mySchedules.append(schedule_class("pholus", pholusSchedule, pholusSchedule.next(), False)) # init nmap schedule nmapSchedule = Cron(NMAP_RUN_SCHD).schedule(start_date=datetime.datetime.now(tz)) - mySchedules.append(serviceSchedule("nmap", nmapSchedule, nmapSchedule.next(), False)) + mySchedules.append(schedule_class("nmap", nmapSchedule, nmapSchedule.next(), False)) # init API schedule apiSchedule = Cron(API_RUN_SCHD).schedule(start_date=datetime.datetime.now(tz)) - mySchedules.append(serviceSchedule("api", apiSchedule, apiSchedule.next(), False)) + mySchedules.append(schedule_class("api", apiSchedule, apiSchedule.next(), False)) # Format and prepare the list of subnets updateSubnets() + # Plugins START + # ----------------- + plugins = get_plugins_configs() + + file_print('[', timeNow(), '] Plugins: Number of dynamically loaded plugins: ', len(plugins.dict) ) + + # handle plugins + for plugin in plugins.list: + print_plugin_info(plugin, ['display_name','description']) + + pref = plugin["settings_short_prefix"] + + # collect plugin level language strings + collect_lang_strings(plugin, pref) + + for set in plugin["settings"]: + setType = set["type"] + # Setting code name / key + key = pref + "_" + setType + + v = ccd(key, set["default_value"], c_d, set["name"][0]["string"], get_form_control(set), str(set["options"]), pref) + + # Save the user defined value into the object + set["value"] = v + + # Setup schedules + if setType == 'RUN_SCHD': + newSchedule = Cron(v).schedule(start_date=datetime.datetime.now(tz)) + mySchedules.append(schedule_class(pref, newSchedule, newSchedule.next(), False)) + + # Collect settings related language strings + collect_lang_strings(set, pref + "_" + set["type"]) + # ----------------- + # Plugins END + + + # Insert settings into the DB sql.execute ("DELETE FROM Settings") sql.executemany ("""INSERT INTO Settings ("Code_Name", "Display_Name", "Description", "Type", "Options", @@ -454,6 +479,9 @@ def importConfig (): commitDB() + # update only the settings datasource + update_api(False, ["settings"]) + file_print('[', timeNow(), '] Config: Imported new config') #=============================================================================== @@ -461,6 +489,7 @@ def importConfig (): #=============================================================================== cycle = "" check_report = [1, "internet_IP", "update_vendors_silent"] +plugins_once_run = False # timestamps of last execution times startTime = time_started @@ -480,7 +509,7 @@ def main (): # Initialize global variables global time_started, cycle, last_network_scan, last_internet_IP_scan, last_run, last_cleanup, last_update_vendors, last_API_update # second set of global variables - global startTime, log_timestamp, sql_connection, sql + global startTime, log_timestamp, sql_connection, sql, plugins_once_run # DB sql_connection = None @@ -492,14 +521,19 @@ def main (): # Upgrade DB if needed upgradeDB() - + while True: # update time started time_started = datetime.datetime.now() - # re-load user configuration - importConfig() + # re-load user configuration and plugins + importConfigs() + + # Handle plugins executed ONCE + if plugins_once_run == False: + run_plugin_script('once') + plugins_once_run = True # check if there is a front end initiated event which needs to be executed check_and_run_event() @@ -819,8 +853,8 @@ def cleanup_database (): file_print('[', startTime, '] Upkeep Database:' ) # Cleanup Online History - file_print(' Online_History: Delete all older than 1 day') - sql.execute ("DELETE FROM Online_History WHERE Scan_Date <= date('now', '-1 day')") + file_print(' Online_History: Delete all older than 3 days') + sql.execute ("DELETE FROM Online_History WHERE Scan_Date <= date('now', '-3 day')") file_print(' Optimize Database') # Cleanup Events @@ -3075,7 +3109,7 @@ def upgradeDB (): Extra TEXT NOT NULL, PRIMARY KEY("Index" AUTOINCREMENT) ); """ - # sql.execute(sql_Plugins_State) + sql.execute(sql_Plugins_State) # Plugin execution results sql_Plugin_Events = """ CREATE TABLE IF NOT EXISTS Plugins_Events( @@ -3091,7 +3125,26 @@ def upgradeDB (): Processed TEXT NOT NULL, PRIMARY KEY("Index" AUTOINCREMENT) ); """ - # sql.execute(sql_Plugin_Events) + sql.execute(sql_Plugin_Events) + + # Dynamically generated language strings + # indicates, if Language_Strings table is available + languageStringsMissing = sql.execute(""" + SELECT name FROM sqlite_master WHERE type='table' + AND name='Language_Strings'; + """).fetchone() == None + + if languageStringsMissing == False: + sql.execute("DROP TABLE Language_Strings;") + + sql.execute(""" CREATE TABLE IF NOT EXISTS Language_Strings( + "Index" INTEGER, + Language_Code TEXT NOT NULL, + String_Key TEXT NOT NULL, + String_Value TEXT NOT NULL, + Extra TEXT NOT NULL, + PRIMARY KEY("Index" AUTOINCREMENT) + ); """) commitDB () @@ -3136,11 +3189,7 @@ def to_binary_sensor(input): #=============================================================================== # API #=============================================================================== -def update_api(isNotification = False): - - # Proceed only if enabled in settings - if ENABLE_API == False: - return +def update_api(isNotification = False, updateOnlyDataSources = []): file_print(' [API] Updating files in /front/api') folder = pialertPath + '/front/api/' @@ -3157,15 +3206,18 @@ def update_api(isNotification = False): ["nmap_scan", sql_nmap_scan_all], ["pholus_scan", sql_pholus_scan_all], ["events_pending_alert", sql_events_pending_alert], + ["settings", sql_settings], ["custom_endpoint", API_CUSTOM_SQL] ] # Save selected database tables for dsSQL in dataSourcesSQLs: - json_string = get_table_as_json(dsSQL[1]).json + if updateOnlyDataSources == [] or dsSQL[0] in updateOnlyDataSources: - write_file(folder + 'table_' + dsSQL[0] + '.json' , json.dumps(json_string)) + json_string = get_table_as_json(dsSQL[1]).json + + write_file(folder + 'table_' + dsSQL[0] + '.json' , json.dumps(json_string)) #------------------------------------------------------------------------------- def get_table_as_json(sqlQuery): @@ -3482,25 +3534,49 @@ def isNewVersion(): #------------------------------------------------------------------------------- def get_plugins_configs(): - plugins = [] + pluginsDict = [] + pluginsList = [] for root, dirs, files in os.walk(pluginsPath): for d in dirs: # Loop over directories, not files - - # filelist.append(os.path.join(root, d)) + pluginsDict.append(json.loads(get_file_content(pluginsPath + "/" + d + '/config.json'), object_hook=custom_plugin_decoder)) + pluginsList.append(json.loads(get_file_content(pluginsPath + "/" + d + '/config.json'))) - plugins.append(json.loads(get_file_content(pluginsPath + "/" + d + '/config.json'), object_hook=custom_plugin_decoder)) - return plugins + return plugins_class(pluginsDict, pluginsList) #------------------------------------------------------------------------------- -def get_setting_type(setting): - if setting.type in ['RUN']: +class plugins_class: + def __init__(self, dict, list): + self.dict = dict + self.list = list + +#------------------------------------------------------------------------------- +def collect_lang_strings(json, pref): + + for prop in json["localized"]: + for language_string in json[prop]: + import_language_string(language_string["language_code"], pref + "_" + prop, language_string["string"]) + + +#------------------------------------------------------------------------------- +def import_language_string(code, key, value, extra = ""): + + sql.execute ("""INSERT INTO Language_Strings ("Language_Code", "String_Key", "String_Value", "Extra") VALUES (?, ?, ?, ?)""", (str(code), str(key), str(value), str(extra))) + + commitDB () + +#------------------------------------------------------------------------------- +def get_form_control(setting): + + type = setting["type"] + + if type in ['RUN']: return 'selecttext' - if setting.type in ['ENABLE', 'FORCE_REPORT']: + if type in ['ENABLE', 'FORCE_REPORT']: return 'boolean' - if setting.type in ['TIMEOUT', 'RUN_TIMEOUT']: + if type in ['TIMEOUT', 'RUN_TIMEOUT']: return 'integer' - if setting.type in ['NOTIFY_ON']: + if type in ['WATCH', 'LIST']: return 'multiselect' return 'text' @@ -3509,16 +3585,65 @@ def get_setting_type(setting): def custom_plugin_decoder(pluginDict): return namedtuple('X', pluginDict.keys())(*pluginDict.values()) +#------------------------------------------------------------------------------- +def run_plugin_script(runType): + + global plugins + + for plugin in plugins.list: + set = get_plugin_setting(plugin, "RUN") + if set['value'] == runType: + file_print(' [Plugin] Run') + print_plugin_info(plugin, ['display_name']) + file_print(' [Plugin] CMD', get_plugin_setting(plugin, "CMD")["value"]) + + + +#------------------------------------------------------------------------------- +def get_plugin_setting(plugin, key): + + for set in plugin['settings']: + if set["type"] == key: + return set + + +#------------------------------------------------------------------------------- +def get_plugin_string(props, el): + + result = '' + + if el in props['localized']: + for str in props[el]: + if str['language_code'] == 'en_us': + result = str['string'] + + if result == '': + result = 'en_us string missing' + + else: + result = props[el] + + return result + +#------------------------------------------------------------------------------- +def print_plugin_info(plugin, elements = ['display_name']): + + file_print(' ---------------------------------------------') + + for el in elements: + res = get_plugin_string(plugin, el) + file_print(' ', el ,': ', res) + #------------------------------------------------------------------------------- # Cron-like Scheduling #------------------------------------------------------------------------------- -class serviceSchedule: +class schedule_class: def __init__(self, service, scheduleObject, last_next_schedule, was_last_schedule_used, last_run = 0): self.service = service self.scheduleObject = scheduleObject self.last_next_schedule = last_next_schedule self.last_run = last_run - self.was_last_schedule_used = was_last_schedule_used + self.was_last_schedule_used = was_last_schedule_used def runScheduleCheck(self): result = False diff --git a/docs/API.md b/docs/API.md index 6d58be3c..bd3ca722 100755 --- a/docs/API.md +++ b/docs/API.md @@ -29,6 +29,7 @@ You can access the following files: | `table_nmap_scan.json` | The current state of the discovered ports by the regular NMAP scans. | | `table_pholus_scan.json` | The latest state of the [pholus](https://github.com/jokob-sk/Pi.Alert/tree/main/pholus) (A multicast DNS and DNS Service Discovery Security Assessment Tool) scan results. | | `table_events_pending_alert.json` | The list of the unprocessed (pending) notification events. | + | `table_settings.json` | The content of the settings table. | | `table_custom_endpoint.json` | A custom endpoint generated by the SQL query specified by the `API_CUSTOM_SQL` setting. | Current/latest state of the aforementioned files depends on your settings. diff --git a/front/php/templates/language/en_us.php b/front/php/templates/language/en_us.php index 562e162e..cf2b4495 100755 --- a/front/php/templates/language/en_us.php +++ b/front/php/templates/language/en_us.php @@ -482,7 +482,8 @@ $lang['en_us'] = array( //General -'General_settings_group' => ' General', +'General_display_name' => 'General', +'General_icon' => '', 'ENABLE_ARPSCAN_name' => 'Enable ARP scan', 'ENABLE_ARPSCAN_description' => 'Arp-scan is a command-line tool that uses the ARP protocol to discover and fingerprint IP hosts on the local network. An alternative to ARP scan is to enable the PIHOLE_ACTIVEPiHole integration settings.', 'SCAN_SUBNETS_name' => 'Subnets to scan', @@ -519,7 +520,8 @@ the arp-scan will take hours to complete instead of seconds. 'UI_LANG_description' => 'Select the preferred UI language.', //Email -'Email_settings_group' => ' Email', +'Email_display_name' => 'Email', +'Email_icon' => '', 'REPORT_MAIL_name' => 'Enable email', 'REPORT_MAIL_description' => 'If enabled an email is sent out with a list of changes you\'ve subscribed to. Please also fill out all remaining settings related to the SMTP setup below.', 'SMTP_SERVER_name' => 'SMTP server URL', @@ -542,7 +544,8 @@ the arp-scan will take hours to complete instead of seconds. 'REPORT_FROM_description' => 'Notification email subject line.', //Webhooks -'Webhooks_settings_group' => ' Webhooks', +'Webhooks_display_name' => 'Webhooks', +'Webhooks_icon' => '', 'REPORT_WEBHOOK_name' => 'Enable Webhooks', 'REPORT_WEBHOOK_description' => 'Enable webhooks for notifications. Webhooks help you to connect to a lot of 3rd party tools, such as IFTTT, Zapier or n8n to name a few. Check out this simple n8n guide here to get started. If enabled, configure related settings below.', 'WEBHOOK_URL_name' => 'Target URL', @@ -553,7 +556,8 @@ the arp-scan will take hours to complete instead of seconds. 'WEBHOOK_REQUEST_METHOD_description' => 'The HTTP request method to be used for the webhook call.', // Apprise -'Apprise_settings_group' => ' Apprise', +'Apprise_display_name' => 'Apprise', +'Apprise_icon' => '', 'REPORT_APPRISE_name' => 'Enable Apprise', 'REPORT_APPRISE_description' => 'Enable sending notifications via Apprise.', 'APPRISE_HOST_name' => 'Apprise host URL', @@ -562,7 +566,8 @@ the arp-scan will take hours to complete instead of seconds. 'APPRISE_URL_description' => 'Apprise notification target URL. For example for Telegram it would be tgram://{bot_token}/{chat_id}.', // NTFY -'NTFY_settings_group' => ' NTFY', +'NTFY_display_name' => 'NTFY', +'NTFY_icon' => '', 'REPORT_NTFY_name' => 'Enable NTFY', 'REPORT_NTFY_description' => 'Enable sending notifications via NTFY.', 'NTFY_HOST_name' => 'NTFY host URL', @@ -575,7 +580,8 @@ the arp-scan will take hours to complete instead of seconds. 'NTFY_PASSWORD_description' => 'Enter password if you need (host) an instance with enabled authetication.', // Pushsafer -'PUSHSAFER_settings_group' => ' Pushsafer', +'PUSHSAFER_display_name' => 'Pushsafer', +'PUSHSAFER_icon' => '', 'REPORT_PUSHSAFER_name' => 'Enable Pushsafer', 'REPORT_PUSHSAFER_description' => 'Enable sending notifications via Pushsafer.', 'PUSHSAFER_TOKEN_name' => 'Pushsafer token', @@ -585,7 +591,8 @@ the arp-scan will take hours to complete instead of seconds. // MQTT -'MQTT_settings_group' => ' MQTT', +'MQTT_display_name' => 'MQTT', +'MQTT_icon' => '', 'REPORT_MQTT_name' => 'Enable MQTT', 'REPORT_MQTT_description' => 'Enable sending notifications via MQTT to your Home Assistance instance.', 'MQTT_BROKER_name' => 'MQTT broker URL', @@ -602,7 +609,8 @@ the arp-scan will take hours to complete instead of seconds. 'MQTT_DELAY_SEC_description' => 'A little hack - delay adding to the queue in case the process is restarted and previous publish processes aborted (it takes ~2s to update a sensor config on the broker). Tested with 2-3 seconds of delay. This delay is only applied when devices are created (during the first notification loop). It doesn\'t affect subsequent scans or notifications.', //DynDNS -'DynDNS_settings_group' => ' DynDNS', +'DynDNS_display_name' => 'DynDNS', +'DynDNS_icon' => '', 'DDNS_ACTIVE_name' => 'Enable DynDNS', 'DDNS_ACTIVE_description' => '', 'DDNS_DOMAIN_name' => 'DynDNS domain URL', @@ -615,14 +623,16 @@ the arp-scan will take hours to complete instead of seconds. 'DDNS_UPDATE_URL_description' => 'Update URL starting with http:// or https://.', // PiHole -'PiHole_settings_group' => ' PiHole', +'PiHole_display_name' => 'PiHole', +'PiHole_icon' => '', 'PIHOLE_ACTIVE_name' => 'Enable PiHole mapping', 'PIHOLE_ACTIVE_description' => 'You need to map:/etc/pihole/pihole-FTL.db in the docker-compose.yml file if you enable this setting.', 'DHCP_ACTIVE_name' => 'Enable PiHole DHCP', 'DHCP_ACTIVE_description' => 'You need to map :/etc/pihole/dhcp.leases in the docker-compose.yml file if you enable this setting.', // Pholus -'Pholus_settings_group' => ' Pholus', +'Pholus_display_name' => 'Pholus', +'Pholus_icon' => '', 'PHOLUS_ACTIVE_name' => 'Cycle run', 'PHOLUS_ACTIVE_description' => 'Pholus is a sniffing tool to discover additional information about the devices on the network, including the device name. If enabled this will execute the scan before every network scan cycle until there are no (unknown) or (name not found) devices. Please be aware it can spam the network with unnecessary traffic. Depends on the SCAN_SUBNETS setting. For a scheduled or one-off scan, check the PHOLUS_RUN setting.', 'PHOLUS_TIMEOUT_name' => 'Cycle run timeout', @@ -640,7 +650,8 @@ the arp-scan will take hours to complete instead of seconds. 'PHOLUS_DAYS_DATA_description' => 'How many days of Pholus scan entries should be kept (globally, not device specific!). The pialert_pholus.log file is not touched. Enter 0 to disable.', // Nmap -'Nmap_settings_group' => ' Nmap', +'Nmap_display_name' => 'Nmap', +'Nmap_icon' => '', 'NMAP_ACTIVE_name' => 'Cycle run', 'NMAP_ACTIVE_description' => 'If enabled this will execute a scan on a newly found device. For a scheduled or one-off scan, check the NMAP_RUN setting.', 'NMAP_TIMEOUT_name' => 'Run timeout', @@ -653,7 +664,8 @@ the arp-scan will take hours to complete instead of seconds. 'NMAP_ARGS_description' => 'Arguments used to run the Nmap scan. Be careful to specify the arguments correctly. For example -p -10000 scans ports from 1 to 10000.', // API -'API_settings_group' => ' API', +'API_display_name' => 'API', +'API_icon' => '', 'ENABLE_API_name' => 'Enable API', 'ENABLE_API_description' => 'If enabled the app will start publishing and updating simple API endpoints under the /home/pi/pialert/front/api/ folder and thus on the pialert_url/api/File_name url.', 'API_RUN_name' => 'Scheduling updates', diff --git a/front/php/templates/language/lang.php b/front/php/templates/language/lang.php index 4b0d404b..4b1b1117 100755 --- a/front/php/templates/language/lang.php +++ b/front/php/templates/language/lang.php @@ -5,6 +5,7 @@ // ################################### $defaultLang = "en_us"; +$allLanguages = ["en_us","es_es","de_de"]; global $db; @@ -17,6 +18,20 @@ switch($result){ if (isset($pia_lang_selected) == FALSE or (strlen($pia_lang_selected) == 0)) {$pia_lang_selected = $defaultLang;} +//Language_Strings ("Language_Code", "String_Key", "String_Value", "Extra") +$result = $db->query("SELECT * FROM Language_Strings"); + +// array +$strings = array(); +while ($row = $result -> fetchArray (SQLITE3_ASSOC)) { + // Push row data + $strings[] = array( 'Language_Code' => $row['Language_Code'], + 'String_Key' => $row['String_Key'], + 'String_Value' => $row['String_Value'], + 'Extra' => $row['Extra'] + ); +} + require dirname(__FILE__).'/../skinUI.php'; require dirname(__FILE__).'/en_us.php'; require dirname(__FILE__).'/de_de.php'; @@ -24,7 +39,13 @@ require dirname(__FILE__).'/es_es.php'; function lang($key) { - global $pia_lang_selected, $lang, $defaultLang; + global $pia_lang_selected, $lang, $defaultLang, $strings; + + // get strings from the DB and append them to the ones from the files + foreach ($strings as $string) + { + $lang[$string["Language_Code"]][$string["String_Key"]] = $string["String_Value"]; + } // check if key exists in selected language if(array_key_exists($key, $lang[$pia_lang_selected]) == FALSE) diff --git a/front/plugins/README.md b/front/plugins/README.md index 046e58ad..95d2b322 100755 --- a/front/plugins/README.md +++ b/front/plugins/README.md @@ -12,7 +12,7 @@ If you wish to develop a plugin, please check the existing plugin structure. | `script.py` | yes | The Python script itself | | `last_result.log` | yes | The file used to interface between PiAlert and the plugin (script). | | `script.log` | no | Logging output (recommended) | - | `README.md` | no | Amy setup considerations or overview | + | `README.md` | no | Any setup considerations or overview (recommended) | More on specific files below. @@ -21,7 +21,7 @@ More on specific files below. Used to interface between PiAlert and the plugin (script). After every scan it should contain only the results from the latest scan/execution. -- The format is a `csv`-like file with the pipe `|` separator. 8 (eight) values need to be supplied, so every line needs to contain 7 pipe separators. Empty values arerepresented by `null` +- The format is a `csv`-like file with the pipe `|` separator. 8 (eight) values need to be supplied, so every line needs to contain 7 pipe separators. Empty values are represented by `null` - Don't render "headers" for these "columns" - Every scan result / event entry needs to be on a new line - You can find which "columns" need to be present in the script results and if the value is required below. @@ -66,14 +66,37 @@ https://www.google.com|null|2023-01-02 15:56:30|200|0.7898| ### config.json -#### Supported settings types +##### Setting object struncture -- `RUN` -- `RUN_SCHD` -- `API_SQL` -- `TIMEOUT` -- `NOTIFY_ON` -- `ARGS` +```json +{ + "type": "RUN", + "default_value":"disabled", + "options": ["disabled", "once", "schedule", "always_after_scan", "on_new_device"], + "localized": ["name", "description"], + "name" :[{ + "language_code":"en_us", + "string" : "Run condition" + }, + { + "language_code":"de_de", + "string" : "Ausführungsbedingung" + }], + "description": [{ + "language_code":"en_us", + "string" : "Enable a regular scan of your services. If you select schedule the scheduling settings from below are applied. If you select once the scan is run only once on start of the application (container) for the time specified in WEBMON_TIMEOUT setting." + }] + } +``` +###### Supported settings types + +- `RUN` - (required) Specifies when the service is executed + - Supported Options: "disabled", "once", "schedule" (if included then a `RUN_SCHD` setting needs to be specified), "always_after_scan", "on_new_device" +- `RUN_SCHD` - (required if you include the `RUN`) Cron-like scheduling used if the `RUN` setting set to `schedule` +- `CMD` - (required) What command should be executed. +- `API_SQL` - (optional) Generates a `table_` + code_name + `.json` file as per (API docs)[https://github.com/jokob-sk/Pi.Alert/blob/main/docs/API.md]. +- `TIMEOUT` - (optional) Max execution time of the script. If not specified a default value of 10 seconds is used to prevent hanging. +- `WATCH` - (optional) Which database columns are watched for changes. If not specified no notifications are sent. #### Example @@ -82,102 +105,157 @@ https://www.google.com|null|2023-01-02 15:56:30|200|0.7898| { "code_name": "website_monitor", "settings_short_prefix": "WEBMON", - "display_name" : "Website monitor", - "font_awesome_icon_classses": "fa-solid fa-globe", - "description": { - "en_us" : "This plugin is to monitor status changes of different services or websites." - }, + "localized": ["display_name", "description", "icon"], + "display_name" : [{ + "language_code":"en_us", + "string" : "Website monitor" + }], + "icon":[{ + "language_code":"en_us", + "string" : "" + }], + "argument" : "urls", + "description": [{ + "language_code":"en_us", + "string" : "This plugin is to monitor status changes of different services or websites." + }], "database_column_aliases":{ "Plugins_Events":{ - "Index":{ - "en_us" : "Index" - }, - "Object_PrimaryID":{ - "en_us" : "Monitored URL" - }, - "DateTime":{ - "en_us" : "Checked on" - }, - "Watched_Value1":{ - "en_us" : "Status code" - }, - "Watched_Value2":{ - "en_us" : "Latency" - } + "Index":[{ + "language_code":"en_us", + "string" : "Index" + }], + "Object_PrimaryID":[{ + "language_code":"en_us", + "string" : "Monitored URL" + }], + "DateTime":[{ + "language_code":"en_us", + "string" : "Checked on" + }], + "Watched_Value1":[{ + "language_code":"en_us", + "string" : "Status code" + }], + "Watched_Value2":[{ + "language_code":"en_us", + "string" : "Latency" + }] } }, "settings":[ + { + "type": "ENABLE", + "default_value":"False", + "options": [], + "localized": ["name", "description"], + "name" : [{ + "language_code":"en_us", + "string" : "Enable plugin" + }], + "description": [{ + "language_code":"en_us", + "string" : "Enable a regular scan of your services. You need to enable this setting for anything to be executed regarding this plugin." + }] + }, { "type": "RUN", "default_value":"none", "options": ["none","once","schedule"], - "name" : { - "en_us" : "Schedule" - }, - "description": - { - "en_us" : "Enable a regular scan of your services. If you select schedule the scheduling settings from below are applied. If you select once the scan is run only once on start of the application (container) for the time specified in WEBMON_TIMEOUT setting." - } + "localized": ["name", "description"], + "name" :[{ + "language_code":"en_us", + "string" : "Schedule" + }], + "description": [{ + "language_code":"en_us", + "string" : "Enable a regular scan of your services. If you select schedule the scheduling settings from below are applied. If you select once the scan is run only once on start of the application (container) for the time specified in WEBMON_TIMEOUT setting." + }] + }, + { + "type": "FORCE_REPORT", + "default_value": false, + "options": [], + "localized": ["name", "description"], + "name" : [{ + "language_code":"en_us", + "string" : "Force report" + }], + "description": [{ + "language_code":"en_us", + "string" : "Force a notification message even if there are nochanges detected." + }] }, { "type": "RUN_SCHD", "default_value":"0 2 * * *", - "name" : { - "en_us" : "Schedule" - }, - "description": - { - "en_us" : "Only enabled if you select schedule in the WEBMON_RUN setting. Make sure you enter the schedule in the correct cron-like format (e.g. validate at crontab.guru). For example entering 0 4 * * * will run the scan after 4 am in the TIMEZONE you set above. Will be run NEXT time the time passes." - } - + "options": [], + "localized": ["name", "description"], + "name" : [{ + "language_code":"en_us", + "string" : "Schedule" + }], + "description": [{ + "language_code":"en_us", + "string" : "Only enabled if you select schedule in the WEBMON_RUN setting. Make sure you enter the schedule in the correct cron-like format (e.g. validate at crontab.guru). For example entering 0 4 * * * will run the scan after 4 am in the TIMEZONE you set above. Will be run NEXT time the time passes." + }] }, { "type": "API_SQL", "default_value":"SELECT * FROM plugin_website_monitor", - "name" : { - "en_us" : "API endpoint" - }, - "description": - { - "en_us" : "You can specify a custom SQL query which will generate a JSON file and then expose it via the plugin_website_monitor.json file endpoint." - } - + "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 plugin_website_monitor.json file endpoint." + }] }, { - "type": "TIMEOUT", + "type": "RUN_TIMEOUT", "default_value":5, - "name" : { - "en_us" : "Run timeout" - }, - "description": - { - "en_us" : "Maximum time in seconds to wait for a Website monitor check to finish for any url." - } - + "options": [], + "localized": ["name", "description"], + "name" : [{ + "language_code":"en_us", + "string" : "Run timeout" + }], + "description": [{ + "language_code":"en_us", + "string" : "Maximum time in seconds to wait for a Website monitor check to finish for any url." + }] }, { - "type": "NOTIFY_ON", + "type": "WATCH", "default_value":["Watched_Value1"], "options": ["Watched_Value1","Watched_Value2","Watched_Value3","Watched_Value4"], - "name" : { - "en_us" : "Notify on" - }, - "description": - { - "en_us" : "Send a notification if selected values change. Use CTRL + Click to select/deselect. " - } + "localized": ["name", "description"], + "name" :[{ + "language_code":"en_us", + "string" : "Notify on" + }] , + "description":[{ + "language_code":"en_us", + "string" : "Send a notification if selected values change. Use CTRL + Click to select/deselect. " + }] }, { "type": "ARGS", "default_value":"", - "name" : { - "en_us" : "Run timeout" - }, - "description": - { - "en_us" : "Change the dig utility arguments if you have issues resolving your Internet IP. Arguments are added at the end of the following command: dig +short ." - } + "options": [], + "localized": ["name", "description"], + "name" : [{ + "language_code":"en_us", + "string" : "Arguments" + }], + "description": [{ + "language_code":"en_us", + "string" : "Change the dig utility arguments if you have issues resolving your Internet IP. Arguments are added at the end of the following command: dig +short ." + }] } ] @@ -185,4 +263,5 @@ https://www.google.com|null|2023-01-02 15:56:30|200|0.7898| + ``` diff --git a/front/plugins/website_monitoring/config.json b/front/plugins/website_monitoring/config.json index f0edbd8e..d3025fdf 100755 --- a/front/plugins/website_monitoring/config.json +++ b/front/plugins/website_monitoring/config.json @@ -1,132 +1,170 @@ { "code_name": "website_monitor", "settings_short_prefix": "WEBMON", - "display_name" : "Website monitor", - "font_awesome_icon_classses": "fa-solid fa-globe", - "description": { - "en_us" : "This plugin is to monitor status changes of different services or websites." + "localized": ["display_name", "description", "icon"], + "display_name" : [{ + "language_code":"en_us", + "string" : "Website monitor" + }], + "icon":[{ + "language_code":"en_us", + "string" : "" + }], + "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" : "sites", + "type" : "setting", + "value" : "WEBMON_LIST" + }], "database_column_aliases":{ "Plugins_Events":{ - "Index":{ - "en_us" : "Index" - }, - "Object_PrimaryID":{ - "en_us" : "Monitored URL" - }, - "DateTime":{ - "en_us" : "Checked on" - }, - "Watched_Value1":{ - "en_us" : "Status code" - }, - "Watched_Value2":{ - "en_us" : "Latency" - } + "Index":[{ + "language_code":"en_us", + "string" : "Index" + }], + "Object_PrimaryID":[{ + "language_code":"en_us", + "string" : "Monitored URL" + }], + "DateTime":[{ + "language_code":"en_us", + "string" : "Checked on" + }], + "Watched_Value1":[{ + "language_code":"en_us", + "string" : "Status code" + }], + "Watched_Value2":[{ + "language_code":"en_us", + "string" : "Latency" + }] } }, "settings":[ { - "type": "ENABLE", - "default_value":"False", - "options": [], - "name" : { - "en_us" : "Enable plugin" - }, - "description": - { - "en_us" : "Enable a regular scan of your services. You need to enable this setting for anything to be executed regarding this plugin." - } - - }, - { - "type": "RUN", - "default_value":"none", - "options": ["none","once","schedule"], - "name" : { - "en_us" : "Schedule" - }, - "description": - { - "en_us" : "Enable a regular scan of your services. If you select schedule the scheduling settings from below are applied. If you select once the scan is run only once on start of the application (container) for the time specified in WEBMON_TIMEOUT setting." - } - + "type": "RUN", + "default_value":"disabled", + "options": ["disabled", "once", "schedule", "always_after_scan", "on_new_device"], + "localized": ["name", "description"], + "name" :[{ + "language_code":"en_us", + "string" : "Run condition" + }], + "description": [{ + "language_code":"en_us", + "string" : "Enable a regular scan of your services. If you select schedule the scheduling settings from below are applied. If you select once the scan is run only once on start of the application (container) for the time specified in WEBMON_TIMEOUT setting." + }] }, { "type": "FORCE_REPORT", "default_value": false, "options": [], - "name" : { - "en_us" : "Schedule" + "localized": ["name", "description"], + "name" : [{ + "language_code":"en_us", + "string" : "Force report" }, - "description": - { - "en_us" : "Enable a regular scan of your services. If you select schedule the scheduling settings from below are applied. If you select once the scan is run only once on start of the application (container) for the time specified in WEBMON_TIMEOUT setting." - } + { + "language_code":"de_de", + "string" : "Zwing Bericht" + }], + "description": [{ + "language_code":"en_us", + "string" : "Force a notification message even if there are no changes detected." + }] }, { "type": "RUN_SCHD", "default_value":"0 2 * * *", "options": [], - "name" : { - "en_us" : "Schedule" - }, - "description": - { - "en_us" : "Only enabled if you select schedule in the WEBMON_RUN setting. Make sure you enter the schedule in the correct cron-like format (e.g. validate at crontab.guru). For example entering 0 4 * * * will run the scan after 4 am in the TIMEZONE you set above. Will be run NEXT time the time passes." - } - + "localized": ["name", "description"], + "name" : [{ + "language_code":"en_us", + "string" : "Schedule" + }], + "description": [{ + "language_code":"en_us", + "string" : "Only enabled if you select schedule in the WEBMON_RUN setting. Make sure you enter the schedule in the correct cron-like format (e.g. validate at crontab.guru). For example entering 0 4 * * * will run the scan after 4 am in the TIMEZONE you set above. Will be run NEXT time the time passes." + }] }, { "type": "API_SQL", "default_value":"SELECT * FROM plugin_website_monitor", "options": [], - "name" : { - "en_us" : "API endpoint" - }, - "description": - { - "en_us" : "You can specify a custom SQL query which will generate a JSON file and then expose it via the plugin_website_monitor.json file endpoint." - } - + "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 plugin_website_monitor.json file endpoint." + }] }, { "type": "RUN_TIMEOUT", "default_value":5, "options": [], - "name" : { - "en_us" : "Run timeout" - }, - "description": - { - "en_us" : "Maximum time in seconds to wait for a Website monitor check to finish for any url." - } - + "localized": ["name", "description"], + "name" : [{ + "language_code":"en_us", + "string" : "Run timeout" + }], + "description": [{ + "language_code":"en_us", + "string" : "Maximum time in seconds to wait for a Website monitor check to finish for any url." + }] }, { - "type": "NOTIFY_ON", + "type": "WATCH", "default_value":["Watched_Value1"], "options": ["Watched_Value1","Watched_Value2","Watched_Value3","Watched_Value4"], - "name" : { - "en_us" : "Notify on" - }, - "description": - { - "en_us" : "Send a notification if selected values change. Use CTRL + Click to select/deselect. " - } + "localized": ["name", "description"], + "name" :[{ + "language_code":"en_us", + "string" : "Notify on" + }] , + "description":[{ + "language_code":"en_us", + "string" : "Send a notification if selected values change. Use CTRL + Click to select/deselect. " + }] }, { - "type": "ARGS", + "type": "CMD", + "default_value":"python3 script.py", + "options": [], + "localized": ["name", "description"], + "name" : [{ + "language_code":"en_us", + "string" : "Command" + }], + "description": [{ + "language_code":"en_us", + "string" : "Change the dig utility arguments if you have issues resolving your Internet IP. Arguments are added at the end of the following command: dig +short ." + }] + }, + { + "type": "LIST", "default_value":"", "options": [], - "name" : { - "en_us" : "Run timeout" - }, - "description": - { - "en_us" : "Change the dig utility arguments if you have issues resolving your Internet IP. Arguments are added at the end of the following command: dig +short ." - } + "localized": ["name", "description"], + "name" : [{ + "language_code":"en_us", + "string" : "Arguments" + }], + "description": [{ + "language_code":"en_us", + "string" : "Change the dig utility arguments if you have issues resolving your Internet IP. Arguments are added at the end of the following command: dig +short ." + }] } ] diff --git a/front/settings.php b/front/settings.php index 88f0ddad..bd1c01a6 100755 --- a/front/settings.php +++ b/front/settings.php @@ -14,6 +14,17 @@ $confPath = "../config/pialert.conf"; checkPermissions([$dbPath, $confPath]); +// get settings from the API json file + +// path to your JSON file +$file = '../front/api/table_settings.json'; +// put the content of the file in a variable +$data = file_get_contents($file); +// JSON decode +$settingsJson = json_decode($data); + +// get settings from the DB + global $db; $result = $db->query("SELECT * FROM Settings"); @@ -72,7 +83,7 @@ while ($row = $result -> fetchArray (SQLITE3_ASSOC)) { $html = $html.'
-

'.lang($group.'_settings_group').'

+

'.lang($group.'_icon')." ".lang($group.'_display_name').'
@@ -280,15 +291,16 @@ while ($row = $result -> fetchArray (SQLITE3_ASSOC)) {