Merge pull request #1134 from jokob-sk/main

sync

.github/FUNDING.yml

@@ -1,3 +1,3 @@
 github: jokob-sk
-patreon: 84385063
+patreon: netalertx
 buy_me_a_coffee: jokobsk

.github/workflows/docker_rewrite.yml

@@ -0,0 +1,81 @@
+name: docker
+
+on:
+  push:
+    branches:
+      - rewrite
+    tags:
+      - '*.*.*'
+  pull_request:
+    branches:
+      - rewrite
+
+jobs: 
+  docker_dev:
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    permissions:
+      contents: read
+      packages: write
+    if: >
+      contains(github.event.head_commit.message, 'PUSHPROD') != 'True' &&
+      github.repository == 'jokob-sk/NetAlertX'  
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Set up dynamic build ARGs
+        id: getargs        
+        run: echo "version=$(cat ./stable/VERSION)" >> $GITHUB_OUTPUT
+
+      - name: Get release version
+        id: get_version
+        run: echo "version=Dev" >> $GITHUB_OUTPUT
+
+      - name: Create .VERSION file
+        run: echo "${{ steps.get_version.outputs.version }}" >> .VERSION
+
+      - name: Docker meta
+        id: meta
+        uses: docker/metadata-action@v4
+        with:
+          images: |
+            ghcr.io/jokob-sk/netalertx-dev-rewrite
+            jokobsk/netalertx-dev-rewrite
+          tags: |
+            type=raw,value=latest
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+            type=sha
+
+      - name: Log in to Github Container Registry (GHCR)
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: jokob-sk
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Log in to DockerHub
+        if: github.event_name != 'pull_request'
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Build and push
+        uses: docker/build-push-action@v3
+        with:
+          context: .
+          platforms: linux/amd64,linux/arm64,linux/arm/v7,linux/arm/v6
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}

Dockerfile

@@ -13,7 +13,7 @@ ENV PATH="/opt/venv/bin:$PATH"
 
 COPY . ${INSTALL_DIR}/
 
-RUN pip install openwrt-luci-rpc asusrouter asyncio aiohttp graphene flask flask-cors tplink-omada-client wakeonlan pycryptodome requests paho-mqtt scapy cron-converter pytz json2table dhcp-leases pyunifi speedtest-cli chardet python-nmap dnspython librouteros yattag git+https://github.com/foreign-sub/aiofreepybox.git \
+RUN pip install openwrt-luci-rpc asusrouter asyncio aiohttp graphene flask flask-cors unifi-sm-api tplink-omada-client wakeonlan pycryptodome requests paho-mqtt scapy cron-converter pytz json2table dhcp-leases pyunifi speedtest-cli chardet python-nmap dnspython librouteros yattag git+https://github.com/foreign-sub/aiofreepybox.git \
     && bash -c "find ${INSTALL_DIR} -type d -exec chmod 750 {} \;" \
     && bash -c "find ${INSTALL_DIR} -type f -exec chmod 640 {} \;" \
     && bash -c "find ${INSTALL_DIR} -type f \( -name '*.sh' -o -name '*.py'  -o -name 'speedtest-cli' \) -exec chmod 750 {} \;"

Dockerfile.debian

@@ -43,7 +43,7 @@ RUN phpenmod -v 8.2 sqlite3
 RUN apt-get install -y python3-venv
 RUN python3 -m venv myenv
 
-RUN /bin/bash -c "source myenv/bin/activate && update-alternatives --install /usr/bin/python python /usr/bin/python3 10 && pip3 install openwrt-luci-rpc asusrouter asyncio aiohttp graphene flask flask-cors tplink-omada-client wakeonlan pycryptodome requests paho-mqtt scapy cron-converter pytz json2table dhcp-leases pyunifi speedtest-cli chardet python-nmap dnspython librouteros yattag "
+RUN /bin/bash -c "source myenv/bin/activate && update-alternatives --install /usr/bin/python python /usr/bin/python3 10 && pip3 install openwrt-luci-rpc asusrouter asyncio aiohttp graphene flask flask-cors unifi-sm-api tplink-omada-client wakeonlan pycryptodome requests paho-mqtt scapy cron-converter pytz json2table dhcp-leases pyunifi speedtest-cli chardet python-nmap dnspython librouteros yattag "
 
 # Create a buildtimestamp.txt to later check if a new version was released
 RUN date +%s > ${INSTALL_DIR}/front/buildtimestamp.txt

docs/DEBUG_PHP.md

@@ -0,0 +1,34 @@
+# Debugging backend PHP issues
+
+## Logs in UI
+
+![Logs UI](./img/DEBUG/maintenance_debug_php.png)
+
+You can view recent backend PHP errors directly in the **Maintenance > Logs** section of the UI. This provides quick access to logs without needing terminal access.
+
+## Accessing logs directly
+
+Sometimes, the UI might not be accessible. In that case, you can access the logs directly inside the container.
+
+### Step-by-step:
+
+1. **Open a shell into the container:**
+
+   ```bash
+   docker exec -it netalertx /bin/sh
+   ```
+
+2. **Check the NGINX error log:**
+
+   ```bash
+   cat /var/log/nginx/error.log
+   ```
+
+3. **Check the PHP application error log:**
+
+   ```bash
+   cat /app/log/app.php_errors.log
+   ```
+
+These logs will help identify syntax issues, fatal errors, or startup problems when the UI fails to load properly.
+

docs/DEVICE_HEURISTICS.md

@@ -53,6 +53,9 @@ The function `guess_device_attributes(...)` runs a series of matching functions
 4. IP pattern → `match_ip()`
 5. Final fallback → defaults defined in the `NEWDEV_devIcon` and `NEWDEV_devType` settings.
 
