From b81d4629769e18dd1e27a29ae615e9a0a54fbb99 Mon Sep 17 00:00:00 2001 From: Jamie Murphy Date: Fri, 8 Sep 2023 00:01:53 +0100 Subject: [PATCH 01/11] show objects that would be deleted by cascade --- netbox/netbox/views/generic/object_views.py | 13 ++++++++++++- netbox/templates/htmx/delete_form.html | 8 ++++++++ 2 files changed, 20 insertions(+), 1 deletion(-) diff --git a/netbox/netbox/views/generic/object_views.py b/netbox/netbox/views/generic/object_views.py index 99d8ff5401c..6051944f73c 100644 --- a/netbox/netbox/views/generic/object_views.py +++ b/netbox/netbox/views/generic/object_views.py @@ -2,7 +2,8 @@ from copy import deepcopy from django.contrib import messages -from django.db import transaction +from django.contrib.admin.utils import NestedObjects +from django.db import transaction, router from django.db.models import ProtectedError from django.shortcuts import redirect, render from django.urls import reverse @@ -334,6 +335,14 @@ def get(self, request, *args, **kwargs): obj = self.get_object(**kwargs) form = ConfirmationForm(initial=request.GET) + using = router.db_for_write(obj._meta.model) + collector = NestedObjects(using=using) + collector.collect([obj]) + if collector.nested(): + nested_objs = collector.nested()[1] + else: + nested_objs = [] + # If this is an HTMX request, return only the rendered deletion form as modal content if is_htmx(request): viewname = get_viewname(self.queryset.model, action='delete') @@ -343,6 +352,7 @@ def get(self, request, *args, **kwargs): 'object_type': self.queryset.model._meta.verbose_name, 'form': form, 'form_url': form_url, + 'nested_objs': nested_objs, **self.get_extra_context(request, obj), }) @@ -350,6 +360,7 @@ def get(self, request, *args, **kwargs): 'object': obj, 'form': form, 'return_url': self.get_return_url(request, obj), + 'nested_objs': nested_objs, **self.get_extra_context(request, obj), }) diff --git a/netbox/templates/htmx/delete_form.html b/netbox/templates/htmx/delete_form.html index d0fba9d369e..150335ae833 100644 --- a/netbox/templates/htmx/delete_form.html +++ b/netbox/templates/htmx/delete_form.html @@ -12,6 +12,14 @@
{% trans "Confirm Deletion" %}
Are you sure you want to delete {{ object_type }} {{ object }}? {% endblocktrans %}

+ {% if nested_objs %} +

+ This will cause deltion of the following related items:
+ {% for nested_obj in nested_objs %} + {{ nested_obj }}
+ {% endfor %} +

+ {% endif %} {% render_form form %}
From 1063db94701c10fe36e4264e26f8f8b3479c2119 Mon Sep 17 00:00:00 2001 From: Jamie Murphy Date: Fri, 8 Sep 2023 00:20:50 +0100 Subject: [PATCH 02/11] some items were not showing (eg ips on devices) --- netbox/netbox/views/generic/object_views.py | 9 +++++---- netbox/templates/htmx/delete_form.html | 4 ++-- 2 files changed, 7 insertions(+), 6 deletions(-) diff --git a/netbox/netbox/views/generic/object_views.py b/netbox/netbox/views/generic/object_views.py index 6051944f73c..4757a77f57c 100644 --- a/netbox/netbox/views/generic/object_views.py +++ b/netbox/netbox/views/generic/object_views.py @@ -338,10 +338,11 @@ def get(self, request, *args, **kwargs): using = router.db_for_write(obj._meta.model) collector = NestedObjects(using=using) collector.collect([obj]) - if collector.nested(): - nested_objs = collector.nested()[1] - else: - nested_objs = [] + nested_objs = [] + if collector.instances_with_model(): + for model, instance in collector.instances_with_model(): + nested_objs.append(f"{model.__name__} - {instance}") + # If this is an HTMX request, return only the rendered deletion form as modal content if is_htmx(request): diff --git a/netbox/templates/htmx/delete_form.html b/netbox/templates/htmx/delete_form.html index 150335ae833..9aac23aa6e7 100644 --- a/netbox/templates/htmx/delete_form.html +++ b/netbox/templates/htmx/delete_form.html @@ -15,8 +15,8 @@
{% trans "Confirm Deletion" %}
{% if nested_objs %}

