Cleanup work

2025-12-07 01:26:11 -08:00 · 2024-08-11 21:13:12 +10:00
parent 3cde177e01
commit fff1f36b61
10 changed files with 43 additions and 309 deletions
--- a/Dockerfile.debian
+++ b/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 tplink-omada-client pycryptodome requests paho-mqtt scapy cron-converter pytz json2table dhcp-leases pyunifi speedtest-cli chardet python-nmap dnspython cryptography "
+RUN /bin/bash -c "source myenv/bin/activate && update-alternatives --install /usr/bin/python python /usr/bin/python3 10 && pip3 install tplink-omada-client pycryptodome requests paho-mqtt scapy cron-converter pytz json2table dhcp-leases pyunifi speedtest-cli chardet python-nmap dnspython cryptography librouteros "

 # Create a buildtimestamp.txt to later check if a new version was released
 RUN date +%s > ${INSTALL_DIR}/front/buildtimestamp.txt
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-# 💻🔍 Network scanner & notification framework
+# 🖧🔍 Network scanner & notification framework

 Get visibility of what's going on on your WIFI/LAN network. Schedule scans for devices, port changes and get alerts if unknown devices or changes are found. Write your own [Plugins](https://github.com/jokob-sk/NetAlertX/tree/main/front/plugins#readme) with auto-generated UI and in-build notification system. Build out and easily maintain your network source of truth (NSoT).