+> [!NOTE]
+> The app will try guessing the device type or icon if `devType` or `devIcon` are `""` or `"null"`.
+
 ### Use of default values
 
 The guessing process runs for every device **as long as the current type or icon still matches the default values**. Even if earlier heuristics return a match, the system continues evaluating additional clues — like name or IP — to try and replace placeholders.

front/appEvents.php

@@ -1,7 +1,7 @@
 <?php
 
   require 'php/templates/header.php';  
-  require 'php/templates/notification.php'; 
+  require 'php/templates/modals.php'; 
 ?>
 <!-- ----------------------------------------------------------------------- -->
  

front/css/app.css

@@ -1726,6 +1726,16 @@ input[readonly] {
     width: 92%;
 }
 
+#modal-ok
+{
+    z-index: 1051; /*highest priority*/
+}
+
+#modal-form-plc
+{
+    display: grid;
+}
+
 /* ----------------------------------------------------------------- */
 /* NETWORK page */
 /* ----------------------------------------------------------------- */

front/deviceDetails.php

@@ -25,7 +25,7 @@
 
 <!-- Content header--------------------------------------------------------- -->
     <section class="content-header">
-      <?php require 'php/templates/notification.php'; ?>
+      <?php require 'php/templates/modals.php'; ?>
 
       <h1 id="pageTitle">
         &nbsp<small>Quering device info...</small>

front/deviceDetailsEdit.php

@@ -290,18 +290,6 @@
   });
   }
 
-
-  // ----------------------------------------
-  // Show the description of a setting
-  function showDescriptionPopup(e) {
-
-    console.log($(e).attr("my-set-key"));    
-
-    showModalOK("Info", getString($(e).attr("my-set-key") + '_description'))
-  }
-
-
-
   // -----------------------------------------------------------------------------
   // Save device data to DB
   function setDeviceData(direction = '', refreshCallback = '') {

front/devices.php

@@ -1004,9 +1004,7 @@ function initializeDatatable (status) {
                 
     }
     
-  });
-
-  
+  });  
 }
 
 

front/img/manifest.json

@@ -4,7 +4,7 @@
     "display": "standalone",
     "icons": [
     {
-      "src": "",
+      "src": "/img/NetAlertX_logo.png",
       "sizes": "180x180",
       "type": "image/png"
     }

front/js/common.js

@@ -1032,6 +1032,7 @@ function getDevDataByMac(macAddress, dbColumn) {
       }
   }
 
+  console.error("⚠ Device with MAC not found:" + macAddress)
   return "Unknown"; // Return a default value if MAC address is not found
 }
 

front/js/modal.js

@@ -161,6 +161,91 @@ function showModalFieldInput(
   $(`#${prefix}`).modal("show");
 }
 
