@file-share/shared-utils/utils/IpUtil.js

Shared utilities for file-share project

const {networkInterfaces} = require('os');
const Setting = require('./Setting');

function _normalizeFamily(family) {
    return family ? family.toLowerCase() : 'ipv4';
}

function isLoopback(addr) {
    return /^(::f{4}:)?127\.([0-9]{1,3})\.([0-9]{1,3})\.([0-9]{1,3})/
            .test(addr) ||
        /^fe80::1$/.test(addr) ||
        /^::1$/.test(addr) ||
        /^::$/.test(addr);
}

function loopback(family) {
    family = _normalizeFamily(family);

    if (family !== 'ipv4' && family !== 'ipv6') {
        throw new Error('family must be ipv4 or ipv6');
    }

    return family === 'ipv4' ? '127.0.0.1' : 'fe80::1';
}

let getIpAddresses = function (netInterfaceName, ipFamily = "ipv4") {
    let interfaces = networkInterfaces();
    if (!interfaces[netInterfaceName]) {
        return [];
    }

    return interfaces[netInterfaceName].filter(function (ipAddress) {
        let {family, address} = ipAddress;
        return family.toLowerCase() === ipFamily && !isLoopback(address);
    });
}

let getNetInterfaceNames = function (ipFamily = "ipv4") {
    let interfaces = networkInterfaces();
    let ipNames = Object.keys(interfaces).filter(function (name) {
            return getIpAddresses(name, ipFamily).length > 0;
        })
    let finalNames = ipNames.filter(function (name) {
        return !/(loopback|vmware|internal|lo|vEthernet)/gi.test(name);
    });
    return finalNames.length === 0 ? (ipNames.length === 0 ? [] : ipNames) : finalNames;
}

let getIpAddress = function (idx = 0, ipFamily = 'ipv4') {
    let names = getNetInterfaceNames(ipFamily);
    if (!names.length) {
        return loopback(ipFamily);
    }

    idx = (idx % names.length);
    let ipAddresses = getIpAddresses(names[idx], ipFamily);
    return ipAddresses.length > 0 ? ipAddresses[0].address : loopback(ipFamily);
};

let getIpAddressByName = function (netInterfaceName, ipFamily = 'ipv4') {
    let ipAddresses = getIpAddresses(netInterfaceName, ipFamily);
    return ipAddresses.length > 0 ? ipAddresses[0].address : loopback(ipFamily);
}

let setIpFamily = function (ipFamily) {
    ipFamily = _normalizeFamily(ipFamily);
    if (ipFamily !== 'ipv4' && ipFamily !== 'ipv6') {
        throw new Error('family must be ipv4 or ipv6');
    }
    Setting.setIpFamily(ipFamily);
}

let getIpFamily = function () {
    let ipFamily = Setting.getIpFamily();
    if (!ipFamily) {
        ipFamily = 'ipv4';
        setIpFamily(ipFamily);
    }
    return ipFamily;
}

let setNetInterface = function (netInterfaceName) {
    if (!netInterfaceName) {
        throw new Error('netInterfaceName is required');
    }
    Setting.setNetInterfaceName(netInterfaceName);
}

let getNetInterface = function () {
    let netInterfaceName = Setting.getNetInterfaceName();
    if (!netInterfaceName) {
        netInterfaceName = getNetInterfaceNames(getIpFamily())[0];
        setNetInterface(netInterfaceName);
    }
    return netInterfaceName;
}

let getIp = function getIp() {
    let ipFamily = getIpFamily()
    let ip = getIpAddressByName(getNetInterface(), ipFamily);
    if (ipFamily === 'ipv6') {
        ip = `[${ip}]`
    }
    return ip;
}

exports.getIpAddress = getIpAddress
exports.getIpAddresses = getIpAddresses
exports.getIp = getIp
exports.getNetInterfaceNames = getNetInterfaceNames
exports.setIpFamily = setIpFamily
exports.getIpFamily = getIpFamily
exports.setNetInterface = setNetInterface
exports.getNetInterface = getNetInterface