bump version

* fix: moved image generation to avoid severe performance issues

* fix: moved button finding code before data handling

* fix: fixed leftover invalid variable naming

README.md

@@ -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 |

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 topology maps'
-    version = '1.0.3'
+    version = '1.2.0'
     author = 'Mattijs Vanhaverbeke'
     author_email = 'author@example.com'
     base_url = 'netbox_topology_views'
@@ -12,7 +12,7 @@ class TopologyViewsConfig(PluginConfig):
     default_settings = {
         'preselected_device_roles': ['Firewall', 'Router', 'Distribution Switch', 'Core Switch', 'Internal Switch', 'Access Switch', 'Server', 'Storage', 'Backup', 'Wireless AP'],
         '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': False,

netbox_topology_views/admin.py

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

netbox_topology_views/filters.py

@@ -1,18 +1,21 @@
 import django_filters
-from extras.filters import TagFilter
-from dcim.models import Device, DeviceRole, Region, Site, Location
-from tenancy.models import TenantGroup, Tenant
-from tenancy.filtersets import TenancyFilterSet
-from utilities.filters import TreeNodeMultipleChoiceFilter
 from django.db.models import Q
 
-class DeviceFilterSet(TenancyFilterSet, django_filters.FilterSet):
+from dcim.models import Device, DeviceRole, Region, Site, Location
+
+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(),
@@ -37,7 +40,7 @@ class DeviceFilterSet(TenancyFilterSet, django_filters.FilterSet):
 
     class Meta:
         model = Device
-        fields = ['id', 'name', ]
+        fields = ['id', 'name']
 
     def search(self, queryset, name, value):
         """Perform the filtered search."""
@@ -46,4 +49,4 @@ class DeviceFilterSet(TenancyFilterSet, 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,26 +1,30 @@
 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 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)
 
-from utilities.forms import (TagFilterField,  DynamicModelMultipleChoiceField, FilterForm)
 allow_coordinates_saving = settings.PLUGINS_CONFIG["netbox_topology_views"]["allow_coordinates_saving"]
 
-class DeviceFilterForm(TenancyFilterForm, FilterForm):
+
+class DeviceFilterForm(TenancyFilterForm, NetBoxModelFilterSetForm):
     model = Device
-    field_groups = [
-        ['q', 'hide_unconnected', 'save_coords'],
-        ['tenant_group_id', 'tenant_id'],
-        ['region_id', 'site_id', 'location_id'],
-        ['device_role_id'],
-        ['tag'],
-    ]
+    fieldsets = (
+        (None, ('q', 'hide_unconnected', 'save_coords')),
+        (None, ('tenant_group_id', 'tenant_id')),
+        (None, ('region_id', 'site_id', 'location_id')),
+        (None, ('device_role_id',)),
+        (None, ('tag',)),
+    )
 
     region_id = DynamicModelMultipleChoiceField(
         queryset=Region.objects.all(),
@@ -49,7 +53,6 @@ class DeviceFilterForm(TenancyFilterForm, FilterForm):
         },
         label=_('Location')
     )
-
     hide_unconnected = forms.BooleanField(
         label=_("Hide Unconnected"),
         required=False,
@@ -60,5 +63,4 @@ class DeviceFilterForm(TenancyFilterForm, FilterForm):
         required=False,
         disabled=(not allow_coordinates_saving),
         initial=False)
-
     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,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=[],coord_save_checkbox=null,htmlElement=null;function getCookie(e){var t=null;if(document.cookie&&""!==document.cookie)for(var n=document.cookie.split(";"),o=0;o<n.length;o++){var a=n[o].trim();if(a.substring(0,e.length+1)===e+"="){t=decodeURIComponent(a.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],handleLoadData(),downloadButton=document.getElementById("btnDownloadImage"),btnFullView=document.getElementById("btnFullView"),coord_save_checkbox=document.getElementById("id_save_coords")},!1)}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],graph.on("afterDrawing",function(){var e=canvas.toDataURL(MIME_TYPE);downloadButton.href=e,downloadButton.download="topology"}),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,n=new XMLHttpRequest;n.open("PATCH","/api/plugins/netbox_topology_views/save-coords/save_coords/"),n.setRequestHeader("X-CSRFToken",csrftoken),n.setRequestHeader("Accept","application/json"),n.setRequestHeader("Content-Type","application/json"),n.onreadystatechange=function(){4===n.readyState&&(console.log(n.status),console.log(n.responseText))};var o=JSON.stringify({node_id:t,x:dragged[t].x,y:dragged[t].y});n.send(o)}}))}
+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'
@@ -75,13 +78,24 @@ function iniPlotboxIndex() {
         csrftoken = getCookie('csrftoken');
         container = document.getElementById('visgraph');
         htmlElement = document.getElementsByTagName("html")[0];
-        handleLoadData();
         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) {
         
@@ -100,11 +114,7 @@ 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);

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 %}

package.json

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