+// -----------------------------------------------------------------------------
+function showModalPopupForm(
+  title,
+  message,
+  btnCancel = getString("Gen_Cancel"),
+  btnOK = getString("Gen_Okay"),
+  curValue = "",
+  callbackFunction = null,
+  triggeredBy = null,
+  popupFormJson = null,
+  parentSettingKey = null
+) {
+  // set captions
+  prefix = "modal-form";
+  console.log(popupFormJson);
+
+  $(`#${prefix}-title`).html(title);
+  $(`#${prefix}-message`).html(message);
+  $(`#${prefix}-cancel`).html(btnCancel);
+  $(`#${prefix}-OK`).html(btnOK);
+
+  if (callbackFunction != null) {    
+    modalCallbackFunction = callbackFunction;
+  }
+
+  if (triggeredBy != null) {
+    $('#'+prefix).attr("data-myparam-triggered-by", triggeredBy)
+  }
+
+  outputHtml = "";
+
+  if (Array.isArray(popupFormJson)) {
+    popupFormJson.forEach((field, index) => {
+        // You'll need to define these or map them from `field`
+        const setName = field.name?.find(n => n.language_code === "en_us")?.string || setKey;
+        const labelClasses = "col-sm-2"; // example, or from your obj.labelClasses
+        const inputClasses = "col-sm-10"; // example, or from your obj.inputClasses
+        const fieldData = field.default_value ?? "";
+        const fieldOptionsOverride = field.type?.elements[0]?.elementOptions || [];
+
+        const setKey = field.function || `field_${index}`;
+        const setValue = field.default_value ?? "";
+        const setType = JSON.stringify(field.type); 
+        const setEvents = field.events || [];  // default to empty array if missing
+
+        const setObj = { setKey, setValue, setType, setEvents };
+
+        // Generate the input field HTML
+        const inputFormHtml = `
+                              <div class="form-group col-xs-12">
+                                  <label id="${setKey}_label" class="${labelClasses}"> ${setName}
+                                      <i my-set-key="${parentSettingKey}_popupform_${setKey}"
+                                          title="${getString("Settings_Show_Description")}" 
+                                          class="fa fa-circle-info pointer helpIconSmallTopRight" 
+                                          onclick="showDescriptionPopup(this)">
+                                      </i>
+                                  </label>
+                                  <div class="${inputClasses}">
+                                      ${generateFormHtml(
+                                        null, // settingsData only required for datatables
+                                        setObj, 
+                                        fieldData.toString(), 
+                                        fieldOptionsOverride, 
+                                        null
+                                      )}
+                                  </div>
+                              </div>
+                  `;
+
+        // Append to result
+        outputHtml += inputFormHtml;
+    });
+  }
+  
+  $(`#modal-form-plc`).html(outputHtml);
+
+  // $(`#${prefix}-field`).val(curValue);
+  // setTimeout(function () {
+  //   $(`#${prefix}-field`).focus();
+  // }, 500);
+
+  // Show modal
+  $(`#${prefix}`).modal("show");
+}
+
 // -----------------------------------------------------------------------------
 function modalDefaultOK() {
   // Hide modal

front/js/settings_utils.js

@@ -67,6 +67,15 @@ function getPluginConfig(pluginsData, prefix) {
   return result;
 }
 
+// ----------------------------------------
+// Show the description of a setting
+function showDescriptionPopup(e) {
+
+  console.log($(e).attr("my-set-key"));    
+
+  showModalOK("Info", getString($(e).attr("my-set-key") + '_description'))
+}
+
 // -------------------------------------------------------------------
 // Generate plugin HTML card based on prefixes in an array
 function pluginCards(prefixesOfEnabledPlugins, includeSettings) {
@@ -299,6 +308,45 @@ function removeDataTableRow(el) {
   }
 }
 
+// ---------------------------------------------------------
+// Add item via pop up form dialog
+function addViaPopupForm(element) {
+  console.log(element)
+
+  const fromId = $(element).attr("my-input-from");
+  const toId = $(element).attr("my-input-to");
+  const curValue = $(`#${fromId}`).val();
+  const triggeredBy = $(element).attr("id");
+  const parsed = JSON.parse(atob($(element).data("elementoptionsbase64")));  
+  const popupFormJson = parsed.find(obj => "popupForm" in obj)?.popupForm ?? null;
+  
+  console.log(`fromId | toId | triggeredBy | curValue: ${fromId} | ${toId} | ${triggeredBy} | ${curValue}`);
+
+  showModalPopupForm(
+    `<i class="fa fa-pen-to-square"></i> ${getString(
+      "Gen_Update_Value"
+    )}`,                                        // title
+    getString("settings_update_item_warning"),  // message
+    getString("Gen_Cancel"),                    // btnCancel
+    getString("Gen_Add"),                       // btnOK
+    curValue,                                   // curValue
+    null,                                       // callbackFunction
+    triggeredBy,                                // triggeredBy
+    popupFormJson,                              // popupform
+    toId                                        // parentSettingKey
+  );
+}
+
+// ---------------------------------------------------------
+// Add item to list via popup form
+function addViaPopupFormToList(element, clearInput = true) {
+
+
+  // flag something changes to prevent navigating from page
+  settingsChanged();
+}
+
+
 // ---------------------------------------------------------
 // Add item to list
 function addList(element, clearInput = true) {
@@ -622,8 +670,6 @@ function generateOptionsOrSetOptions(
   // obj.push({ id: item, name: item })
   options = arrayToObject(createArray(overrideOptions ? overrideOptions : getSettingOptions(setKey)))
 
-  
-  
   // Call to render lists
   renderList(
     options,
@@ -633,8 +679,6 @@ function generateOptionsOrSetOptions(
     targetField,
     transformers
   );
-  
-  
 }
 
 
@@ -655,6 +699,13 @@ function applyTransformers(val, transformers) {
           val = btoa(val);
         }
         break;
+      case "name|base64":
+        // // Implement base64  logic
+        // if (!isBase64(val)) {
+        //   val = btoa(val);
+        // }
+        val = val;   // probably TODO ⚠
+        break;
       case "getString":
         // no change
         val = val;        
@@ -681,6 +732,13 @@ function reverseTransformers(val, transformers) {
           val = atob(val);
         }
         break;
+      case "name|base64":
+        // // Implement base64 decoding logic
+        // if (isBase64(val)) {
+        //   val = atob(val);
+        // }
+        val = val;   // probably TODO ⚠
+        break;
       case "getString":
         // retrieve string
         val = getString(val);        
@@ -720,8 +778,8 @@ const handleElementOptions = (setKey, elementOptions, transformers, val) => {
   let customParams = "";
   let customId = "";
   let columns = [];
-  let base64Regex = "";
-
+  let base64Regex = "";  
+  let elementOptionsBase64 = btoa(JSON.stringify(elementOptions));
 
   elementOptions.forEach((option) => {
     if (option.prefillValue) {
@@ -804,7 +862,8 @@ const handleElementOptions = (setKey, elementOptions, transformers, val) => {
     customParams,
     customId,
     columns,
-    base64Regex
+    base64Regex,
+    elementOptionsBase64
   };
 };
 
@@ -955,6 +1014,8 @@ function generateFormHtml(settingsData, set, overrideValue, overrideOptions, ori
   // }
 
   // Parse the setType JSON string
+  console.log(processQuotes(setType));
+  
   const setTypeObject = JSON.parse(processQuotes(setType))
   const dataType = setTypeObject.dataType;
   const elements = setTypeObject.elements || [];
@@ -982,7 +1043,8 @@ function generateFormHtml(settingsData, set, overrideValue, overrideOptions, ori
       customParams,
       customId,
       columns,
-      base64Regex
+      base64Regex,
+      elementOptionsBase64
     } = handleElementOptions(setKey, elementOptions, transformers, inVal);
 
     // Override value
@@ -1051,6 +1113,7 @@ function generateFormHtml(settingsData, set, overrideValue, overrideOptions, ori
                         my-originalSetKey="${originalSetKey}"
                         my-input-from="${sourceIds}" 
                         my-input-to="${setKey}" 
+                        data-elementoptionsbase64="${elementOptionsBase64}"
                         onclick="${onClick}">
                         ${getString(getStringKey)}
                       </button>`;

front/js/ui_components.js

@@ -782,17 +782,17 @@ function initSelect2() {
 // ------------------------------------------
 // Render a device link with hover-over functionality
 function renderDeviceLink(data, container, useName = false) {
-  if (!data.id) return data.text; // default placeholder etc.
+  if (!data.id || !isValidMac(data.id)) return data.text; // default placeholder etc.
 
   const device = getDevDataByMac(data.id);
-
+  
   const badge = getStatusBadgeParts(
     device.devPresentLastScan,
     device.devAlertDown,
     device.devMac
   );
 
-  // Add badge class and hover-info class to container
+  // badge class and hover-info class to container
   $(container)
     .addClass(`${badge.cssClass} hover-node-info`)
     .attr({

front/maintenance.php

@@ -1,6 +1,6 @@
 <?php
   require 'php/templates/header.php';
-  require 'php/templates/notification.php';
+  require 'php/templates/modals.php';
 ?>
 
 <!-- Page ------------------------------------------------------------------ -->

front/multiEditCore.php

@@ -136,7 +136,8 @@
                     customParams,
                     customId,
                     columns,
-                    base64Regex
+                    base64Regex,
+                    elementOptionsBase64
                   } = handleElementOptions('none', elementOptions, transformers, val = "");
 
                   //  render based on element type 

front/network.php

@@ -1,6 +1,6 @@
 <?php
   require 'php/templates/header.php';
-  require 'php/templates/notification.php';  
+  require 'php/templates/modals.php';  
 ?>
     
 <script>

front/php/templates/migrationCheck.php

@@ -1,6 +1,6 @@
 <?php 
 
-  require 'php/templates/notification.php'; 
+  require 'php/templates/modals.php'; 
   //------------------------------------------------------------------------------
   // check if authenticated
   require_once  $_SERVER['DOCUMENT_ROOT'] . '/php/templates/security.php';

front/php/templates/modals.php

@@ -117,6 +117,29 @@
   </div>
 </div>
 
+<!-- Modal form input -->
+<div class="modal fade" id="modal-form" data-myparam-triggered-by="" style="display: none;">
+  <div class="modal-dialog">
+    <div class="modal-content">
+
+      <div class="modal-header">
+        <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">&times;</span></button>
+        <h4 id="modal-form-title" class="modal-title"> Modal Title </h4>
+      </div>
+
+      <div id="modal-form-message" class="modal-body"> Modal message </div>
+
+      <div id="modal-form-plc"></div>
+
+      <div class="modal-footer">
+        <button id="modal-form-cancel" type="button" class="btn btn-outline pull-left" style="min-width: 80px;" data-dismiss="modal"> Cancel </button>
+        <button id="modal-form-OK" type="button" class="btn btn-outline btn-modal-submit" style="min-width: 80px;" onclick="modalDefaultForm()"> OK </button>
+      </div>
+
+    </div>
+  </div>
+</div>
+
 
 <!-- Modal field input -->
 <div class="modal modal-warning fade" id="modal-field-input" data-myparam-triggered-by="" style="display: none;">

front/plugins.php

@@ -1,7 +1,7 @@
 <?php
 
   require 'php/templates/header.php';  
-  require 'php/templates/notification.php'; 
+  require 'php/templates/modals.php'; 
 ?>
 
 <!-- Page ------------------------------------------------------------------ -->

front/plugins/unifi_api_import/README.md

@@ -0,0 +1,26 @@
+## Overview
+
+Unifi import plugin using the Site Manager API.
+
+> [!TIP]
+> The Site Manager API doesn't seems to have feature parity with the old API yet, so certain limitations apply.  
+
+### Quick setup guide
+
+Navigate to your UniFi Site Manager _⚙️ Settings -> Control Plane -> Integrations_.
+
+- `api_key` : You can generate your API key under the _Your API Keys_ section.
+- `base_url` : You can find your base url in the _API Request Format_ section, e.g. `https://192.168.100.1/proxy/network/integration/`
+- `version` : You can find your version as part of the url in the _API Request Format_ section, e.g. `v1`
+- `skip_ssl` : To skip SSL with you don't have an SSL certificate
+
+
+### Usage
+
+- Head to **Settings** > **Plugin name** to adjust the default values.
+
+### Notes
+
+- Version: 1.0.0
+- Author: `jokob-sk`
+- Release Date: `Aug 2025`

front/plugins/unifi_api_import/config.json

@@ -0,0 +1,743 @@
+{
+  "code_name": "unifi_api_import",
+  "unique_prefix": "UNIFIAPI",
+  "plugin_type": "device_scanner",
+  "execution_order": "Layer_0",
+  "enabled": true,
+  "data_source": "script",
+  "mapped_to_table": "CurrentScan",
+  "data_filters": [
+    {
+      "compare_column": "Object_PrimaryID",
+      "compare_operator": "==",
+      "compare_field_id": "txtMacFilter",
+      "compare_js_template": "'{value}'.toString()",
+      "compare_use_quotes": true
+    }
+  ],
+  "show_ui": true,
+  "localized": [
+    "display_name",
+    "description",
+    "icon"
+  ],
+  "display_name": [
+    {
+      "language_code": "en_us",
+      "string": "UniFi import (API)"
+    }
+  ],
+  "description": [
+    {
+      "language_code": "en_us",
+      "string": "This plugin is used to import devices from an UNIFI controller via the Site Manager API."
+    }
+  ],
+  "icon": [
+    {
+      "language_code": "en_us",
+      "string": "<i class=\"fa-solid fa-shield-halved\"></i>"
+    }
+  ],
+  "params": [],
+  "settings": [
+    {
+      "function": "RUN",
+      "events": [
+        "run"
+      ],
+      "type": {
+        "dataType": "string",
+        "elements": [
+          {
+            "elementType": "select",
+            "elementOptions": [],
+            "transformers": []
+          }
+        ]
+      },
+      "default_value": "disabled",
+      "options": [
+        "disabled",
+        "once",
+        "schedule"
+      ],
+      "localized": [
+        "name",
+        "description"
+      ],
+      "name": [
+        {
+          "language_code": "en_us",
+          "string": "When to run"
+        }
+      ],
+      "description": [
+        {
+          "language_code": "en_us",
+          "string": "When the plugin should run. Good options are <code>schedule</code>, <code>once</code>."
+        }
+      ]
+    },
+    {
+      "function": "RUN_SCHD",
+      "type": {
+        "dataType": "string",
+        "elements": [
+          {
+            "elementType": "span",
+            "elementOptions": [
+              {
+                "cssClasses": "input-group-addon validityCheck"
+              },
+              {
+                "getStringKey": "Gen_ValidIcon"
+              }
+            ],
+            "transformers": []
+          },
+          {
+            "elementType": "input",
+            "elementOptions": [
+              {
+                "onChange": "validateRegex(this)"
+              },
+              {
+                "base64Regex": "Xig/OlwqfCg/OlswLTldfFsxLTVdWzAtOV18WzAtOV0rLVswLTldK3xcKi9bMC05XSspKVxzKyg/OlwqfCg/OlswLTldfDFbMC05XXwyWzAtM118WzAtOV0rLVswLTldK3xcKi9bMC05XSspKVxzKyg/OlwqfCg/OlsxLTldfFsxMl1bMC05XXwzWzAxXXxbMC05XSstWzAtOV0rfFwqL1swLTldKykpXHMrKD86XCp8KD86WzEtOV18MVswLTJdfFswLTldKy1bMC05XSt8XCovWzAtOV0rKSlccysoPzpcKnwoPzpbMC02XXxbMC02XS1bMC02XXxcKi9bMC05XSspKSQ="
+              }
+            ],
+            "transformers": []
+          }
+        ]
+      },
+      "default_value": "*/5 * * * *",
+      "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=\"#UNIFIAPI_RUN\"><code>UNIFIAPI_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": "CMD",
+      "type": {
+        "dataType": "string",
+        "elements": [
+          {
+            "elementType": "input",
+            "elementOptions": [
+              {
+                "readonly": "true"
+              }
+            ],
+            "transformers": []
+          }
+        ]
+      },
+      "default_value": "python3 /app/front/plugins/unifi_api_import/unifi_api_import.py",
+      "options": [],
+      "localized": [
+        "name",
+        "description"
+      ],
+      "name": [
+        {
+          "language_code": "en_us",
+          "string": "Command"
+        }
+      ],
+      "description": [
+        {
+          "language_code": "en_us",
+          "string": "Command to run. This can not be changed"
+        }
+      ]
+    },
+    {
+      "function": "RUN_TIMEOUT",
+      "type": {
+        "dataType": "integer",
+        "elements": [
+          {
+            "elementType": "input",
+            "elementOptions": [
+              {
+                "type": "number"
+              }
+            ],
+            "transformers": []
+          }
+        ]
+      },
+      "default_value": 10,
+      "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 the script to finish. If this time is exceeded the script is aborted."
+        }
+      ]
+    },
+    {
+      "function": "sites",
+      "type": {
+        "dataType": "array",
+        "elements": [
+          {
+            "elementType": "button",
+            "elementOptions": [
+              {
+                "sourceSuffixes": [
+                  "_in"
+                ]
+              },
+              {
+                "separator": ""
+              },
+              {
+                "cssClasses": "col-xs-12"
+              },
+              {
+                "onClick": "addViaPopupForm(this)"
+              },
+              {
+                "getStringKey": "Gen_Add"
+              },
+              {
+                "popupForm": [
+                  {
+                    "function": "name",
+                    "type": {
+                      "dataType": "string",
+                      "elements": [
+                        {
+                          "elementType": "input",
+                          "elementOptions": [
+                            {
+                              "placeholder": "Enter value"
+                            },
+                            {
+                              "suffix": "_in"
+                            },
+                            {
+                              "cssClasses": "col-sm-10"
+                            },
+                            {
+                              "prefillValue": "null"
+                            }
+                          ],
+                          "transformers": []
+                        }
+                      ]
+                    },
+                    "default_value": "default",
+                    "options": [],
+                    "localized": [
+                      "name",
+                      "description"
+                    ],
+                    "name": [
+                      {
+                        "language_code": "en_us",
+                        "string": "Site name"
+                      }
+                    ],
+                    "description": [
+                      {
+                        "language_code": "en_us",
+                        "string": "The name of your site. Use a descriptive name."
+                      }
+                    ]
+                  },
+                  {
+                    "function": "base_url",
+                    "type": {
+                      "dataType": "string",
+                      "elements": [
+                        {
+                          "elementType": "input",
+                          "elementOptions": [
+                            {
+                              "placeholder": "https://host_ip/proxy/network/integration/"
+                            },
+                            {
+                              "suffix": "_in"
+                            },
+                            {
+                              "cssClasses": "col-sm-10"
+                            },
+                            {
+                              "prefillValue": "null"
+                            }
+                          ],
+                          "transformers": []
+                        }
+                      ]
+                    },
+                    "default_value": "default",
+                    "options": [],
+                    "localized": [
+                      "name",
+                      "description"
+                    ],
+                    "name": [
+                      {
+                        "language_code": "en_us",
+                        "string": "Base URL"
+                      }
+                    ],
+                    "description": [
+                      {
+                        "language_code": "en_us",
+                        "string": "You can find your base url in the UniFi Site Manager in <i>Settings -> Control Plane -> Integrations</i> in the <i>API Request Format</i> section, (e.g. <code>https://host_ip/proxy/network/integration/</code>)."
+                      }
+                    ]
+                  },
+                  {
+                    "function": "version",
+                    "type": {
+                      "dataType": "string",
+                      "elements": [
+                        {
+                          "elementType": "input",
+                          "elementOptions": [
+                            {
+                              "placeholder": "v1"
+                            },
+                            {
+                              "suffix": "_in"
+                            },
+                            {
+                              "cssClasses": "col-sm-10"
+                            },
+                            {
+                              "prefillValue": "null"
+                            }
+                          ],
+                          "transformers": []
+                        }
+                      ]
+                    },
+                    "default_value": "default",
+                    "options": [],
+                    "localized": [
+                      "name",
+                      "description"
+                    ],
+                    "name": [
+                      {
+                        "language_code": "en_us",
+                        "string": "API version"
+                      }
+                    ],
+                    "description": [
+                      {
+                        "language_code": "en_us",
+                        "string": "The version of the API (e.g.: <code>v1</code>)."
+                      }
+                    ]
+                  },
+                  {
+                    "function": "api_key",
+                    "type": {
+                      "dataType": "string",
+                      "elements": [
+                        {
+                          "elementType": "input",
+                          "elementOptions": [
+                            {
+                              "placeholder": "Enter value"
+                            },
+                            {
+                              "suffix": "_in"
+                            },
+                            {
+                              "cssClasses": "col-sm-10"
+                            },
+                            {
+                              "prefillValue": "null"
+                            }
+                          ],
+                          "transformers": []
+                        }
+                      ]
+                    },
+                    "default_value": "default",
+                    "options": [],
+                    "localized": [
+                      "name",
+                      "description"
+                    ],
+                    "name": [
+                      {
+                        "language_code": "en_us",
+                        "string": "API key"
+                      }
+                    ],
+                    "description": [
+                      {
+                        "language_code": "en_us",
+                        "string": "You can get an API key in your UniFi Site Manager in <i>Settings -> Control Plane -> Integrations</i>."
+                      }
+                    ]
+                  },
+                  {
+                    "function": "hide.site.verify_ssl",
+                    "type": {
+                      "dataType": "boolean",
+                      "elements": [
+                        {
+                          "elementType": "input",
+                          "elementOptions": [
+                            {
+                              "type": "checkbox"
+                            }
+                          ],
+                          "transformers": []
+                        }
+                      ]
+                    },
+                    "default_value": 1,
+                    "options": [],
+                    "localized": [
+                      "name",
+                      "description"
+                    ],
+                    "name": [
+                      {
+                        "language_code": "en_us",
+                        "string": "Verify SSL"
+                      }
+                    ],
+                    "description": [
+                      {
+                        "language_code": "en_us",
+                        "string": "Disable if you do not have an SSL certificate set up."
+                      }
+                    ]
+                  }
+                ],
+                "transformers": []
+              }
+            ],
+            "transformers": []
+          },
+          {
+            "elementType": "select",
+            "elementHasInputValue": 1,
+            "elementOptions": [
+              {
+                "multiple": "true"
+              },
+              {
+                "readonly": "true"
+              },
+              {
+                "editable": "true"
+              }
+            ],
+            "transformers": [
+              "name|base64"
+            ]
+          },
+          {
+            "elementType": "button",
+            "elementOptions": [
+              {
+                "sourceSuffixes": []
+              },
+              {
+                "separator": ""
+              },
+              {
+                "cssClasses": "col-xs-6"
+              },
+              {
+                "onClick": "removeFromList(this)"
+              },
+              {
+                "getStringKey": "Gen_Remove_Last"
+              }
+            ],
+            "transformers": []
+          },
+          {
+            "elementType": "button",
+            "elementOptions": [
+              {
+                "sourceSuffixes": []
+              },
+              {
+                "separator": ""
+              },
+              {
+                "cssClasses": "col-xs-6"
+              },
+              {
+                "onClick": "removeAllOptions(this)"
+              },
+              {
+                "getStringKey": "Gen_Remove_All"
+              }
+            ],
+            "transformers": []
+          }
+        ]
+      },
+      "default_value": [],
+      "options": [],
+      "localized": [
+        "name",
+        "description"
+      ],
+      "name": [
+        {
+          "language_code": "en_us",
+          "string": "Sites"
+        }
+      ],
+      "description": [
+        {
+          "language_code": "en_us",
+          "string": "UniFi sites"
+        }
+      ]
+    }
+  ],
+  "database_column_definitions": [
+    {
+      "column": "Index",
+      "css_classes": "col-sm-2",
+      "show": true,
+      "type": "none",
+      "default_value": "",
+      "options": [],
+      "localized": [
+        "name"
+      ],
+      "name": [
+        {
+          "language_code": "en_us",
+          "string": "Index"
+        }
+      ]
+    },
+    {
+      "column": "Object_PrimaryID",
+      "mapped_to_column": "cur_MAC",
+      "css_classes": "col-sm-3",
+      "show": true,
+      "type": "device_name_mac",
+      "default_value": "",
+      "options": [],
+      "localized": [
+        "name"
+      ],
+      "name": [
+        {
+          "language_code": "en_us",
+          "string": "MAC (name)"
+        }
+      ]
+    },
+    {
+      "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"
+        }
+      ]
+    },
+    {
+      "column": "Watched_Value1",
+      "mapped_to_column": "cur_Name",
+      "css_classes": "col-sm-2",
+      "show": true,
+      "type": "label",
+      "default_value": "",
+      "options": [],
+      "localized": [
+        "name"
+      ],
+      "name": [
+        {
+          "language_code": "en_us",
+          "string": "Name"
+        }
+      ]
+    },
+    {
+      "column": "Watched_Value2",
+      "mapped_to_column": "cur_Vendor",
+      "css_classes": "col-sm-2",
+      "show": true,
+      "type": "label",
+      "default_value": "",
+      "options": [],
+      "localized": [
+        "name"
+      ],
+      "name": [
+        {
+          "language_code": "en_us",
+          "string": "Vendor"
+        }
+      ]
+    },
+    {
+      "column": "Watched_Value3",
+      "mapped_to_column": "cur_Type",
+      "css_classes": "col-sm-2",
+      "show": true,
+      "type": "label",
+      "default_value": "",
+      "options": [],
+      "localized": [
+        "name"
+      ],
+      "name": [
+        {
+          "language_code": "en_us",
+          "string": "Device Type"
+        }
+      ]
+    },
+    {
+      "column": "Watched_Value4",
+      "css_classes": "col-sm-2",
+      "show": false,
+      "type": "label",
+      "default_value": "",
+      "options": [],
+      "localized": [
+        "name"
+      ],
+      "name": [
+        {
+          "language_code": "en_us",
+          "string": "N/A"
+        }
+      ]
+    },
+    {
+      "column": "Dummy",
+      "mapped_to_column": "cur_ScanMethod",
+      "mapped_to_column_data": {
+        "value": "Example Plugin"
+      },
+      "css_classes": "col-sm-2",
+      "show": false,
+      "type": "label",
+      "default_value": "",
+      "options": [],
+      "localized": [
+        "name"
+      ],
+      "name": [
+        {
+          "language_code": "en_us",
+          "string": "Scan method"
+        }
+      ]
+    },
+    {
+      "column": "DateTimeCreated",
+      "css_classes": "col-sm-2",
+      "show": true,
+      "type": "label",
+      "default_value": "",
+      "options": [],
+      "localized": [
+        "name"
+      ],
+      "name": [
+        {
+          "language_code": "en_us",
+          "string": "Created"
+        }
+      ]
+    },
+    {
+      "column": "DateTimeChanged",
+      "css_classes": "col-sm-2",
+      "show": true,
+      "type": "label",
+      "default_value": "",
+      "options": [],
+      "localized": [
+        "name"
+      ],
+      "name": [
+        {
+          "language_code": "en_us",
+          "string": "Changed"
+        }
+      ]
+    },
+    {
+      "column": "Status",
+      "css_classes": "col-sm-1",
+      "show": true,
+      "type": "replace",
+      "default_value": "",
+      "options": [
+        {
+          "equals": "watched-not-changed",
+          "replacement": "<div style='text-align:center'><i class='fa-solid fa-square-check'></i><div></div>"
+        },
+        {
+          "equals": "watched-changed",
+          "replacement": "<div style='text-align:center'><i class='fa-solid fa-triangle-exclamation'></i></div>"
+        },
+        {
+          "equals": "new",
+          "replacement": "<div style='text-align:center'><i class='fa-solid fa-circle-plus'></i></div>"
+        },
+        {
+          "equals": "missing-in-last-scan",
+          "replacement": "<div style='text-align:center'><i class='fa-solid fa-question'></i></div>"
+        }
+      ],
+      "localized": [
+        "name"
+      ],
+      "name": [
+        {
+          "language_code": "en_us",
+          "string": "Status"
+        }
+      ]
+    }
+  ]
+}

front/plugins/unifi_api_import/unifi_api_import.py

@@ -0,0 +1,124 @@
+#!/usr/bin/env python
+
+import os
+import pathlib
+import sys
+import json
+import sqlite3
+from pytz import timezone
+
+# Define the installation path and extend the system path for plugin imports
+INSTALL_PATH = "/app"
+sys.path.extend([f"{INSTALL_PATH}/front/plugins", f"{INSTALL_PATH}/server"])
+
+from plugin_helper import Plugin_Object, Plugin_Objects, decodeBase64
+from plugin_utils import get_plugins_configs
+from logger import mylog, Logger
+from const import pluginsPath, fullDbPath, logPath
+from helper import timeNowTZ, get_setting_value 
+
+from messaging.in_app import write_notification
+import conf
+
+# Make sure the TIMEZONE for logging is correct
+conf.tz = timezone(get_setting_value('TIMEZONE'))
+
+# Make sure log level is initialized correctly
+Logger(get_setting_value('LOG_LEVEL'))
+
+pluginName = '<unique_prefix>'
+
+# Define the current path and log file paths
+LOG_PATH = logPath + '/plugins'
+LOG_FILE = os.path.join(LOG_PATH, f'script.{pluginName}.log')
+RESULT_FILE = os.path.join(LOG_PATH, f'last_result.{pluginName}.log')
+
+# Initialize the Plugin obj output file
+plugin_objects = Plugin_Objects(RESULT_FILE)
+
+
+
+def main():
+    mylog('verbose', [f'[{pluginName}] In script']) 
+
+    # Retrieve configuration settings
+    some_setting = get_setting_value('SYNC_plugins')
+
+    mylog('verbose', [f'[{pluginName}] some_setting value {some_setting}'])
+
+    # retrieve data
+    device_data = get_device_data(some_setting)
+
+    #  Process the data into native application tables
+    if len(device_data) > 0:
+
+        # insert devices into the lats_result.log 
+        # make sure the below mapping is mapped in config.json, for example: 
+        #"database_column_definitions": [
+        # {
+        #   "column": "Object_PrimaryID",                 <--------- the value I save into primaryId
+        #   "mapped_to_column": "cur_MAC",                <--------- gets inserted into the CurrentScan DB table column cur_MAC
+        # 
+        for device in device_data:
+                plugin_objects.add_object(
+                    primaryId   = device['mac_address'],
+                    secondaryId = device['ip_address'],
+                    watched1    = device['hostname'],
+                    watched2    = device['vendor'],
+                    watched3    = device['device_type'],
+                    watched4    = device['last_seen'],
+                    extra       = '',
+                    foreignKey  = device['mac_address']
+                    # helpVal1  = "Something1",  # Optional Helper values to be passed for mapping into the app 
+                    # helpVal2  = "Something1",  # If you need to use even only 1, add the remaining ones too 
+                    # helpVal3  = "Something1",  # and set them to 'null'. Check the the docs for details:
+                    # helpVal4  = "Something1",  # https://github.com/jokob-sk/NetAlertX/blob/main/docs/PLUGINS_DEV.md
+                    )
+
+        mylog('verbose', [f'[{pluginName}] New entries: "{len(device_data)}"'])
+
+    # log result
+    plugin_objects.write_result_file()
+
+    return 0
+
+#  retrieve data
+def get_device_data(some_setting):
+    
+    device_data = []
+
+    # do some processing, call exteranl APIs, and return a device_data list
+    #  ...
+    # 
+    # Sample data for testing purposes, you can adjust the processing in main() as needed
+    # ... before adding it to the plugin_objects.add_object(...)
+    device_data = [
+        {
+            'device_id': 'device1',
+            'mac_address': '00:11:22:33:44:55',
+            'ip_address': '192.168.1.2',
+            'hostname': 'iPhone 12',
+            'vendor': 'Apple Inc.',
+            'device_type': 'Smartphone',
+            'last_seen': '2024-06-27 10:00:00',
+            'port': '1',
+            'network_id': 'network1'
+        },
+        {
+            'device_id': 'device2',
+            'mac_address': '00:11:22:33:44:66',
+            'ip_address': '192.168.1.3',
+            'hostname': 'Moto G82',
+            'vendor': 'Motorola Inc.',
+            'device_type': 'Laptop',
+            'last_seen': '2024-06-27 10:05:00',
+            'port': '',
+            'network_id': 'network1'
+        }
+    ]
+
+    # Return the data to be detected by the main application 
+    return device_data
+
+if __name__ == '__main__':
+    main()

front/report.php

@@ -1,7 +1,7 @@
 <?php
 
   require 'php/templates/header.php';
-  require 'php/templates/notification.php';
+  require 'php/templates/modals.php';
   
 ?>
 

front/settings.php

@@ -58,6 +58,12 @@ $settingsJSON_DB = json_encode($settings, JSON_HEX_TAG | JSON_HEX_AMP | JSON_HEX
 
 <div id="settingsPage" class="content-wrapper">
 
+<a style="cursor:pointer">
+  <span>
+    <i id='toggleSettings' onclick="toggleAllSettings()" class="settings-expand-icon fa fa-angle-double-down"></i>
+  </span> 
+</a>
+
 <!-- Content header--------------------------------------------------------- -->
 
     <section class="content-header">
@@ -597,7 +603,8 @@ $settingsJSON_DB = json_encode($settings, JSON_HEX_TAG | JSON_HEX_AMP | JSON_HEX
             customParams,
             customId,
             columns,
-            base64Regex
+            base64Regex,
+            elementOptionsBase64
           } = handleElementOptions('none', elementOptions, transformers, val = "");
 
           let value;

front/systeminfo.php

@@ -13,7 +13,7 @@
 
   require 'php/templates/header.php';
 ?>
-<?php require 'php/templates/notification.php'; ?>
+<?php require 'php/templates/modals.php'; ?>
 <!-- ----------------------------------------------------------------------- -->
  
 

front/workflows.php

@@ -1,7 +1,7 @@
 <?php
 
   require 'php/templates/header.php';  
-  require 'php/templates/notification.php'; 
+  require 'php/templates/modals.php'; 
 ?>
 <!-- ----------------------------------------------------------------------- -->
  

install/install_dependencies.debian.sh

@@ -30,5 +30,5 @@ source myenv/bin/activate
 update-alternatives --install /usr/bin/python python /usr/bin/python3 10
 
 #  install packages thru pip3
-pip3 install openwrt-luci-rpc asusrouter asyncio aiohttp graphene flask flask-cors tplink-omada-client wakeonlan pycryptodome requests paho-mqtt scapy cron-converter pytz json2table dhcp-leases pyunifi speedtest-cli chardet python-nmap dnspython librouteros yattag git+https://github.com/foreign-sub/aiofreepybox.git 
+pip3 install openwrt-luci-rpc asusrouter asyncio aiohttp graphene flask flask-cors unifi-sm-api tplink-omada-client wakeonlan pycryptodome requests paho-mqtt scapy cron-converter pytz json2table dhcp-leases pyunifi speedtest-cli chardet python-nmap dnspython librouteros yattag git+https://github.com/foreign-sub/aiofreepybox.git 
 

mkdocs.yml

@@ -64,6 +64,7 @@ nav:
       - Debugging Tips: DEBUG_TIPS.md
       - Debugging GraphQL: DEBUG_GRAPHQL.md
       - Debugging Invalid JSON: DEBUG_INVALID_JSON.md
+      - Debugging PHP: DEBUG_PHP.md
       - Debugging Plugins: DEBUG_PLUGINS.md
       - Debugging Web UI Port: WEB_UI_PORT_DEBUG.md
       - Debugging Workflows: WORKFLOWS_DEBUGGING.md

server/initialise.py

@@ -275,6 +275,15 @@ def importConfigs (db, all_plugins):
                 # Save the user defined value into the object
                 set["value"] = v
 
+                # Now check for popupForm inside elements → elementOptions
+                elements = set.get("type", {}).get("elements", [])
+                for element in elements:
+                    for option in element.get("elementOptions", []):
+                        if "popupForm" in option:
+                            for popup_entry in option["popupForm"]:
+                                popup_pref = key + "_popupform_" + popup_entry.get("function", "")
+                                stringSqlParams = collect_lang_strings(popup_entry, popup_pref, stringSqlParams)
+
                 # Collect settings related language strings
                 # Creates an entry with key, for example ARPSCAN_CMD_name
                 stringSqlParams = collect_lang_strings(set,  pref + "_" + set["function"], stringSqlParams)