This will cause deltion of the following related items:
- {% for nested_obj in nested_objs %} - {{ nested_obj }}
+ {% for nested_obj in nested_objs %} + - {{ nested_obj }}
{% endfor %}

{% endif %} From 298a7860b20c2fd90e887c66c4f196460097e71e Mon Sep 17 00:00:00 2001 From: Jamie Murphy Date: Fri, 8 Sep 2023 00:33:42 +0100 Subject: [PATCH 03/11] dont include the item being deleted in the list of related items --- netbox/netbox/views/generic/object_views.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/netbox/netbox/views/generic/object_views.py b/netbox/netbox/views/generic/object_views.py index 4757a77f57c..dac1ddd2472 100644 --- a/netbox/netbox/views/generic/object_views.py +++ b/netbox/netbox/views/generic/object_views.py @@ -341,7 +341,8 @@ def get(self, request, *args, **kwargs): nested_objs = [] if collector.instances_with_model(): for model, instance in collector.instances_with_model(): - nested_objs.append(f"{model.__name__} - {instance}") + if not instance == obj: + nested_objs.append(f"{model.__name__} - {instance}") # If this is an HTMX request, return only the rendered deletion form as modal content From 7c3caf5e392d7c711b1de684a8edf1988eb716c0 Mon Sep 17 00:00:00 2001 From: Jamie Murphy Date: Fri, 29 Sep 2023 21:17:05 +0100 Subject: [PATCH 04/11] Revert "dont include the item being deleted in the list of related items" This reverts commit 298a7860b20c2fd90e887c66c4f196460097e71e. --- netbox/netbox/views/generic/object_views.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/netbox/netbox/views/generic/object_views.py b/netbox/netbox/views/generic/object_views.py index dac1ddd2472..4757a77f57c 100644 --- a/netbox/netbox/views/generic/object_views.py +++ b/netbox/netbox/views/generic/object_views.py @@ -341,8 +341,7 @@ def get(self, request, *args, **kwargs): nested_objs = [] if collector.instances_with_model(): for model, instance in collector.instances_with_model(): - if not instance == obj: - nested_objs.append(f"{model.__name__} - {instance}") + nested_objs.append(f"{model.__name__} - {instance}") # If this is an HTMX request, return only the rendered deletion form as modal content From 63b1736c97ff6c1fc2a26d2cb9c1e459d41a341a Mon Sep 17 00:00:00 2001 From: Jamie Murphy Date: Fri, 20 Oct 2023 07:52:06 +0100 Subject: [PATCH 05/11] cleanup - migrate code to use collector directly instead of the NestedObjects wrapper from admin.utils - adjust object names and text output --- netbox/netbox/views/generic/object_views.py | 17 ++++++++++------- netbox/templates/htmx/delete_form.html | 8 ++++---- 2 files changed, 14 insertions(+), 11 deletions(-) diff --git a/netbox/netbox/views/generic/object_views.py b/netbox/netbox/views/generic/object_views.py index 4757a77f57c..de6b5cb9a6d 100644 --- a/netbox/netbox/views/generic/object_views.py +++ b/netbox/netbox/views/generic/object_views.py @@ -2,9 +2,9 @@ from copy import deepcopy from django.contrib import messages -from django.contrib.admin.utils import NestedObjects from django.db import transaction, router from django.db.models import ProtectedError +from django.db.models.deletion import Collector from django.shortcuts import redirect, render from django.urls import reverse from django.utils.html import escape @@ -336,13 +336,16 @@ def get(self, request, *args, **kwargs): form = ConfirmationForm(initial=request.GET) using = router.db_for_write(obj._meta.model) - collector = NestedObjects(using=using) + collector = Collector(using=using) collector.collect([obj]) - nested_objs = [] + deletion_objects = [] if collector.instances_with_model(): for model, instance in collector.instances_with_model(): - nested_objs.append(f"{model.__name__} - {instance}") - + # we could ignore the instance == obj so that the list doesnt contain itself... + deletion_objects.append({ + "modelname":f"{model.__name__}", + "object": instance, + }) # If this is an HTMX request, return only the rendered deletion form as modal content if is_htmx(request): @@ -353,7 +356,7 @@ def get(self, request, *args, **kwargs): 'object_type': self.queryset.model._meta.verbose_name, 'form': form, 'form_url': form_url, - 'nested_objs': nested_objs, + 'deletion_objects': deletion_objects, **self.get_extra_context(request, obj), }) @@ -361,7 +364,7 @@ def get(self, request, *args, **kwargs): 'object': obj, 'form': form, 'return_url': self.get_return_url(request, obj), - 'nested_objs': nested_objs, + 'deletion_objects': deletion_objects, **self.get_extra_context(request, obj), }) diff --git a/netbox/templates/htmx/delete_form.html b/netbox/templates/htmx/delete_form.html index 9aac23aa6e7..f108f41eafc 100644 --- a/netbox/templates/htmx/delete_form.html +++ b/netbox/templates/htmx/delete_form.html @@ -12,11 +12,11 @@
{% trans "Confirm Deletion" %}
Are you sure you want to delete {{ object_type }} {{ object }}? {% endblocktrans %}

