Merge pull request #20 from mattieserver/19052020_dev

#14, added circuit terminations

README.md

@@ -44,7 +44,7 @@ PLUGINS_CONFIG = {
 | allow_coordinates_saving      | False | (bool) Set to true if you use the custom coordinates fields and want to save the coordinates |
 | ignore_cable_type      | 'power outlet,power port' | The cable types that you want to ignore in the views  |
 | preselected_tags      | '' | The name of tags you want to preload  |
-
+| enable_circuit_terminations      | False  | (bool) Set to true if you want to see circuit terminations in the topology  |
 
 ### Custom Images
 
@@ -54,4 +54,12 @@ If you add your own image you also need to add the slug to the `device_img` sett
 
 ## Use
 
-Go to the plugins tab in the navbar and click topology or go to NETBOX_URL/plugins/topology-views/ view your topologies
+Go to the plugins tab in the navbar and click topology or go to `$NETBOX_URL/plugins/topology-views/` to view your topologies
+
+### Update
+
+Run `pip install netbox-topology-views --upgrade` in your venv.
+
+Run `python3 manage.py collectstatic --no-input`
+
+Clear you browser cache.

netbox_topology_views/__init__.py

@@ -4,7 +4,7 @@ class TopologyViewsConfig(PluginConfig):
     name = 'netbox_topology_views'
     verbose_name = 'Topology views'
     description = 'An plugin to render toplogoy maps'
-    version = '0.4.2'
+    version = '0.4.7'
     author = 'Mattijs Vanhaverbeke'
     author_email = 'author@example.com'
     base_url = 'topology-views'
@@ -14,7 +14,8 @@ class TopologyViewsConfig(PluginConfig):
         'ignore_cable_type': 'power outlet,power port',
         'device_img': 'access-switch,core-switch,firewall,router,distribution-switch,backup,storage,wan-network,wireless-ap,server,internal-switch,isp-cpe-material,non-racked-devices,power-units',
         'allow_coordinates_saving': False,
-        'preselected_tags' : ''
+        'preselected_tags' : '',
+        'enable_circuit_terminations': False
     }
 
 config = TopologyViewsConfig

netbox_topology_views/api/views.py

@@ -9,6 +9,7 @@ from django.conf import settings
 from utilities.api import IsAuthenticatedOrLoginNotRequired
 
 from dcim.models import  DeviceRole, Device, Cable
+from circuits.models import Circuit
 from extras.models import Tag, CustomField, CustomFieldValue
 
 ignore_cable_type_raw = settings.PLUGINS_CONFIG["netbox_topology_views"]["ignore_cable_type"]
@@ -120,6 +121,7 @@ class SearchViewSet(GenericViewSet):
         edges = []
         edge_ids = 0
         cable_ids = []
+        circuit_ids = []
         for device in devices:
             cables = device.get_cables()
             for cable in cables:
@@ -128,25 +130,110 @@ class SearchViewSet(GenericViewSet):
                         if cable.termination_a_type.name not in ignore_cable_type and cable.termination_b_type.name not in ignore_cable_type:
                             cable_ids.append(cable.id)
                             edge_ids += 1
+
+                            cable_a_dev_name = cable.termination_a.device.name
+                            if cable_a_dev_name is None:
+                                cable_a_dev_name = "device A name unknown"
+                            cable_a_name = cable.termination_a.name
+                            if cable_a_name is None:
+                                cable_a_name = "cable A name unknown"
+                            cable_b_dev_name = cable.termination_b.device.name
+                            if cable_b_dev_name is None:
+                                cable_b_dev_name = "device B name unknown"
+                            cable_b_name = cable.termination_b.name
+                            if cable_b_name is None:
+                                cable_b_name = "cable B name unknown"
+
                             edge = {}
                             edge["id"] = edge_ids
                             edge["from"] = cable.termination_a.device.id
                             edge["to"] = cable.termination_b.device.id
-                            edge["title"] = "Connection between <br> " + cable.termination_a.device.name + " [" + cable.termination_a.name +  "]<br>" + cable.termination_b.device.name + " [" + cable.termination_b.name + "]"
+                            edge["title"] = "Cable between <br> " + cable_a_dev_name + " [" + cable_a_name +  "]<br>" + cable_b_dev_name + " [" + cable_b_name + "]"
+                            if cable.color != "":
+                                edge["color"] = "#" + cable.color
                             edges.append(edge)
                 else:
