# -*- coding: utf-8 -*-
'''
This salt util uses WMI to gather network information on Windows 7 and .NET 4.0+
on newer systems.
The reason for this is that calls to WMI tend to be slower. Especially if the
query has not been optimized. For example, timing to gather NIC info from WMI
and .NET were as follows in testing:
WMI: 3.4169998168945312 seconds
NET: 1.0390000343322754 seconds
Since this is used to generate grain information we want to avoid using WMI as
much as possible.
There are 3 functions in this salt util.
- get_interface_info_dot_net
- get_interface_info_wmi
- get_interface_info
The ``get_interface_info`` function will call one of the other two functions
depending on the the version of Windows this is run on. Once support for Windows
7 is dropped we can remove the WMI stuff and just use .NET.
:depends: - pythonnet
          - wmi
'''
# https://docs.microsoft.com/en-us/dotnet/api/system.net.networkinformation.networkinterface.getallnetworkinterfaces?view=netframework-4.7.2
# Import python libs
from __future__ import absolute_import, unicode_literals, print_function
import ipaddress
import platform

# Import Salt libs
from salt.utils.versions import StrictVersion

# Import 3rd party libs
# I don't understand why I need this import, but the linter fails without it
from salt.ext.six.moves import range

IS_WINDOWS = platform.system() == 'Windows'

__virtualname__ = 'win_network'

if IS_WINDOWS:
    USE_WMI = StrictVersion(platform.version()) < StrictVersion('6.2')
    if USE_WMI:
        import wmi
        import salt.utils.winapi
    else:
        import clr
        from System.Net import NetworkInformation

enum_adapter_types = {
    1: 'Unknown',
    6: 'Ethernet',
    9: 'TokenRing',
    15: 'FDDI',
    20: 'BasicISDN',
    21: 'PrimaryISDN',
    23: 'PPP',
    24: 'Loopback',
    26: 'Ethernet3Megabit',
    28: 'Slip',
    37: 'ATM',
    48: 'GenericModem',
    53: 'TAPAdapter',  # Not in MSDN Defined enumeration
    62: 'FastEthernetT',
    63: 'ISDN',
    69: 'FastEthernetFx',
    71: 'Wireless802.11',
    94: 'AsymmetricDSL',
    95: 'RateAdaptDSL',
    96: 'SymmetricDSL',
    97: 'VeryHighSpeedDSL',
    114: 'IPOverATM',
    117: 'GigabitEthernet',
    131: 'Tunnel',
    143: 'MultiRateSymmetricDSL',
    144: 'HighPerformanceSerialBus',
    237: 'WMAN',
    243: 'WWANPP',
    244: 'WWANPP2'}

enum_operational_status = {
    1: 'Up',
    2: 'Down',
    3: 'Testing',
    4: 'Unknown',
    5: 'Dormant',
    6: 'NotPresent',
    7: 'LayerDown'}

enum_prefix_suffix = {
    0: 'Other',
    1: 'Manual',
    2: 'WellKnown',
    3: 'DHCP',
    4: 'Router',
    5: 'Random'}

af_inet = 2
af_inet6 = 23


def __virtual__():
    '''
    Only load if windows
    '''
    if not IS_WINDOWS:
        return False, 'This utility will only run on Windows'

    return __virtualname__


def _get_base_properties(i_face):
    raw_mac = i_face.GetPhysicalAddress().ToString()
    try:
        i_face_type = enum_adapter_types[i_face.NetworkInterfaceType]
    except KeyError:
        i_face_type = i_face.Description
    return {
        'alias': i_face.Name,
        'description': i_face.Description,
        'id': i_face.Id,
        'receive_only': i_face.IsReceiveOnly,
        'type': i_face_type,
        'status': enum_operational_status[i_face.OperationalStatus],
        'physical_address': ':'.join(raw_mac[i:i+2] for i in range(0, 12, 2))}


def _get_ip_base_properties(i_face):
    ip_properties = i_face.GetIPProperties()
    return {'dns_suffix': ip_properties.DnsSuffix,
            'dns_enabled': ip_properties.IsDnsEnabled,
            'dynamic_dns_enabled': ip_properties.IsDynamicDnsEnabled}


