#
#    NEPI, a framework to manage network experiments
#    Copyright (C) 2014 INRIA
#
#    This program is free software: you can redistribute it and/or modify
#    it under the terms of the GNU General Public License as published by
#    the Free Software Foundation, either version 3 of the License, or
#    (at your option) any later version.
#
#    This program is distributed in the hope that it will be useful,
#    but WITHOUT ANY WARRANTY; without even the implied warranty of
#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#    GNU General Public License for more details.
#
#    You should have received a copy of the GNU General Public License
#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
#
# Author: Alina Quereilhac <alina.quereilhac@inria.fr>

from nepi.execution.attribute import Attribute, Flags
from nepi.execution.resource import clsinit_copy
from nepi.resources.ns3.ns3base import NS3Base

@clsinit_copy
class NS3BaseNetDevice(NS3Base):
    _rtype = "abstract::ns3::NetDevice"

    @classmethod
    def _register_attributes(cls):
        mac = Attribute("mac", "MAC address for device",
                flags = Flags.ExecReadOnly)

        ip = Attribute("ip", "IP address for device",
                flags = Flags.ExecReadOnly)

        prefix = Attribute("prefix", "Network prefix for device",
                flags = Flags.ExecReadOnly)

        cls._register_attribute(mac)
        cls._register_attribute(ip)
        cls._register_attribute(prefix)

    @property
    def channel(self):
        from nepi.resources.ns3.ns3channel import NS3Channel
        channels = self.get_connected(NS3BaseChannel.get_rtype())
        if channels: return channels[0]
        return None

    @property
    def others_to_wait(self):
        others = set()
        node = self.node
        if node: others.add(node)
        
        channel = self.channel
        if channel: others.add(channel)
        return others

    def _configure_object(self):
        # Set Mac
        mac = self.get("mac")
        if mac:
            mac_uuid = self.simulator.create("Mac48Address", mac)
        else:
            mac_uuid = self.simulator.invoke("singleton::Mac48Address", "Allocate")
        self.simulator.invoke(self.uuid, "SetAddress", mac_uuid)

        # Set IP address
        ip = self.get("ip")
        prefix = self.get("prefix")

        i = ipaddr.IPAddress(ip)
        if i.version == 4:
            # IPv4
            ipv4 = self.node.ipv4
            ifindex_uuid = self.simulator.invoke(ipv4.uuid, "AddInterface", 
                    self.uuid)
            ipv4_addr_uuid = self.simulator.create("Ipv4Address", ip)
            ipv4_mask_uuid = self.simulator.create("Ipv4Mask", "/%s" % str(prefix))
            inaddr_uuid = self.simulator.create("Ipv4InterfaceAddress", 
                    ipv4_addr_uuid, ipv4_mask_uuid)
            self.simulator.invoke(ipv4.uuid, "AddAddress", ifindex_uuid, 
                    inaddr_uuid)
            self.simulator.invoke(ipv4.uuid, "SetMetric", ifindex_uuid, 1)
            self.simulator.invoke(ipv4.uuid, "SetUp", ifindex_uuid)
        else:
            # IPv6
            # TODO!
            pass

    def _connect_object(self):
        node = self.node
        if node and node.uuid not in self.connected:
            self.simulator.invoke(node.uuid, "AddDevice", self.uuid)
            self._connected.add(node.uuid)

        channel = self.channel
        if channel and channel.uuid not in self.connected:
            self.simulator.invoke(self.uuid, "Attach", channel.uuid)
            self._connected.add(channel.uuid)