Move the generation of the list of ports to the server

Ref #676

gns3server/controller/ports/atm_port.py

@@ -0,0 +1,65 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2014 GNS3 Technologies Inc.
+#
+# 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/>.
+
+"""
+ATM port for ATM link end points.
+"""
+
+from .port import Port
+
+
+class ATMPort(Port):
+
+    @staticmethod
+    def longNameType():
+        """
+        Returns the long name type for this port.
+
+        :returns: string
+        """
+
+        return "ATM"
+
+    @staticmethod
+    def shortNameType():
+        """
+        Returns the short name type for this port.
+
+        :returns: string
+        """
+
+        return "a"
+
+    @staticmethod
+    def linkType():
+        """
+        Returns the link type to be used to connect this port.
+
+        :returns: string
+        """
+
+        return "Serial"
+
+    @staticmethod
+    def dataLinkTypes():
+        """
+        Returns the supported PCAP DLTs.
+
+        :return: dictionary
+        """
+
+        return {"ATM": "DLT_ATM_RFC1483"}

gns3server/controller/ports/ethernet_port.py

@@ -0,0 +1,50 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2014 GNS3 Technologies Inc.
+#
+# 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/>.
+
+"""
+Ethernet port for Ethernet link end points.
+"""
+
+
+from .port import Port
+
+
+class EthernetPort(Port):
+
+    """
+    Ethernet port.
+    """
+
+    @staticmethod
+    def longNameType():
+        """
+        Returns the long name type for this port.
+
+        :returns: string
+        """
+
+        return "Ethernet"
+
+    @staticmethod
+    def shortNameType():
+        """
+        Returns the short name type for this port.
+
+        :returns: string
+        """
+
+        return "e"

gns3server/controller/ports/fastethernet_port.py

@@ -0,0 +1,45 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2014 GNS3 Technologies Inc.
+#
+# 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/>.
+
+"""
+FastEthernet port for Ethernet link end points.
+"""
+
+from .port import Port
+
+
+class FastEthernetPort(Port):
+
+    @staticmethod
+    def longNameType():
+        """
+        Returns the long name type for this port.
+
+        :returns: string
+        """
+
+        return "FastEthernet"
+
+    @staticmethod
+    def shortNameType():
+        """
+        Returns the short name type for this port.
+
+        :returns: string
+        """
+
+        return "f"

gns3server/controller/ports/frame_relay_port.py

@@ -0,0 +1,45 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2014 GNS3 Technologies Inc.
+#
+# 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/>.
+
+"""
+Frame relay port for serial link end points.
+"""
+
+from .serial_port import SerialPort
+
+
+class FrameRelayPort(SerialPort):
+
+    @staticmethod
+    def longNameType():
+        """
+        Returns the long name type for this port.
+
+        :returns: string
+        """
+
+        return "FrameRelay"
+
+    @staticmethod
+    def dataLinkTypes():
+        """
+        Returns the supported PCAP DLTs.
+
+        :return: dictionary
+        """
+
+        return {"Frame Relay": "DLT_FRELAY"}

gns3server/controller/ports/gigabitethernet_port.py

@@ -0,0 +1,45 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2014 GNS3 Technologies Inc.
+#
+# 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/>.
+
+"""
+GigabitEthernet port for Ethernet link end points.
+"""
+
+from .port import Port
+
+
+class GigabitEthernetPort(Port):
+
+    @staticmethod
+    def longNameType():
+        """
+        Returns the long name type for this port.
+
+        :returns: string
+        """
+
+        return "GigabitEthernet"
+
+    @staticmethod
+    def shortNameType():
+        """
+        Returns the short name type for this port.
+
+        :returns: string
+        """
+
+        return "g"

gns3server/controller/ports/port.py

@@ -0,0 +1,51 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2014 GNS3 Technologies Inc.
+#
+# 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/>.
+
+
+class Port:
+    """
+    Base class for port objects.
+    """
+
+    def __init__(self, name, interface_number, adapter_number, port_number):
+        self._interface_number = interface_number
+        self._adapter_number = adapter_number
+        self._port_number = port_number
+        self._name = name
+
+    @staticmethod
+    def dataLinkTypes():
+        """
+        Returns the supported PCAP DLTs.
+
+        :return: dictionary
+        """
+        return {"Ethernet": "DLT_EN10MB"}
+
+    @staticmethod
+    def linkType():
+        return "Ethernet"
+
+    def __json__(self):
+        return {
+            "name": self._name,
+            "short_name": self.shortNameType() + "{}/{}".format(self._interface_number, self._port_number),
+            "data_link_types": self.dataLinkTypes(),
+            "port_number": self._port_number,
+            "adapter_number": self._adapter_number,
+            "link_type": self.linkType().lower()
+        }

