netbox-plugin-plan-drawing 1.0.0__tar.gz → 1.1.0__tar.gz

{netbox_plugin_plan_drawing-1.0.0/netbox_plugin_plan_drawing.egg-info → netbox_plugin_plan_drawing-1.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: netbox-plugin-plan-drawing
-Version: 1.0.0
+Version: 1.1.0
 Summary: NetBox plugin for plan drawings (floor plans etc.) with draw.io, linking drawing elements to NetBox objects
 Author-email: Stefan Bethke <stb@lassitu.de>
 License-Expression: MIT

{netbox_plugin_plan_drawing-1.0.0 → netbox_plugin_plan_drawing-1.1.0}/netbox_plugin_plan_drawing/__init__.py

@@ -5,7 +5,7 @@ class PlanDrawingConfig(PluginConfig):
     name = 'netbox_plugin_plan_drawing'
     verbose_name = 'Plan Drawings'
     description = 'Plan drawings (floor plans etc.) edited with draw.io, with elements linked to NetBox objects'
-    version = '1.0.0'
+    version = '1.1.0'
     author = 'Stefan Bethke'
     author_email = 'stb@lassitu.de'
     base_url = 'plan-drawing'

{netbox_plugin_plan_drawing-1.0.0 → netbox_plugin_plan_drawing-1.1.0}/netbox_plugin_plan_drawing/static/netbox_plugin_plan_drawing/plan-drawing.css

@@ -36,6 +36,37 @@
   background-color: color-mix(in srgb, var(--plan-drawing-select-color) 12%, transparent);
 }
 