- {% if nested_objs %} + {% if deletion_objects %}

- This will cause deltion of the following related items:
- {% for nested_obj in nested_objs %} - - {{ nested_obj }}
+ This will cause deltion of the following items:
+ {% for deletion_object in deletion_objects %} + - {{ deletion_object.modelname }} - {{ deletion_object.object | linkify }}
{% endfor %}

{% endif %} From 48d7ca7a64af881f557ac0e674b0b206ac8391d2 Mon Sep 17 00:00:00 2001 From: Jamie Murphy Date: Fri, 20 Oct 2023 12:15:07 +0100 Subject: [PATCH 06/11] requested adjustments --- netbox/netbox/views/generic/object_views.py | 18 ++++++++---------- netbox/templates/htmx/delete_form.html | 12 ++++++++---- 2 files changed, 16 insertions(+), 14 deletions(-) diff --git a/netbox/netbox/views/generic/object_views.py b/netbox/netbox/views/generic/object_views.py index de6b5cb9a6d..e3373350eda 100644 --- a/netbox/netbox/views/generic/object_views.py +++ b/netbox/netbox/views/generic/object_views.py @@ -338,14 +338,12 @@ def get(self, request, *args, **kwargs): using = router.db_for_write(obj._meta.model) collector = Collector(using=using) collector.collect([obj]) - deletion_objects = [] - if collector.instances_with_model(): - for model, instance in collector.instances_with_model(): - # we could ignore the instance == obj so that the list doesnt contain itself... - deletion_objects.append({ - "modelname":f"{model.__name__}", - "object": instance, - }) + related_objects = {} + for model, instance in collector.instances_with_model(): + # we could ignore the instance == obj so that the list doesnt contain itself... + if not model.__name__ in related_objects: + related_objects[model.__name__] = [] + related_objects[model.__name__].append(instance) # If this is an HTMX request, return only the rendered deletion form as modal content if is_htmx(request): @@ -356,7 +354,7 @@ def get(self, request, *args, **kwargs): 'object_type': self.queryset.model._meta.verbose_name, 'form': form, 'form_url': form_url, - 'deletion_objects': deletion_objects, + 'related_objects': related_objects, **self.get_extra_context(request, obj), }) @@ -364,7 +362,7 @@ def get(self, request, *args, **kwargs): 'object': obj, 'form': form, 'return_url': self.get_return_url(request, obj), - 'deletion_objects': deletion_objects, + 'related_objects': related_objects, **self.get_extra_context(request, obj), }) diff --git a/netbox/templates/htmx/delete_form.html b/netbox/templates/htmx/delete_form.html index f108f41eafc..799e7262761 100644 --- a/netbox/templates/htmx/delete_form.html +++ b/netbox/templates/htmx/delete_form.html @@ -12,11 +12,15 @@
{% trans "Confirm Deletion" %}
Are you sure you want to delete {{ object_type }} {{ object }}? {% endblocktrans %}

- {% if deletion_objects %} + {% if related_objects %}