gns3server/controller/ports/port_factory.py

@@ -0,0 +1,189 @@
+#!/usr/bin/env python
+#
+# Copyright (C) 2016 GNS3 Technologies Inc.
+#
+# 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/>.
+
+from .atm_port import ATMPort
+from .frame_relay_port import FrameRelayPort
+from .gigabitethernet_port import GigabitEthernetPort
+from .fastethernet_port import FastEthernetPort
+from .ethernet_port import EthernetPort
+from .serial_port import SerialPort
+from .pos_port import POSPort
+
+import logging
+log = logging.getLogger(__name__)
+
+PORTS = {
+    'atm': ATMPort,
+    'frame_relay': FrameRelayPort,
+    'fastethernet': FastEthernetPort,
+    'gigabitethernet': GigabitEthernetPort,
+    'ethernet': EthernetPort,
+    'serial': SerialPort
+}
+
+
+class PortFactory:
+    """
+    Factory to create an Port object based on the type
+    """
+
+    def __new__(cls, name, interface_number, adapter_number, port_number, port_type, **kwargs):
+        return PORTS[port_type](name, interface_number, adapter_number, port_number, **kwargs)
+
+
+class StandardPortFactory:
+    """
+    Create ports for standard device
+    """
+    def __new__(cls, properties, port_by_adapter, first_port_name, port_name_format, port_segment_size):
+        ports = []
+        interface_number = segment_number = 0
+        if "serial_adapters" in properties:
+            for adapter_number in range(0, properties["serial_adapters"]):
+                for port_number in range(0, port_by_adapter):
+                    ports.append(PortFactory("Serial{}/{}".format(adapter_number, port_number), adapter_number, adapter_number, port_number, "serial"))
+
+        if "ethernet_adapters" in properties:
+            ethernet_adapters = properties["ethernet_adapters"]
+        else:
+            ethernet_adapters = properties.get("adapters", 1)
+
+        for adapter_number in range(0, ethernet_adapters):
+            for port_number in range(0, port_by_adapter):
+                if first_port_name and adapter_number == 0:
+                    port_name = first_port_name
+                else:
+                    port_name = port_name_format.format(
+                        interface_number,
+                        segment_number,
+                        adapter=adapter_number,
+                        **cls._generate_replacement(interface_number, segment_number))
+                    interface_number += 1
+                    if port_segment_size and interface_number % port_segment_size == 0:
+                        segment_number += 1
+                        interface_number = 0
+
+                ports.append(PortFactory(port_name, adapter_number, adapter_number, port_number, "ethernet"))
+        return ports
+
+    @staticmethod
+    def _generate_replacement(interface_number, segment_number):
+        """
+        This will generate replacement string for
+        {port0} => {port9}
+        {segment0} => {segment9}
+        """
+        replacements = {}
+        for i in range(0, 9):
+            replacements["port" + str(i)] = interface_number + i
+            replacements["segment" + str(i)] = segment_number + i
+        return replacements
+
+
+class DynamipsPortFactory:
+    """
+    Create port for dynamips devices
+    """
+    ADAPTER_MATRIX = {
+        "C1700-MB-1FE": {"nb_ports": 1,
+                         "port": FastEthernetPort},
+        "C1700-MB-WIC1": {"nb_ports": 0,
+                          "port": None},
+        "C2600-MB-1E": {"nb_ports": 1,
+                        "port": EthernetPort},
+        "C2600-MB-1FE": {"nb_ports": 1,
+                         "port": FastEthernetPort},
+        "C2600-MB-2E": {"nb_ports": 2,
+                        "port": EthernetPort},
+        "C2600-MB-2FE": {"nb_ports": 2,
+                         "port": FastEthernetPort},
+        "C7200-IO-2FE": {"nb_ports": 2,
+                         "port": FastEthernetPort},
+        "C7200-IO-FE": {"nb_ports": 1,
+                        "port": FastEthernetPort},
+        "C7200-IO-GE-E": {"nb_ports": 1,
+                          "port": GigabitEthernetPort},
+        "GT96100-FE": {"nb_ports": 2,
+                       "port": FastEthernetPort},
+        "Leopard-2FE": {"nb_ports": 2,
+                        "port": FastEthernetPort},
+        "NM-16ESW": {"nb_ports": 16,
+                     "port": FastEthernetPort},
+        "NM-1E": {"nb_ports": 1,
+                  "port": EthernetPort},
+        "NM-1FE-TX": {"nb_ports": 1,
+                      "port": FastEthernetPort},
+        "NM-4E": {"nb_ports": 4,
+                  "port": EthernetPort},
+        "NM-4T": {"nb_ports": 4,
+                  "port": SerialPort},
+        "PA-2FE-TX": {"nb_ports": 2,
+                      "port": FastEthernetPort},
+        "PA-4E": {"nb_ports": 4,
+                  "port": EthernetPort},
+        "PA-4T+": {"nb_ports": 4,
+                   "port": SerialPort},
+        "PA-8E": {"nb_ports": 8,
+                  "port": EthernetPort},
+        "PA-8T": {"nb_ports": 8,
+                  "port": SerialPort},
+        "PA-A1": {"nb_ports": 1,
+                  "port": ATMPort},
+        "PA-FE-TX": {"nb_ports": 1,
+                     "port": FastEthernetPort},
+        "PA-GE": {"nb_ports": 1,
+                  "port": GigabitEthernetPort},
+        "PA-POS-OC3": {"nb_ports": 1,
+                       "port": POSPort},
+    }
+
+    WIC_MATRIX = {"WIC-1ENET": {"nb_ports": 1,
+                                "port": EthernetPort},
+
+                  "WIC-1T": {"nb_ports": 1,
+                             "port": SerialPort},
+
+                  "WIC-2T": {"nb_ports": 2,
+                             "port": SerialPort}
+                  }
+
+    def __new__(cls, properties):
+        ports = []
+
+        interface_numbers = {}
+
+        adapter_number = 0
+        wic_port_number = 16
+        for name in sorted(properties.keys()):
+            if name.startswith("slot") and properties[name]:
+                port_class = cls.ADAPTER_MATRIX[properties[name]]["port"]
+                if port_class:
+                    interface_numbers.setdefault(port_class, 0)
+                    interface_number = interface_numbers[port_class]
+                    for port_number in range(0, cls.ADAPTER_MATRIX[properties[name]]["nb_ports"]):
+                        name = "{}{}/{}".format(port_class.longNameType(), interface_number, port_number)
+                        ports.append(port_class(name, interface_number, adapter_number, port_number))
+                    interface_numbers[port_class] += 1
+                adapter_number += 1
+            elif name.startswith("wic") and properties[name]:
+                port_class = cls.WIC_MATRIX[properties[name]]["port"]
+                if port_class:
+                    for port_number in range(0, cls.WIC_MATRIX[properties[name]]["nb_ports"]):
+                        name = "{}{}/{}".format(port_class.longNameType(), 0, wic_port_number)
+                        ports.append(port_class(name, 0, 0, wic_port_number))
+                        wic_port_number += 1
+        return ports

