nautobot 2.4.18__py3-none-any.whl → 2.4.19__py3-none-any.whl

nautobot/core/views/generic.py

@@ -44,6 +44,7 @@ from nautobot.core.templatetags.helpers import bettertitle, validated_viewname
 from nautobot.core.utils.config import get_settings_or_config
 from nautobot.core.utils.permissions import get_permission_for_model
 from nautobot.core.utils.requests import (
+    convert_querydict_to_dict,
     convert_querydict_to_factory_formset_acceptable_querydict,
     get_filterable_params_from_filter_params,
     normalize_querydict,
@@ -58,6 +59,7 @@ from nautobot.core.views.paginator import EnhancedPaginator, get_paginate_count
 from nautobot.core.views.utils import (
     check_filter_for_display,
     common_detail_view_context,
+    get_bulk_queryset_from_view,
     get_csv_form_fields_from_serializer_class,
     get_saved_views_for_user,
     handle_protectederror,
@@ -68,7 +70,7 @@ from nautobot.core.views.utils import (
 from nautobot.extras.models import ExportTemplate, SavedView, UserSavedViewAssociation
 
 
-class GenericView(LoginRequiredMixin, UIComponentsMixin, View):
+class GenericView(UIComponentsMixin, LoginRequiredMixin, View):
     """
     Base class for non-object-related views.
 
@@ -76,7 +78,7 @@ class GenericView(LoginRequiredMixin, UIComponentsMixin, View):
     """
 
 
-class ObjectView(ObjectPermissionRequiredMixin, UIComponentsMixin, View):
+class ObjectView(UIComponentsMixin, ObjectPermissionRequiredMixin, View):
     """
     Retrieve a single object for display.
 
@@ -141,7 +143,7 @@ class ObjectView(ObjectPermissionRequiredMixin, UIComponentsMixin, View):
         return render(request, self.get_template_name(), context)
 
 
-class ObjectListView(ObjectPermissionRequiredMixin, UIComponentsMixin, View):
+class ObjectListView(UIComponentsMixin, ObjectPermissionRequiredMixin, View):
     """
     List a series of objects.
 
@@ -421,7 +423,7 @@ class ObjectListView(ObjectPermissionRequiredMixin, UIComponentsMixin, View):
         return {}
 
 
-class ObjectEditView(GetReturnURLMixin, UIComponentsMixin, ObjectPermissionRequiredMixin, View):
+class ObjectEditView(UIComponentsMixin, GetReturnURLMixin, ObjectPermissionRequiredMixin, View):
     """
     Create or edit a single object.
 
@@ -569,7 +571,7 @@ class ObjectEditView(GetReturnURLMixin, UIComponentsMixin, ObjectPermissionRequi
         )
 
 
-class ObjectDeleteView(GetReturnURLMixin, UIComponentsMixin, ObjectPermissionRequiredMixin, View):
+class ObjectDeleteView(UIComponentsMixin, GetReturnURLMixin, ObjectPermissionRequiredMixin, View):
     """
     Delete a single object.
 
@@ -646,7 +648,7 @@ class ObjectDeleteView(GetReturnURLMixin, UIComponentsMixin, ObjectPermissionReq
         )
 
 
-class BulkCreateView(GetReturnURLMixin, UIComponentsMixin, ObjectPermissionRequiredMixin, View):
+class BulkCreateView(UIComponentsMixin, GetReturnURLMixin, ObjectPermissionRequiredMixin, View):
     """
     Create new objects in bulk.
 
@@ -760,7 +762,7 @@ class BulkCreateView(GetReturnURLMixin, UIComponentsMixin, ObjectPermissionRequi
         )
 
 
-class ObjectImportView(GetReturnURLMixin, UIComponentsMixin, ObjectPermissionRequiredMixin, View):
+class ObjectImportView(UIComponentsMixin, GetReturnURLMixin, ObjectPermissionRequiredMixin, View):
     """
     Import a single object (YAML or JSON format).
 
@@ -908,7 +910,7 @@ class ObjectImportView(GetReturnURLMixin, UIComponentsMixin, ObjectPermissionReq
 
 
 class BulkImportView(
-    GetReturnURLMixin, UIComponentsMixin, ObjectPermissionRequiredMixin, View
+    UIComponentsMixin, GetReturnURLMixin, ObjectPermissionRequiredMixin, View
 ):  # 3.0 TODO: remove as it's no longer used
     """
     Import objects in bulk (CSV format).
@@ -1019,7 +1021,7 @@ class BulkImportView(
 
 
 class BulkEditView(
-    GetReturnURLMixin, UIComponentsMixin, ObjectPermissionRequiredMixin, BulkEditAndBulkDeleteModelMixin, View
+    UIComponentsMixin, GetReturnURLMixin, ObjectPermissionRequiredMixin, BulkEditAndBulkDeleteModelMixin, View
 ):
     """
     Edit objects in bulk.
@@ -1056,15 +1058,19 @@ class BulkEditView(
         if self.queryset is None or self.form is None or self.table is None:
             raise RuntimeError("self.queryset, self.form, and self.table must not be None")
         model = self.queryset.model
-        edit_all = request.POST.get("_all")
+        pk_list = list(request.POST.getlist("pk"))
+        edit_all = bool(self.request.POST.get("_all"))
+        saved_view_id = request.GET.get("saved_view", "")
+
+        self.key_params = {
+            "content_type": ContentType.objects.get_for_model(model),
+            "edit_all": edit_all,
+            "filter_query_params": convert_querydict_to_dict(request.GET),
+            "pk_list": pk_list,
+            "saved_view_id": saved_view_id,
+        }
 
-        # If we are editing *all* objects in the queryset, replace the PK list with all matched objects.
-        if edit_all:
-            pk_list = []
-            queryset = self._get_bulk_edit_delete_all_queryset(request)
-        else:
-            pk_list = request.POST.getlist("pk")
-            queryset = self.queryset.filter(pk__in=pk_list)
+        queryset = get_bulk_queryset_from_view(user=request.user, action="change", **self.key_params)
 
         if "_apply" in request.POST:
             form = self.form(model, request.POST, edit_all=edit_all)  # pylint: disable=not-callable
@@ -1072,7 +1078,7 @@ class BulkEditView(
 
             if form.is_valid():
                 logger.debug("Form validation was successful")
-                return self.send_bulk_edit_objects_to_job(request, form.cleaned_data, model)
+                return self.send_bulk_edit_objects_to_job(request, form.cleaned_data)
             else:
                 logger.debug("Form validation failed")
 
@@ -1116,7 +1122,7 @@ class BulkEditView(
         return {}
 
 
-class BulkRenameView(GetReturnURLMixin, UIComponentsMixin, ObjectPermissionRequiredMixin, View):
+class BulkRenameView(UIComponentsMixin, GetReturnURLMixin, ObjectPermissionRequiredMixin, View):
     """
     An extendable view for renaming objects in bulk.
     """
@@ -1217,7 +1223,7 @@ class BulkRenameView(GetReturnURLMixin, UIComponentsMixin, ObjectPermissionRequi
 
 
 class BulkDeleteView(
-    GetReturnURLMixin, UIComponentsMixin, ObjectPermissionRequiredMixin, BulkEditAndBulkDeleteModelMixin, View
+    UIComponentsMixin, GetReturnURLMixin, ObjectPermissionRequiredMixin, BulkEditAndBulkDeleteModelMixin, View
 ):
     """
     Delete objects in bulk.
@@ -1246,15 +1252,19 @@ class BulkDeleteView(
         if self.queryset is None or self.table is None:
             raise RuntimeError("self.queryset and self.table must not be None")
         model = self.queryset.model
-        delete_all = request.POST.get("_all")
+        pk_list = list(request.POST.getlist("pk"))
+        delete_all = bool(request.POST.get("_all"))
+        saved_view_id = request.GET.get("saved_view", "")
 
-        # Are we deleting *all* objects in the queryset or just a selected subset?
-        if delete_all:
-            queryset = self._get_bulk_edit_delete_all_queryset(request)
-            pk_list = []
-        else:
-            pk_list = request.POST.getlist("pk")
-            queryset = self.queryset.filter(pk__in=pk_list)
+        self.key_params = {
+            "content_type": ContentType.objects.get_for_model(model),
+            "delete_all": delete_all,
+            "filter_query_params": convert_querydict_to_dict(request.GET),
+            "pk_list": pk_list,
+            "saved_view_id": saved_view_id,
+        }
+
+        queryset = get_bulk_queryset_from_view(user=request.user, action="delete", **self.key_params)
 
         form_cls = self.get_form()
 
@@ -1266,7 +1276,7 @@ class BulkDeleteView(
 
             if form.is_valid():
                 logger.debug("Form validation was successful")
-                return self.send_bulk_delete_objects_to_job(request, pk_list, model, delete_all)
+                return self.send_bulk_delete_objects_to_job(request)
             else:
                 logger.debug("Form validation failed")
 
@@ -1329,7 +1339,7 @@ class BulkDeleteView(
 
 
 # TODO: Replace with BulkCreateView
-class ComponentCreateView(GetReturnURLMixin, UIComponentsMixin, ObjectPermissionRequiredMixin, View):
+class ComponentCreateView(UIComponentsMixin, GetReturnURLMixin, ObjectPermissionRequiredMixin, View):
     """
     Add one or more components (e.g. interfaces, console ports, etc.) to a Device or VirtualMachine.
     """
@@ -1435,7 +1445,7 @@ class ComponentCreateView(GetReturnURLMixin, UIComponentsMixin, ObjectPermission
         )
 
 
-class BulkComponentCreateView(GetReturnURLMixin, UIComponentsMixin, ObjectPermissionRequiredMixin, View):
+class BulkComponentCreateView(UIComponentsMixin, GetReturnURLMixin, ObjectPermissionRequiredMixin, View):
     """
     Add one or more components (e.g. interfaces, console ports, etc.) to a set of Devices or VirtualMachines.
     """

nautobot/core/views/mixins.py

@@ -31,7 +31,6 @@ from rest_framework.parsers import FormParser, MultiPartParser
 from rest_framework.response import Response
 from rest_framework.viewsets import GenericViewSet
 
-from nautobot.core import exceptions as core_exceptions
 from nautobot.core.api.views import BulkDestroyModelMixin, BulkUpdateModelMixin
 from nautobot.core.forms import (
     BootstrapMixin,
@@ -40,13 +39,17 @@ from nautobot.core.forms import (
     CSVFileField,
     restrict_form_fields,
 )
-from nautobot.core.jobs import BulkDeleteObjects, BulkEditObjects
 from nautobot.core.ui.breadcrumbs import Breadcrumbs
 from nautobot.core.ui.titles import Titles
-from nautobot.core.utils import filtering, lookup, permissions
-from nautobot.core.utils.requests import get_filterable_params_from_filter_params, normalize_querydict
+from nautobot.core.utils import lookup, permissions
+from nautobot.core.utils.requests import (
+    convert_querydict_to_dict,
+    get_filterable_params_from_filter_params,
+    normalize_querydict,
+)
 from nautobot.core.views.renderers import NautobotHTMLRenderer
 from nautobot.core.views.utils import (
+    get_bulk_queryset_from_view,
     get_csv_form_fields_from_serializer_class,
     handle_protectederror,
     import_csv_helper,
@@ -671,13 +674,16 @@ class NautobotViewSetMixin(GenericViewSet, UIComponentsMixin, AccessMixin, GetRe
     def get_extra_context(self, request, instance=None):
         """
         Return any additional context data for the template.
-        request: The current request
-        instance: The object being viewed
+
+        Args:
+            request (Request): The current request
+            instance (Model, optional): The specific object being viewed, if any
         """
         if instance is not None:
-            return {
-                "active_tab": request.GET.get("tab", "main"),
-            }
+            default_tab = "main"
+            if hasattr(self, "action") and self.action != "retrieve":
+                default_tab = self.action
+            return {"active_tab": request.GET.get("tab", default_tab)}
         return {}
 
     def get_template_name(self):
@@ -1113,60 +1119,14 @@ class BulkEditAndBulkDeleteModelMixin:
 
     logger = logging.getLogger(__name__)
 
-    def _get_bulk_edit_delete_all_queryset(self, request):
-        """
-        Retrieve the queryset of model instances to be bulk-deleted or bulk-deleted, filtered based on request parameters.
-
-        This method handles the retrieval of a queryset of model instances that match the specified
-        filter criteria in the request parameters, allowing a bulk delete operation to be performed
-        on all matching instances.
-        """
-        model = self.queryset.model
-
-        # This Mixin is currently been used by both NautobotUIViewSet ObjectBulkDestroyViewMixin, ObjectBulkUpdateViewMixin
-        # BulkEditView, and BulkDeleteView which uses different keys for accessing filterset
-        filterset_class = getattr(self, "filterset", None)
-        if filterset_class is None:
-            filterset_class = getattr(self, "filterset_class", None)
-
-        if request.GET and filterset_class is not None:
-            queryset = filterset_class(request.GET, model.objects.all()).qs  # pylint: disable=not-callable
-            # We take this approach because filterset.qs has already applied .distinct(),
-            # and performing a .delete directly on a queryset with .distinct applied is not allowed.
-            queryset = self.queryset.filter(pk__in=queryset)
-        else:
-            queryset = model.objects.all()
-        return queryset
-
-    def send_bulk_delete_objects_to_job(self, request, pk_list, model, delete_all):
+    def send_bulk_delete_objects_to_job(self, request):
         """Prepare and enqueue bulk delete job."""
-        job_model = Job.objects.get_for_class_path(BulkDeleteObjects.class_path)
-
-        if filterset_class := lookup.get_filterset_for_model(model):
-            filter_query_params = normalize_querydict(request.GET, filterset=filterset_class())
-        else:
-            filter_query_params = {}
+        from nautobot.core.jobs import BulkDeleteObjects
 
-        # Discarding non-filter query params
-        new_filter_query_params = {}
-
-        for key, value in filter_query_params.items():
-            try:
-                filtering.get_filterset_field(filterset_class(), key)
-                new_filter_query_params[key] = value
-            except core_exceptions.FilterSetFieldNotFound:
-                self.logger.debug(f"Query parameter `{key}` not found in `{filterset_class}`, discarding it")
+        job_model = Job.objects.get_for_class_path(BulkDeleteObjects.class_path)
 
-        filter_query_params = new_filter_query_params
+        job_form = BulkDeleteObjects.as_form(data={**self.key_params})
 
-        job_form = BulkDeleteObjects.as_form(
-            data={
-                "pk_list": pk_list,
-                "content_type": ContentType.objects.get_for_model(model),
-                "delete_all": delete_all,
-                "filter_query_params": filter_query_params,
-            }
-        )
         # BulkDeleteObjects job form cannot be invalid; Hence no handling of invalid case.
         job_form.is_valid()
         job_kwargs = BulkDeleteObjects.prepare_job_kwargs(job_form.cleaned_data)
@@ -1177,39 +1137,18 @@ class BulkEditAndBulkDeleteModelMixin:
         )
         return redirect("extras:jobresult", pk=job_result.pk)
 
-    def send_bulk_edit_objects_to_job(self, request, form_data, model):
+    def send_bulk_edit_objects_to_job(self, request, form_data):
         """Prepare and enqueue a bulk edit job."""
-        job_model = Job.objects.get_for_class_path(BulkEditObjects.class_path)
-        if filterset_class := lookup.get_filterset_for_model(model):
-            filter_query_params = normalize_querydict(request.GET, filterset=filterset_class())
-        else:
-            filter_query_params = {}
+        from nautobot.core.jobs import BulkEditObjects
 
-        # Discarding non-filter query params
-        new_filter_query_params = {}
-
-        for key, value in filter_query_params.items():
-            try:
-                filtering.get_filterset_field(filterset_class(), key)
-                new_filter_query_params[key] = value
-            except core_exceptions.FilterSetFieldNotFound:
-                self.logger.debug(f"Query parameter `{key}` not found in `{filterset_class}`, discarding it")
-
-        filter_query_params = new_filter_query_params
+        job_model = Job.objects.get_for_class_path(BulkEditObjects.class_path)
 
         if nullified_fields := request.POST.getlist("_nullify"):
             form_data["_nullify"] = nullified_fields
         else:
             form_data["_nullify"] = []
 
-        job_form = BulkEditObjects.as_form(
-            data={
-                "form_data": form_data,
-                "content_type": ContentType.objects.get_for_model(model),
-                "edit_all": request.POST.get("_all") is not None,
-                "filter_query_params": filter_query_params,
-            }
-        )
+        job_form = BulkEditObjects.as_form(data={"form_data": form_data, **self.key_params})
         # NOTE: BulkEditObjects cant be invalid, so there is no need for handling invalid error
         job_form.is_valid()
         job_kwargs = BulkEditObjects.prepare_job_kwargs(job_form.cleaned_data)
@@ -1228,17 +1167,25 @@ class ObjectBulkDestroyViewMixin(NautobotViewSetMixin, BulkDestroyModelMixin, Bu
 
     bulk_destroy_form_class: Optional[type[Form]] = None
     filterset_class: Optional[type[FilterSet]] = None
+    logger = logging.getLogger(__name__)
 
     def _process_bulk_destroy_form(self, form):
         request = self.request
-        pk_list = self.pk_list
         queryset = self.get_queryset()
         model = queryset.model
         # Delete objects
-        if self.request.POST.get("_all"):
-            queryset = self._get_bulk_edit_delete_all_queryset(self.request)
-        else:
-            queryset = queryset.filter(pk__in=pk_list)
+        delete_all = bool(self.request.POST.get("_all"))
+        saved_view_id = request.GET.get("saved_view", "")
+
+        self.key_params = {
+            "content_type": ContentType.objects.get_for_model(model),
+            "delete_all": delete_all,
+            "filter_query_params": convert_querydict_to_dict(request.GET),
+            "pk_list": self.pk_list,
+            "saved_view_id": saved_view_id,
+        }
+
+        queryset = get_bulk_queryset_from_view(user=request.user, action="delete", **self.key_params)
 
         try:
             with transaction.atomic():
@@ -1267,21 +1214,26 @@ class ObjectBulkDestroyViewMixin(NautobotViewSetMixin, BulkDestroyModelMixin, Bu
         request.POST "_confirm": Function to validate the table form/BulkDestroyConfirmationForm and to perform the action of bulk destroy. Render the form with errors if exceptions are raised.
         """
         queryset = self.get_queryset()
+        model = queryset.model
+        self.pk_list = list(request.POST.getlist("pk"))
         delete_all = bool(request.POST.get("_all"))
+        saved_view_id = request.GET.get("saved_view", "")
         data = {}
-        # Are we deleting *all* objects in the queryset or just a selected subset?
-        if delete_all:
-            self.pk_list = []
-            queryset = self._get_bulk_edit_delete_all_queryset(self.request)
-        else:
-            self.pk_list = list(request.POST.getlist("pk"))
-            queryset = queryset.filter(pk__in=self.pk_list)
+        self.key_params = {
+            "content_type": ContentType.objects.get_for_model(model),
+            "delete_all": delete_all,
+            "filter_query_params": convert_querydict_to_dict(request.GET),
+            "pk_list": self.pk_list,
+            "saved_view_id": saved_view_id,
+        }
+
+        queryset = get_bulk_queryset_from_view(user=request.user, action="delete", **self.key_params)
 
         if "_confirm" in request.POST:
             form_class = self.get_form_class(**kwargs)
             form = form_class(request.POST, initial=normalize_querydict(request.GET, form_class=form_class))
             if form.is_valid():
-                return self.send_bulk_delete_objects_to_job(request, self.pk_list, queryset.model, delete_all)
+                return self.send_bulk_delete_objects_to_job(request)
             else:
                 return self.form_invalid(form)
         table = None
@@ -1368,12 +1320,25 @@ class ObjectBulkUpdateViewMixin(NautobotViewSetMixin, BulkUpdateModelMixin, Bulk
     """
 
     filterset_class: ClassVar[Optional[type[FilterSet]]] = None
+    logger = logging.getLogger(__name__)
 
     # NOTE: Performing BulkEdit Objects has been moved to a system job, but the logic remains here to ensure backward compatibility.
     def _process_bulk_update_form(self, form):
         request = self.request
+        self.pk_list = list(request.POST.getlist("pk"))
         queryset = self.get_queryset()
         model = queryset.model
+        edit_all = bool(self.request.POST.get("_all"))
+        saved_view_id = request.GET.get("saved_view", "")
+
+        self.key_params = {
+            "content_type": ContentType.objects.get_for_model(model),
+            "edit_all": edit_all,
+            "filter_query_params": convert_querydict_to_dict(request.GET),
+            "pk_list": self.pk_list,
+            "saved_view_id": saved_view_id,
+        }
+
         form_custom_fields = getattr(form, "custom_fields", [])
         form_relationships = getattr(form, "relationships", [])
         # Standard fields are those that are intrinsic to self.model in the form
@@ -1385,14 +1350,12 @@ class ObjectBulkUpdateViewMixin(NautobotViewSetMixin, BulkUpdateModelMixin, Bulk
             if field not in form_custom_fields + form_relationships + ["pk"] + ["object_note"]
         ]
         nullified_fields = request.POST.getlist("_nullify") or []
+
         with deferred_change_logging_for_bulk_operation():
             updated_objects = []
-            edit_all = self.request.POST.get("_all")
 
-            if edit_all:
-                queryset = self._get_bulk_edit_delete_all_queryset(self.request)
-            else:
-                queryset = queryset.filter(pk__in=form.cleaned_data["pk"])
+            queryset = get_bulk_queryset_from_view(user=request.user, action="change", **self.key_params)
+
             for obj in queryset:
                 self.obj = obj
                 # Update standard fields. If a field is listed in _nullify, delete its value.
@@ -1464,14 +1427,21 @@ class ObjectBulkUpdateViewMixin(NautobotViewSetMixin, BulkUpdateModelMixin, Bulk
         request.POST "_edit": Function to render the user selection of objects in a table form/BulkUpdateForm via Response that is passed to NautobotHTMLRenderer.
         request.POST "_apply": Function to validate the table form/BulkUpdateForm and to perform the action of bulk update. Render the form with errors if exceptions are raised.
         """
-        edit_all = request.POST.get("_all")
+        _queryset = self.get_queryset()
+        model = _queryset.model
+        self.pk_list = list(request.POST.getlist("pk"))
+        edit_all = bool(self.request.POST.get("_all"))
+        saved_view_id = request.GET.get("saved_view", "")
+
+        self.key_params = {
+            "content_type": ContentType.objects.get_for_model(model),
+            "edit_all": edit_all,
+            "filter_query_params": convert_querydict_to_dict(request.GET),
+            "pk_list": self.pk_list,
+            "saved_view_id": saved_view_id,
+        }
 
-        if edit_all:
-            self.pk_list = None
-            queryset = self._get_bulk_edit_delete_all_queryset(request)
-        else:
-            self.pk_list = list(request.POST.getlist("pk"))
-            queryset = self.get_queryset().filter(pk__in=self.pk_list)
+        queryset = get_bulk_queryset_from_view(user=request.user, action="change", **self.key_params)
 
         data = {}
         form_class = self.get_form_class()
@@ -1480,7 +1450,7 @@ class ObjectBulkUpdateViewMixin(NautobotViewSetMixin, BulkUpdateModelMixin, Bulk
             form = form_class(queryset.model, request.POST, edit_all=edit_all)
             restrict_form_fields(form, request.user)
             if form.is_valid():
-                return self.send_bulk_edit_objects_to_job(self.request, form.cleaned_data, queryset.model)
+                return self.send_bulk_edit_objects_to_job(request, form.cleaned_data)
             else:
                 return self.form_invalid(form)
         table = None