def _get_ip_unicast_info(i_face):
    ip_properties = i_face.GetIPProperties()
    int_dict = {}
    if ip_properties.UnicastAddresses.Count > 0:
        names = {af_inet: 'ip_addresses',
                 af_inet6: 'ipv6_addresses'}
        for addrs in ip_properties.UnicastAddresses:
            if addrs.Address.AddressFamily == af_inet:
                ip = addrs.Address.ToString()
                mask = addrs.IPv4Mask.ToString()
                net = ipaddress.IPv4Network(ip + '/' + mask, False)
                ip_info = {
                    'address': ip,
                    'netmask': mask,
                    'broadcast': net.broadcast_address.compressed,
                    'loopback': addrs.Address.Loopback.ToString()}
            else:
                ip_info = {
                    'address': addrs.Address.ToString().split('%')[0],
                    # ScopeID is a suffix affixed to the end of an IPv6
                    # address it denotes the adapter. This is different from
                    # ScopeLevel. Need to figure out how to get ScopeLevel
                    # for feature parity with Linux
                    'interface_index': int(addrs.Address.ScopeId)}
            ip_info.update({
                'prefix_length': addrs.PrefixLength,
                'prefix_origin': enum_prefix_suffix[addrs.PrefixOrigin],
                'suffix_origin': enum_prefix_suffix[addrs.SuffixOrigin]})
            int_dict.setdefault(
                names[addrs.Address.AddressFamily], []).append(ip_info)
    return int_dict


def _get_ip_gateway_info(i_face):
    ip_properties = i_face.GetIPProperties()
    int_dict = {}
    if ip_properties.GatewayAddresses.Count > 0:
        names = {af_inet: 'ip_gateways',
                 af_inet6: 'ipv6_gateways'}
        for addrs in ip_properties.GatewayAddresses:
            int_dict.setdefault(
                names[addrs.Address.AddressFamily],
                []).append(addrs.Address.ToString().split('%')[0])
    return int_dict


def _get_ip_dns_info(i_face):
    ip_properties = i_face.GetIPProperties()
    int_dict = {}
    if ip_properties.DnsAddresses.Count > 0:
        names = {af_inet: 'ip_dns',
                 af_inet6: 'ipv6_dns'}
        for addrs in ip_properties.DnsAddresses:
            int_dict.setdefault(
                names[addrs.AddressFamily],
                []).append(addrs.ToString().split('%')[0])
    return int_dict


def _get_ip_multicast_info(i_face):
    ip_properties = i_face.GetIPProperties()
    int_dict = {}
    if ip_properties.MulticastAddresses.Count > 0:
        names = {af_inet: 'ip_multicast',
                 af_inet6: 'ipv6_multicast'}
        for addrs in ip_properties.MulticastAddresses:
            int_dict.setdefault(
                names[addrs.Address.AddressFamily],
                []).append(addrs.Address.ToString().split('%')[0])
    return int_dict


def _get_ip_anycast_info(i_face):
    ip_properties = i_face.GetIPProperties()
    int_dict = {}
    if ip_properties.AnycastAddresses.Count > 0:
        names = {af_inet: 'ip_anycast',
                 af_inet6: 'ipv6_anycast'}
        for addrs in ip_properties.AnycastAddresses:
            int_dict.setdefault(
                names[addrs.Address.AddressFamily],
                []).append(addrs.Address.ToString())
    return int_dict


def _get_ip_wins_info(i_face):
    ip_properties = i_face.GetIPProperties()
    int_dict = {}
    if ip_properties.WinsServersAddresses.Count > 0:
        for addrs in ip_properties.WinsServersAddresses:
            int_dict.setdefault(
                'ip_wins', []).append(addrs.ToString())
    return int_dict


def _get_network_interfaces():
    clr.AddReference('System.Net')
    return NetworkInformation.NetworkInterface.GetAllNetworkInterfaces()