-                    pass
+                    if cable.termination_a_type.name == "circuit termination":
-                    #circuittermination not supported for now
+                        if settings.PLUGINS_CONFIG["netbox_topology_views"]["enable_circuit_terminations"]:
+                            if cable.termination_a.circuit.id not in circuit_ids:
+                                circuit_ids.append(cable.termination_a.circuit.id)
+                                edge_ids += 1
+
+                                cable_b_dev_name = cable.termination_b.device.name
+                                if cable_b_dev_name is None:
+                                    cable_b_dev_name = "device B name unknown"
+                                cable_b_name = cable.termination_b.name
+                                if cable_b_name is None:
+                                    cable_b_name = "cable B name unknown"
+
+                                edge = {}
+                                edge["id"] = edge_ids
+                                edge["to"] = cable.termination_b.device.id
+                                edge["dashes"] = True
+                                title = ""
+
+                                title += "Circuit provider: "  + cable.termination_a.circuit.provider.name + "<br>"
+                                title += "Termination between <br>"
+                                title += cable_b_dev_name + " [" + cable_b_name +  "]<br>"
+                                if cable.termination_a.circuit.termination_a is not None:
+                                    if cable.termination_a.circuit.termination_a.cable is not None:
+                                        if cable.termination_a.circuit.termination_a.cable.id != cable.id:
+                                            edge["from"] = cable.termination_a.circuit.termination_a.cable.termination_b.device.id
+
+                                            cable_a_dev_name = cable.termination_a.circuit.termination_a.cable.termination_b.device.name
+                                            if cable_a_dev_name is None:
+                                                cable_a_dev_name = "device B name unknown"
+                                            cable_b_name = cable.termination_a.circuit.termination_a.cable.termination_b.name
+                                            if cable_a_name is None:
+                                                cable_a_name = "cable B name unknown"
+                                            title += cable_a_dev_name + " [" + cable_a_name +  "]<br>"
+                                if cable.termination_a.circuit.termination_z is not None:
+                                    if cable.termination_a.circuit.termination_z.cable is not None:
+                                        if cable.termination_a.circuit.termination_z.cable.id != cable.id:
+                                            edge["from"] = cable.termination_a.circuit.termination_z.cable.termination_b.device.id
+
+                                            cable_a_dev_name = cable.termination_a.circuit.termination_z.cable.termination_b.device.name
+                                            if cable_a_dev_name is None:
+                                                cable_a_dev_name = "device B name unknown"
+                                            cable_a_name = cable.termination_a.circuit.termination_z.cable.termination_b.name
+                                            if cable_a_name is None:
+                                                cable_a_name = "cable B name unknown"
+                                            title += cable_a_dev_name + " [" + cable_a_name +  "]<br>"
+
+                                edge["title"] = title
+                                edges.append(edge)
+                
+            dev_name = device.name
+            if dev_name is None:
+                dev_name = "device name unknown"
+
+            node_content = ""
+
+            if device.device_type.display_name is not None:
+                node_content += "<tr><th>Type: </th><td>" + device.device_type.display_name + "</td></tr>"
+            if device.device_role.name is not None:
+                node_content +=  "<tr><th>Role: </th><td>" + device.device_role.name + "</td></tr>"
+            if device.serial != "":
+                node_content += "<tr><th>Serial: </th><td>" + device.serial + "</td></tr>"
+            if device.primary_ip is not None:
+                node_content += "<tr><th>IP Address: </th><td>" + str(device.primary_ip.address) + "</td></tr>"
+
+            dev_title = "<table> %s </table>" % (node_content)
+
             node = {}
             node["id"] = device.id
-            node["name"] = device.name
+            node["name"] = dev_name
-            node["label"] = device.name + " " + device.device_type.display_name
+            node["label"] = dev_name
+            node["title"] = dev_title
             node["shape"] = 'image'
             if device.device_role.slug in settings.PLUGINS_CONFIG["netbox_topology_views"]["device_img"]:
                 node["image"] = '../../static/netbox_topology_views/img/'  + device.device_role.slug + ".png"
             else:
                 node["image"] = "../../static/netbox_topology_views/img/role-unknown.png"
 
+            if device.device_role.color != "":
+                node["color.border"] = "#" + device.device_role.color
+
             for device_custom_field in device.custom_field_values.all():
                 if device_custom_field.field.name == "coordinates":
                     cords =  device_custom_field.serialized_value.split(";")

package.json

@@ -1,7 +1,7 @@
 {
   "private": true,
   "name": "netbox_topology_views",
-  "version": "0.4.2",
+  "version": "0.4.7",
   "scripts": {
     "resources": "gulp build",
     "resources_dev": "gulp build_dev"

setup.py

@@ -3,7 +3,7 @@ from setuptools import setup, find_packages
 
 setup(
     name='netbox-topology-views',
-    version='0.4.2',
+    version='0.4.7',
     description='An NetBox plugin to create Topology maps',
     url='https://github.com/mattieserver/netbox-topology-views',
     author='Mattijs Vanhaverbeke',