- This will cause deltion of the following items:
- {% for deletion_object in deletion_objects %} - - {{ deletion_object.modelname }} - {{ deletion_object.object | linkify }}
+ This will cause deletion of the following items:
+ {% for model,objects in related_objects.items %} + - {{ model }}: + {% for object in objects %} + {{ object | linkify }}, + {% endfor %} +
{% endfor %}

{% endif %} From 413824934c12cacd2ac839f5ac987f7d2035984e Mon Sep 17 00:00:00 2001 From: Jamie Murphy Date: Sun, 22 Oct 2023 15:27:19 +0100 Subject: [PATCH 07/11] remove comma from end of list --- netbox/templates/htmx/delete_form.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/netbox/templates/htmx/delete_form.html b/netbox/templates/htmx/delete_form.html index 799e7262761..370f4885115 100644 --- a/netbox/templates/htmx/delete_form.html +++ b/netbox/templates/htmx/delete_form.html @@ -18,7 +18,7 @@
{% trans "Confirm Deletion" %}
{% for model,objects in related_objects.items %} - {{ model }}: {% for object in objects %} - {{ object | linkify }}, + {{ object | linkify }}{% if not forloop.last %}, {% endif %} {% endfor %}
{% endfor %} From cdae6c2d94147e5b4488772cba79db9d03e000c3 Mon Sep 17 00:00:00 2001 From: Jamie Murphy Date: Sun, 22 Oct 2023 15:40:15 +0100 Subject: [PATCH 08/11] linting --- netbox/netbox/views/generic/object_views.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/netbox/netbox/views/generic/object_views.py b/netbox/netbox/views/generic/object_views.py index e3373350eda..f0e50c7ab63 100644 --- a/netbox/netbox/views/generic/object_views.py +++ b/netbox/netbox/views/generic/object_views.py @@ -341,7 +341,7 @@ def get(self, request, *args, **kwargs): related_objects = {} for model, instance in collector.instances_with_model(): # we could ignore the instance == obj so that the list doesnt contain itself... - if not model.__name__ in related_objects: + if model.__name__ not in related_objects: related_objects[model.__name__] = [] related_objects[model.__name__].append(instance) From 6be745f13cd5004d40aed03121bf401f4e1d5c86 Mon Sep 17 00:00:00 2001 From: Jamie Murphy Date: Tue, 31 Oct 2023 21:36:38 +0000 Subject: [PATCH 09/11] refactor, add accordion --- netbox/netbox/views/generic/object_views.py | 34 +++++++++++++++------ netbox/templates/htmx/delete_form.html | 26 +++++++++++----- 2 files changed, 44 insertions(+), 16 deletions(-) diff --git a/netbox/netbox/views/generic/object_views.py b/netbox/netbox/views/generic/object_views.py index f0e50c7ab63..478b7818fa5 100644 --- a/netbox/netbox/views/generic/object_views.py +++ b/netbox/netbox/views/generic/object_views.py @@ -321,6 +321,30 @@ class ObjectDeleteView(GetReturnURLMixin, BaseObjectView): def get_required_permission(self): return get_permission_for_model(self.queryset.model, 'delete') + def _get_dependent_objects(self, obj): + """ + Returns a dict of dependent objects, model names as primary key, inside each two keys exist name and items (list) + + Args: + obj: The object to return dependent objects for + """ + using = router.db_for_write(obj._meta.model) + collector = Collector(using=using) + collector.collect([obj]) + related_objects = {} + for model, instance in collector.instances_with_model(): + if instance == obj: + continue + if model.__name__ not in related_objects: + related_objects[model.__name__] = { + "name": model._meta.verbose_name, + "items": [] + } + related_objects[model.__name__]['items'].append(instance) + if len(related_objects[model.__name__]['items']) > 1: + related_objects[model.__name__]['name'] = model._meta.verbose_name_plural + return related_objects + # # Request handlers # @@ -335,15 +359,7 @@ def get(self, request, *args, **kwargs): obj = self.get_object(**kwargs) form = ConfirmationForm(initial=request.GET) - using = router.db_for_write(obj._meta.model) - collector = Collector(using=using) - collector.collect([obj]) - related_objects = {} - for model, instance in collector.instances_with_model(): - # we could ignore the instance == obj so that the list doesnt contain itself... - if model.__name__ not in related_objects: - related_objects[model.__name__] = [] - related_objects[model.__name__].append(instance) + related_objects = self._get_dependent_objects(obj) # If this is an HTMX request, return only the rendered deletion form as modal content if is_htmx(request): diff --git a/netbox/templates/htmx/delete_form.html b/netbox/templates/htmx/delete_form.html index 370f4885115..71e70ba6eb6 100644 --- a/netbox/templates/htmx/delete_form.html +++ b/netbox/templates/htmx/delete_form.html @@ -14,14 +14,26 @@
{% trans "Confirm Deletion" %}

