bump version

added Filter topology via URL Parameter

README.md

@@ -1,7 +1,8 @@
 # Netbox Topology Views Plugin
 
 Create topology views/maps from your devices in netbox.
-Support to filter on name, site and device role.
+The connections are based on the cables you created in netbox.
+Support to filter on name, site, tag and device role.
 
 ## Preview
 
@@ -9,9 +10,22 @@ Support to filter on name, site and device role.
 
 ## Install
 
+The plugin is available as a Python package and can be installed with pip.
+
 Run `pip install netbox-topology-views` in your virtual env.
 
-Add 'netbox_topology_views' to the PLUGINS array in your django configuration file.  
+To ensure NetBox Topology Views plugin is automatically re-installed during future upgrades, create a file named `local_requirements.txt` (if not already existing) in the NetBox root directory (alongside `requirements.txt`) and list the `netbox-topology-views` package:
+
+```no-highlight
+# echo netbox-topology-views >> local_requirements.txt
+```
+
+Once installed, the plugin needs to be enabled in your `configuration.py`
+
+```python
+# In your configuration.py
+PLUGINS = ["netbox_topology_views"]
+```
 
 Then run `python3 manage.py collectstatic --no-input`
 
@@ -44,7 +58,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
 
@@ -62,4 +76,14 @@ Run `pip install netbox-topology-views --upgrade` in your venv.
 
 Run `python3 manage.py collectstatic --no-input`
 
+
 Clear you browser cache.
+
+
+### Permissions
+
+To view `/plugins/topology-views/` you need the following permissions:
+ + dcim | device | can view device
+ + dcim | site | can view site
+ + extras | tag | can view tag
+ + dcim | device role | can view device role

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.3'
+    version = '0.4.9'
     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"]
@@ -29,11 +30,11 @@ class PreSelectTagsViewSet(ReadOnlyModelViewSet):
     queryset = Tag.objects.filter(name__in=preselected_tags)
     serializer_class = PreTagSerializer
 
-class SaveCoordsViewSet(GenericViewSet):
+class SaveCoordsViewSet(ReadOnlyModelViewSet):
     queryset = Device.objects.all()
     serializer_class = TopologyDummySerializer
 
-    @action(detail=False, methods=['post'])
+    @action(detail=False, methods=['patch'])
     def save_coords(self, request):
         results = {}
         if settings.PLUGINS_CONFIG["netbox_topology_views"]["allow_coordinates_saving"]:
@@ -75,14 +76,14 @@ class SaveCoordsViewSet(GenericViewSet):
             results["status"] = "not allowed to save coords"
             return Response(results, status=500)
 
-class SearchViewSet(GenericViewSet):
+class SearchViewSet(ReadOnlyModelViewSet):
     #_ignore_model_permissions = True
     #permission_classes = [IsAuthenticatedOrLoginNotRequired]
 
     queryset = Device.objects.all()
     serializer_class = TopologyDummySerializer
 
-    def _filter(self, site, role, name, tags):
+    def _filter(self, site, role, name, tags, region):
         filter_devices = Device.objects.all()
         if name is not None:
             filter_devices = filter_devices.filter(name__contains=name)
@@ -92,34 +93,40 @@ class SearchViewSet(GenericViewSet):
             filter_devices = filter_devices.filter(device_role__id__in=role)
         if tags is not None:
             filter_devices = filter_devices.filter(tags__id__in=tags)
+        if region is not None:
+            filter_devices = filter_devices.filter(site__region__id__in=region)
         return filter_devices
 
 
-    @action(detail=False, methods=['post'])
+    @action(detail=False, methods=['get'])
     def search(self, request):
-        name = None
-        sites = None
-        devicerole = None
-        tags = None
-        if "devicerole" in request.data:
-            if request.data["devicerole"]:
-                devicerole = request.data["devicerole"]
-        if "sites" in request.data:
-            if request.data["sites"]:
-                sites = request.data["sites"]
-        if "name" in request.data:
-            if request.data["name"]:
-                name = request.data["name"]
-        if "tags" in request.data:
-            if request.data["tags"]:
-                tags = request.data["tags"]
+        name = request.query_params.get('name', None)
+        if name == "":
+            name = None
 