def get_interface_info_dot_net_formatted():
    '''
    Returns data gathered via ``get_interface_info_dot_net`` and returns the
    info in the same manner as ``get_interface_info_wmi``

    Returns:
        dict: A dictionary of information about all interfaces on the system
    '''
    # Massage the data returned by dotnet to mirror that returned by wmi
    interfaces = get_interface_info_dot_net()
    i_faces = {}
    for i_face in interfaces:
        if interfaces[i_face]['status'] == 'Up':
            name = interfaces[i_face]['description']
            i_faces.setdefault(name, {}).update({
                'hwaddr': interfaces[i_face]['physical_address'],
                'up': True})
            for ip in interfaces[i_face].get('ip_addresses', []):
                i_faces[name].setdefault('inet', []).append({
                    'address': ip['address'],
                    'broadcast': ip['broadcast'],
                    'netmask': ip['netmask'],
                    'gateway': interfaces[i_face].get('ip_gateways', [''])[0],
                    'label': name})
            for ip in interfaces[i_face].get('ipv6_addresses', []):
                i_faces[name].setdefault('inet6', []).append({
                    'address': ip['address'],
                    'gateway': interfaces[i_face].get('ipv6_gateways', [''])[0],
                    # Add prefix length
                })

    return i_faces


def get_interface_info_dot_net():
    '''
    Uses .NET 4.0+ to gather Network Interface information. Should only run on
    Windows systems newer than Windows 7/Server 2008R2

    Returns:
        dict: A dictionary of information about all interfaces on the system
    '''
    interfaces = {}
    for i_face in _get_network_interfaces():
        temp_dict = _get_base_properties(i_face)
        temp_dict.update(_get_ip_base_properties(i_face))
        temp_dict.update(_get_ip_unicast_info(i_face))
        temp_dict.update(_get_ip_gateway_info(i_face))
        temp_dict.update(_get_ip_dns_info(i_face))
        temp_dict.update(_get_ip_multicast_info(i_face))
        temp_dict.update(_get_ip_anycast_info(i_face))
        temp_dict.update(_get_ip_wins_info(i_face))
        interfaces[i_face.Name] = temp_dict

    return interfaces


def get_interface_info_wmi():
    '''
    Uses WMI to gather Network Interface information. Should only run on
    Windows 7/2008 R2 and lower systems. This code was pulled from the
    ``win_interfaces`` function in ``salt.utils.network`` unchanged.

    Returns:
        dict: A dictionary of information about all interfaces on the system
    '''
    with salt.utils.winapi.Com():
        c = wmi.WMI()
        i_faces = {}
        for i_face in c.Win32_NetworkAdapterConfiguration(IPEnabled=1):
            i_faces[i_face.Description] = {}
            if i_face.MACAddress:
                i_faces[i_face.Description]['hwaddr'] = i_face.MACAddress
            if i_face.IPEnabled:
                i_faces[i_face.Description]['up'] = True
                for ip in i_face.IPAddress:
                    if '.' in ip:
                        if 'inet' not in i_faces[i_face.Description]:
                            i_faces[i_face.Description]['inet'] = []
                        item = {'address': ip,
                                'label': i_face.Description}
                        if i_face.DefaultIPGateway:
                            broadcast = next((i for i in i_face.DefaultIPGateway if '.' in i), '')
                            if broadcast:
                                item['broadcast'] = broadcast
                        if i_face.IPSubnet:
                            netmask = next((i for i in i_face.IPSubnet if '.' in i), '')
                            if netmask:
                                item['netmask'] = netmask
                        i_faces[i_face.Description]['inet'].append(item)
                    if ':' in ip:
                        if 'inet6' not in i_faces[i_face.Description]:
                            i_faces[i_face.Description]['inet6'] = []
                        item = {'address': ip}
                        if i_face.DefaultIPGateway:
                            broadcast = next((i for i in i_face.DefaultIPGateway if ':' in i), '')
                            if broadcast:
                                item['broadcast'] = broadcast
                        if i_face.IPSubnet:
                            netmask = next((i for i in i_face.IPSubnet if ':' in i), '')
                            if netmask:
                                item['netmask'] = netmask
                        i_faces[i_face.Description]['inet6'].append(item)
            else:
                i_faces[i_face.Description]['up'] = False
    return i_faces


def get_interface_info():
    '''
    This function will return network interface information for the system and
    will use the best method to retrieve that information. Windows 7/2008R2 and
    below will use WMI. Newer systems will use .NET.
    Returns:
        dict: A dictionary of information about the Network interfaces
    '''
    # On Windows 7 machines, use WMI as dotnet 4.0 is not available by default
    if USE_WMI:
        return get_interface_info_wmi()
    else:
        return get_interface_info_dot_net_formatted()
