bump version

* Add hide-device-role feature

* Add hide-device-role feature

* Remove end^Cevices not in queryset

* clean up

* Fix destination.device.id test

* Query optimization

* multiple updates

README.md

@@ -8,7 +8,7 @@ Support to filter on name, site, tag and device role.
 
 ## Preview
 
-![preview image](doc/img/preview.png?raw=true "preview")
+![preview image](doc/img/preview_3.1.jpeg?raw=true "preview")
 
 ## Install
 
@@ -35,7 +35,8 @@ Then run `python3 manage.py collectstatic --no-input`
 
 | netbox version        | netbox-topology-views version          |
 | ------------- |-------------|
-| >= 3.1.8 | >= v1.0.0a1 |
+| >= 3.2.0 | >= v1.1.0 |
+| >= 3.1.8 | >= v1.0.0 |
 | >= 2.11.1 | >= v0.5.3 |
 | >= 2.10.0 | >= v0.5.0 |
 | < 2.10.0 | =< v0.4.10 |
@@ -66,6 +67,7 @@ PLUGINS_CONFIG = {
 | ------------- |-------------| -----|
 | 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'] | The slug of the device roles that you have a image for. |
 | preselected_device_roles      | ['Firewall', 'Router', 'Distribution Switch', 'Core Switch', 'Internal Switch', 'Access Switch', 'Server', 'Storage', 'Backup', 'Wireless AP'] | The full name of the device roles you want to pre select in the global view.  Note that this is case sensitive|
+| preselected_intermediate_dev_roles      | ['Patch-panel'] | The full name of the device roles you want to display in the global view when using end-to-end connections mode.  Note that this is case sensitive|
 | 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  |
@@ -80,7 +82,7 @@ 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/` to view your topologies
+Go to the plugins tab in the navbar and click topology or go to `$NETBOX_URL/plugins/netbox_topology_views/` to view your topologies
 
 ### Update
 

netbox_topology_views/__init__.py

@@ -4,18 +4,20 @@ class TopologyViewsConfig(PluginConfig):
     name = 'netbox_topology_views'
     verbose_name = 'Topology views'
     description = 'An plugin to render topology maps'
-    version = '1.0.0-alpha.5'
+    version = '2.0.0'
     author = 'Mattijs Vanhaverbeke'
     author_email = 'author@example.com'
     base_url = 'netbox_topology_views'
     required_settings = []
     default_settings = {
         'preselected_device_roles': ['Firewall', 'Router', 'Distribution Switch', 'Core Switch', 'Internal Switch', 'Access Switch', 'Server', 'Storage', 'Backup', 'Wireless AP'],
+        'preselected_intermediate_dev_roles' : [],
+        'end2end_connections': False,
         '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'],
+        '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' : [],
-        'enable_circuit_terminations': True,
+        'enable_circuit_terminations': False,
         'draw_default_layout': False
     }
 

netbox_topology_views/admin.py

@@ -1,3 +0,0 @@
-from django.contrib import admin
-
-#no models yet

netbox_topology_views/filters.py

@@ -1,16 +1,23 @@
+from cProfile import label
 import django_filters
-from extras.filters import TagFilter
-from dcim.models import Device, DeviceRole, Region, Site, Location
-from utilities.filters import TreeNodeMultipleChoiceFilter
 from django.db.models import Q
 
-class DeviceFilterSet(django_filters.FilterSet):
+from dcim.models import Device, DeviceRole, Region, Site, Location
+from dcim.choices import DeviceStatusChoices
+
+from netbox.filtersets import NetBoxModelFilterSet
+
+from tenancy.models import TenantGroup, Tenant
+from tenancy.filtersets import TenancyFilterSet
+
+from utilities.filters import TreeNodeMultipleChoiceFilter
+
+
+class DeviceFilterSet(TenancyFilterSet, NetBoxModelFilterSet):
     q = django_filters.CharFilter(
         method='search',
         label='Search',
     )
-    tag = TagFilter()
-
     device_role_id = django_filters.ModelMultipleChoiceFilter(
         field_name='device_role_id',
         queryset=DeviceRole.objects.all(),
@@ -32,10 +39,15 @@ class DeviceFilterSet(django_filters.FilterSet):
         lookup_expr='in',
         label='Location (ID)',
     )
+    status = django_filters.MultipleChoiceFilter(
+        choices=DeviceStatusChoices,
+        null_value=None
+    )
+
 
     class Meta:
         model = Device
-        fields = ['id', 'name', ]
+        fields = ['id', 'name']
 
     def search(self, queryset, name, value):
         """Perform the filtered search."""
@@ -44,4 +56,4 @@ class DeviceFilterSet(django_filters.FilterSet):
         qs_filter = (
              Q(name__icontains=value) 
         )
-        return queryset.filter(qs_filter)
+        return queryset.filter(qs_filter)

netbox_topology_views/forms.py

@@ -1,21 +1,33 @@
+from cProfile import label
+import imp
 from django import forms
 from django.conf import settings
+
 from django.utils.translation import gettext as _
 
-from extras.models import Tag
 from dcim.models import Device, Site, Region, DeviceRole, Location
 
+from django import forms
+from dcim.choices import DeviceStatusChoices
+from tenancy.models import TenantGroup, Tenant
+from tenancy.forms import TenancyFilterForm
+from django.conf import settings
+from netbox.forms import NetBoxModelFilterSetForm
+from utilities.forms import (TagFilterField, DynamicModelMultipleChoiceField, MultipleChoiceField)
 
-from utilities.forms import (TagFilterField,  DynamicModelMultipleChoiceField, FilterForm)
+allow_coordinates_saving = settings.PLUGINS_CONFIG["netbox_topology_views"]["allow_coordinates_saving"]
+end2end = settings.PLUGINS_CONFIG["netbox_topology_views"]["end2end_connections"]
 
-class DeviceFilterForm(FilterForm):
+
+class DeviceFilterForm(TenancyFilterForm, NetBoxModelFilterSetForm):
     model = Device
-    field_groups = [
-        ['q', 'hide_unconnected'],
-        ['region_id', 'site_id', 'location_id'],
-        ['device_role_id'],
-        ['tag'],
-    ]
+    fieldsets = (
+        (None, ('q', 'hide_unconnected', 'save_coords', 'end2end_connections')),
+        (None, ('tenant_group_id', 'tenant_id')),
+        (None, ('region_id', 'site_id', 'location_id')),
+        (None, ('device_role_id', 'intermediate_dev_role_id')),
+        (None, ('tag', 'status')),
+    )
 
     region_id = DynamicModelMultipleChoiceField(
         queryset=Region.objects.all(),
@@ -27,6 +39,17 @@ class DeviceFilterForm(FilterForm):
         required=False,
         label=_('Device Role')
     )
+    end2end_connections = forms.BooleanField(
+        label=_("Display end-to-end connections"),
+        required=False,
+        initial=end2end
+    )
+    intermediate_dev_role_id = DynamicModelMultipleChoiceField(
+        queryset=DeviceRole.objects.all(),
+        required=False,
+        label=_('Intermediate Devices Role'),
+        help_text='Intermediate devices to display when using end-to-end connections mode, even if they do not match the query'
+    )
     site_id = DynamicModelMultipleChoiceField(
         queryset=Site.objects.all(),
         required=False,
@@ -44,10 +67,20 @@ class DeviceFilterForm(FilterForm):
         },
         label=_('Location')
     )
-
     hide_unconnected = forms.BooleanField(
         label=_("Hide Unconnected"),
         required=False,
-        initial=False)
-
+        initial=False
+    )
+    save_coords = forms.BooleanField(
+        label=_("Save Coordinates"),
+        required=False,
+        disabled=(not allow_coordinates_saving),
+        initial=False
+    )
+    status = MultipleChoiceField(
+        choices=DeviceStatusChoices,
+        required=False,
+        label=_("Device Status")
+    )
     tag = TagFilterField(model)

netbox_topology_views/models.py

@@ -1,3 +0,0 @@
-from django.db import models
-
-# no modeles yet

netbox_topology_views/navigation.py

@@ -4,14 +4,6 @@ from utilities.choices import ButtonColorChoices
 menu_items = (
     PluginMenuItem(
         link='plugins:netbox_topology_views:home',
-        link_text='Topology',
-        buttons=(
-               PluginMenuButton(
-                link='plugins:netbox_topology_views:home',
-                title='Topology View',
-                icon_class='mdi mdi-plus-thick',
-                permissions=[],
-            ),
-        )
+        link_text='Topology'
     ),
-)
+)

netbox_topology_views/static/netbox_topology_views/css/app.css

@@ -1 +1 @@
-#visgraph{height:70vh}
+#visgraph{height:70vh}html[data-netbox-color-mode=dark] #visgraph{background-color:#212529}

netbox_topology_views/static/netbox_topology_views/js/app.js

@@ -1 +1 @@
-var graph=null,container=null;function iniPlotboxFull(){document.addEventListener("DOMContentLoaded",function(){container=document.getElementById("fullvisgraph"),startRender()},!1)}function startRender(){var e=location.search;$.ajax({type:"GET",url:"../../api/plugins/topology-views/search/search/"+e,contentType:"application/json; charset=utf-8",success:function(e,n,t){graph=null,nodes=new vis.DataSet,edges=new vis.DataSet,graph=new vis.Network(container,{nodes:nodes,edges:edges},options),$.each(e.nodes,function(e,n){nodes.add(n)}),$.each(e.edges,function(e,n){edges.add(n)}),graph.fit(),canvas=document.getElementById("fullvisgraph").getElementsByTagName("canvas")[0]}})}graph=null,container=null;var downloadButton=null,MIME_TYPE="image/png",canvas=null,csrftoken=null,nodes=new vis.DataSet,edges=new vis.DataSet,options={interaction:{hover:!0,hoverConnectedEdges:!0,multiselect:!1},nodes:{shape:"image",brokenImage:"../../static/netbox_topology_views/img/role-unknown.png",size:35,font:{multi:"md",face:"helvetica"}},edges:{length:100,width:2,font:{face:"helvetica"}},physics:{solver:"forceAtlas2Based"}},selected_regions=[],selected_sites=[];function htmlTitle(e){return(container=document.createElement("div")).innerHTML=e,container}function addEdge(e){e.title=htmlTitle(e.title),edges.add(e)}function addNode(e){e.title=htmlTitle(e.title),nodes.add(e)}function iniPlotboxIndex(){document.addEventListener("DOMContentLoaded",function(){container=document.getElementById("visgraph"),handleLoadData(),downloadButton=document.getElementById("btnDownloadImage"),btnFullView=document.getElementById("btnFullView")},!1)}function handleLoadData(){graph=null,nodes=new vis.DataSet,edges=new vis.DataSet,graph=new vis.Network(container,{nodes:nodes,edges:edges},options),topology_data.edges.forEach(addEdge),topology_data.nodes.forEach(addNode),graph.fit(),canvas=document.getElementById("visgraph").getElementsByTagName("canvas")[0],graph.on("afterDrawing",function(){var e=canvas.toDataURL(MIME_TYPE);downloadButton.href=e,downloadButton.download="topology"})}
+var graph=null,container=null,downloadButton=null,MIME_TYPE="image/png",canvas=null,csrftoken=null,nodes=new vis.DataSet,edges=new vis.DataSet,options={interaction:{hover:!0,hoverConnectedEdges:!0,multiselect:!1},nodes:{shape:"image",brokenImage:"../../static/netbox_topology_views/img/role-unknown.png",size:35,font:{multi:"md",face:"helvetica"}},edges:{length:100,width:2,font:{face:"helvetica"},shadow:{enabled:!0}},physics:{solver:"forceAtlas2Based"}},selected_regions=[],selected_sites=[],coord_save_checkbox=null,htmlElement=null;function getCookie(e){var t=null;if(document.cookie&&""!==document.cookie)for(var o=document.cookie.split(";"),n=0;n<o.length;n++){var d=o[n].trim();if(d.substring(0,e.length+1)===e+"="){t=decodeURIComponent(d.substring(e.length+1));break}}return t}function htmlTitle(e){return(container=document.createElement("div")).innerHTML=e,container}function addEdge(e){e.title=htmlTitle(e.title),edges.add(e)}function addNode(e){e.title=htmlTitle(e.title),nodes.add(e)}function iniPlotboxIndex(){document.addEventListener("DOMContentLoaded",function(){csrftoken=getCookie("csrftoken"),container=document.getElementById("visgraph"),htmlElement=document.getElementsByTagName("html")[0],downloadButton=document.getElementById("btnDownloadImage"),handleLoadData(),btnFullView=document.getElementById("btnFullView"),coord_save_checkbox=document.getElementById("id_save_coords")},!1)}function performGraphDownload(){var e=document.createElement("a"),t=canvas.toDataURL(MIME_TYPE);e.href=t,e.download="topology",document.body.appendChild(e),e.click(),document.body.removeChild(e)}function handleLoadData(){null!==topology_data&&("dark"==htmlElement.dataset.netboxColorMode&&(options.nodes.font.color="#fff"),graph=null,nodes=new vis.DataSet,edges=new vis.DataSet,graph=new vis.Network(container,{nodes:nodes,edges:edges},options),topology_data.edges.forEach(addEdge),topology_data.nodes.forEach(addNode),graph.fit(),canvas=document.getElementById("visgraph").getElementsByTagName("canvas")[0],downloadButton.onclick=function(e){return performGraphDownload(),!1},graph.on("dragEnd",function(e){if(dragged=this.getPositions(e.nodes),coord_save_checkbox.checked&&0!==Object.keys(dragged).length)for(dragged_device in dragged){var t=dragged_device,o=new XMLHttpRequest;o.open("PATCH","/api/plugins/netbox_topology_views/save-coords/save_coords/"),o.setRequestHeader("X-CSRFToken",csrftoken),o.setRequestHeader("Accept","application/json"),o.setRequestHeader("Content-Type","application/json"),o.onreadystatechange=function(){4===o.readyState&&(console.log(o.status),console.log(o.responseText))};var n=JSON.stringify({node_id:t,x:dragged[t].x,y:dragged[t].y});o.send(n)}}))}

netbox_topology_views/static_dev/css/app.scss

@@ -2,3 +2,6 @@
     height: 70vh;
   }
 
+html[data-netbox-color-mode=dark] #visgraph {
+  background-color: #212529;
+}

netbox_topology_views/static_dev/js/home.js

@@ -27,6 +27,9 @@ var options = {
         font: {
             face: 'helvetica',
         },
+        shadow: {
+            enabled: true
+        }
     },
     physics: {
         solver: 'forceAtlas2Based'
@@ -34,6 +37,25 @@ var options = {
 };
 var selected_regions = [];
 var selected_sites = [];
+var coord_save_checkbox = null;
+var htmlElement = null;
+
+function getCookie(name) {
+    var cookieValue = null;
+    if (document.cookie && document.cookie !== '') {
+        var cookies = document.cookie.split(';');
+        for (var i = 0; i < cookies.length; i++) {
+            var cookie = cookies[i].trim();
+            // Does this cookie string begin with the name we want?
+            if (cookie.substring(0, name.length + 1) === (name + '=')) {
+                cookieValue = decodeURIComponent(cookie.substring(name.length + 1));
+                break;
+            }
+        }
+    }
+    return cookieValue;
+}
+
 
 function htmlTitle(html) {
     container = document.createElement("div");
@@ -53,14 +75,33 @@ function addNode(item) {
 
 function iniPlotboxIndex() {
     document.addEventListener('DOMContentLoaded', function () {
+        csrftoken = getCookie('csrftoken');
         container = document.getElementById('visgraph');
-        handleLoadData();
+        htmlElement = document.getElementsByTagName("html")[0];
         downloadButton = document.getElementById('btnDownloadImage');
+        handleLoadData();
         btnFullView = document.getElementById('btnFullView');
+        coord_save_checkbox = document.getElementById('id_save_coords');
     }, false);
 }
 
+function performGraphDownload() {
+    var tempDownloadLink = document.createElement('a');
+    var generatedImageUrl = canvas.toDataURL(MIME_TYPE);
+
+    tempDownloadLink.href = generatedImageUrl;
+    tempDownloadLink.download = "topology";
+    document.body.appendChild(tempDownloadLink);
+    tempDownloadLink.click();
+    document.body.removeChild(tempDownloadLink);
+}
+
 function handleLoadData() {
+    if (topology_data !== null) {
+        
+        if (htmlElement.dataset.netboxColorMode == "dark") {
+            options.nodes.font.color = "#fff";
+        }
 
         graph = null;
         nodes = new vis.DataSet();
@@ -73,10 +114,38 @@ function handleLoadData() {
         graph.fit();
         canvas = document.getElementById('visgraph').getElementsByTagName('canvas')[0];
 
-        graph.on('afterDrawing', function () {
-            var image = canvas.toDataURL(MIME_TYPE);
-            downloadButton.href = image;
-            downloadButton.download = "topology";
-        });
+        downloadButton.onclick = function(e) { performGraphDownload(); return false; };
 
+        graph.on("dragEnd", function (params) {
+            dragged = this.getPositions(params.nodes);
+
+            if (coord_save_checkbox.checked) {
+                if (Object.keys(dragged).length !== 0) {
+                    for (dragged_device in dragged) {
+                        var node_id = dragged_device;
+
+                        var url = "/api/plugins/netbox_topology_views/save-coords/save_coords/";
+                        var xhr = new XMLHttpRequest();
+                        xhr.open("PATCH", url);
+                        xhr.setRequestHeader('X-CSRFToken', csrftoken );
+                        xhr.setRequestHeader("Accept", "application/json");
+                        xhr.setRequestHeader("Content-Type", "application/json");
+    
+                        xhr.onreadystatechange = function () {
+                        if (xhr.readyState === 4) {
+                            console.log(xhr.status);
+                            console.log(xhr.responseText);
+                        }};
+    
+                        var data = JSON.stringify({
+                            'node_id': node_id,
+                            'x': dragged[node_id].x,
+                            'y': dragged[node_id].y});
+    
+                        xhr.send(data);
+                    }
+                }
+            }
+        });
+    }
 }

netbox_topology_views/templates/netbox_topology_views/index.html

@@ -16,7 +16,7 @@
   <div class="controls">
     	<div class="control-group">
 			{% block extra_controls %}{% endblock %}
-			<a id="btnDownloadImage" class="btn btn-sm btn-info">
+			<a id="btnDownloadImage" class="btn btn-sm btn-info" href="#">
 				<i class="mdi mdi-download"></i>
 				Download
 			</a>
@@ -36,7 +36,7 @@
         <li class="nav-item" role="presentation">
           <button class="nav-link" id="filters-form-tab" data-bs-toggle="tab" data-bs-target="#filters-form" type="button" role="tab" aria-controls="object-list" aria-selected="false">
             Filters
-            {% if filter_form %}{% badge filter_form.changed_data|length bg_class="primary" %}{% endif %}
+            {% if filter_form %}{% badge filter_form.changed_data|length bg_color="blue" %}{% endif %}
           </button>
         </li>
       	{% endif %}
@@ -45,30 +45,31 @@
 {% endblock tabs %}
 
 {% block content-wrapper %}
-{% with config=settings.PLUGINS_CONFIG.netbox_topology_views %}
-	<div class="tab-content">
+  {% with config=settings.PLUGINS_CONFIG.netbox_topology_views %}
+    <div class="tab-content">
 
-		<div class="tab-pane show active" id="networks" role="tabpanel" aria-labelledby="network-tab">
-			<div class="panel-body">
-				<div id="visgraph" class=""></div>
-			</div>
+      <div class="tab-pane show active" id="networks" role="tabpanel" aria-labelledby="network-tab">
+        <div class="panel-body">
+          <div id="visgraph" class=""></div>
+        </div>
 
-			<script type="text/javascript">
-				var topology_data = {{ topology_data | safe }};
-			</script>
-		</div>
+        <script type="text/javascript">
+          var topology_data = {{ topology_data | safe }};
+        </script>
+      </div>
 
-		{% if filter_form %}
-		<div class="tab-pane show" id="filters-form" role="tabpanel" aria-labelledby="filters-form-tab">
-		  {% include 'inc/filter_list.html' %}
-		</div>
-	  {% endif %}
+      {% if filter_form %}
+      <div class="tab-pane show" id="filters-form" role="tabpanel" aria-labelledby="filters-form-tab">
+        {% include 'inc/filter_list.html' %}
+      </div>
+      {% endif %}
 
-	</div>
-
-	<script src="{% static 'netbox_topology_views/js/vendor.js' %}"></script>
-	<script src="{% static 'netbox_topology_views/js/app.js' %}"></script>
-
-	<script type="application/javascript"> iniPlotboxIndex()</script>
-{% endwith %}
+    </div>
+  {% endwith %}
 {% endblock content-wrapper %}
+
+{% block javascript %}
+  <script src="{% static 'netbox_topology_views/js/vendor.js' %}"></script>
+	<script src="{% static 'netbox_topology_views/js/app.js' %}"></script>
+	<script type="application/javascript">iniPlotboxIndex()</script>
+{% endblock javascript %}

netbox_topology_views/views.py

@@ -11,12 +11,82 @@ from .filters import DeviceFilterSet
 
 import json
 
-from dcim.models import Device, Cable, DeviceRole, DeviceType
+from dcim.models import Device, Cable, DeviceRole, PathEndpoint
+from circuits.models import CircuitTermination, ProviderNetwork
 from extras.models import Tag
 
-def get_topology_data(queryset, hide_unconnected):
-    nodes = []
-    nodes_ids = []
+
+def create_node(device):
+    dev_name = device.name
+    if dev_name is None:
+        dev_name = "device name unknown"
+
+    node_content = ""
+
+    if device.device_type is not None:
+        node_content += "<tr><th>Type: </th><td>" + device.device_type.model + "</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"] = dev_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
+
+    if "coordinates" in device.custom_field_data:
+        if device.custom_field_data["coordinates"] is not None:
+            if ";" in device.custom_field_data["coordinates"]:
+                cords =  device.custom_field_data["coordinates"].split(";")
+                node["x"] = int(cords[0])
+                node["y"] = int(cords[1])
+                node["physics"] = False
+    return node
+
+def create_edge(edge_id, cable, termination_a, termination_b, path = None, circuit = None):
+    cable_a_dev_name = "device A name unknown" if termination_a.device.name is None else termination_a.device.name
+    cable_a_name = "device A name unknown" if termination_a.name is None else termination_a.name
+    cable_b_dev_name = "device A name unknown" if termination_b.device.name is None else termination_b.device.name
+    cable_b_name = "cable B name unknown" if termination_b.name is None else termination_b.name
+
+    edge = {}
+    edge["id"] = edge_id
+    edge["from"] = termination_a.device.id
+    edge["to"] = termination_b.device.id
+
+    if circuit is not None:
+        edge["dashes"] = True
+        edge["title"] = "Circuit provider: "  + circuit.provider.name + "<br>"
+        edge["title"] += "Termination between <br>"
+        edge["title"] += cable_b_dev_name + " [" + cable_b_name +  "]<br>"
+        edge["title"] += cable_a_dev_name + " [" + cable_a_name +  "]"
+    else:
+        edge["title"] = "Cable between <br> " + cable_a_dev_name + " [" + cable_a_name +  "]<br>" + cable_b_dev_name + " [" + cable_b_name + "]"
+    
+    if path is not None:
+        edge["title"] += "" if len(path) <= 0 else "<br>Through " + "/".join(path)
+        
+    if cable is not None and cable.color != "":
+        edge["color"] = "#" + cable.color
+    
+    return edge
+
+def get_topology_data(queryset, hide_unconnected, intermediate_dev_role_ids, end2end_connections):
+    nodes_devices = {}
     edges = []
     edge_ids = 0
     cable_ids = []
@@ -25,182 +95,203 @@ def get_topology_data(queryset, hide_unconnected):
         return None
 
     ignore_cable_type = settings.PLUGINS_CONFIG["netbox_topology_views"]["ignore_cable_type"]
+    enable_circuit_terminations = settings.PLUGINS_CONFIG["netbox_topology_views"]["enable_circuit_terminations"]
 
     device_ids = [d.id for d in queryset]
 
-    for qs_device in queryset:
-        device_has_connections = False
+    links = Cable.objects.filter( Q(_termination_a_device_id__in=device_ids) | Q(_termination_b_device_id__in=device_ids) ) \
+                        .select_related("termination_a_type", "termination_b_type") \
+                        .prefetch_related("termination_a", "termination_b")
+
+    for link in links:
+
+        if link.termination_a_type.name in ignore_cable_type or link.termination_b_type.name in ignore_cable_type \
+            or link.id in cable_ids:
+            continue
+        
+        a_is_path_endoint = isinstance(link.termination_a, PathEndpoint)
+        b_is_path_endoint = isinstance(link.termination_b, PathEndpoint)
+
+        if not end2end_connections or (not a_is_path_endoint and not b_is_path_endoint):
+
+            if isinstance(link.termination_a, CircuitTermination):
+                if enable_circuit_terminations and link.termination_a.circuit.id not in circuit_ids:
+                    circuit = link.termination_a.circuit
+                    circuit_ids.append(circuit.id)
+                    cable_ids.append(link.id)
+                    
+                    path_destination = circuit.termination_z if link.termination_a.term_side == "A" else circuit.termination_a
+
+                    if path_destination is not None and path_destination.provider_network is None:
+                        # ProviderNetwork not supported at the moment
+                        # $path_destination.cable would be none : there is no cable between a CircuitTermination and ProviderNetwork
+                        origin_device = link.termination_b.device
+                        destination_device = path_destination.cable.termination_b.device
+
+                        if origin_device.id in device_ids and destination_device.id in device_ids:
+                            if origin_device.id not in nodes_devices:
+                                nodes_devices[origin_device.id] = origin_device
+                            if destination_device.id not in nodes_devices:
+                                nodes_devices[destination_device.id] = destination_device
 
-        links_device = Cable.objects.filter(Q(_termination_a_device_id=qs_device.id) | Q(_termination_b_device_id=qs_device.id) )
-        for link_from in links_device:
-            if link_from.termination_a_type.name != "circuit termination" and link_from.termination_b_type.name != "circuit termination":
-                if link_from.termination_a_type.name not in ignore_cable_type and link_from.termination_b_type.name not in ignore_cable_type:
-                    if link_from.id not in cable_ids:
-                        if link_from.termination_a.device.id in device_ids and link_from.termination_b.device.id in device_ids:
-                            device_has_connections = True
-                            cable_ids.append(link_from.id)
                             edge_ids += 1
-                            cable_a_dev_name = link_from.termination_a.device.name
-                            if cable_a_dev_name is None:
-                                cable_a_dev_name = "device A name unknown"
-                            cable_a_name = link_from.termination_a.name
-                            if cable_a_name is None:
-                                cable_a_name = "cable A name unknown"
-                            cable_b_dev_name = link_from.termination_b.device.name
-                            if cable_b_dev_name is None:
-                                cable_b_dev_name = "device B name unknown"
-                            cable_b_name = link_from.termination_b.name
-                            if cable_b_name is None:
-                                cable_b_name = "cable B name unknown"
+                            edges.append(create_edge(edge_ids, link, link.termination_b, path_destination.cable.termination_b, [circuit.cid], circuit))
 
-                            edge = {}
-                            edge["id"] = edge_ids
-                            edge["from"] = link_from.termination_a.device.id
-                            edge["to"] = link_from.termination_b.device.id
-                            edge["title"] = "Cable between <br> " + cable_a_dev_name + " [" + cable_a_name +  "]<br>" + cable_b_dev_name + " [" + cable_b_name + "]"
-                            if link_from.color != "":
-                                edge["color"] = "#" + link_from.color
-                            edges.append(edge)
-                    else:
-                        if link_from.termination_a.device.id in device_ids and link_from.termination_b.device.id in device_ids:
-                            device_has_connections = True
+            elif link.termination_a.device.id in device_ids and link.termination_b.device.id in device_ids:
+
+                    if link.termination_a.device.id not in nodes_devices:
+                        nodes_devices[link.termination_a.device.id] = link.termination_a.device
+                    if link.termination_b.device.id not in nodes_devices:
+                        nodes_devices[link.termination_b.device.id] = link.termination_b.device
+
+                    cable_ids.append(link.id)
+                    edge_ids += 1
+                    edges.append(create_edge(edge_ids, link, link.termination_a, link.termination_b))
+        else:
+            # termination_a can be a CircuitTermination (no trace()) while termination_b is a PathEndpoint
+            # If so, we swap them so we can follow the path using PathEndpoint#trace()
+            path_start = link.termination_a if a_is_path_endoint else link.termination_b
+            if path_start.device is not None and path_start.device.id not in device_ids:
+                # device not in queryset, skip
+                continue
+
+            # Ignore incomplete path when in end-to-end connection mode
+            if path_start.path is not None:
+                if not path_start.path.is_active or path_start.path.is_split:
+                    continue
             else:
-                if settings.PLUGINS_CONFIG["netbox_topology_views"]["enable_circuit_terminations"]:
-                    if link_from.termination_a.circuit.id not in circuit_ids:
-                        circuit_ids.append(link_from.termination_a.circuit.id)
+                continue
+
+            path_destination = path_start.path.destination
+            if hasattr(path_destination, "device") and path_destination.device is not None and path_destination.device.id not in device_ids:
+                # device not in queryset, skip
+                continue
+
+            valid_path = False
+
+            # variables needed for trace() browsing
+            origin = None
+            circuit = None
+            tmp_path = []
+
+            # trace() : Return the path as a list of three-tuples (A termination, cable, B termination)
+            # TODO device qui ne s"affichent pas si hide_unconnected
+            for (termination_a, cable, termination_b) in path_start.trace():
+                
+                if origin is None:
+                    # New part of the link
+                    origin = termination_a
+                    circuit = None
+                    tmp_path = []
+
+                if isinstance(termination_b, ProviderNetwork):
+                    # ProviderNetwork not supported at the moment
+                    # It would need to manage several kind of nodes (Device, ProviderNetwork)
+                    # and maps javascript nodes ID with Devices IDs and ProviderNetworks IDs
+                    # When $termination_b is a ProviderNetwork instance, $cable will be None
+                    break
+
+                if cable is not None and (cable.termination_a_type in ignore_cable_type or cable.termination_b_type in ignore_cable_type):
+                    # Ignore this path
+                    break
+
+                if isinstance(termination_b, CircuitTermination):
+                    if enable_circuit_terminations:
+                        circuit = termination_b.circuit
+                        tmp_path.append(circuit.cid)
+                        if circuit.id not in circuit_ids:
+                            circuit_ids.append(circuit.id)
+                    else:
+                        # Ignore this path
+                        break
+                elif end2end_connections and termination_b != path_destination \
+                        and termination_b.device.device_role.id not in intermediate_dev_role_ids \
+                        and termination_b.device.id not in device_ids:
+                    # Skip this intermediate device, origin device is keep in $origin for next iteration
+                    tmp_path.append(termination_b.device.name)
+                elif cable is not None and termination_b is not None:
+                    if cable.id not in cable_ids:
+                        # New part of the link we want to display
+                        cable_ids.append(cable.id)
                         edge_ids += 1
+                        edges.append(create_edge(edge_ids, cable, origin, termination_b, tmp_path, circuit))
 
-                        cable_b_dev_name = link_from.termination_b.device.name
-                        if cable_b_dev_name is None:
-                            cable_b_dev_name = "device B name unknown"
-                        cable_b_name = link_from.termination_b.name
-                        if cable_b_name is None:
-                            cable_b_name = "cable B name unknown"
+                    if not valid_path:
+                        valid_path = True
 
-                        edge = {}
-                        edge["id"] = edge_ids
-                        edge["to"] = link_from.termination_b.device.id
-                        edge["dashes"] = True
-                        title = ""
+                    if termination_b.device.id not in nodes_devices and \
+                      (termination_b.device.device_role.id in intermediate_dev_role_ids or termination_b.device.id in device_ids) :
+                        nodes_devices[termination_b.device.id] = termination_b.device
+                    # Reset for next iteration
+                    origin = None
+            # endfor (trace)
 
-                        title += "Circuit provider: "  + link_from.termination_a.circuit.provider.name + "<br>"
-                        title += "Termination between <br>"
-                        title += cable_b_dev_name + " [" + cable_b_name +  "]<br>"
+            if valid_path and path_start.device.id not in nodes_devices:
+                nodes_devices[path_start.device.id] = path_start.device
 
-                        if link_from.termination_a.circuit.termination_a is not None and link_from.termination_a.circuit.termination_a.cable is not None and link_from.termination_a.circuit.termination_a.cable.id != link_from.id and link_from.termination_a.circuit.termination_a.cable.termination_b is not None and link_from.termination_a.circuit.termination_a.cable.termination_b.device is not None:
-                            edge["from"] = link_from.termination_a.circuit.termination_a.cable.termination_b.device.id
-
-                            cable_a_dev_name = link_from.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 = link_from.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>"
-                            edge["title"] = title
-                            edges.append(edge)
-
-                        if link_from.termination_a.circuit.termination_z is not None and link_from.termination_a.circuit.termination_z.cable is not None and link_from.termination_a.circuit.termination_z.cable.id != link_from.id and link_from.termination_a.circuit.termination_z.cable.termination_b is not None and link_from.termination_a.circuit.termination_z.cable.termination_b.device is not None:
-                            edge["from"] = link_from.termination_a.circuit.termination_z.cable.termination_b.device.id
-
-                            cable_a_dev_name = link_from.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 = link_from.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)
-
-        if qs_device.id not in nodes_ids:
-            if hide_unconnected == None or (hide_unconnected is True and device_has_connections is True): 
-                nodes_ids.append(qs_device.id)
-
-                dev_name = qs_device.name
-                if dev_name is None:
-                    dev_name = "device name unknown"
-
-                node_content = ""
-
-                if qs_device.device_type is not None:
-                    node_content += "<tr><th>Type: </th><td>" + qs_device.device_type.model + "</td></tr>"
-                if qs_device.device_role.name is not None:
-                    node_content +=  "<tr><th>Role: </th><td>" + qs_device.device_role.name + "</td></tr>"
-                if qs_device.serial != "":
-                    node_content += "<tr><th>Serial: </th><td>" + qs_device.serial + "</td></tr>"
-                if qs_device.primary_ip is not None:
-                    node_content += "<tr><th>IP Address: </th><td>" + str(qs_device.primary_ip.address) + "</td></tr>"
-
-                dev_title = "<table> %s </table>" % (node_content)
-
-                node = {}
-                node["id"] = qs_device.id
-                node["name"] = dev_name
-                node["label"] = dev_name
-                node["title"] = dev_title
-                node["shape"] = 'image'
-                if qs_device.device_role.slug in settings.PLUGINS_CONFIG["netbox_topology_views"]["device_img"]:
-                    node["image"] = '../../static/netbox_topology_views/img/'  + qs_device.device_role.slug + ".png"
-                else:
-                    node["image"] = "../../static/netbox_topology_views/img/role-unknown.png"
-
-                if qs_device.device_role.color != "":
-                    node["color.border"] = "#" + qs_device.device_role.color
-
-                if "coordinates" in qs_device.custom_field_data:
-                    if qs_device.custom_field_data["coordinates"] is not None:
-                        cords =  qs_device.custom_field_data["coordinates"].split(";")
-                        node["x"] = int(cords[0])
-                        node["y"] = int(cords[1])
-                        node["physics"] = False
-                nodes.append(node)
+    # endfor (link)
+    
+    for qs_device in queryset:
+        if qs_device.id not in nodes_devices and not hide_unconnected:
+            nodes_devices[qs_device.id] = qs_device
 
     results = {}
-    results["nodes"] = nodes
+    results["nodes"] = [create_node(d) for d in nodes_devices.values()]
     results["edges"] = edges
     return results
 
-
 class TopologyHomeView(PermissionRequiredMixin, View):
-    permission_required = ('dcim.view_site', 'dcim.view_device')
+    permission_required = ("dcim.view_site", "dcim.view_device")
 
     """
     Show the home page
     """
     def get(self, request):
         self.filterset = DeviceFilterSet
-        self.queryset = Device.objects.all()
+        self.queryset = Device.objects.all().select_related("device_type", "device_role")
         self.queryset = self.filterset(request.GET, self.queryset).qs
         topo_data = None
 
         if request.GET:
-            hide_unconnected = None
-            if 'hide_unconnected' in request.GET:
+            hide_unconnected = False
+            if "hide_unconnected" in request.GET:
                 if request.GET["hide_unconnected"] == "on" :
                     hide_unconnected = True
 
-            if 'draw_init' in request.GET:
-                if request.GET["draw_init"].lower() == 'true':
-                    topo_data = get_topology_data(self.queryset, hide_unconnected)
+            if "intermediate_dev_role_id" in request.GET:
+                intermediate_dev_role_ids = list(map(int, request.GET.getlist("intermediate_dev_role_id")))
             else:
-                topo_data = get_topology_data(self.queryset, hide_unconnected)
+                intermediate_dev_role_ids = []
+
+            end2end_connections = False
+            if "end2end_connections" in request.GET:
+                if request.GET["end2end_connections"] == "on" :
+                    end2end_connections = True
+            
+            if "draw_init" in request.GET:
+                if request.GET["draw_init"].lower() == "true":
+                    topo_data = get_topology_data(self.queryset, hide_unconnected, intermediate_dev_role_ids, end2end_connections)
+            else:
+                topo_data = get_topology_data(self.queryset, hide_unconnected, intermediate_dev_role_ids, end2end_connections)
         else:
             preselected_device_roles = settings.PLUGINS_CONFIG["netbox_topology_views"]["preselected_device_roles"]
+            preselected_intermediate_dev_roles = settings.PLUGINS_CONFIG["netbox_topology_views"]["preselected_intermediate_dev_roles"]
             preselected_tags = settings.PLUGINS_CONFIG["netbox_topology_views"]["preselected_tags"]
 
-            q_device_role_id = DeviceRole.objects.filter(name__in=preselected_device_roles).values_list('id', flat=True)
-            q_tags = Tag.objects.filter(name__in=preselected_tags).values_list('name', flat=True)
+            q_device_role_id = DeviceRole.objects.filter(name__in=preselected_device_roles).values_list("id", flat=True)
+            q_intermediate_dev_role_id = DeviceRole.objects.filter(name__in=preselected_intermediate_dev_roles).values_list("id", flat=True)
+            q_tags = Tag.objects.filter(name__in=preselected_tags).values_list("name", flat=True)
 
             q = QueryDict(mutable=True)
-            q.setlist('device_role_id', list(q_device_role_id))
-            q.setlist('tag', list(q_tags))
-            q['draw_init'] = settings.PLUGINS_CONFIG["netbox_topology_views"]["draw_default_layout"]
+            q.setlist("device_role_id", list(q_device_role_id))
+            q.setlist("intermediate_dev_role_id", list(q_intermediate_dev_role_id))
+            q.setlist("tag", list(q_tags))
+            q["draw_init"] = settings.PLUGINS_CONFIG["netbox_topology_views"]["draw_default_layout"]
             query_string = q.urlencode()
             return HttpResponseRedirect(request.path + "?" + query_string)
 
-        return render(request, 'netbox_topology_views/index.html' , {
-             'filter_form': DeviceFilterForm(request.GET, label_suffix=''),
-             'topology_data': json.dumps(topo_data)
+        return render(request, "netbox_topology_views/index.html" , {
+             "filter_form": DeviceFilterForm(request.GET, label_suffix=""),
+             "topology_data": json.dumps(topo_data)
             }
         )

package.json

@@ -1,7 +1,7 @@
 {
   "private": true,
   "name": "netbox_topology_views",
-  "version": "1.0.0-alpha.45",
+  "version": "2.0.0",
   "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='1.0.0-alpha.5',
+    version='2.0.0',
     description='An NetBox plugin to create Topology maps',
     url='https://github.com/mattieserver/netbox-topology-views',
     author='Mattijs Vanhaverbeke',