"""
ieee80211abg.py: EMANE IEEE 802.11abg model for CORE
"""

from core import emane
from core.emane.emanemodel import EmaneModel
from core.emane.universal import EmaneUniversalModel
from core.enumerations import ConfigDataTypes
from core.misc import log

logger = log.get_logger(__name__)

try:
    from emanesh.events import EventService
except:
    logger.error("error importing emanesh")


class EmaneIeee80211abgModel(EmaneModel):
    def __init__(self, session, object_id=None):
        EmaneModel.__init__(self, session, object_id)

    # model name
    name = "emane_ieee80211abg"
    _80211rates = '1 1 Mbps,2 2 Mbps,3 5.5 Mbps,4 11 Mbps,5 6 Mbps,' + \
                  '6 9 Mbps,7 12 Mbps,8 18 Mbps,9 24 Mbps,10 36 Mbps,11 48 Mbps,' + \
                  '12 54 Mbps'
    if emane.VERSION >= emane.EMANE091:
        xml_path = '/usr/share/emane/xml/models/mac/ieee80211abg'
    else:
        xml_path = "/usr/share/emane/models/ieee80211abg/xml"

    # MAC parameters
    _confmatrix_mac_base = [
        ("mode", ConfigDataTypes.UINT8.value, '0',
         '0 802.11b (DSSS only),1 802.11b (DSSS only),' + \
         '2 802.11a or g (OFDM),3 802.11b/g (DSSS and OFDM)', 'mode'),
        ("enablepromiscuousmode", ConfigDataTypes.BOOL.value, '0',
         'On,Off', 'enable promiscuous mode'),
        ("distance", ConfigDataTypes.UINT32.value, '1000',
         '', 'max distance (m)'),
        ("unicastrate", ConfigDataTypes.UINT8.value, '4', _80211rates,
         'unicast rate (Mbps)'),
        ("multicastrate", ConfigDataTypes.UINT8.value, '1', _80211rates,
         'multicast rate (Mbps)'),
        ("rtsthreshold", ConfigDataTypes.UINT16.value, '0',
         '', 'RTS threshold (bytes)'),
        ("pcrcurveuri", ConfigDataTypes.STRING.value,
         '%s/ieee80211pcr.xml' % xml_path,
         '', 'SINR/PCR curve file'),
        ("flowcontrolenable", ConfigDataTypes.BOOL.value, '0',
         'On,Off', 'enable traffic flow control'),
        ("flowcontroltokens", ConfigDataTypes.UINT16.value, '10',
         '', 'number of flow control tokens'),
    ]
    # mac parameters introduced in EMANE 0.8.1
    # Note: The entry format for category queue parameters (queuesize, aifs, etc) were changed in
    # EMANE 9.x, but are being preserved for the time being due to space constraints in the
    # CORE GUI. A conversion function (get9xmacparamequivalent) has been defined to support this.
    _confmatrix_mac_extended = [
        ("wmmenable", ConfigDataTypes.BOOL.value, '0',
         'On,Off', 'WiFi Multimedia (WMM)'),
        ("queuesize", ConfigDataTypes.STRING.value, '0:255 1:255 2:255 3:255',
         '', 'queue size (0-4:size)'),
        ("cwmin", ConfigDataTypes.STRING.value, '0:32 1:32 2:16 3:8',
         '', 'min contention window (0-4:minw)'),
        ("cwmax", ConfigDataTypes.STRING.value, '0:1024 1:1024 2:64 3:16',
         '', 'max contention window (0-4:maxw)'),
        ("aifs", ConfigDataTypes.STRING.value, '0:2 1:2 2:2 3:1',
         '', 'arbitration inter frame space (0-4:aifs)'),
        ("txop", ConfigDataTypes.STRING.value, '0:0 1:0 2:0 3:0',
         '', 'txop (0-4:usec)'),
        ("retrylimit", ConfigDataTypes.STRING.value, '0:3 1:3 2:3 3:3',
         '', 'retry limit (0-4:numretries)'),
    ]
    _confmatrix_mac_091 = [
        ('radiometricenable', ConfigDataTypes.BOOL.value, '0',
         'On,Off', 'report radio metrics via R2RI'),
        ('radiometricreportinterval', ConfigDataTypes.FLOAT.value, '1.0',
         '', 'R2RI radio metric report interval (sec)'),
        ('neighbormetricdeletetime', ConfigDataTypes.FLOAT.value, '60.0',
         '', 'R2RI neighbor table inactivity time (sec)'),
    ]
    _confmatrix_mac = _confmatrix_mac_base + _confmatrix_mac_extended
    if emane.VERSION >= emane.EMANE091:
        _confmatrix_mac += _confmatrix_mac_091

    # PHY parameters from Universal PHY
    _confmatrix_phy = EmaneUniversalModel.config_matrix

    config_matrix = _confmatrix_mac + _confmatrix_phy
    # value groupings
    config_groups = "802.11 MAC Parameters:1-%d|Universal PHY Parameters:%d-%d" % (
        len(_confmatrix_mac), len(_confmatrix_mac) + 1, len(config_matrix))

    def buildnemxmlfiles(self, e, ifc):
        """
        Build the necessary nem, mac, and phy XMLs in the given path.
        If an individual NEM has a nonstandard config, we need to build
        that file also. Otherwise the WLAN-wide
        nXXemane_ieee80211abgnem.xml, nXXemane_ieee80211abgemac.xml,
        nXXemane_ieee80211abgphy.xml are used.
        """
        values = e.getifcconfig(self.object_id, self.name, self.getdefaultvalues(), ifc)
        if values is None:
            return
        nemdoc = e.xmldoc("nem")
        nem = nemdoc.getElementsByTagName("nem").pop()
        nem.setAttribute("name", "ieee80211abg NEM")
        e.appendtransporttonem(nemdoc, nem, self.object_id, ifc)
        mactag = nemdoc.createElement("mac")
        mactag.setAttribute("definition", self.macxmlname(ifc))
        nem.appendChild(mactag)
        phytag = nemdoc.createElement("phy")
        phytag.setAttribute("definition", self.phyxmlname(ifc))
        nem.appendChild(phytag)
        e.xmlwrite(nemdoc, self.nemxmlname(ifc))

        macdoc = e.xmldoc("mac")
        mac = macdoc.getElementsByTagName("mac").pop()
        mac.setAttribute("name", "ieee80211abg MAC")
        mac.setAttribute("library", "ieee80211abgmaclayer")

        names = self.getnames()
        macnames = names[:len(self._confmatrix_mac)]
        phynames = names[len(self._confmatrix_mac):]

        # append all MAC options to macdoc
        if emane.VERSION >= emane.EMANE091:
            for macname in macnames:
                mac9xnvpairlist = self.get9xmacparamequivalent(macname, values)
                for nvpair in mac9xnvpairlist:
                    mac.appendChild(e.xmlparam(macdoc, nvpair[0], nvpair[1]))
        else:
            map(lambda n: mac.appendChild(e.xmlparam(macdoc, n, self.valueof(n, values))), macnames)

        e.xmlwrite(macdoc, self.macxmlname(ifc))

        phydoc = EmaneUniversalModel.getphydoc(e, self, values, phynames)
        e.xmlwrite(phydoc, self.phyxmlname(ifc))

    #
    # TEMP HACK: Account for parameter convention change in EMANE 9.x
    # This allows CORE to preserve the entry layout for the mac 'category' parameters
    # and work with EMANE 9.x onwards.
    #
    def get9xmacparamequivalent(self, macname, values):
        """
        Generate a list of 80211abg mac parameters in 0.9.x layout for a given mac parameter
        in 8.x layout.For mac category parameters, the list returned will contain the four
        equivalent 9.x parameter and value pairs. Otherwise, the list returned will only
        contain a single name and value pair.
        """
        nvpairlist = []
        macparmval = self.valueof(macname, values)
        if macname in ["queuesize", "aifs", "cwmin", "cwmax", "txop", "retrylimit"]:
            for catval in macparmval.split():
                idx_and_val = catval.split(":")
                idx = int(idx_and_val[0])
                val = idx_and_val[1]
                # aifs and tx are in microseconds. Convert to seconds.
                if macname in ["aifs", "txop"]:
                    val = "%f" % (float(val) * 1e-6)
                name9x = "%s%d" % (macname, idx)
                nvpairlist.append([name9x, val])
        else:
            nvpairlist.append([macname, macparmval])
        return nvpairlist