-        devices = self._filter(sites, devicerole, name, tags)
+        sites = request.query_params.getlist('sites[]', None)
+        if sites == []:
+            sites = None
+
+        devicerole = request.query_params.getlist('devicerole[]', None)
+        if devicerole == []:
+            devicerole = None
+
+        tags = request.query_params.getlist('tags[]', None)
+        if tags == []:
+            tags = None
+
+        regions = request.query_params.getlist('regions[]', None)
+        if regions == []:
+            regions = None
+
+        devices = self._filter(sites, devicerole, name, tags, regions)
 
         nodes = []
         edges = []
         edge_ids = 0
         cable_ids = []
+        circuit_ids = []
         for device in devices:
             cables = device.get_cables()
             for cable in cables:
@@ -131,45 +138,113 @@ class SearchViewSet(GenericViewSet):
 
                             cable_a_dev_name = cable.termination_a.device.name
                             if cable_a_dev_name is None:
-                                cable_a_dev_name = "device A name unkown"
+                                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 unkown"
+                                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 unkown"
+                                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 unkown"
+                                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_a_dev_name + " [" + cable_a_name +  "]<br>" + cable_b_dev_name + " [" + cable_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
-                    #circuittermination not supported for now
-            
+                    if cable.termination_a_type.name == "circuit termination":
+                        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>"
+                                # To Many if's
+                                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:
+                                            if cable.termination_a.circuit.termination_a.cable.termination_b is not None:
+                                                if cable.termination_a.circuit.termination_a.cable.termination_b.device is not None:
+                                                    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>"
+                                                    edge["title"] = title
+                                                    edges.append(edge)
+                                # To Many if's
+                                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:
+                                            if cable.termination_a.circuit.termination_z.cable.termination_b is not None:
+                                                if cable.termination_a.circuit.termination_z.cable.termination_b.device is not None:
+                                                    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 unkown"
+                dev_name = "device name unknown"
 
-            cable_role_name = device.device_type.display_name
-            if cable_role_name is None:
-                cable_role_name = "device role name unkown"
+            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"] = dev_name
-            node["label"] = dev_name + " {" + cable_role_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(";")

netbox_topology_views/static_dev/js/full.js

@@ -0,0 +1,33 @@
+var graph = null;
+var container = null;
+
+function iniPlotboxFull() {
+    document.addEventListener('DOMContentLoaded', function () {
+        container = document.getElementById('fullvisgraph');
+        startRender();
+    }, false);
+}
+
+function startRender() {
+  var url = location.search;
+
+  $.ajax({
+    type: "GET",
+    url: "../../api/plugins/topology-views/search/search/" + url,
+    contentType: "application/json; charset=utf-8",
+    success: function (data_result, status, xhr) {
+        graph = null;
+        nodes = new vis.DataSet();
+        edges = new vis.DataSet();
+        graph = new vis.Network(container, { nodes: nodes, edges: edges }, options);
+        $.each(data_result["nodes"], function (index, device) {
+            nodes.add(device);
+        });
+        $.each(data_result["edges"], function (index, edge) {
+            edges.add(edge);
+        });
+        graph.fit();
+        canvas = document.getElementById('fullvisgraph').getElementsByTagName('canvas')[0];
+    }
+});
+}

netbox_topology_views/static_dev/js/home.js

@@ -1,5 +1,8 @@
 var graph = null;
 var container = null;
+var downloadButton = null;
+var MIME_TYPE = "image/png";
+var canvas = null;
 var csrftoken = null;
 var nodes = new vis.DataSet();
 var edges = new vis.DataSet();
@@ -29,6 +32,7 @@ var options = {
         solver: 'forceAtlas2Based'
     }
 };
