netbox-plugin-plan-drawing 1.0.0__tar.gz

netbox_plugin_plan_drawing-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Stefan Bethke
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

netbox_plugin_plan_drawing-1.0.0/MANIFEST.in

@@ -0,0 +1,4 @@
+include LICENSE README.md
+include scripts/fetch_drawio.py
+graft drawio-overrides
+prune netbox_plugin_plan_drawing/static/netbox_plugin_plan_drawing/drawio

netbox_plugin_plan_drawing-1.0.0/PKG-INFO

@@ -0,0 +1,67 @@
+Metadata-Version: 2.4
+Name: netbox-plugin-plan-drawing
+Version: 1.0.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
+Project-URL: Homepage, https://github.com/stblassitude/netbox-plugin-plan-drawing
+Project-URL: Documentation, https://stblassitude.github.io/netbox-plugin-plan-drawing/
+Project-URL: Issues, https://github.com/stblassitude/netbox-plugin-plan-drawing/issues
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: Django
+Classifier: Intended Audience :: System Administrators
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: defusedxml>=0.7
+Dynamic: license-file
+
+# Netbox Plugin: Plan Drawing
+
+This plugin provides the ability to add plan drawings, like floor plans, to Netbox, and place objects like devices, racks, or locations on those plans.
+
+The plugin embeds draw.io to create and update the drawings. Each object in the drawing can be associated with a Netbox object. A draw.io plugin implements the necessary GUI to select the Netbox object to attach to a draw.io object in the drawing.
+
+Besides a list of drawings and the ability to edit them with draw.io, a drawing viewer shows a drawing and the Netbox objects associated with the drawing objects in that file. A search allows to highlight elements based on their Netbox objects. Netbox object pages are extended with links to the drawing viewer, so a single click takes you from an object to the drawing it is in, and hightlights the element for that objects.
+
+draw.io is included in the plugin and served by NetBox itself: there is no separate service to install, and nothing is sent to draw.io's online services.
+
+![The drawing viewer, with the access point ap1 highlighted](https://raw.githubusercontent.com/stblassitude/netbox-plugin-plan-drawing/main/docs/images/viewer.png)
+
+**Documentation: <https://stblassitude.github.io/netbox-plugin-plan-drawing/>**
+
+* [Overview](https://stblassitude.github.io/netbox-plugin-plan-drawing/): viewing and editing drawings, and linking elements to NetBox objects
+* [Installation](https://stblassitude.github.io/netbox-plugin-plan-drawing/installation/): installation and configuration
+* [REST API](https://stblassitude.github.io/netbox-plugin-plan-drawing/rest-api/)
+* [Development](https://stblassitude.github.io/netbox-plugin-plan-drawing/development/) and [implementation notes](https://stblassitude.github.io/netbox-plugin-plan-drawing/implementation/)
+
+## Compatibility
+
+| NetBox Version | Plugin Version |
+|-----------------|----------------|
+| 4.7 - 4.99      | 1.0.0          |
+
+## Installation
+
+```bash
+pip install netbox-plugin-plan-drawing
+```
+
+Add `"netbox_plugin_plan_drawing"` to `PLUGINS` in NetBox's `configuration.py`, then run `python manage.py migrate` and `python manage.py collectstatic --no-input`, and restart NetBox. See the [installation guide](https://stblassitude.github.io/netbox-plugin-plan-drawing/installation/) for details and configuration options.
+
+## Development
+
+```bash
+docker compose up -d --build
+```
+
+This starts NetBox with the plugin installed from the source tree, and demo data, at <http://localhost:8000/> (`admin` / `admin`). Run the tests with `docker compose exec netbox python manage.py test netbox_plugin_plan_drawing`. See the [development guide](https://stblassitude.github.io/netbox-plugin-plan-drawing/development/) for more.
+
+## License
+
+MIT; see [LICENSE](LICENSE). The bundled [draw.io](https://github.com/jgraph/drawio) is licensed under the Apache License 2.0.

netbox_plugin_plan_drawing-1.0.0/README.md

@@ -0,0 +1,44 @@
+# Netbox Plugin: Plan Drawing
+
+This plugin provides the ability to add plan drawings, like floor plans, to Netbox, and place objects like devices, racks, or locations on those plans.
+
+The plugin embeds draw.io to create and update the drawings. Each object in the drawing can be associated with a Netbox object. A draw.io plugin implements the necessary GUI to select the Netbox object to attach to a draw.io object in the drawing.
+
+Besides a list of drawings and the ability to edit them with draw.io, a drawing viewer shows a drawing and the Netbox objects associated with the drawing objects in that file. A search allows to highlight elements based on their Netbox objects. Netbox object pages are extended with links to the drawing viewer, so a single click takes you from an object to the drawing it is in, and hightlights the element for that objects.
+
+draw.io is included in the plugin and served by NetBox itself: there is no separate service to install, and nothing is sent to draw.io's online services.
+
+![The drawing viewer, with the access point ap1 highlighted](https://raw.githubusercontent.com/stblassitude/netbox-plugin-plan-drawing/main/docs/images/viewer.png)
+
+**Documentation: <https://stblassitude.github.io/netbox-plugin-plan-drawing/>**
+
+* [Overview](https://stblassitude.github.io/netbox-plugin-plan-drawing/): viewing and editing drawings, and linking elements to NetBox objects
+* [Installation](https://stblassitude.github.io/netbox-plugin-plan-drawing/installation/): installation and configuration
+* [REST API](https://stblassitude.github.io/netbox-plugin-plan-drawing/rest-api/)
+* [Development](https://stblassitude.github.io/netbox-plugin-plan-drawing/development/) and [implementation notes](https://stblassitude.github.io/netbox-plugin-plan-drawing/implementation/)
+
+## Compatibility
+
+| NetBox Version | Plugin Version |
+|-----------------|----------------|
+| 4.7 - 4.99      | 1.0.0          |
+
+## Installation
+
+```bash
+pip install netbox-plugin-plan-drawing
+```
+
+Add `"netbox_plugin_plan_drawing"` to `PLUGINS` in NetBox's `configuration.py`, then run `python manage.py migrate` and `python manage.py collectstatic --no-input`, and restart NetBox. See the [installation guide](https://stblassitude.github.io/netbox-plugin-plan-drawing/installation/) for details and configuration options.
+
+## Development
+
+```bash
+docker compose up -d --build
+```
+
+This starts NetBox with the plugin installed from the source tree, and demo data, at <http://localhost:8000/> (`admin` / `admin`). Run the tests with `docker compose exec netbox python manage.py test netbox_plugin_plan_drawing`. See the [development guide](https://stblassitude.github.io/netbox-plugin-plan-drawing/development/) for more.
+
+## License
+
+MIT; see [LICENSE](LICENSE). The bundled [draw.io](https://github.com/jgraph/drawio) is licensed under the Apache License 2.0.

netbox_plugin_plan_drawing-1.0.0/drawio-overrides/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

netbox_plugin_plan_drawing-1.0.0/drawio-overrides/js/PostConfig.js

@@ -0,0 +1,15 @@
+/**
+ * draw.io configuration for the copy bundled with netbox-plugin-plan-drawing. Replaces the
+ * stock js/PostConfig.js; loaded after draw.io's code, but before the application starts.
+ */
+window.ICONSEARCH_PATH = null;
+window.ICON_SERVICE_PATH = null;
+
+// Registers the NetBox plugin as a built-in plugin, so that it can be loaded with ?p=netbox.
+// The plugin lives next to the drawio directory in the plugin's static files; the editor page
+// passes a version (nbv) to bypass cached copies of older versions.
+if (typeof App !== 'undefined')
+{
+	App.pluginRegistry['netbox'] = '../drawio-netbox.js' +
+		((urlParams['nbv'] != null) ? '?v=' + encodeURIComponent(urlParams['nbv']) : '');
+}

netbox_plugin_plan_drawing-1.0.0/drawio-overrides/js/PreConfig.js

@@ -0,0 +1,28 @@
+/**
+ * draw.io configuration for the copy bundled with netbox-plugin-plan-drawing. Replaces the
+ * stock js/PreConfig.js; loaded before draw.io initializes.
+ *
+ * draw.io runs embedded in NetBox pages only: all online services and integrations are off.
+ */
+window.DRAWIO_PUBLIC_BUILD = true;
+window.EXPORT_URL = null;
+window.DRAWIO_BASE_URL = null;
+window.DRAWIO_VIEWER_URL = null;
+window.DRAWIO_LIGHTBOX_URL = null;
+window.DRAW_MATH_URL = null;
+window.DRAWIO_CONFIG = null;
+window.DRAWIO_GOOGLE_APP_ID = null;
+window.DRAWIO_GOOGLE_CLIENT_ID = null;
+window.DRAWIO_MSGRAPH_CLIENT_ID = null;
+window.DRAWIO_GITLAB_ID = null;
+window.DRAWIO_GITHUB_ID = null;
+window.DRAWIO_DROPBOX_ID = null;
+window.DRAWIO_NEXTCLOUD_ID = null;
+urlParams['sync'] = 'manual';
+urlParams['gapi'] = '0';
+urlParams['db'] = '0';
+urlParams['od'] = '0';
+urlParams['gh'] = '0';
+urlParams['gl'] = '0';
+urlParams['tr'] = '0';
+urlParams['math'] = '0';

netbox_plugin_plan_drawing-1.0.0/netbox_plugin_plan_drawing/__init__.py

@@ -0,0 +1,25 @@
+from netbox.plugins import PluginConfig
+
+
+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'
+    author = 'Stefan Bethke'
+    author_email = 'stb@lassitu.de'
+    base_url = 'plan-drawing'
+    min_version = '4.7.0'
+    max_version = '4.99.99'
+    default_settings = {
+        # Apps whose models can be linked to drawing elements.
+        'object_type_apps': ['dcim', 'circuits', 'wireless'],
+        # Models from those apps that cannot be linked, as '<app_label>.<model_name>'. Replaces
+        # the built-in default list (see object_types.DEFAULT_EXCLUDED_OBJECT_TYPES) when set.
+        'exclude_object_types': None,
+        # Additional linkable models from other apps or plugins, as '<app_label>.<model_name>'.
+        'extra_object_types': [],
+    }
+
+
+config = PlanDrawingConfig

netbox_plugin_plan_drawing-1.0.0/netbox_plugin_plan_drawing/api/serializers.py

@@ -0,0 +1,35 @@
+from dcim.api.serializers import LocationSerializer, SiteSerializer
+from netbox.api.fields import ContentTypeField, RelatedObjectCountField
+from netbox.api.gfk_fields import GFKSerializerField
+from netbox.api.serializers import BaseModelSerializer, PrimaryModelSerializer
+
+from ..models import PlanDrawing, PlanDrawingElement
+
+
+class PlanDrawingSerializer(PrimaryModelSerializer):
+    site = SiteSerializer(nested=True, required=False, allow_null=True)
+    location = LocationSerializer(nested=True, required=False, allow_null=True)
+    element_count = RelatedObjectCountField('elements')
+
+    class Meta:
+        model = PlanDrawing
+        fields = (
+            'id', 'url', 'display_url', 'display', 'name', 'site', 'location', 'description', 'content',
+            'element_count', 'owner', 'comments', 'tags', 'custom_fields', 'created', 'last_updated',
+        )
+        brief_fields = ('id', 'url', 'display', 'name', 'description')
+
+
+class PlanDrawingElementSerializer(BaseModelSerializer):
+    drawing = PlanDrawingSerializer(nested=True, read_only=True)
+    assigned_object_type = ContentTypeField(read_only=True)
+    assigned_object = GFKSerializerField(read_only=True)
+
+    class Meta:
+        model = PlanDrawingElement
+        fields = (
+            'id', 'url', 'display', 'drawing', 'page_id', 'page_name', 'cell_id', 'label',
+            'assigned_object_type', 'assigned_object_id', 'assigned_object',
+        )
+        brief_fields = ('id', 'url', 'display', 'cell_id', 'label')
+

netbox_plugin_plan_drawing-1.0.0/netbox_plugin_plan_drawing/api/urls.py

@@ -0,0 +1,11 @@
+from netbox.api.routers import NetBoxRouter
+
+from . import views
+
+app_name = 'netbox_plugin_plan_drawing'
+
+router = NetBoxRouter()
+router.register('drawings', views.PlanDrawingViewSet)
+router.register('elements', views.PlanDrawingElementViewSet)
+
+urlpatterns = router.urls

netbox_plugin_plan_drawing-1.0.0/netbox_plugin_plan_drawing/api/views.py

@@ -0,0 +1,37 @@
+from netbox.api.authentication import TokenPermissions
+from netbox.api.viewsets import NetBoxModelViewSet, NetBoxReadOnlyModelViewSet
+from utilities.query import count_related
+
+from ..filtersets import PlanDrawingElementFilterSet, PlanDrawingFilterSet
+from ..models import PlanDrawing, PlanDrawingElement
+from .serializers import PlanDrawingElementSerializer, PlanDrawingSerializer
+
+
+class PlanDrawingViewSet(NetBoxModelViewSet):
+    queryset = PlanDrawing.objects.annotate(
+        element_count=count_related(PlanDrawingElement, 'drawing'),
+    )
+    serializer_class = PlanDrawingSerializer
+    filterset_class = PlanDrawingFilterSet
+
+
+class PlanDrawingElementPermissions(TokenPermissions):
+    """
+    Drawing elements can be viewed by users who may view drawings; the queryset is restricted
+    to the drawings they may view (see PlanDrawingElementQuerySet).
+    """
+    perms_map = {
+        **TokenPermissions.perms_map,
+        'GET': ['netbox_plugin_plan_drawing.view_plandrawing'],
+        'HEAD': ['netbox_plugin_plan_drawing.view_plandrawing'],
+    }
+
+    def has_object_permission(self, request, view, obj):
+        return True
+
+
+class PlanDrawingElementViewSet(NetBoxReadOnlyModelViewSet):
+    queryset = PlanDrawingElement.objects.select_related('drawing', 'assigned_object_type')
+    permission_classes = (PlanDrawingElementPermissions,)
+    serializer_class = PlanDrawingElementSerializer
+    filterset_class = PlanDrawingElementFilterSet

netbox_plugin_plan_drawing-1.0.0/netbox_plugin_plan_drawing/assets.py

@@ -0,0 +1,26 @@
+"""
+Versioned URLs for the plugin's static files.
+
+NetBox serves static files with a long cache lifetime, and the plugin's files keep their names
+across releases; a content hash in the query string makes browsers load changed files.
+"""
+import hashlib
+from functools import cache
+
+from django.contrib.staticfiles import finders
+from django.templatetags.static import static
+
+
+@cache
+def static_digest(path):
+    found = finders.find(path)
+    if not found:
+        return None
+    with open(found, 'rb') as f:
+        return hashlib.sha256(f.read()).hexdigest()[:12]
+
+
+def versioned_static(path):
+    url = static(path)
+    digest = static_digest(path)
+    return f'{url}?v={digest}' if digest else url

netbox_plugin_plan_drawing-1.0.0/netbox_plugin_plan_drawing/drawio.py

@@ -0,0 +1,120 @@
+"""
+Reading draw.io files.
+
+A draw.io file is an <mxfile> with one <diagram> per page; each page holds an <mxGraphModel>,
+either as XML or compressed (raw deflate, base64 encoded, of the URL-encoded XML). Cells with
+custom properties are wrapped in an <object> (or <UserObject>) element carrying those
+properties as attributes. A cell linked to a NetBox object carries two of them:
+
+    <object id="7" label="Rack 1" netbox_type="dcim.rack" netbox_id="12">
+      <mxCell style="..." vertex="1" parent="1">...</mxCell>
+    </object>
+"""
+import base64
+import html
+import re
+import urllib.parse
+import zlib
+from dataclasses import dataclass
+from xml.etree.ElementTree import ParseError
+
+from defusedxml import DefusedXmlException
+from defusedxml.ElementTree import fromstring
+from django.utils.html import strip_tags
+
+TYPE_ATTRIBUTE = 'netbox_type'
+ID_ATTRIBUTE = 'netbox_id'
+LABEL_MAX_LENGTH = 200
+
+
+class DrawingParseError(ValueError):
+    pass
+
+
+@dataclass(frozen=True)
+class DrawingLink:
+    page_id: str
+    page_name: str
+    cell_id: str
+    label: str
+    object_type: str
+    object_id: int
+
+
+def _parse_xml(text):
+    try:
+        return fromstring(text)
+    except (ParseError, DefusedXmlException) as e:
+        raise DrawingParseError(f'Invalid drawing XML: {e}')
+
+
+def decompress_diagram(text):
+    try:
+        data = zlib.decompress(base64.b64decode(text), -zlib.MAX_WBITS)
+    except (ValueError, zlib.error) as e:
+        raise DrawingParseError(f'Invalid compressed diagram: {e}')
+    return urllib.parse.unquote(data.decode('utf-8'))
+
+
+def iter_pages(content):
+    """
+    Yield (page_id, page_name, mxGraphModel element) for each page of a drawing.
+    """
+    root = _parse_xml(content)
+    if root.tag == 'mxGraphModel':
+        yield '', '', root
+        return
+    if root.tag != 'mxfile':
+        raise DrawingParseError(f'Not a draw.io file: unexpected root element <{root.tag}>')
+
+    for index, diagram in enumerate(root.findall('diagram')):
+        page_id = diagram.get('id') or str(index)
+        page_name = diagram.get('name') or f'Page-{index + 1}'
+        model = diagram.find('mxGraphModel')
+        if model is None:
+            text = (diagram.text or '').strip()
+            if not text:
+                continue
+            model = _parse_xml(decompress_diagram(text))
+        yield page_id, page_name, model
+
+
+def label_text(label):
+    """
+    Return the plain text of a cell label, which may contain HTML.
+    """
+    text = re.sub(r'<br\s*/?>|</div>|</p>', ' ', label or '', flags=re.IGNORECASE)
+    text = ' '.join(html.unescape(strip_tags(text)).split())
+    return text[:LABEL_MAX_LENGTH]
+
+
+def parse_links(content):
+    """
+    Return a DrawingLink for every cell in the drawing that is linked to a NetBox object.
+    """
+    if not content or not content.strip():
+        return []
+
+    links = []
+    for page_id, page_name, model in iter_pages(content):
+        for element in model.iter():
+            object_type = element.get(TYPE_ATTRIBUTE)
+            object_id = element.get(ID_ATTRIBUTE)
+            if not object_type and not object_id:
+                continue
+            cell_id = element.get('id', '')
+            if not object_type or not object_id:
+                raise DrawingParseError(f'Cell {cell_id} has an incomplete NetBox object link')
+            try:
+                object_id = int(object_id)
+            except ValueError:
+                raise DrawingParseError(f'Cell {cell_id} links to an invalid NetBox object ID: {object_id}')
+            links.append(DrawingLink(
+                page_id=page_id,
+                page_name=page_name,
+                cell_id=cell_id,
+                label=label_text(element.get('label')),
+                object_type=object_type.lower(),
+                object_id=object_id,
+            ))
+    return links