{% if related_objects %}

- This will cause deletion of the following items:
- {% for model,objects in related_objects.items %} - - {{ model }}: - {% for object in objects %} - {{ object | linkify }}{% if not forloop.last %}, {% endif %} - {% endfor %} -
+ This will cause deletion of the following objects:
+

+ + {% for model,object_dict in related_objects.items %} +
+

+ +

+
+
+ {% for object in object_dict.items %} + - {{ object | linkify }}{% if not forloop.last %}
{% endif %} + {% endfor %} +
+
+
{% endfor %} +

{% endif %} {% render_form form %} From ee5be84911d5feb4d7860154d649c89ffe71c355 Mon Sep 17 00:00:00 2001 From: Jamie Murphy Date: Tue, 31 Oct 2023 21:54:40 +0000 Subject: [PATCH 10/11] migrate to defaultdict, use title for capitalisation of accordian titles --- netbox/netbox/views/generic/object_views.py | 24 ++++++++++----------- netbox/templates/htmx/delete_form.html | 4 ++-- 2 files changed, 14 insertions(+), 14 deletions(-) diff --git a/netbox/netbox/views/generic/object_views.py b/netbox/netbox/views/generic/object_views.py index 478b7818fa5..c5b0df8026d 100644 --- a/netbox/netbox/views/generic/object_views.py +++ b/netbox/netbox/views/generic/object_views.py @@ -1,5 +1,6 @@ import logging from copy import deepcopy +from collections import defaultdict from django.contrib import messages from django.db import transaction, router @@ -16,7 +17,7 @@ from utilities.forms import ConfirmationForm, restrict_form_fields from utilities.htmx import is_htmx from utilities.permissions import get_permission_for_model -from utilities.utils import get_viewname, normalize_querydict, prepare_cloned_fields +from utilities.utils import get_viewname, normalize_querydict, prepare_cloned_fields, title from utilities.views import GetReturnURLMixin from .base import BaseObjectView from .mixins import ActionsMixin, TableMixin @@ -323,7 +324,7 @@ def get_required_permission(self): def _get_dependent_objects(self, obj): """ - Returns a dict of dependent objects, model names as primary key, inside each two keys exist name and items (list) + Returns a dict of dependent objects, model names as primary key, inside each two keys exist title and objects (list) Args: obj: The object to return dependent objects for @@ -331,19 +332,18 @@ def _get_dependent_objects(self, obj): using = router.db_for_write(obj._meta.model) collector = Collector(using=using) collector.collect([obj]) - related_objects = {} + related_objects = defaultdict(dict) for model, instance in collector.instances_with_model(): if instance == obj: continue - if model.__name__ not in related_objects: - related_objects[model.__name__] = { - "name": model._meta.verbose_name, - "items": [] - } - related_objects[model.__name__]['items'].append(instance) - if len(related_objects[model.__name__]['items']) > 1: - related_objects[model.__name__]['name'] = model._meta.verbose_name_plural - return related_objects + + related_objects.setdefault(model.__name__, {"objects": []})['objects'].append(instance) + + if len(related_objects[model.__name__]['objects']) == 1: + related_objects[model.__name__]['title'] = title(model._meta.verbose_name) + else: + related_objects[model.__name__]['title'] = title(model._meta.verbose_name_plural) + return dict(related_objects) # # Request handlers diff --git a/netbox/templates/htmx/delete_form.html b/netbox/templates/htmx/delete_form.html index 71e70ba6eb6..14288512b1d 100644 --- a/netbox/templates/htmx/delete_form.html +++ b/netbox/templates/htmx/delete_form.html @@ -21,12 +21,12 @@
{% trans "Confirm Deletion" %}

- {% for object in object_dict.items %} + {% for object in object_dict.objects %} - {{ object | linkify }}{% if not forloop.last %}
{% endif %} {% endfor %}
From 593fa468a5a1b7abe9cef4f17575d68b91612add Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Wed, 1 Nov 2023 11:29:09 -0400 Subject: [PATCH 11/11] Misc cleanup --- netbox/netbox/views/generic/object_views.py | 27 +++++------ netbox/templates/htmx/delete_form.html | 50 ++++++++++++--------- 2 files changed, 42 insertions(+), 35 deletions(-) diff --git a/netbox/netbox/views/generic/object_views.py b/netbox/netbox/views/generic/object_views.py index c5b0df8026d..ab176a678b1 100644 --- a/netbox/netbox/views/generic/object_views.py +++ b/netbox/netbox/views/generic/object_views.py @@ -324,7 +324,8 @@ def get_required_permission(self): def _get_dependent_objects(self, obj): """ - Returns a dict of dependent objects, model names as primary key, inside each two keys exist title and objects (list) + Returns a dictionary mapping of dependent objects (organized by model) which will be deleted as a result of + deleting the requested object. Args: obj: The object to return dependent objects for @@ -332,18 +333,15 @@ def _get_dependent_objects(self, obj): using = router.db_for_write(obj._meta.model) collector = Collector(using=using) collector.collect([obj]) - related_objects = defaultdict(dict) - for model, instance in collector.instances_with_model(): - if instance == obj: - continue - related_objects.setdefault(model.__name__, {"objects": []})['objects'].append(instance) + # Compile a mapping of models to instances + dependent_objects = defaultdict(list) + for model, instance in collector.instances_with_model(): + # Omit the root object + if instance != obj: + dependent_objects[model].append(instance) - if len(related_objects[model.__name__]['objects']) == 1: - related_objects[model.__name__]['title'] = title(model._meta.verbose_name) - else: - related_objects[model.__name__]['title'] = title(model._meta.verbose_name_plural) - return dict(related_objects) + return dict(dependent_objects) # # Request handlers @@ -358,8 +356,7 @@ def get(self, request, *args, **kwargs): """ obj = self.get_object(**kwargs) form = ConfirmationForm(initial=request.GET) - - related_objects = self._get_dependent_objects(obj) + dependent_objects = self._get_dependent_objects(obj) # If this is an HTMX request, return only the rendered deletion form as modal content if is_htmx(request): @@ -370,7 +367,7 @@ def get(self, request, *args, **kwargs): 'object_type': self.queryset.model._meta.verbose_name, 'form': form, 'form_url': form_url, - 'related_objects': related_objects, + 'dependent_objects': dependent_objects, **self.get_extra_context(request, obj), }) @@ -378,7 +375,7 @@ def get(self, request, *args, **kwargs): 'object': obj, 'form': form, 'return_url': self.get_return_url(request, obj), - 'related_objects': related_objects, + 'dependent_objects': dependent_objects, **self.get_extra_context(request, obj), }) diff --git a/netbox/templates/htmx/delete_form.html b/netbox/templates/htmx/delete_form.html index 14288512b1d..4d13072dd4e 100644 --- a/netbox/templates/htmx/delete_form.html +++ b/netbox/templates/htmx/delete_form.html @@ -12,29 +12,39 @@
{% trans "Confirm Deletion" %}
Are you sure you want to delete {{ object_type }} {{ object }}? {% endblocktrans %}

- {% if related_objects %} -

- This will cause deletion of the following objects:
+ {% if dependent_objects %} +

+ {% trans "The following objects will be deleted as a result of this action." %} +

- - {% for model,object_dict in related_objects.items %} -
-

- -

-
-
- {% for object in object_dict.objects %} - - {{ object | linkify }}{% if not forloop.last %}
{% endif %} - {% endfor %} + {% for model, instances in dependent_objects.items %} +
+

+ +

+
+
+
+ {% for instance in instances %} + {% with url=instance.get_absolute_url %} + {{ instance }} + {% endwith %} + {% endfor %} +
+
-
- {% endfor %} -
-

+ {% endfor %} +
{% endif %} {% render_form form %}