+/* The objects in a location or rack are only listed while it is selected, or while one of the
+   objects in it is selected from the list. */
+.plan-drawing-element:not(.active, .plan-drawing-expanded) .plan-drawing-element-contents {
+  display: none;
+}
+
+.plan-drawing-contents {
+  padding-left: 0.75rem;
+  border-left: 1px solid var(--bs-border-color);
+}
+
+.plan-drawing-node {
+  padding: 0 0.25rem;
+  cursor: default;
+  border-radius: var(--bs-border-radius-sm);
+}
+
+/* Objects in a location or rack that are linked in the drawing as well: clicking them selects
+   their elements. */
+.plan-drawing-node-linked {
+  cursor: pointer;
+}
+
+.plan-drawing-node-linked:hover {
+  background-color: var(--bs-tertiary-bg);
+}
+
+.plan-drawing-node.active {
+  background-color: color-mix(in srgb, var(--plan-drawing-select-color) 20%, transparent);
+}
+
 /* Listing only the current page's elements: their page names are redundant. */
 .plan-drawing-this-page .plan-drawing-element-page {
   display: none;

{netbox_plugin_plan_drawing-1.0.0 → netbox_plugin_plan_drawing-1.1.0}/netbox_plugin_plan_drawing/static/netbox_plugin_plan_drawing/viewer.js

@@ -3,7 +3,8 @@
  * the list of elements linked to NetBox objects: clicking either one highlights the other,
  * searching the list highlights all matching elements, and ?highlight=<type>:<id> in the page
  * URL highlights the elements of that object when the page opens. The list shows the elements
- * of the current page, or of all pages.
+ * of the current page, or of all pages. A selected location or rack lists the objects in it;
+ * clicking those that are linked in the drawing as well selects their elements.
  */
 (function () {
   'use strict';
@@ -52,8 +53,9 @@
     this.container = container;
     this.elements = elements;
     this.rows = Array.from(document.querySelectorAll('.plan-drawing-element'));
+    this.nodes = Array.from(document.querySelectorAll('.plan-drawing-node-linked'));
     this.highlights = [];
-    this.hoverHighlight = null;
+    this.hoverHighlights = [];
     this.selected = [];
     this.matches = [];
     this.searchTerms = [];
@@ -245,13 +247,13 @@
     this.rows.forEach(function (row) {
       const index = parseInt(row.dataset.index, 10);
       row.addEventListener('click', function (evt) {
-        if (evt.target.closest('a')) {
+        if (evt.target.closest('a, .plan-drawing-element-contents')) {
           return;
         }
         self.select([index], { switchPage: true, scrollDrawing: true });
       });
       row.addEventListener('keydown', function (evt) {
-        if (evt.key === 'Enter' || evt.key === ' ') {
+        if (evt.target === row && (evt.key === 'Enter' || evt.key === ' ')) {
           evt.preventDefault();
           self.select([index], { switchPage: true, scrollDrawing: true });
         }
@@ -264,6 +266,40 @@
       });
     });
 
+    // The objects in a location or rack that are linked in the drawing as well select their
+    // elements, and keep the location or rack expanded.
+    this.nodes.forEach(function (node) {
+      const type = node.dataset.objectType;
+      const id = parseInt(node.dataset.objectId, 10);
+      const row = parseInt(node.closest('.plan-drawing-element').dataset.index, 10);
+      node.indices = [];
+      self.elements.forEach(function (element, index) {
+        if (element.object_type === type && element.object_id === id) {
+          node.indices.push(index);
+        }
+      });
+      const select = function () {
+        self.select(node.indices, { switchPage: true, scrollDrawing: true, expand: row });
+      };
+      node.addEventListener('click', function (evt) {
+        if (!evt.target.closest('a')) {
+          select();
+        }
+      });
+      node.addEventListener('keydown', function (evt) {
+        if (evt.target === node && (evt.key === 'Enter' || evt.key === ' ')) {
+          evt.preventDefault();
+          select();
+        }
+      });
+      node.addEventListener('mouseenter', function () {
+        self.hover(node.indices);
+      });
+      node.addEventListener('mouseleave', function () {
+        self.hover(row);
+      });
+    });
+
     const search = document.getElementById('plan-drawing-search');
     if (search) {
       search.addEventListener('input', function () {
@@ -332,7 +368,14 @@
     this.refreshHighlights();
 
     this.rows.forEach(function (row) {
-      row.classList.toggle('active', indices.indexOf(parseInt(row.dataset.index, 10)) >= 0);
+      const index = parseInt(row.dataset.index, 10);
+      row.classList.toggle('active', indices.indexOf(index) >= 0);
+      row.classList.toggle('plan-drawing-expanded', index === options.expand);
+    });
+    this.nodes.forEach(function (node) {
+      node.classList.toggle('active', node.indices.some(function (index) {
+        return indices.indexOf(index) >= 0;
+      }));
     });
 
     if (options.scrollList && indices.length > 0) {
@@ -350,17 +393,20 @@
     }
   };
 
-  PlanDrawingViewer.prototype.hover = function (index) {
-    if (this.hoverHighlight) {
-      this.hoverHighlight.destroy();
-      this.hoverHighlight = null;
-    }
-    if (index != null) {
-      const cell = this.cellForElement(index);
-      if (cell) {
-        this.hoverHighlight = this.addHighlight(cell, HOVER_COLOR, 3);
+  /** Highlights the elements with the given index or indices on the current page. */
+  PlanDrawingViewer.prototype.hover = function (indices) {
+    const self = this;
+    this.hoverHighlights.forEach(function (highlight) {
+      highlight.destroy();
+    });
+    this.hoverHighlights = [];
+    [].concat(indices == null ? [] : indices).forEach(function (index) {
+      const cell = self.cellForElement(index);
+      const highlight = cell && self.addHighlight(cell, HOVER_COLOR, 3);
+      if (highlight) {
+        self.hoverHighlights.push(highlight);
       }
-    }
+    });
   };
 
   PlanDrawingViewer.prototype.matchesSearch = function (element) {

netbox_plugin_plan_drawing-1.1.0/netbox_plugin_plan_drawing/templates/netbox_plugin_plan_drawing/inc/element_contents.html

@@ -0,0 +1,21 @@
+{% load i18n %}
+<ul class="list-unstyled mb-0 plan-drawing-contents">
+  {% for node in nodes %}
+    <li>
+      {% if node.linked %}
+        <div class="d-flex justify-content-between gap-2 plan-drawing-node plan-drawing-node-linked" data-object-type="{{ node.object_type }}" data-object-id="{{ node.object_id }}" tabindex="0" title="{% trans 'Show in the drawing' %}">
+      {% else %}
+        <div class="d-flex justify-content-between gap-2 plan-drawing-node">
+      {% endif %}
+        <span>
+          <a href="{{ node.url }}">{{ node.display }}</a>
+          {% if node.linked %}<i class="mdi mdi-link-variant text-muted"></i>{% endif %}
+        </span>
+        <span class="text-muted text-nowrap">{{ node.object_type_label }}{% if node.position is not None %} &middot; U{{ node.position|floatformat:"-1" }}{% endif %}</span>
+      </div>
+      {% if node.children %}
+        {% include 'netbox_plugin_plan_drawing/inc/element_contents.html' with nodes=node.children %}
+      {% endif %}
+    </li>
+  {% endfor %}
+</ul>

{netbox_plugin_plan_drawing-1.0.0 → netbox_plugin_plan_drawing-1.1.0}/netbox_plugin_plan_drawing/templates/netbox_plugin_plan_drawing/plandrawing.html

@@ -77,6 +77,15 @@
               <small class="text-muted">
                 {{ element.object_type_label }}{% if element.label and element.label != element.display %} &middot; {{ element.label }}{% endif %}
               </small>
+              {% if element.contents is not None %}
+                <div class="small mt-1 plan-drawing-element-contents">
+                  {% if element.contents %}
+                    {% include 'netbox_plugin_plan_drawing/inc/element_contents.html' with nodes=element.contents %}
+                  {% else %}
+                    <span class="text-muted">{% trans "No objects in it." %}</span>
+                  {% endif %}
+                </div>
+              {% endif %}
             </div>
           {% empty %}
             <div class="list-group-item text-muted">{% trans "No drawing elements are linked to NetBox objects." %}</div>

{netbox_plugin_plan_drawing-1.0.0 → netbox_plugin_plan_drawing-1.1.0}/netbox_plugin_plan_drawing/tests/test_views.py

@@ -43,6 +43,30 @@ class PlanDrawingViewsTestCase(TestCase):
         self.assertEqual(response.context['elements'][0]['display'], str(self.rack))
         self.assertEqual(response.context['elements'][0]['url'], self.rack.get_absolute_url())
 
+    def test_detail_lists_location_and_rack_contents(self):
+        self.drawing.content = self.content(
+            linked_cell('b', 'Room', 'dcim.location', self.location.pk),
+            linked_cell('c', 'Device', 'dcim.device', self.device.pk),
+        )
+        self.drawing.save()
+
+        response = self.client.get(self.drawing.get_absolute_url())
+
+        contents = {e['object_type']: e['contents'] for e in response.context['elements']}
+        self.assertIsNone(contents['dcim.device'])
+        [rack] = contents['dcim.location']
+        self.assertEqual((rack['display'], rack['url'], rack['linked']), (str(self.rack), self.rack.get_absolute_url(), False))
+        [device] = rack['children']
+        self.assertEqual((device['object_type'], device['object_id'], device['linked']), ('dcim.device', self.device.pk, True))
+        self.assertContains(response, f'data-object-type="dcim.device" data-object-id="{self.device.pk}"')
+
+    def test_detail_lists_rack_contents(self):
+        response = self.client.get(self.drawing.get_absolute_url())
+
+        [device] = response.context['elements'][0]['contents']
+        self.assertEqual((device['display'], device['linked']), (str(self.device), False))
+        self.assertContains(response, f'href="{self.device.get_absolute_url()}"')
+
     def test_detail_lists_elements_in_page_order(self):
         self.drawing.content = drawing_file(
             ('z', 'Zeta', graph_model(linked_cell('a', 'Rack', 'dcim.rack', self.rack.pk))),

{netbox_plugin_plan_drawing-1.0.0 → netbox_plugin_plan_drawing-1.1.0}/netbox_plugin_plan_drawing/views.py

@@ -3,13 +3,16 @@ from collections import defaultdict
 
 from django.core.exceptions import ValidationError
 from django.db import transaction
+from django.db.models import F, Q
 from django.http import JsonResponse
 from django.middleware.csrf import get_token
 from django.templatetags.static import static
+from django.utils.text import capfirst
 from django.shortcuts import get_object_or_404
 from django.urls import NoReverseMatch, reverse
 from django.views import View
 
+from dcim.models import Device, Location, PowerPanel, Rack
 from netbox.views import generic
 from utilities.permissions import get_permission_for_model
 from utilities.query import count_related
@@ -26,11 +29,82 @@ from .tables import PlanDrawingTable
 DRAWIO_INDEX = 'netbox_plugin_plan_drawing/drawio/index.html'
 
 
+def location_and_rack_contents(objects, user):
+    """
+    Return the trees of objects in the given locations and racks, keyed by (model, pk) of the
+    location or rack. A location contains its child locations, racks, devices not mounted in a
+    rack, and power panels; a rack contains its devices, top to bottom; and a device contains the
+    devices installed in its device bays. Objects in the given list are marked as linked. Objects
+    the user may not view are left out.
+    """
+    linked = {(type(obj), obj.pk) for obj in objects}
+    location_ids = set()
+    for obj in objects:
+        if isinstance(obj, Location):
+            location_ids.update(obj.get_descendants(include_self=True).values_list('pk', flat=True))
+    linked_rack_ids = [obj.pk for obj in objects if isinstance(obj, Rack)]
+    if not location_ids and not linked_rack_ids:
+        return {}
+
+    locations = Location.objects.restrict(user, 'view').filter(pk__in=location_ids)
+    racks = list(Rack.objects.restrict(user, 'view').filter(Q(location__in=location_ids) | Q(pk__in=linked_rack_ids)))
+    devices = Device.objects.restrict(user, 'view').filter(
+        Q(rack__in=[rack.pk for rack in racks]) | Q(location__in=location_ids, rack__isnull=True),
+    ).select_related('parent_bay').order_by(F('position').desc(nulls_last=True), 'name')
+    panels = PowerPanel.objects.restrict(user, 'view').filter(location__in=location_ids)
+
+    nodes = {}
+
+    def add(obj, *parents, position=None):
+        """
+        Add the object below the first of the parents, given as (model, pk), that is in the tree.
+        """
+        node = nodes[(type(obj), obj.pk)] = {
+            'display': str(obj),
+            'url': obj.get_absolute_url(),
+            'object_type': f'{obj._meta.app_label}.{obj._meta.model_name}',
+            'object_id': obj.pk,
+            'object_type_label': capfirst(obj._meta.verbose_name),
+            'position': position,
+            'linked': (type(obj), obj.pk) in linked,
+            'children': [],
+        }
+        for parent in parents:
+            if parent in nodes:
+                nodes[parent]['children'].append(node)
+                break
+
+    # Locations are ordered by their path, so that parents are added before their children.
+    for location in locations:
+        add(location, (Location, location.parent_id))
+    for rack in racks:
+        add(rack, (Location, rack.location_id))
+    # Devices in device bays go below their parent device, once it has been added; devices whose
+    # parent is not in the tree go below their rack or location.
+    pending = list(devices)
+    while pending:
+        remaining = []
+        pending_ids = {device.pk for device in pending}
+        for device in pending:
+            parent_bay = getattr(device, 'parent_bay', None)
+            parent = (Device, parent_bay.device_id) if parent_bay else None
+            if parent and parent not in nodes and parent_bay.device_id in pending_ids:
+                remaining.append(device)
+                continue
+            add(device, parent, (Rack, device.rack_id), (Location, device.location_id), position=device.position)
+        if len(remaining) == len(pending):
+            break
+        pending = remaining
+    for panel in panels:
+        add(panel, (Location, panel.location_id))
+    return nodes
+
+
 def linked_elements(drawing, user):
     """
     Return the drawing's linked elements, with the NetBox objects they are linked to, for the
     drawing viewer, in the order of the drawing's pages. Objects the user may not view are shown
-    without their name.
+    without their name. Locations and racks come with the objects in them.
     """
     elements = list(drawing.elements.select_related('assigned_object_type'))
 
@@ -44,6 +118,7 @@ def linked_elements(drawing, user):
             continue
         for obj in model.objects.restrict(user, 'view').filter(pk__in=ids):
             objects[(content_type.pk, obj.pk)] = obj
+    contents = location_and_rack_contents(list(objects.values()), user)
 
     result = []
     for element in elements:
@@ -60,6 +135,7 @@ def linked_elements(drawing, user):
             'object_id': element.assigned_object_id,
             'display': str(obj) if obj else None,
             'url': obj.get_absolute_url() if obj else None,
+            'contents': contents[(model, obj.pk)]['children'] if isinstance(obj, (Location, Rack)) else None,
         })
 
     try:

{netbox_plugin_plan_drawing-1.0.0 → netbox_plugin_plan_drawing-1.1.0/netbox_plugin_plan_drawing.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: netbox-plugin-plan-drawing
-Version: 1.0.0
+Version: 1.1.0
 Summary: NetBox plugin for plan drawings (floor plans etc.) with draw.io, linking drawing elements to NetBox objects
 Author-email: Stefan Bethke <stb@lassitu.de>
 License-Expression: MIT

{netbox_plugin_plan_drawing-1.0.0 → netbox_plugin_plan_drawing-1.1.0}/netbox_plugin_plan_drawing.egg-info/SOURCES.txt

@@ -39,6 +39,7 @@ netbox_plugin_plan_drawing/static/netbox_plugin_plan_drawing/plan-drawing.css
 netbox_plugin_plan_drawing/static/netbox_plugin_plan_drawing/viewer.js
 netbox_plugin_plan_drawing/templates/netbox_plugin_plan_drawing/plandrawing.html
 netbox_plugin_plan_drawing/templates/netbox_plugin_plan_drawing/plandrawing_draw.html
+netbox_plugin_plan_drawing/templates/netbox_plugin_plan_drawing/inc/element_contents.html
 netbox_plugin_plan_drawing/templates/netbox_plugin_plan_drawing/inc/object_drawings_panel.html
 netbox_plugin_plan_drawing/templatetags/__init__.py
 netbox_plugin_plan_drawing/templatetags/plan_drawing.py

{netbox_plugin_plan_drawing-1.0.0 → netbox_plugin_plan_drawing-1.1.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "netbox-plugin-plan-drawing"
-version = "1.0.0"
+version = "1.1.0"
 authors = [
     { name = "Stefan Bethke", email = "stb@lassitu.de" },
 ]