raspap-webgui-mirror/includes/wifi_functions.php

<?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;
                }
            }
        }
    }
}

function nearbyWifiStations(&$networks, $cached = true)
{
    $cacheTime = filemtime(RASPI_WPA_SUPPLICANT_CONFIG);
    $cacheKey  = "nearby_wifi_stations_$cacheTime";

    if ($cached == false) {
        deleteCache($cacheKey);
    }

    $scan_results = cache(
        $cacheKey, function () {
            exec('sudo wpa_cli -i ' .$_SESSION['wifi_client_interface']. ' scan');
            sleep(3);
            $stdout = shell_exec('sudo wpa_cli -i ' .$_SESSION['wifi_client_interface']. ' scan_results');
            return preg_split("/\n/", $stdout);
        }
    );
    // get the name of the AP. Should be excluded from nearby networks
    exec('cat '.RASPI_HOSTAPD_CONFIG.' | sed -rn "s/ssid=(.*)\s*$/\1/p" ', $ap_ssid);
    $ap_ssid = $ap_ssid[0];

    $index = 0;
    if ( !empty($networks) ) {
        $lastnet = end($networks);
        if ( isset($lastnet['index']) ) $index = $lastnet['index'] + 1;
    }

    if (is_array($scan_results)) {
        array_shift($scan_results);
        foreach ($scan_results as $network) {
            $arrNetwork = preg_split("/[\t]+/", $network);  // split result into array
            $ssid = $arrNetwork[4];

            // exclude raspap ssid
            if (empty($ssid) || $ssid == $ap_ssid) {
                continue;
            }

            // filter SSID string: unprintable 7bit ASCII control codes, delete or quotes -> ignore network
            if (preg_match('[\x00-\x1f\x7f\'\`\´\"]', $ssid)) {
                continue;
            }

            // If network is saved
            if (array_key_exists($ssid, $networks)) {
                $networks[$ssid]['visible'] = true;
                $networks[$ssid]['channel'] = ConvertToChannel($arrNetwork[1]);
                // TODO What if the security has changed?
            } else {
                $networks[$ssid] = array(
                    'ssid' => $ssid,
                    'configured' => false,
                    'protocol' => ConvertToSecurity($arrNetwork[3]),
                    'channel' => ConvertToChannel($arrNetwork[1]),
                    'passphrase' => '',
                    'visible' => true,
                    'connected' => false,
                    'index' => $index
                );
                ++$index;
            }

            // Save RSSI, if the current value is larger than the already stored
            if (array_key_exists(4, $arrNetwork) && array_key_exists($arrNetwork[4], $networks)) {
                if (! array_key_exists('RSSI', $networks[$arrNetwork[4]]) || $networks[$ssid]['RSSI'] < $arrNetwork[2]) {
                    $networks[$ssid]['RSSI'] = $arrNetwork[2];
                }
            }
        }
    }
}

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()
{
        $arrHostapdConf = parse_ini_file(RASPI_CONFIG.'/hostapd.ini');
        $iface = $_SESSION['ap_interface'] = isset($arrHostapdConf['WifiInterface']) ?  $arrHostapdConf['WifiInterface'] : 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]));

        // specifically for rpi0W in AP-STA mode, the above check ends up with the interfaces
        // crossed over (wifi_client_interface vs 'ap_interface'), because the second interface (uap0) is 
        // created by raspap and used as the access point.
        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;
}