gns3server/controller/ports/pos_port.py

@@ -0,0 +1,66 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2014 GNS3 Technologies Inc.
+#
+# 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/>.
+
+"""
+POS port for Packet over SONET link end points.
+"""
+
+from .port import Port
+
+
+class POSPort(Port):
+
+    @staticmethod
+    def longNameType():
+        """
+        Returns the long name type for this port.
+
+        :returns: string
+        """
+
+        return "POS"
+
+    @staticmethod
+    def shortNameType():
+        """
+        Returns the short name type for this port.
+
+        :returns: string
+        """
+
+        return "p"
+
+    @staticmethod
+    def linkType():
+        """
+        Returns the link type to be used to connect this port.
+
+        :returns: string
+        """
+
+        return "Serial"
+
+    @staticmethod
+    def dataLinkTypes():
+        """
+        Returns the supported PCAP DLTs.
+
+        :return: dictionary
+        """
+
+        # Packet capture on PoS is not supported
+        return {}

gns3server/controller/ports/serial_port.py

@@ -0,0 +1,67 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2014 GNS3 Technologies Inc.
+#
+# 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/>.
+
+"""
+Serial port for serial link end points.
+"""
+
+from .port import Port
+
+
+class SerialPort(Port):
+
+    @staticmethod
+    def longNameType():
+        """
+        Returns the long name type for this port.
+
+        :returns: string
+        """
+
+        return "Serial"
+
+    @staticmethod
+    def shortNameType():
+        """
+        Returns the short name type for this port.
+
+        :returns: string
+        """
+
+        return "s"
+
+    @staticmethod
+    def linkType():
+        """
+        Returns the link type to be used to connect this port.
+
+        :returns: string
+        """
+
+        return "Serial"
+
+    @staticmethod
+    def dataLinkTypes():
+        """
+        Returns the supported PCAP DLTs.
+
+        :return: dictionary
+        """
+
+        return {"Frame Relay": "DLT_FRELAY",
+                "Cisco HDLC": "DLT_C_HDLC",
+                "Cisco PPP": "DLT_PPP_SERIAL"}