@@ -64,7 +64,7 @@ Head to [https://netalertx.com/](https://netalertx.com/) for more gifs and scree
 | Docs        | Link    | 
 |-------------|-------------|
 | 📥🐳  | [Docker instructions](https://github.com/jokob-sk/NetAlertX/blob/main/dockerfiles/README.md) 
-| 📥💻  | [HW install (experimental 🧪)](https://github.com/jokob-sk/NetAlertX/blob/main/docs/HW_INSTALL.md) |
+| 📥🗄️  | [HW install (experimental 🧪)](https://github.com/jokob-sk/NetAlertX/blob/main/docs/HW_INSTALL.md) |
 | 📥🟧  | [Unraid App](https://unraid.net/community/apps) |
 | 📚     | [All Documentation](https://github.com/jokob-sk/NetAlertX/blob/main/docs/README.md) (App Usage and Configuration) |
 
--- a/dockerfiles/README.md
+++ b/dockerfiles/README.md
@@ -4,7 +4,7 @@
 ![GitHub Release](https://img.shields.io/github/v/release/jokob-sk/NetAlertX?color=0aa8d2&logoColor=fff&logo=GitHub)
 [![GitHub Sponsors](https://img.shields.io/github/sponsors/jokob-sk?style=social)](https://github.com/sponsors/jokob-sk)

-# NetAlertX 💻🔍 Network scanner & notification framework
+# NetAlertX 🖧🔍 Network scanner & notification framework

  | 🐳 [Docker hub](https://registry.hub.docker.com/r/jokobsk/netalertx) |  📑 [Docker guide](https://github.com/jokob-sk/NetAlertX/blob/main/dockerfiles/README.md) |🆕 [Release notes](https://github.com/jokob-sk/NetAlertX/releases) | 📚 [All Docs](https://github.com/jokob-sk/NetAlertX/tree/main/docs) |
  |----------------------|----------------------| ----------------------|  ----------------------| 
--- a/front/js/common.js
+++ b/front/js/common.js
@@ -666,7 +666,7 @@ function openUrl(urls) {
 // -----------------------------------------------------------------------------
 function navigateToDeviceWithIp (ip) {

-  $.get('api/table_devices.json', function(res) {    
+  $.get('api/table_devices.json?nocache=' + Date.now(), function(res) {    
        
    devices = res["data"];

@@ -876,9 +876,9 @@ function cacheDevices()

  return new Promise((resolve, reject) => {

-    if(!getCache('completedCalls').includes('cacheDevices'))
-    {
-      $.get('api/table_devices.json', function(data) {    
+    // if(!getCache('completedCalls').includes('cacheDevices'))
+    // {
+      $.get('api/table_devices.json?nocache=' + Date.now(), function(data) {    
        
        // console.log(data)

@@ -901,7 +901,8 @@ function cacheDevices()
        // console.log(getCache('devicesListAll_JSON'))
      }).then(() => handleSuccess('cacheDevices', resolve())).catch(() => handleFailure('cacheDevices', reject("cacheDevices already completed"))); // handle AJAX synchronization
    } 
-  });
+  // }
+);
 }

 var devicesListAll_JSON      = [];   // this will contain a list off all devices 
@@ -1281,7 +1282,7 @@ const areAllStringsInitialized = () => {
 // Call the function to execute the code
 executeOnce();

-// Set timer for regular checks 
+// Set timer for regular UI refresh if enabled 
 setTimeout(() => {

  // page refresh if configured
--- a/front/js/modal.js
+++ b/front/js/modal.js
@@ -242,6 +242,18 @@ $(document).ready(function () {
 });


+// -----------------------------------------------------------------------------
+// Escape text
+function safeDecodeURIComponent(content) {
+    try {
+      return decodeURIComponent(content);
+    } catch (error) {
+      console.warn('Failed to decode URI component:', error);
+      return content;  // Return the original content if decoding fails
+    }
+  }
+  
+
 // -----------------------------------------------------------------------------
 // Backend notification Polling 
 // -----------------------------------------------------------------------------
@@ -266,7 +278,9 @@ function checkNotification() {
                if (oldestInterruptNotification) {
                    // Show modal dialog with the oldest unread notification

-                    const decodedContent = decodeURIComponent(oldestInterruptNotification.content);
+                    console.log(oldestInterruptNotification.content);
+
+                    const decodedContent = safeDecodeURIComponent(oldestInterruptNotification.content);

                    showModalOK("Notification", decodedContent, function() {
                        // Mark the notification as read
--- a/front/network.php
+++ b/front/network.php
@@ -359,12 +359,17 @@
  <?php   

    // Get all Unassigned / unconnected nodes 
-    $func_sql = 'SELECT dev_MAC as mac,  
-                        dev_PresentLastScan as online, 
-                        dev_Name as name,                        
-                        dev_LastIP as last_ip,
+    $func_sql = 'SELECT 
+                  dev_MAC AS mac,
+                  dev_PresentLastScan AS online,
+                  dev_Name AS name,
+                  dev_LastIP AS last_ip,
                  dev_Network_Node_MAC_ADDR
-                    FROM Devices WHERE (dev_Network_Node_MAC_ADDR is null or dev_Network_Node_MAC_ADDR = "" or dev_Network_Node_MAC_ADDR = " " or dev_Network_Node_MAC_ADDR = "undefined") and dev_MAC not like "%internet%" order by name asc'; 
+                FROM Devices
+                WHERE dev_Network_Node_MAC_ADDR IS NULL 
+                  OR dev_Network_Node_MAC_ADDR IN ("", " ", "undefined", "null")
+                  AND dev_MAC NOT LIKE "%internet%"
+                ORDER BY name ASC;'; 

    global $db;
    $func_result = $db->query($func_sql);  
--- a/front/plugins/README.md
+++ b/front/plugins/README.md
@@ -44,7 +44,7 @@ Device-detecting plugins insert values into the `CurrentScan` database table.  T
 | `NSLOOKUP`    | ♻       | NSLookup (DNS-based) name resolution      |           |          | Script       | [nslookup_scan](/front/plugins/nslookup_scan/)                    |
 | `NTFPRCS`     | ⚙       | Notification processing                   |           |  Yes     | Template     | [notification_processing](/front/plugins/notification_processing/)|
 | `NTFY`        | ▶️      | NTFY notifications                        |           |          | Script       | [_publisher_ntfy](/front/plugins/_publisher_ntfy/)                |
-| `OMDSDN`      | 📥      | OMADA TP-Link import                      |   📊🔄   |          | Script       | [omada_sdn_imp](/front/plugins/omada_sdn_imp/)                    |
+| `OMDSDN`      | 📥      | OMADA TP-Link import                      |   🖧 🔄   |          | Script       | [omada_sdn_imp](/front/plugins/omada_sdn_imp/)                    |
 | `PHOLUS`      | ♻       | Pholus name resolution                    |           |          | Script       | [pholus_scan](/front/plugins/pholus_scan/)                        |
 | `PIHOLE`      | 🔍/📥   | Pi-hole device import & sync              |           |          | SQLite DB    | [pihole_scan](/front/plugins/pihole_scan/)                        |
 | `PUSHSAFER`   | ▶️      | Pushsafer notifications                   |           |          | Script       | [_publisher_pushsafer](/front/plugins/_publisher_pushsafer/)      |
@@ -52,9 +52,9 @@ Device-detecting plugins insert values into the `CurrentScan` database table.  T
 | `SETPWD`      | ⚙       | Set password                              |           |  Yes     | Template     | [set_password](/front/plugins/set_password/)                      |
 | `SMTP`        | ▶️      | Email notifications                       |           |          | Script       | [_publisher_email](/front/plugins/_publisher_email/)              |
 | `SNMPDSC`     | 🔍/📥   | SNMP device import & sync                 |           |          | Script       | [snmp_discovery](/front/plugins/snmp_discovery/)                  |
-| `SYNC`        | 🔍/⚙/📥| Sync & import from NetAlertX instances    |   📊🔄    |          | Script       | [sync](/front/plugins/sync/)                                     |
+| `SYNC`        | 🔍/⚙/📥| Sync & import from NetAlertX instances    |   🖧 🔄    |          | Script       | [sync](/front/plugins/sync/)                                     |
 | `UNDIS`       | 🔍/📥   | Create dummy devices                      |           |          | Script       | [undiscoverables](/front/plugins/undiscoverables/)                |
-| `UNFIMP`      | 🔍/📥   | UniFi device import & sync                |           |          | Script       | [unifi_import](/front/plugins/unifi_import/)                      |
+| `UNFIMP`      | 🔍/📥   | UniFi device import & sync                |  🖧       |          | Script       | [unifi_import](/front/plugins/unifi_import/)                      |
 | `VNDRPDT`     | ⚙       | Vendor database update                    |           |          | Script       | [vendor_update](/front/plugins/vendor_update/)                    |
 | `WEBHOOK`     | ▶️      | Webhook notifications                     |           |          | Script       | [_publisher_webhook](/front/plugins/_publisher_webhook/)          |
 | `WEBMON`      | ♻       | Website down monitoring                   |           |          | Script       | [website_monitor](/front/plugins/website_monitor/)                |
@@ -81,7 +81,7 @@ Device-detecting plugins insert values into the `CurrentScan` database table.  T

 | Icon  | Description                                                  | 
 |------|---------------------------------------------------------------|
-| 📊   | Auto-imports the network topology diagram                     |
+| 🖧    | Auto-imports the network topology diagram                     |
 | 🔄   | Has the option to sync some data back into the plugin source  |


--- a/front/plugins/omada_sdn_imp/testre.py
+++ b/front/plugins/omada_sdn_imp/testre.py
@@ -1,285 +0,0 @@
-import re
-
-""""
-how to rebuild and re-run...
-
-savefolder=~/naxdev/NetAlertX.v7
-cd ~/naxdev
-mv NetAlertX $savefolder
-gh repo clone FlyingToto/NetAlertX
-cd NetAlertX
-ln -s ../docker-compose.yml.ffsb42 .
-ln -s ../.env.omada.ffsb42 .
-cd front/plugins/omada_sdn_imp/
-cp -p $savefoder/front/plugins/omada_sdn_imp/omada_sdn.py* .
-cp -p $savefoder/front/plugins/omada_sdn_imp/README.md .
-cp -p $savefoder/front/plugins/omada_sdn_imp/omada_account_sample.png .
-cp -p $savefoder/front/plugins/omada_sdn_imp/testre.py .
-#cp -p $savefoder/front/plugins/omada_sdn_imp/config.json config.json.v6
-cd ~/naxdev/NetAlertX
-sudo docker-compose --env-file .env.omada.ffsb42  -f ./docker-compose.yml.ffsb42  up
-
-to gather data for Boris:
-today=$(date +%Y_%m_%d__%H_%M)
-mkdir /drives/c/temp/4boris/$today
-cd  /drives/c/temp/4boris/$today
-scp hal:~/naxdev/logs/app.log .
-scp hal:~/naxdev/NetAlertX/front/plugins/omada_sdn_imp/* .
-gzip -c app.log  > app_$today.log.gz
-
-
-scp hal:~/naxdev/NetAlertX/front/plugins/omada_sdn_imp/omada_sdn.py /drives/c/temp/4boris/
-"""
-
-
-
-
-def extract_mac_addresses(text):
-    mac_pattern = r"([0-9A-Fa-f]{2}[:-][0-9A-Fa-f]{2}[:-][0-9A-Fa-f]{2}[:-][0-9A-Fa-f]{2}[:-][0-9A-Fa-f]{2}[:-][0-9A-Fa-f]{2})"
-    #mac_pattern = r'([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})'
-    #r"(([0-9A-F]{2}-){5}[0-9A-F]{2})"
-    #r"([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})"
-    #r"([0-9A-Fa-f]{2}[:-][0-9A-Fa-f]{2}[:-][0-9A-Fa-f]{2}[:-][0-9A-Fa-f]{2}[:-][0-9A-Fa-f]{2}[:-][0-9A-Fa-f]{2})"
-    mac_addresses = re.findall(mac_pattern, text)
-    return ["".join(parts) for parts in mac_addresses]
-
-# Example usage:
-foo = """
-Name: office
-Address: 0C-80-63-69-C4-D1 (192.168.0.5)
-Status: CONNECTED (CONNECTED)
-Ports: 28
-Supports PoE: False
-Model: T1600G-28TS v3.0
-LED Setting: SITE_SETTINGS
-Uptime: 5day(s) 22h 39m 6s
-Uplink switch: D8-07-B6-71-FF-7F office24
-Downlink devices:
- 40-AE-30-A5-A7-50 ompapaoffice
- B0-95-75-46-0C-39 pantry12
-"""
-
-mac_list = extract_mac_addresses(foo)
-print("mac list",mac_list)
-# ['0C-80-63-69-C4-D1', 'D8-07-B6-71-FF-7F', '40-AE-30-A5-A7-50', 'B0-95-75-46-0C-39']
-# ['C4-:D1', 'FF-:7F', 'A7-:50', '0C-:39']
-
-linked_switches_and_ports_by_mac = {}
-
-
-foo = """"
-something
-some BOB12
-blah BOB23
--- BEGIN ---
-something else BOB12
-blah BOB23
--- END ---
-"""
-def extract_BOB_patterns(foo):
-    pattern = r"BOB\d{2}(?=.*BEGIN)"
-    matches = re.findall(pattern, foo, re.DOTALL)
-    return matches
-
-BOBresult = extract_BOB_patterns(foo)
-print("BOB:",BOBresult)  # Output: ['BOB12', 'BOB23']
-
-
-#0C-80-63-69-C4-D1 
-clientmac_by_switchmac_by_switchportSSID = {}
-switch_mac_and_ports_by_clientmac = {}
-
-def extract_uplinks_mac_and_ports(tplink_device_dump):
-    mac_switches = []
-    mac_pattern = r"([0-9A-Fa-f]{2}[:-][0-9A-Fa-f]{2}[:-][0-9A-Fa-f]{2}[:-][0-9A-Fa-f]{2}[:-][0-9A-Fa-f]{2}[:-][0-9A-Fa-f]{2})(?=.*BEGIN)"
-    mac_addresses = re.findall(mac_pattern, tplink_device_dump,re.DOTALL)
-    mac_switches =  ["".join(parts) for parts in mac_addresses]
-    print(" mac_switches1=",mac_switches)
-    mymac = mac_switches[0]
-    mylinks =  mac_switches[1:]
-    for mylink in mylinks:
-        port_pattern = r"(?=\{.*\"port\"\: )([0-9]+)(?=.*"+re.escape(mylink)+r")"
-        port_pattern = r"(?:{/s\"port\"\: )([0-9]+)(?:[!\}].*"+re.escape(mylink)+r")"        
-        #port_pattern = rf"{{.*?{found_mac}.*?port\s*:\s*(\d+).*?}}"
-        #port_pattern = rf"{{.*?.*?port\s*:\s*(\d+)[!\\}]*{mylink}?}}"
-        port_pattern = r"(?:\{[!\}]port/s:/s)([0-9]+\,)(?:[!\}]*"+re.escape(mylink)+r"[!\{]*\})"        
-        #port_pattern = r"(?:\{.*\"port\"\: )([0-9]+)(?=.*"+re.escape(mylink)+r")"
-        port_pattern = r"(?:{[^}]*\"port\"\: )([0-9]+)(?=[^}]*"+re.escape(mylink)+r")"
-        
-        myport = re.findall(port_pattern, tplink_device_dump,re.DOTALL)
-        print("myswitch=",mymac, "- link_switch=", mylink, "myport=", myport) 
-    return(0)
-
-
-'''
-with open('/tmp/switch.bigroom.dump.json', 'r') as file:
-    foo3 = file_content = file.read()
-print("bigroom", end="")
-extract_uplinks_mac_and_ports(foo3)
-with open('/tmp/switch.office.dump.json', 'r') as file:
-    foo4 = file_content = file.read()
-print("office", end="")
-extract_uplinks_mac_and_ports(foo4)
-'''
-
-import netifaces
-gw = netifaces.gateways()
-print(gw['default'][netifaces.AF_INET][0])
-
-
-d = {'a': ['0', 'Arthur'], 'b': ['foo', 'Belling']}
-
-print(d.items())
-print(d.keys())
-print(d.values())
-
-
-foo = 2
-#while foo > 0:
-#    foo = 'toto'
-print("foo is ",foo)
-
-if foo in ( 'bar', '', 'null'):
-    print("foo is bar")
-else:
-    print("foo is not bar")
-
-foo='192-168-0-150.local'
-bar = foo.split('.')[0]
-print("bar=",bar,"-")
-bar2 = 'toto'
-print("bar2=",bar2,"-")
-
-
-
-import concurrent.futures
-import time
-import random
-
-def phello(arg):
-    print('running phell',arg)
-    delay = random.uniform(0, 6)
-    time.sleep(delay)
-    return f"parallel hello : {arg}", delay
-
-def testparalel():
-    arguments = ["Alice", "Bob", "Charlie", "David"]
-    results = {}
-    results2 = {}
-    para = 10
-
-    # Using ThreadPoolExecutor for parallel execution
-    with concurrent.futures.ThreadPoolExecutor(max_workers=para) as executor:
-        # Submit tasks to the executor
-        future_to_arg = {executor.submit(phello, arg): arg for arg in arguments}
-        
-        # Wait for all futures to complete
-        done, _ = concurrent.futures.wait(future_to_arg)
-
-        # Retrieve results
-        for future in done:
-            arg = future_to_arg[future]
-            try:
-                result, result2 = future.result()
-                results[arg] = result
-                results2[arg] = result2
-            except Exception as exc:
-                print(f"{arg} generated an exception: {exc}")
-
-    # Print results after all threads have completed
-    print("All threads completed. Results:")
-    for arg, result in results.items():
-        print(f"arg:{arg}, result={results[arg]}, result2={results2[arg]}")
-
-
-#testparalel()
-
-
-
-import netifaces
-import ipaddress
-
-def get_interfaces_and_subnets():
-    result = []
-    for interface in netifaces.interfaces():
-        addrs = netifaces.ifaddresses(interface)
-        if netifaces.AF_INET in addrs:
-            for addr in addrs[netifaces.AF_INET]:
-                ip = addr['addr']
-                mask = addr['netmask']
-                try:
-                    network = ipaddress.IPv4Network(f"{ip}/{mask}", strict=False)
-                    result.append((interface, str(network)))
-                except ValueError:
-                    pass
-    return result
-
-# Example usage:
-interfaces_and_subnets = get_interfaces_and_subnets()
-for interface, subnet in interfaces_and_subnets:
-    print(f"interface={interface}, subnet={subnet}")
-
-
-'''
-interface=lo, subnet=127.0.0.0/8
-interface=enp6s0, subnet=192.168.0.0/24
-interface=br-ba0070d71f2a, subnet=172.16.0.16/29
-interface=br-bc4a4c4e0f93, subnet=172.16.0.40/29
-interface=br-e043e0ae9c8c, subnet=172.16.0.72/29
-interface=br-6acc3945cfba, subnet=172.16.0.48/29
-interface=br-6f931807e709, subnet=172.16.0.80/29
-interface=docker0, subnet=172.17.0.0/16
-interface=br-9ce2cb7c38c3, subnet=172.16.0.24/29
-interface=br-eec81501f666, subnet=172.16.0.32/29
-interface=br-1064712a4791, subnet=172.16.0.56/29
-interface=br-a93ebdba2a28, subnet=172.16.0.8/29
-interface=br-d8fa7a3015e2, subnet=172.16.0.64/29
-interface=br-e7cdd041d3d3, subnet=172.16.0.0/29
-'''
-
-
-import timeit
-
-# Setup: Create a dictionary and a function with if-elif statements
-data = {
-    "apple": 1,
-    "banana": 2,
-    "cherry": 3,
-    "date": 4,
-    "elderberry": 5
-}
-
-def get_value_dict(key):
-    return data.get(key, 0)
-
-def get_value_if_elif(key):
-    if key == "apple":
-        return 1
-    elif key == "banana":
-        return 2
-    elif key == "cherry":
-        return 3
-    elif key == "date":
-        return 4
-    elif key == "elderberry":
-        return 5
-    else:
-        return 0
-
-# Test dictionary lookup
-dict_time = timeit.timeit(
-    'get_value_dict("elderberry")',
-    setup='from __main__ import get_value_dict',
-    number=1000000
-)
-
-# Test if-elif statements
-if_elif_time = timeit.timeit(
-    'get_value_if_elif("elderberry")',
-    setup='from __main__ import get_value_if_elif',
-    number=1000000
-)
-
-print(f"Dictionary lookup time: {dict_time:.6f} seconds")
-print(f"If-elif statements time: {if_elif_time:.6f} seconds")
-print(f"Dictionary is {if_elif_time / dict_time:.2f}x faster")
--- a/front/plugins/unifi_import/README.md
+++ b/front/plugins/unifi_import/README.md
@@ -1,6 +1,6 @@
 ## Overview

-A plugin allowing for importing devices from a UniFi controller.  
+A plugin allowing for importing devices from a UniFi controller. The plugin also tries to import the network map. 

 ### Usage

@@ -17,5 +17,4 @@ Specify the following settings in the Settings section of NetAlertX:

 ### Notes

- Currently only used to import devices, not their status, type or network map.
 - It is recommended to create a read-only user in your UniFi controller 
--- a/install/install_dependencies.debian.sh
+++ b/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 netifaces tplink-omada-client pycryptodome requests paho-mqtt scapy cron-converter pytz json2table dhcp-leases pyunifi speedtest-cli chardet python-nmap dnspython cryptography 
+pip3 install netifaces tplink-omada-client pycryptodome requests paho-mqtt scapy cron-converter pytz json2table dhcp-leases pyunifi speedtest-cli chardet python-nmap dnspython librouteros cryptography