Replace global wifi_functions with WiFiManager class

includes/configure_client.php

@@ -1,6 +1,6 @@
 <?php
 
-require_once 'includes/wifi_functions.php';
+use RaspAP\Networking\Hotspot\WiFiManager;
 
 /**
  *
@@ -8,12 +8,13 @@ require_once 'includes/wifi_functions.php';
  */
 function DisplayWPAConfig()
 {
+    $wifi = new WiFiManager();
     $status = new \RaspAP\Messages\StatusMessage;
     $networks = [];
 
-    getWifiInterface();
+    $wifi->getWifiInterface();
-    knownWifiStations($networks);
+    $wifi->knownWifiStations($networks);
-    setKnownStationsWPA($networks);
+    $wifi->setKnownStationsWPA($networks);
 
     $iface = escapeshellarg($_SESSION['wifi_client_interface']);
 
@@ -30,7 +31,7 @@ function DisplayWPAConfig()
     } elseif (isset($_POST['wpa_reinit'])) {
         $status->addMessage('Attempting to reinitialize wpa_supplicant', 'warning');
         $force_remove = true;
-        $result = reinitializeWPA($force_remove);
+        $result = $wifi->reinitializeWPA($force_remove);
     } elseif (isset($_POST['client_settings'])) {
         $tmp_networks = $networks;
         if ($wpa_file = fopen('/tmp/wifidata', 'w')) {
@@ -90,7 +91,7 @@ function DisplayWPAConfig()
                     if (strlen($network['passphrase']) >=8 && strlen($network['passphrase']) <= 63) {
                         unset($wpa_passphrase);
                         unset($line);
-                        exec('wpa_passphrase '. ssid2utf8( escapeshellarg($ssid) ) . ' ' . escapeshellarg($network['passphrase']), $wpa_passphrase);
+                        exec('wpa_passphrase '. $wifi->ssid2utf8( escapeshellarg($ssid) ) . ' ' . escapeshellarg($network['passphrase']), $wpa_passphrase);
                         foreach ($wpa_passphrase as $line) {
                             if (preg_match('/^\s*}\s*$/', $line)) {
                                 if (array_key_exists('priority', $network)) {

includes/dashboard.php

@@ -1,22 +1,28 @@
 <?php
 
 require_once 'includes/config.php';
-require_once 'includes/wifi_functions.php';
 require_once 'includes/functions.php';
 
+use RaspAP\System\Sysinfo;
+use RaspAP\UI\Dashboard;
+use RaspAP\Messages\StatusMessage;
+use RaspAP\Plugins\PluginManager;
+use RaspAP\Networking\Hotspot\WiFiManager;
+
 /**
  * Displays the dashboard
  */
 function DisplayDashboard(&$extraFooterScripts): void
 {
     // instantiate RaspAP objects
-    $system = new \RaspAP\System\Sysinfo;
+    $system = new Sysinfo();
-    $dashboard = new \RaspAP\UI\Dashboard;
+    $dashboard = new Dashboard();
-    $status = new \RaspAP\Messages\StatusMessage;
+    $status = new StatusMessage();
-    $pluginManager = \RaspAP\Plugins\PluginManager::getInstance();
+    $pluginManager = PluginManager::getInstance();
+    $wifi = new WiFiManager();
 
     // set AP and client interface session vars
-    getWifiInterface();
+    $wifi->getWifiInterface();
 
     $interface = $_SESSION['ap_interface'] ?? 'wlan0';
     $clientInterface = $_SESSION['wifi_client_interface'];

includes/dhcp.php

@@ -2,12 +2,18 @@
 
 require_once 'config.php';
 
+use RaspAP\Networking\Hotspot\WiFiManager;
+use RaspAP\Messages\StatusMessage;
+
 /**
  * Manage DHCP configuration
  */
 function DisplayDHCPConfig()
 {
-    $status = new \RaspAP\Messages\StatusMessage;
+    $status = new StatusMessage();
+    $wifi = new WiFiManager();
+    $wifi->getWifiInterface();
+
     if (!RASPI_MONITOR_ENABLED) {
         if (isset($_POST['savedhcpdsettings'])) {
             saveDHCPConfig($status);
@@ -43,7 +49,6 @@ function DisplayDHCPConfig()
             }
         }
     }
-    getWifiInterface();
     $ap_iface = $_SESSION['ap_interface'];
     $serviceStatus = $dnsmasq_state ? "up" : "down";
     exec('cat '. RASPI_DNSMASQ_PREFIX.'raspap.conf', $return);

includes/openvpn.php

@@ -1,9 +1,10 @@
 <?php
 
 require_once 'includes/config.php';
-require_once 'includes/wifi_functions.php';
 
-getWifiInterface();
+use RaspAP\Networking\Hotspot\WiFiManager;
+$wifi = new WiFiManager();
+$wifi->getWifiInterface();
 
 /**
  * Manage OpenVPN configuration

includes/wifi_functions.php

@@ -1,366 +0,0 @@
-<?php
-
-require_once 'functions.php';
-
-const MIN_RSSI = -100;
-const MAX_RSSI = -55;
-
-function knownWifiStations(&$networks)
-{
-    // Find currently configured networks
-    exec(' sudo cat ' . RASPI_WPA_SUPPLICANT_CONFIG, $known_return);
-    //$index = 0;
-    foreach ($known_return as $line) {
-        if (preg_match('/network\s*=/', $line)) {
-            $network = array('visible' => false, 'configured' => true, 'connected' => false, 'index' => null);
-            ++$index;
-        } elseif (isset($network) && $network !== null) {
-            if (preg_match('/^\s*}\s*$/', $line)) {
-                $networks[$ssid] = $network;
-                $network = null;
-                $ssid = null;
-            } elseif ($lineArr = preg_split('/\s*=\s*/', trim($line), 2)) {
-                switch (strtolower($lineArr[0])) {
-                case 'ssid':
-                    $ssid = trim($lineArr[1], '"');
-                    $ssid = str_replace('P"','',$ssid);
-                    $network['ssid'] = $ssid;
-                    $index = getNetworkIdBySSID($ssid);
-                    $network['index'] = $index;
-                    break;
-                case 'psk':
-                    $network['passkey'] = trim($lineArr[1]);
-                    $network['protocol'] = 'WPA';
-                    break;
-                case '#psk':
-                    $network['protocol'] = 'WPA';
-                case 'wep_key0': // Untested
-                    $network['passphrase'] = trim($lineArr[1], '"');
-                    break;
-                case 'key_mgmt':
-                    if (! array_key_exists('passphrase', $network) && $lineArr[1] === 'NONE') {
-                        $network['protocol'] = 'Open';
-                    }
-                    break;
-                case 'priority':
-                    $network['priority'] = trim($lineArr[1], '"');
-                    break;
-                }
-            }
-        }
-    }
-}
-
-/**
- * Scans for nearby WiFi networks using `iw` and updates the reference array
- *
- * @param array $networks Reference to the array of known and discovered networks.
- * @param bool $cached    If false, bypasses the cache and performs a fresh scan.
- */
-function nearbyWifiStations(&$networks, $cached = true)
-{
-    $cacheTime = filemtime(RASPI_WPA_SUPPLICANT_CONFIG);
-    $cacheKey  = "nearby_wifi_stations_$cacheTime";
-
-    if ($cached == false) {
-        deleteCache($cacheKey);
-    }
-
-    $iface = escapeshellarg($_SESSION['wifi_client_interface']);
-
-    $scan_results = cache(
-        $cacheKey,
-        function () use ($iface) {
-            $stdout = shell_exec("sudo iw dev $iface scan");
-            return preg_split("/\n/", $stdout);
-        }
-    );
-
-    // exclude the AP from nearby networks
-    exec('sed -rn "s/ssid=(.*)\s*$/\1/p" ' . escapeshellarg(RASPI_HOSTAPD_CONFIG), $ap_ssid);
-    $ap_ssid = $ap_ssid[0] ?? '';
-
-    $index = 0;
-    if (!empty($networks)) {
-        $lastnet = end($networks);
-        if (isset($lastnet['index'])) {
-            $index = $lastnet['index'] + 1;
-        }
-    }
-
-    $current = [];
-    $commitCurrent = function () use (&$current, &$networks, &$index, $ap_ssid) {
-        if (empty($current['ssid'])) {
-            return;
-        }
-
-        $ssid = $current['ssid'];
-
-        // unprintable 7bit ASCII control codes, delete or quotes -> ignore network
-        if ($ssid === $ap_ssid || preg_match('/[\x00-\x1f\x7f\'`\´"]/', $ssid)) {
-            return;
-        }
-
-        $channel = ConvertToChannel($current['freq'] ?? 0);
-        $rssi = $current['signal'] ?? -100;
-
-        // if network is saved
-        if (array_key_exists($ssid, $networks)) {
-            $networks[$ssid]['visible'] = true;
-            $networks[$ssid]['channel'] = $channel;
-            if (!isset($networks[$ssid]['RSSI']) || $networks[$ssid]['RSSI'] < $rssi) {
-                $networks[$ssid]['RSSI'] = $rssi;
-            }
-        } else {
-            $networks[$ssid] = [
-                'ssid' => $ssid,
-                'configured' => false,
-                'protocol' => $current['security'] ?? 'OPEN',
-                'channel' => $channel,
-                'passphrase' => '',
-                'visible' => true,
-                'connected' => false,
-                'RSSI' => $rssi,
-                'index' => $index
-            ];
-            ++$index;
-        }
-    };
-
-    foreach ($scan_results as $line) {
-        $line = trim($line);
-
-        if (preg_match('/^BSS\s+([0-9a-f:]{17})/', $line, $match)) {
-            $commitCurrent(); // commit previous
-            $current = [
-                'bssid' => $match[1],
-                'ssid' => '',
-                'signal' => null,
-                'freq' => null,
-                'security' => 'OPEN'
-            ];
-            continue;
-        }
-        if (preg_match('/^SSID:\s*(.*)$/', $line, $match)) {
-            $current['ssid'] = $match[1];
-            continue;
-        }
-        if (preg_match('/^signal:\s*(-?\d+\.\d+)/', $line, $match)) {
-            $current['signal'] = (float)$match[1];
-            continue;
-        }
-        if (preg_match('/^freq:\s*(\d+)/', $line, $match)) {
-            $current['freq'] = (int)$match[1];
-            continue;
-        }
-        if (preg_match('/^RSN:/', $line) || preg_match('/^WPA:/', $line)) {
-            $current['security'] = 'WPA/WPA2';
-            continue;
-        }
-    }
-    $commitCurrent();
-}
-
-function connectedWifiStations(&$networks)
-{
-    exec('iwconfig ' .$_SESSION['wifi_client_interface'], $iwconfig_return);
-    foreach ($iwconfig_return as $line) {
-        if (preg_match('/ESSID:\"([^"]+)\"/i', $line, $iwconfig_ssid)) {
-            $networks[hexSequence2lower($iwconfig_ssid[1])]['connected'] = true;
-        }
-    }
-}
-
-function sortNetworksByRSSI(&$networks)
-{
-    $valRSSI = array();
-    foreach ($networks as $SSID => $net) {
-        if (!array_key_exists('RSSI', $net)) {
-            $net['RSSI'] = -1000;
-        }
-        $valRSSI[$SSID] = $net['RSSI'];
-    }
-    $nets = $networks;
-    arsort($valRSSI);
-    $networks = array();
-    foreach ($valRSSI as $SSID => $RSSI) {
-        $networks[$SSID] = $nets[$SSID];
-        $networks[$SSID]['RSSI'] = $RSSI;
-    }
-}
-
-/*
- * Determines the configured wireless AP interface
- *
- * If not saved in /etc/raspap/hostapd.ini, check for a second
- * wireless interface with iw dev. Fallback to the constant
- * value defined in config.php
- */
-function getWifiInterface()
-{
-    $hostapdIni = RASPI_CONFIG . '/hostapd.ini';
-    $arrHostapdConf = file_exists($hostapdIni) ? parse_ini_file($hostapdIni) : [];
-
-    $iface = $_SESSION['ap_interface'] = $arrHostapdConf['WifiInterface'] ?? RASPI_WIFI_AP_INTERFACE;
-
-    if (!validateInterface($iface)) {
-        $iface = RASPI_WIFI_AP_INTERFACE;
-    }
-
-    // check for 2nd wifi interface -> wifi client on different interface
-    exec("iw dev | awk '$1==\"Interface\" && $2!=\"$iface\" {print $2}'", $iface2);
-    $client_iface = $_SESSION['wifi_client_interface'] = empty($iface2) ? $iface : trim($iface2[0]);
-
-    // handle special case for RPi Zero W in AP-STA mode
-    if ($client_iface === "uap0" && ($arrHostapdConf['WifiAPEnable'] ?? 0)) {
-        $_SESSION['wifi_client_interface'] = $iface;
-        $_SESSION['ap_interface'] = $client_iface;
-    }
-}
-
-/*
- * Reinitializes wpa_supplicant for the wireless client interface
- * The 'force' parameter deletes the socket in /var/run/wpa_supplicant/
- *
- * @param boolean $force
- */
-function reinitializeWPA($force)
-{
-    $iface = escapeshellarg($_SESSION['wifi_client_interface']);
-    if ($force == true) {
-        $cmd = "sudo /bin/rm /var/run/wpa_supplicant/$iface";
-        $result = shell_exec($cmd);
-    }
-    $cmd = "sudo wpa_supplicant -B -Dnl80211 -c/etc/wpa_supplicant/wpa_supplicant.conf -i$iface";
-    $result = shell_exec($cmd);
-    sleep(1);
-    return $result;
-}
-
-/*
- * Replace escaped bytes (hex) by binary - assume UTF8 encoding
- *
- * @param string $ssid
- */
-function ssid2utf8($ssid)
-{
-    return  evalHexSequence($ssid);
-}
-
-/*
- * Returns a signal strength indicator based on RSSI value
- *
- * @param string $rssi
- */
-function getSignalBars($rssi)
-{
-    // assign css class based on RSSI value
-    if ($rssi >= MAX_RSSI) {
-        $class = 'strong';
-    } elseif ($rssi >= -56) {
-        $class = 'medium';
-    } elseif ($rssi >= -67) {
-        $class = 'weak';
-    } elseif ($rssi >= -89) {
-        $class = '';
-    }
-
-    // calculate percent strength
-    if ($rssi >= -50) {
-        $pct =  100;
-    } elseif ($rssi <= MIN_RSSI) {
-        $pct = 0;
-    } else {
-        $pct = 2*($rssi + 100);
-    }
-    $elem = '<div data-toggle="tooltip" title="' . _("Signal strength"). ': ' .$pct. '%" class="signal-icon ' .$class. '">'.PHP_EOL;
-    for ($n = 0; $n < 3; $n++ ) {
-        $elem .= '<div class="signal-bar"></div>'.PHP_EOL;
-    }
-    $elem .= '</div>'.PHP_EOL;
-    return $elem;
-}
-
-/*
- * Parses output of wpa_cli list_networks, compares with known networks
- * from wpa_supplicant, and adds with wpa_cli if not found
- *
- * @param array $networks
- */
-function setKnownStationsWPA($networks)
-{
-    $iface = escapeshellarg($_SESSION['wifi_client_interface']);
-    $output = shell_exec("sudo wpa_cli -i $iface list_networks");
-    $lines = explode("\n", $output);
-    array_shift($lines);
-    $wpaCliNetworks = [];
-
-    foreach ($lines as $line) {
-        $data = explode("\t", trim($line));
-        if (!empty($data) && count($data) >= 2) {
-            $id = $data[0];
-            $ssid = $data[1];
-            $item = [
-                'id' => $id,
-                'ssid' => $ssid
-            ];
-            $wpaCliNetworks[] = $item;
-        }
-    }
-    foreach ($networks as $network) {
-        $ssid = $network['ssid'];
-        if (!networkExists($ssid, $wpaCliNetworks)) {
-            $ssid = escapeshellarg('"'.$network['ssid'].'"');
-            $psk = escapeshellarg('"'.$network['passphrase'].'"');
-            $protocol = $network['protocol'];
-            $netid = trim(shell_exec("sudo wpa_cli -i $iface add_network"));
-            if (isset($netid) && !isset($known[$netid])) {
-                $commands = [
-                    "sudo wpa_cli -i $iface set_network $netid ssid $ssid",
-                    "sudo wpa_cli -i $iface set_network $netid psk $psk",
-                    "sudo wpa_cli -i $iface enable_network $netid"
-                ];
-                if ($protocol === 'Open') {
-                    $commands[1] = "sudo wpa_cli -i $iface set_network $netid key_mgmt NONE";
-                }
-                foreach ($commands as $cmd) {
-                    exec($cmd);
-                    usleep(1000);
-                }
-            }
-        }
-    }
-}
-
-/*
- * Parses wpa_cli list_networks output and returns the id
- * of a corresponding network SSID
- *
- * @param string $ssid
- * @return integer id
- */
-function getNetworkIdBySSID($ssid) {
-    $iface = escapeshellarg($_SESSION['wifi_client_interface']);
-    $cmd = "sudo wpa_cli -i $iface list_networks";
-    $output = [];
-    exec($cmd, $output);
-    array_shift($output);
-    foreach ($output as $line) {
-        $columns = preg_split('/\t/', $line);
-        if (count($columns) >= 4 && trim($columns[1]) === trim($ssid)) {
-            return $columns[0]; // return network ID
-        }
-    }
-    return null;
-}
-
-function networkExists($ssid, $collection)
-{
-    foreach ($collection as $network) {
-        if ($network['ssid'] === $ssid) {
-            return true;
-        }
-    }
-    return false;
-}
-

includes/wireguard.php

@@ -1,9 +1,11 @@
 <?php
 
-require_once 'includes/wifi_functions.php';
 require_once 'includes/config.php';
 
-getWifiInterface();
+use RaspAP\Networking\Hotspot\WiFiManager;
+
+$wifi = new WiFiManager();
+$wifi->getWifiInterface();
 
 /**
  * Displays wireguard server & peer configuration