+var selected_regions = [];
 
 function iniPlotboxIndex() {
     document.addEventListener('DOMContentLoaded', function () {
@@ -36,6 +40,8 @@ function iniPlotboxIndex() {
         csrftoken = jQuery("[name=csrfmiddlewaretoken]").val();
         startLoadSearchBar();
         handleButtonPress();
+        downloadButton = document.getElementById('btnDownloadImage');
+        btnFullView = document.getElementById('btnFullView');
     }, false);
 }
 
@@ -73,11 +79,23 @@ function startLoadSearchBar() {
         theme: "bootstrap",
         multiple: true,
         ajax: {
-            url: "../../api/dcim/sites/?brief=true",
+            url: function (params) { 
+                var base_url = "../../api/dcim/sites/?brief=true";
+                if (selected_regions.length == 0) {
+                    return base_url;
+                }
+                else {
+                    for (var i = 0; i < selected_regions.length; i++) {
+                        var tmp = "&region_id=" + selected_regions[i];
+                        base_url = base_url + tmp;
+                    }
+                    return base_url;
+                }
+
+            },
             dataType: "json",
             type: "GET",
             data: function (params) {
-
                 var queryParameters = {
                     q: params.term
                 }
@@ -122,6 +140,53 @@ function startLoadSearchBar() {
             }
         }
     });
+    $('#regions').select2({
+        allowClear: true,
+        placeholder: "---------",
+        theme: "bootstrap",
+        multiple: true,
+        ajax: {
+            url: "../../api/dcim/regions/?brief=true",
+            dataType: "json",
+            type: "GET",
+            data: function (params) {
+                var queryParameters = {
+                    q: params.term
+                }
+                return queryParameters;
+            },
+            processResults: function (data) {
+                return {
+                    results: $.map(data.results, function (item) {
+                        return {
+                            text: item.name,
+                            id: item.id
+                        }
+                    })
+                };
+            }
+        }
+    });
+
+    $('#regions').on('select2:select', function (e) {
+        var data = e.params.data;
+        var index = selected_regions.indexOf(data.id.toString());
+        if (index == -1) {
+            selected_regions.push(data.id.toString());
+        }
+    });
+    $('#regions').on('select2:unselect', function (e) {
+        var data = e.params.data;
+        var index = selected_regions.indexOf(data.id.toString());
+        console.log(index);
+        if (index > -1) {
+            selected_regions.splice(index, 1);
+          }
+    });
+    $('#regions').on('select2:clear', function (e) {
+         selected_regions = [];
+    });
+
 
     var deviceRolesSelect = $('#device-roles');
     $.ajax({
@@ -166,19 +231,29 @@ function handleButtonPress() {
         var value2 = $("#device-roles").val();
         var value3 = $("#sites").val();
         var value4 = $("#tags").val();
+        var value5 = $("#regions").val();
         $.ajax({
-            type: "POST",
+            type: "GET",
             url: "../../api/plugins/topology-views/search/search/",
-            data: JSON.stringify({
+            data: {
                 'name': value,
-                'devicerole': value2,
-                'sites': value3,
-                'tags': value4
-            }),
+                'devicerole[]': value2,
+                'sites[]': value3,
+                'tags[]': value4,
+                'regions[]': value5
+            },
             headers: { "X-CSRFToken": csrftoken },
             contentType: "application/json; charset=utf-8",
             dataType: "json",
-            success: function (data_result) {
+            beforeSend: function(){ 
+                new_url = this.url.split("../../api/plugins/topology-views/search/search/?");
+                new_url = new_url[1];
+                new_url = "../../plugins/topology-views/full?" + new_url
+
+                btnFullView.classList.remove("disabled");
+                btnFullView.href = new_url;
+            },
+            success: function (data_result, status, xhr) {
                 $("#status").html('<span class="label  label-info">Drawing network</span>');
                 graph = null;
                 nodes = new vis.DataSet();
@@ -191,9 +266,13 @@ function handleButtonPress() {
                     edges.add(edge);
                 });
                 graph.fit();
+                canvas = document.getElementById('visgraph').getElementsByTagName('canvas')[0];
 
                 graph.on('afterDrawing', function () {
                     $("#status").html('<span class="label label-success">Ready</span>');
+                    var image = canvas.toDataURL(MIME_TYPE);
+                    downloadButton.href = image;
+                    downloadButton.download = "topology";
                 });
 
                 graph.on("dragEnd", function (params) {
@@ -204,10 +283,11 @@ function handleButtonPress() {
                             //nodes.update({ id: node_id, physics: false });
                             $.ajax({
                                 url: "../../api/plugins/topology-views/save-coords/save_coords/",
-                                type: 'POST',
+                                type: 'PATCH',
                                 dataType: 'json',
                                 headers: { "X-CSRFToken": csrftoken },
                                 contentType: "application/json; charset=utf-8",
+                                processData: false,
                                 data: JSON.stringify({
                                     'node_id': node_id,
                                     'x': coordinates.x,
@@ -223,6 +303,7 @@ function handleButtonPress() {
                         }
                     });
                 });
+
             },
             error: function (error_result) {
                 $("#status").html('<span class="label label-warning">Something went wrong</span>');

netbox_topology_views/templates/netbox_topology_views/full.html

@@ -0,0 +1,24 @@
+{% load static %}
+{% load helpers %}
+
+{% block content %}
+{% with config=settings.PLUGINS_CONFIG.netbox_topology_views %}
+<link rel="stylesheet" href="{% static 'netbox_topology_views/css/vendor.css' %}">
+<link rel="stylesheet" href="{% static 'netbox_topology_views/css/app.css' %}">
+
+
+<div class="panel-body">
+    <div id="fullvisgraph" class=""></div>
+</div>
+
+
+{% endwith %}
+{% endblock %}
+
+{% block javascript %}
+<script src="{% static 'jquery/jquery-3.4.1.min.js' %}"></script>
+<script src="{% static 'netbox_topology_views/js/vendor.js' %}"></script>
+<script src="{% static 'netbox_topology_views/js/app.js' %}"></script>
+
+<script type="application/javascript"> iniPlotboxFull()</script>
+{% endblock %}

netbox_topology_views/templates/netbox_topology_views/index.html

@@ -12,6 +12,14 @@
 		<div class="panel panel-default">
 			<div class="panel-heading">
 				<strong>Network</strong>  <span id="status"></span>
+				<div class="buttons pull-right">
+					<a id="btnDownloadImage" class="btn btn-xs btn-info">
+						<i class="fa fa-download"></i>
+					</a>
+					<a id="btnFullView" class="btn btn-xs btn-info disabled" target="_blank">
+						<i class="fa fa-share"></i>
+					</a>
+				</div>
 			</div>
 			<div class="panel-body">
 				<div id="visgraph" class=""></div>
@@ -41,6 +49,10 @@
 					<div class="form-group">
                         <label for="tags">Tags</label>
                         <select class="form-control" multiple="multiple" id="tags"></select>
+					</div>
+					<div class="form-group">
+                        <label for="regions">Regions</label>
+                        <select class="form-control" multiple="multiple" id="regions"></select>
                     </div>
 					<hr class="mb-4">
 					<button class="btn btn-primary btn-lg btn-block" type="submit" id="start-search">Search</button>

netbox_topology_views/urls.py

@@ -7,4 +7,5 @@ from . import views
 # a specific view so that it can be accessed by users.
 urlpatterns = (
     path('', views.TopologyHomeView.as_view(), name='home'),
+    path('full', views.TopologyFullView.as_view(), name='full'),
 )

netbox_topology_views/views.py

@@ -9,4 +9,13 @@ class TopologyHomeView(PermissionRequiredMixin, View):
     Show the home page
     """
     def get(self, request):        
-        return render(request, 'netbox_topology_views/index.html')
+        return render(request, 'netbox_topology_views/index.html')
+
+class TopologyFullView(PermissionRequiredMixin, View):
+    permission_required = ('dcim.view_site', 'dcim.view_device')
+
+    """
+    Show the full view page
+    """
+    def get(self, request):        
+        return render(request, 'netbox_topology_views/full.html')

package.json

@@ -1,7 +1,7 @@
 {
   "private": true,
   "name": "netbox_topology_views",
-  "version": "0.4.3",
+  "version": "0.4.9",
   "scripts": {
     "resources": "gulp build",
     "resources_dev": "gulp build_dev"
@@ -9,10 +9,20 @@
   "dependencies": {},
   "devDependencies": {
     "gulp": "^4.0.2",
-    "gulp-clean-css": "^4.2.0",
+    "gulp-clean-css": "^4.3.0",
     "gulp-concat": "^2.6.1",
-    "gulp-sass": "^4.0.2",
+    "gulp-sass": "^4.1.0",
     "gulp-uglify": "^3.0.2",
-    "vis-network": "^7.6.4"
+    "vis-network": "^7.10.0",
+    "keycharm": "^0.3.0",
+    "moment": "^2.24.0",
+    "timsort": "^0.3.0",
+    "vis-data": "^6.2.1",
+    "vis-util": "^4.0.0",
+    "uuid": "7.0.0",
+    "@egjs/hammerjs" : "^2.0.0"
+  },
+  "peerDependencies": {
+
   }
 }

setup.py

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