diff --git a/front/plugins/unifi_import/config.json b/front/plugins/unifi_import/config.json old mode 100755 new mode 100644 index d9cd84c5..6b6291dc --- a/front/plugins/unifi_import/config.json +++ b/front/plugins/unifi_import/config.json @@ -1,372 +1,370 @@ { "code_name": "unifi_import", - "unique_prefix": "UNFIMP", - "enabled": true, - "data_source": "script", - "show_ui": true, "data_filters": [ { - "compare_column" : "Object_PrimaryID", - "compare_operator" : "==", + "compare_column": "Object_PrimaryID", "compare_field_id": "txtMacFilter", - "compare_js_template": "'{value}'.toString()", - "compare_use_quotes": true + "compare_js_template": "'{value}'.toString()", + "compare_operator": "==", + "compare_use_quotes": true } ], - "localized": ["display_name", "description", "icon"], - "mapped_to_table": "CurrentScan", - "display_name" : [{ - "language_code":"en_us", - "string" : "UniFi import" - }, - { - "language_code":"es_es", - "string" : "Importación UniFi" - }], - "icon":[{ - "language_code":"en_us", - "string" : "" - }, - { - "language_code":"es_es", - "string" : "" - }], - "description": [{ - "language_code":"en_us", - "string" : "This plugin is used to import devices from an UNIFI controller." - }, - { - "language_code":"es_es", - "string" : "Este plugin se utiliza para importar dispositivos desde un controlador UNIFI." - }, - { - "language_code":"de_de", - "string" : "Dieses Plugin imporiert die Geräte von einem UNIFI Controller." - }], - "params" : [ + "data_source": "script", + "database_column_definitions": [ { - "name" : "username", - "type" : "setting", - "value" : "UNFIMP_username" - }, - { - "name" : "password", - "type" : "setting", - "value" : "UNFIMP_password" - }, - { - "name" : "host", - "type" : "setting", - "value" : "UNFIMP_host" - }, - { - "name" : "sites", - "type" : "setting", - "value" : "UNFIMP_sites" - }, - { - "name" : "port", - "type" : "setting", - "value" : "UNFIMP_port" - }, - { - "name" : "verifyssl", - "type" : "setting", - "value" : "UNFIMP_verifyssl" - }, - { - "name" : "version", - "type" : "setting", - "value" : "UNFIMP_version" - } - ], - "database_column_definitions": - [ - { - "column": "Index", + "column": "Index", "css_classes": "col-sm-2", - "show": false, - "type": "label", - "default_value":"", - "options": [], - "localized": ["name"], - "name":[{ - "language_code":"en_us", - "string" : "N/A" + "default_value": "", + "localized": [ + "name" + ], + "name": [ + { + "language_code": "en_us", + "string": "N/A" }, { - "language_code":"es_es", - "string" : "N/A" + "language_code": "es_es", + "string": "N/A" }, { - "language_code":"de_de", - "string" : "N/A" + "language_code": "de_de", + "string": "N/A" } - ] - } , + ], + "options": [], + "show": false, + "type": "label" + }, { "column": "Plugin", "css_classes": "col-sm-2", - "show": false, - "type": "label", - "default_value":"", + "default_value": "", + "localized": [ + "name" + ], + "name": [ + { + "language_code": "en_us", + "string": "N/A" + }, + { + "language_code": "es_es", + "string": "N/A" + }, + { + "language_code": "de_de", + "string": "N/A" + } + ], "options": [], - "localized": ["name"], - "name":[{ - "language_code":"en_us", - "string" : "N/A" - }, - { - "language_code":"es_es", - "string" : "N/A" - }, - { - "language_code":"de_de", - "string" : "N/A" - }] + "show": false, + "type": "label" }, { "column": "Object_PrimaryID", - "mapped_to_column": "cur_MAC", "css_classes": "col-sm-2", - "show": true, - "type": "device_mac", - "default_value":"", + "default_value": "", + "localized": [ + "name" + ], + "mapped_to_column": "cur_MAC", + "name": [ + { + "language_code": "en_us", + "string": "MAC address" + }, + { + "language_code": "es_es", + "string": "Dirección MAC" + }, + { + "language_code": "de_de", + "string": "MAC Adresse" + } + ], "options": [], - "localized": ["name"], - "name":[{ - "language_code":"en_us", - "string" : "MAC address" - }, - { - "language_code":"es_es", - "string" : "Dirección MAC" - }, - { - "language_code":"de_de", - "string" : "MAC Adresse" - }] + "show": true, + "type": "device_mac" }, { "column": "Object_SecondaryID", - "mapped_to_column": "cur_IP", "css_classes": "col-sm-2", - "show": true, - "type": "device_ip", - "default_value":"", - "options": [], - "localized": ["name"], - "name":[{ - "language_code":"en_us", - "string" : "IP" + "default_value": "", + "localized": [ + "name" + ], + "mapped_to_column": "cur_IP", + "name": [ + { + "language_code": "en_us", + "string": "IP" }, { - "language_code":"es_es", - "string" : "IP" + "language_code": "es_es", + "string": "IP" }, { - "language_code":"de_de", - "string" : "IP" + "language_code": "de_de", + "string": "IP" } - ] - } , + ], + "options": [], + "show": true, + "type": "device_ip" + }, { "column": "DateTimeCreated", "css_classes": "col-sm-2", - "show": true, - "type": "label", - "default_value":"", + "default_value": "", + "localized": [ + "name" + ], + "name": [ + { + "language_code": "en_us", + "string": "Created" + }, + { + "language_code": "es_es", + "string": "Creado" + }, + { + "language_code": "de_de", + "string": "Erstellt" + } + ], "options": [], - "localized": ["name"], - "name":[{ - "language_code":"en_us", - "string" : "Created" - }, - { - "language_code":"es_es", - "string" : "Creado" - }, - { - "language_code":"de_de", - "string" : "Erstellt" - }] + "show": true, + "type": "label" }, { "column": "DateTimeChanged", - "mapped_to_column": "cur_DateTime", "css_classes": "col-sm-2", - "show": true, - "type": "label", - "default_value":"", + "default_value": "", + "localized": [ + "name" + ], + "mapped_to_column": "cur_DateTime", + "name": [ + { + "language_code": "en_us", + "string": "Changed" + }, + { + "language_code": "es_es", + "string": "Cambiado" + }, + { + "language_code": "de_de", + "string": "Angepasst" + } + ], "options": [], - "localized": ["name"], - "name":[{ - "language_code":"en_us", - "string" : "Changed" - }, - { - "language_code":"es_es", - "string" : "Cambiado" - }, - { - "language_code":"de_de", - "string" : "Angepasst" - }] + "show": true, + "type": "label" }, { "column": "Watched_Value1", - "mapped_to_column": "cur_Name", "css_classes": "col-sm-2", - "show": true, - "type": "label", - "default_value":"", + "default_value": "", + "localized": [ + "name" + ], + "mapped_to_column": "cur_Name", + "name": [ + { + "language_code": "en_us", + "string": "Hostname" + }, + { + "language_code": "es_es", + "string": "Nombre de host" + }, + { + "language_code": "de_de", + "string": "Name des Hosts" + } + ], "options": [], - "localized": ["name"], - "name":[{ - "language_code":"en_us", - "string" : "Hostname" - }, - { - "language_code":"es_es", - "string" : "Nombre de host" - }, - { - "language_code":"de_de", - "string" : "Name des Hosts" - }] + "show": true, + "type": "label" }, { - "column": "Watched_Value2", + "column": "Watched_Value2", "css_classes": "col-sm-2", - "show": true, - "type": "label", - "default_value":"", + "default_value": "", + "localized": [ + "name" + ], + "name": [ + { + "language_code": "en_us", + "string": "Vendor" + }, + { + "language_code": "es_es", + "string": "Proveedor" + }, + { + "language_code": "de_de", + "string": "Hersteller" + } + ], "options": [], - "localized": ["name"], - "name":[{ - "language_code":"en_us", - "string" : "Vendor" - }, - { - "language_code":"es_es", - "string" : "Proveedor" - }, - { - "language_code":"de_de", - "string" : "Hersteller" - }] + "show": true, + "type": "label" }, { "column": "Watched_Value3", "css_classes": "col-sm-2", - "show": true, - "type": "label", - "default_value":"", + "default_value": "", + "localized": [ + "name" + ], + "name": [ + { + "language_code": "en_us", + "string": "Type" + }, + { + "language_code": "es_es", + "string": "Tipo" + }, + { + "language_code": "de_de", + "string": "Typ" + } + ], "options": [], - "localized": ["name"], - "name":[{ - "language_code":"en_us", - "string" : "Type" - }, - { - "language_code":"es_es", - "string" : "Tipo" - }, - { - "language_code":"de_de", - "string" : "Typ" - }] - } , + "show": true, + "type": "label" + }, { "column": "Watched_Value4", "css_classes": "col-sm-2", - "show": true, - "type": "label", - "default_value":"", + "default_value": "", + "localized": [ + "name" + ], + "name": [ + { + "language_code": "en_us", + "string": "Online?" + }, + { + "language_code": "es_es", + "string": "¿Online?" + }, + { + "language_code": "de_de", + "string": "Online?" + } + ], "options": [], - "localized": ["name"], - "name":[{ - "language_code":"en_us", - "string" : "Online?" - }, - { - "language_code":"es_es", - "string" : "¿Online?" - }, - { - "language_code":"de_de", - "string" : "Online?" - }] - } , + "show": true, + "type": "label" + }, { "column": "UserData", "css_classes": "col-sm-2", - "show": false, - "type": "textbox_save", - "default_value":"", + "default_value": "", + "localized": [ + "name" + ], + "name": [ + { + "language_code": "en_us", + "string": "Comments" + }, + { + "language_code": "es_es", + "string": "Comentarios" + }, + { + "language_code": "de_de", + "string": "Kommentar" + } + ], "options": [], - "localized": ["name"], - "name":[{ - "language_code":"en_us", - "string" : "Comments" - }, - { - "language_code":"es_es", - "string" : "Comentarios" - }, - { - "language_code":"de_de", - "string" : "Kommentar" - }] - }, + "show": false, + "type": "textbox_save" + }, { "column": "Dummy", - "mapped_to_column": "cur_ScanMethod", - "mapped_to_column_data": { - "value": "UNFIMP" - }, "css_classes": "col-sm-2", - "show": true, - "type": "label", - "default_value":"", - "options": [], - "localized": ["name"], - "name":[{ - "language_code":"en_us", - "string" : "Scan method" + "default_value": "", + "localized": [ + "name" + ], + "mapped_to_column": "cur_ScanMethod", + "mapped_to_column_data": { + "value": "UNFIMP" + }, + "name": [ + { + "language_code": "en_us", + "string": "Scan method" }, { - "language_code":"es_es", - "string" : "Método de escaneo" - }] - } , + "language_code": "es_es", + "string": "Método de escaneo" + }, + { + "language_code": "de_de", + "string": "Scan Methode" + } + ], + "options": [], + "show": true, + "type": "label" + }, { "column": "Extra", "css_classes": "col-sm-3", - "show": true, - "type": "label", - "default_value":"", + "default_value": "", + "localized": [ + "name" + ], + "name": [ + { + "language_code": "en_us", + "string": "Network" + }, + { + "language_code": "es_es", + "string": "Red" + }, + { + "language_code": "de_de", + "string": "Netzwerk" + } + ], "options": [], - "localized": ["name"], - "name":[{ - "language_code":"en_us", - "string" : "Network" - }, - { - "language_code":"es_es", - "string" : "Red" - }, - { - "language_code":"de_de", - "string" : "Netzwerk" - }] - }, + "show": true, + "type": "label" + }, { "column": "Status", "css_classes": "col-sm-1", - "show": true, - "type": "replace", - "default_value":"", + "default_value": "", + "localized": [ + "name" + ], + "name": [ + { + "language_code": "en_us", + "string": "Status" + }, + { + "language_code": "es_es", + "string": "Estado" + }, + { + "language_code": "de_de", + "string": "Status" + } + ], "options": [ { "equals": "watched-not-changed", @@ -385,345 +383,573 @@ "replacement": "
" } ], - "localized": ["name"], - "name":[{ - "language_code":"en_us", - "string" : "Status" - }, - { - "language_code":"es_es", - "string" : "Estado" - }, - { - "language_code":"de_de", - "string" : "Status" - }] - } + "show": true, + "type": "replace" + } ], - "settings":[ + "description": [ { - "function": "RUN", - "type": "text.select", - "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" - }, - { - "language_code":"es_es", - "string" : "Cuándo ejecutar" - }, - { - "language_code":"de_de", - "string" : "Ausführungszeitpunkt" - }], - "description": [{ - "language_code":"en_us", - "string" : "Enable import of devices from a UNIFI controller. 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) or after you update your settings." - }, - { - "language_code":"es_es", - "string" : "Habilite la importación de dispositivos desde un controlador UNIFI. Si selecciona schedule, se aplican las configuraciones de programación de abajo. Si selecciona once, el análisis se ejecuta solo una vez al iniciar la aplicación (contenedor) o después de actualizar su configuración." - }, + "language_code": "en_us", + "string": "This plugin is used to import devices from an UNIFI controller." + }, + { + "language_code": "es_es", + "string": "Este plugin se utiliza para importar dispositivos desde un controlador UNIFI." + }, + { + "language_code": "de_de", + "string": "Dieses Plugin imporiert die Geräte von einem UNIFI Controller." + } + ], + "display_name": [ + { + "language_code": "en_us", + "string": "UniFi import" + }, + { + "language_code": "es_es", + "string": "Importación UniFi" + } + ], + "enabled": true, + "icon": [ + { + "language_code": "en_us", + "string": "" + }, + { + "language_code": "es_es", + "string": "" + } + ], + "localized": [ + "display_name", + "description", + "icon" + ], + "mapped_to_table": "CurrentScan", + "params": [ + { + "name": "username", + "type": "setting", + "value": "UNFIMP_username" + }, + { + "name": "password", + "type": "setting", + "value": "UNFIMP_password" + }, + { + "name": "host", + "type": "setting", + "value": "UNFIMP_host" + }, + { + "name": "sites", + "type": "setting", + "value": "UNFIMP_sites" + }, + { + "name": "port", + "type": "setting", + "value": "UNFIMP_port" + }, + { + "name": "verifyssl", + "type": "setting", + "value": "UNFIMP_verifyssl" + }, + { + "name": "version", + "type": "setting", + "value": "UNFIMP_version" + }, + { + "name": "fullimport", + "type": "setting", + "value": "UNFIMP_fullimport" + } + ], + "settings": [ + { + "default_value": "disabled", + "description": [ { - "language_code":"de_de", - "string" : "Aktiviere den Import von einem UNIFI controller. Bei schedule werden die Richtzeiten von weiter unten verwendet. Bei der Auswahl once der Import wird einmalig beim Start der Applikation (container), oder nach einem Update der Einstellungen durchgeführt." - }] + "language_code": "en_us", + "string": "Enable import of devices from a UNIFI controller. 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) or after you update your settings." + }, + { + "language_code": "es_es", + "string": "Habilite la importación de dispositivos desde un controlador UNIFI. Si selecciona schedule, se aplican las configuraciones de programación de abajo. Si selecciona once, el análisis se ejecuta solo una vez al iniciar la aplicación (contenedor) o después de actualizar su configuración." + }, + { + "language_code": "de_de", + "string": "Aktiviere den Import von einem UNIFI controller. Bei schedule werden die Richtzeiten von weiter unten verwendet. Bei der Auswahl once der Import wird einmalig beim Start der Applikation (container), oder nach einem Update der Einstellungen durchgeführt." + } + ], + "function": "RUN", + "localized": [ + "name", + "description" + ], + "name": [ + { + "language_code": "en_us", + "string": "When to run" + }, + { + "language_code": "es_es", + "string": "Cuándo ejecutar" + }, + { + "language_code": "de_de", + "string": "Ausführungszeitpunkt" + } + ], + "options": [ + "disabled", + "once", + "schedule", + "always_after_scan", + "on_new_device" + ], + "type": "text.select" }, { + "default_value": "python3 /home/pi/pialert/front/plugins/unifi_import/script.py username={username} password={password} host={host} sites={sites} port={port} verifyssl={verifyssl} version={version} fullimport={fullimport}", + "description": [ + { + "language_code": "en_us", + "string": "Command to run. Not recommended to change." + }, + { + "language_code": "es_es", + "string": "Comando para ejecutar. No se recomienda cambiar." + }, + { + "language_code": "de_de", + "string": "Befehl der ausgeführt wird. Anpassung nicht empfohlen" + } + ], "function": "CMD", - "type": "text", - "default_value":"python3 /home/pi/pialert/front/plugins/unifi_import/script.py username={username} password={password} host={host} sites={sites} port={port} verifyssl={verifyssl} version={version}", + "localized": [ + "name", + "description" + ], + "name": [ + { + "language_code": "en_us", + "string": "Command" + }, + { + "language_code": "es_es", + "string": "Comando" + }, + { + "language_code": "de_de", + "string": "Befehl" + } + ], "options": [], - "localized": ["name", "description"], - "name" : [{ - "language_code":"en_us", - "string" : "Command" - }, - { - "language_code":"es_es", - "string" : "Comando" - }, - { - "language_code":"de_de", - "string" : "Befehl" - }], - "description": [{ - "language_code":"en_us", - "string" : "Command to run. Not recommended to change." - }, - { - "language_code":"es_es", - "string" : "Comando para ejecutar. No se recomienda cambiar." - }, - { - "language_code":"de_de", - "string" : "Befehl der ausgeführt wird. Anpassung nicht empfohlen" - }] + "type": "text" }, { + "default_value": "", + "description": [ + { + "language_code": "en_us", + "string": "The username used to login into your UNIFI controller. It is recommended to create a read-only user account." + }, + { + "language_code": "es_es", + "string": "El nombre de usuario utilizado para iniciar sesión en su controlador UNIFI. Se recomienda crear una cuenta de usuario de sólo lectura." + } + ], "function": "username", - "type": "text", - "default_value":"", + "localized": [ + "name", + "description" + ], + "name": [ + { + "language_code": "en_us", + "string": "Username" + }, + { + "language_code": "es_es", + "string": "Nombre de usuario" + } + ], "options": [], - "localized": ["name", "description"], - "name" : [{ - "language_code":"en_us", - "string" : "Username" - }, - { - "language_code":"es_es", - "string" : "Nombre de usuario" - }], - "description": [{ - "language_code":"en_us", - "string" : "The username used to login into your UNIFI controller. It is recommended to create a read-only user account." - }, - { - "language_code":"es_es", - "string" : "El nombre de usuario utilizado para iniciar sesión en su controlador UNIFI. Se recomienda crear una cuenta de usuario de sólo lectura." - }] + "type": "text" }, { + "default_value": "", + "description": [ + { + "language_code": "en_us", + "string": "The password used to login into your UNIFI controller." + }, + { + "language_code": "es_es", + "string": "La contraseña utilizada para iniciar sesión en su controlador UNIFI." + } + ], "function": "password", - "type": "password", - "default_value":"", + "localized": [ + "name", + "description" + ], + "name": [ + { + "language_code": "en_us", + "string": "Password" + }, + { + "language_code": "es_es", + "string": "Contraseña" + } + ], "options": [], - "localized": ["name", "description"], - "name" : [{ - "language_code":"en_us", - "string" : "Password" - }, - { - "language_code":"es_es", - "string" : "Contraseña" - }], - "description": [{ - "language_code":"en_us", - "string" : "The password used to login into your UNIFI controller." - }, - { - "language_code":"es_es", - "string" : "La contraseña utilizada para iniciar sesión en su controlador UNIFI." - }] + "type": "password" }, { + "default_value": "192.168.1.1", + "description": [ + { + "language_code": "en_us", + "string": "The host (IP) where the UNIFI controller is runnig. Do NOT include the protocol (e.g. https://)" + }, + { + "language_code": "es_es", + "string": "El host (IP) donde se ejecuta el controlador UNIFI. NO incluya el protocolo (por ejemplo, https://)" + } + ], "function": "host", - "type": "text", - "default_value":"192.168.1.1", + "localized": [ + "name", + "description" + ], + "name": [ + { + "language_code": "en_us", + "string": "Host" + }, + { + "language_code": "es_es", + "string": "Host" + } + ], "options": [], - "localized": ["name", "description"], - "name" : [{ - "language_code":"en_us", - "string" : "Host" - }, - { - "language_code":"es_es", - "string" : "Host" - }], - "description": [{ - "language_code":"en_us", - "string" : "The host (IP) where the UNIFI controller is runnig. Do NOT include the protocol (e.g. https://)" - }, - { - "language_code":"es_es", - "string" : "El host (IP) donde se ejecuta el controlador UNIFI. NO incluya el protocolo (por ejemplo, https://)" - }] + "type": "text" }, { + "default_value": "8443", + "description": [ + { + "language_code": "en_us", + "string": "The port number where the UNIFI controller is runnig. Usually it is 8443, for UDM(P) devices its 443." + }, + { + "language_code": "es_es", + "string": "El número de puerto donde se ejecuta el controlador UNIFI. Normalmente es 8443." + } + ], "function": "port", - "type": "text", - "default_value":"8443", + "localized": [ + "name", + "description" + ], + "name": [ + { + "language_code": "en_us", + "string": "Port number" + }, + { + "language_code": "es_es", + "string": "Número de puerto" + } + ], "options": [], - "localized": ["name", "description"], - "name" : [{ - "language_code":"en_us", - "string" : "Port number" - }, - { - "language_code":"es_es", - "string" : "Número de puerto" - }], - "description": [{ - "language_code":"en_us", - "string" : "The port number where the UNIFI controller is runnig. Usually it is 8443." - }, - { - "language_code":"es_es", - "string" : "El número de puerto donde se ejecuta el controlador UNIFI. Normalmente es 8443." - }] + "type": "text" }, { + "default_value": "false", + "description": [ + { + "language_code": "en_us", + "string": "verify SSL certificate validity true|false." + }, + { + "language_code": "es_es", + "string": "verificar la validez del certificado SSL true|false." + } + ], "function": "verifyssl", - "type": "text", - "default_value":"false", + "localized": [ + "name", + "description" + ], + "name": [ + { + "language_code": "en_us", + "string": "verify SSL" + }, + { + "language_code": "es_es", + "string": "verificar SSL" + } + ], "options": [], - "localized": ["name", "description"], - "name" : [{ - "language_code":"en_us", - "string" : "verify SSL" - }, - { - "language_code": "es_es", - "string": "verificar SSL" - }], - "description": [{ - "language_code":"en_us", - "string" : "verify SSL certificate validity true|false." - }, - { - "language_code":"es_es", - "string" : "verificar la validez del certificado SSL true|false." - }] + "type": "text" }, { "function": "version", "type": "text", - "default_value":"v4", + "default_value": "v4", "options": [], - "localized": ["name", "description"], - "name" : [{ - "language_code":"en_us", - "string" : "API version" - }, - { - "language_code":"es_es", - "string" : "Versión API" - }], - "description": [{ - "language_code":"en_us", - "string" : "The base version of the Unify controller API. Supported values as of time of writing are v4|v5|unifiOS|UDMP-unifiOS." - }, - { - "language_code":"es_es", - "string" : "La versión base de la API del controlador Unify. Los valores admitidos al momento de escribir este artículo son v4|v5|unifiOS|UDMP-unifiOS." - }] + "localized": ["name","description"], + "name": [ + { + "language_code": "en_us", + "string": "API version" + }, + { + "language_code": "es_es", + "string": "Versión API" + } + ], + "description": [ + { + "language_code": "en_us", + "string": "The base version of the Unify controller API. Supported values as of time of writing are v4|v5|unifiOS|UDMP-unifiOS." + }, + { + "language_code": "es_es", + "string": "La versión base de la API del controlador Unify. Los valores admitidos al momento de escribir este artículo son v4|v5|unifiOS|UDMP-unifiOS." + } + ] + }, { + "default_value": [ + "default" + ], + "description": [ + { + "language_code": "en_us", + "string": "The sites you want to connect to. Usually it is only one and the name is default. Check the URL in your UniFi controller UI if unsure." + }, + { + "language_code": "es_es", + "string": "Los sitios a los que desea conectarse. Generalmente es solo uno y el nombre es default. Verifique la URL en la interfaz de usuario de su controlador UniFi si no está seguro." + } + ], "function": "sites", - "type": "list", - "default_value":["default"], + "localized": [ + "name", + "description" + ], + "name": [ + { + "language_code": "en_us", + "string": "UNIFI sites" + }, + { + "language_code": "es_es", + "string": "Sitios UNIFI" + } + ], "options": [], - "localized": ["name", "description"], - "name" : [{ - "language_code":"en_us", - "string" : "UNIFI sites" - }, - { - "language_code":"es_es", - "string" : "Sitios UNIFI" - }], - "description": [{ - "language_code":"en_us", - "string" : "The sites you want to connect to. Usually it is only one and the name is default. Check the URL in your UniFi controller UI if unsure." - }, - { - "language_code":"es_es", - "string" : "Los sitios a los que desea conectarse. Generalmente es solo uno y el nombre es default. Verifique la URL en la interfaz de usuario de su controlador UniFi si no está seguro." - }] + "type": "list" }, { + "default_value": "0 2 * * *", + "description": [ + { + "language_code": "en_us", + "string": "Only enabled if you select schedule in the UNFIMP_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." + }, + { + "language_code": "es_es", + "string": "Solo está habilitado si selecciona schedule en la configuración UNFIMP_RUN. Asegúrese de ingresar la programación en el formato similar a cron correcto (por ejemplo, valide en crontab.guru). Por ejemplo, ingresar 0 4 * * * ejecutará el escaneo después de las 4 a.m. en el TIMEZONE que configuró arriba. Se ejecutará la PRÓXIMA vez que pase el tiempo." + } + ], "function": "RUN_SCHD", - "type": "text", - "default_value":"0 2 * * *", + "localized": [ + "name", + "description" + ], + "name": [ + { + "language_code": "en_us", + "string": "Schedule" + }, + { + "language_code": "es_es", + "string": "Schedule" + } + ], "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 schedule in the UNFIMP_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." - }, - { - "language_code":"es_es", - "string" : "Solo está habilitado si selecciona schedule en la configuración UNFIMP_RUN. Asegúrese de ingresar la programación en el formato similar a cron correcto (por ejemplo, valide en crontab.guru). Por ejemplo, ingresar 0 4 * * * ejecutará el escaneo después de las 4 a.m. en el TIMEZONE que configuró arriba. Se ejecutará la PRÓXIMA vez que pase el tiempo." - }] + "type": "text" }, { + "default_value": 5, + "description": [ + { + "language_code": "en_us", + "string": "Maximum time in seconds to wait for the script to finish. If this time is exceeded the script is aborted." + }, + { + "language_code": "es_es", + "string": "Tiempo máximo en segundos para esperar a que finalice el script. Si se supera este tiempo, el script se cancela." + }, + { + "language_code": "de_de", + "string": "Maximale Laufzeit des Scripts. Nach Ablauf der Zeit wird das Script abgebrochen." + } + ], "function": "RUN_TIMEOUT", - "type": "integer", - "default_value":5, + "localized": [ + "name", + "description" + ], + "name": [ + { + "language_code": "en_us", + "string": "Run timeout" + }, + { + "language_code": "es_es", + "string": "Tiempo límite de ejecución" + }, + { + "language_code": "de_de", + "string": "Wartezeit" + } + ], "options": [], - "localized": ["name", "description"], - "name" : [{ - "language_code":"en_us", - "string" : "Run timeout" - }, - { - "language_code":"es_es", - "string" : "Tiempo límite de ejecución" - }, - { - "language_code":"de_de", - "string" : "Wartezeit" - }], - "description": [{ - "language_code":"en_us", - "string" : "Maximum time in seconds to wait for the script to finish. If this time is exceeded the script is aborted." - }, - { - "language_code":"es_es", - "string" : "Tiempo máximo en segundos para esperar a que finalice el script. Si se supera este tiempo, el script se cancela." - }, - { - "language_code":"de_de", - "string" : "Maximale Laufzeit des Scripts. Nach Ablauf der Zeit wird das Script abgebrochen." - }] + "type": "integer" }, { + "default_value": [ + "Watched_Value1", + "Watched_Value4" + ], + "description": [ + { + "language_code": "en_us", + "string": "Send a notification if selected values change. Use CTRL + Click to select/deselect. " + }, + { + "language_code": "es_es", + "string": "Envíe una notificación si los valores seleccionados cambian. Utilice CTRL + clic para seleccionar/deseleccionar. " + } + ], "function": "WATCH", - "type": "text.multiselect", - "default_value":["Watched_Value1", "Watched_Value4"], - "options": ["Watched_Value1","Watched_Value2","Watched_Value3","Watched_Value4"], - "localized": ["name", "description"], - "name" :[{ - "language_code":"en_us", - "string" : "Watched" - }, - { - "language_code":"es_es", - "string" : "Visto" - }] , - "description":[{ - "language_code":"en_us", - "string" : "Send a notification if selected values change. Use CTRL + Click to select/deselect. " - }, - { - "language_code":"es_es", - "string" : "Envíe una notificación si los valores seleccionados cambian. Utilice CTRL + clic para seleccionar/deseleccionar. " - }] + "localized": [ + "name", + "description" + ], + "name": [ + { + "language_code": "en_us", + "string": "Watched" + }, + { + "language_code": "es_es", + "string": "Visto" + } + ], + "options": [ + "Watched_Value1", + "Watched_Value2", + "Watched_Value3", + "Watched_Value4" + ], + "type": "text.multiselect" }, { + "default_value": [ + "new", + "watched-changed" + ], + "description": [ + { + "language_code": "en_us", + "string": "Send a notification only on these statuses. new means a new unique (unique combination of PrimaryId and SecondaryId) object was discovered. watched-changed means that selected Watched_ValueN columns changed." + }, + { + "language_code": "es_es", + "string": "Envíe una notificación solo en estos estados. new significa que se descubrió un nuevo objeto único (una combinación única de PrimaryId y SecondaryId). watched-changed significa que las columnas Watched_ValueN seleccionadas cambiaron." + } + ], "function": "REPORT_ON", - "type": "text.multiselect", - "default_value":["new","watched-changed"], - "options": ["new","watched-changed","watched-not-changed", "missing-in-last-scan"], - "localized": ["name", "description"], - "name" :[{ - "language_code":"en_us", - "string" : "Report on" + "localized": [ + "name", + "description" + ], + "name": [ + { + "language_code": "en_us", + "string": "Report on" + }, + { + "language_code": "es_es", + "string": "Informar sobre" + } + ], + "options": [ + "new", + "watched-changed", + "watched-not-changed", + "missing-in-last-scan" + ], + "type": "text.multiselect" + }, + { + "default_value": "disabled", + "description": [ + { + "language_code": "en_us", + "string": "Enable a full import of all known devices by the controller instead of only the online ones. During the scan, all found devices appear online. If you select once the full import is only performed once and the status is set to done afterwards." }, { - "language_code":"es_es", - "string" : "Informar sobre" - }] , - "description":[{ - "language_code":"en_us", - "string" : "Send a notification only on these statuses. new means a new unique (unique combination of PrimaryId and SecondaryId) object was discovered. watched-changed means that selected Watched_ValueN columns changed." + "language_code": "es_es", + "string": "Translation Needed - Enable a full import of all known devices by the controller instead of only the online ones. During the scan, all found devices appear online. If you select once the full import is only performed once and the status is set to done afterwards." }, { - "language_code":"es_es", - "string" : "Envíe una notificación solo en estos estados. new significa que se descubrió un nuevo objeto único (una combinación única de PrimaryId y SecondaryId). watched-changed significa que las columnas Watched_ValueN seleccionadas cambiaron." - }] + "language_code": "de_de", + "string": "Führe einen kompletten Import aller dem Controller bekannten Geräten durch. Während des Scans werden alle gefundenen Geräte einmalig als Online angezeigt. Bei der Auswahl von once wird der Scan einmalig durchgeführt und der Status anschliessend auf done gesetzt" + } + ], + "function": "fullimport", + "localized": [ + "name", + "description" + ], + "name": [ + { + "language_code": "en_us", + "string": "Perform full import" + }, + { + "language_code": "es_es", + "string": "[ES] Perform full import" + }, + { + "language_code": "de_de", + "string": "Vollständigen Import durchführen" + } + ], + "options": [ + "disabled", + "once", + "always" + ], + "type": "text.select" } - ] + ], + "show_ui": true, + "unique_prefix": "UNFIMP" } - diff --git a/front/plugins/unifi_import/script.py b/front/plugins/unifi_import/script.py old mode 100755 new mode 100644 index ccadeeb4..a3f10c14 --- a/front/plugins/unifi_import/script.py +++ b/front/plugins/unifi_import/script.py @@ -2,7 +2,7 @@ # Inspired by https://github.com/stevehoek/Pi.Alert # Example call -# python3 /home/pi/pialert/front/plugins/unifi_import/script.py username=pialert password=passw0rd host=192.168.1.1 site=default protocol=https port=8443 version='UDMP-unifiOS' +# python3 /home/pi/pialert/front/plugins/unifi_import/script.py username=pialert password=passw0rd host=192.168.1.1 site=default protocol=https port=443 verifyssl=false version='UDMP-unifiOS' # python3 /home/pi/pialert/front/plugins/unifi_import/script.py username=pialert password=passw0rd host=192.168.1.1 sites=sdefault port=8443 verifyssl=false version=v5 from __future__ import unicode_literals @@ -28,6 +28,7 @@ from logger import mylog CUR_PATH = str(pathlib.Path(__file__).parent.resolve()) LOG_FILE = os.path.join(CUR_PATH, 'script.log') RESULT_FILE = os.path.join(CUR_PATH, 'last_result.log') +LOCK_FILE = os.path.join(CUR_PATH, 'full_run.lock') requests.packages.urllib3.disable_warnings(InsecureRequestWarning) @@ -39,7 +40,7 @@ def main(): # init global variables - global UNIFI_USERNAME, UNIFI_PASSWORD, UNIFI_HOST, UNIFI_SITES, PORT, VERIFYSSL, VERSION + global UNIFI_USERNAME, UNIFI_PASSWORD, UNIFI_HOST, UNIFI_SITES, PORT, VERIFYSSL, VERSION, FULL_IMPORT parser = argparse.ArgumentParser(description='Import devices from a UNIFI controller') @@ -51,9 +52,13 @@ def main(): parser.add_argument('port', action="store", help="Usually 8443") parser.add_argument('verifyssl', action="store", help="verify SSL certificate [true|false]") parser.add_argument('version', action="store", help="The base version of the controller API [v4|v5|unifiOS|UDMP-unifiOS]") + parser.add_argument('fullimport', action="store", help="Defines if a full import or only online devices hould be imported [disabled|once|always]") values = parser.parse_args() + + + # parse output plugin_objects = Plugin_Objects(RESULT_FILE) @@ -69,6 +74,7 @@ def main(): PORT = values.port.split('=')[1] VERIFYSSL = values.verifyssl.split('=')[1] VERSION = values.version.split('=')[1] + FULL_IMPORT = values.fullimport.split('=')[1] plugin_objects = get_entries(plugin_objects) @@ -79,9 +85,14 @@ def main(): # ............................................. -def get_entries(plugin_objects): +def get_entries(plugin_objects: Plugin_Objects) -> Plugin_Objects: global VERIFYSSL + # check if the full run must be run: + lock_file_value = read_lock_file() + perform_full_run = check_full_run_state(FULL_IMPORT, lock_file_value) + + sites = [] if ',' in UNIFI_SITES: @@ -148,7 +159,7 @@ def get_entries(plugin_objects): # get_users() returns all clients known by the controller for user in c.get_users(): - mylog('verbose', [f'{json.dumps(user)}']) + #mylog('verbose', [f'{json.dumps(user)}']) name = get_unifi_val(user, 'name') hostName = get_unifi_val(user, 'hostname') @@ -157,7 +168,7 @@ def get_entries(plugin_objects): status = 1 if user['mac'] in online_macs else 0 - if status == 1: + if status == 1 or perform_full_run is True: ipTmp = get_unifi_val(user, 'last_ip') @@ -174,11 +185,17 @@ def get_entries(plugin_objects): extra=get_unifi_val(user, 'last_connection_network_name') ) - + # check if the lockfile needs to be adapted + + mylog('verbose', [f'[UNFIMP] check if Lock file needs to be modified']) + set_lock_file_value(FULL_IMPORT, lock_file_value) + + mylog('verbose', [f'[UNFIMP] Found {len(plugin_objects)} Clients overall']) return plugin_objects + # ----------------------------------------------------------------------------- def get_unifi_val(obj, key): @@ -192,8 +209,8 @@ def get_unifi_val(obj, key): return 'null' -# ----------------------------------------------------------------------------- +# ----------------------------------------------------------------------------- def set_name(name: str, hostName: str) -> str: if name != 'null': @@ -205,8 +222,47 @@ def set_name(name: str, hostName: str) -> str: else: return 'null' + +# ----------------------------------------------------------------------------- +def set_lock_file_value(config_value: str, lock_file_value: bool) -> None: + + mylog('verbose', [f'[UNFIMP] Lock Params: config_value={config_value}, lock_file_value={lock_file_value}']) + # set lock if 'once' is set and the lock is not set + if config_value == 'once' and lock_file_value is False: + out = 1 + # reset lock if not 'once' is set and the lock is present + elif config_value != 'once' and lock_file_value is True: + out = 0 + else: + mylog('verbose', [f'[UNFIMP] No change on lock file needed']) + return + + mylog('verbose', [f'[UNFIMP] Setting lock value for "full import" to {out}']) + with open(LOCK_FILE, 'w') as lock_file: + lock_file.write(str(out)) + + +# ----------------------------------------------------------------------------- +def read_lock_file() -> bool: + + try: + with open(LOCK_FILE, 'r') as lock_file: + return bool(int(lock_file.readline())) + except (FileNotFoundError, ValueError): + return False + + +# ----------------------------------------------------------------------------- +def check_full_run_state(config_value: str, lock_file_value: bool) -> bool: + if config_value == 'always' or (config_value == 'once' and lock_file_value == False): + mylog('verbose', [f'[UNFIMP] Full import needs to be done: config_value: {config_value} and lock_file_value: {lock_file_value}']) + return True + else: + mylog('verbose', [f'[UNFIMP] Full import NOT needed: config_value: {config_value} and lock_file_value: {lock_file_value}']) + return False + #=============================================================================== # BEGIN #=============================================================================== if __name__ == '__main__': - main() \ No newline at end of file + main()