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

nautobot/core/jobs/bulk_actions.py

@@ -7,10 +7,9 @@ from django.core.exceptions import (
 )
 from django.db.models import ManyToManyField, ProtectedError
 
-from nautobot.core import exceptions
 from nautobot.core.forms.utils import restrict_form_fields
-from nautobot.core.utils.filtering import get_filterset_field
-from nautobot.core.utils.lookup import get_filterset_for_model, get_form_for_model
+from nautobot.core.utils.lookup import get_form_for_model
+from nautobot.core.views.utils import get_bulk_queryset_from_view
 from nautobot.extras.context_managers import deferred_change_logging_for_bulk_operation
 from nautobot.extras.jobs import (
     BooleanVar,
@@ -19,6 +18,7 @@ from nautobot.extras.jobs import (
     ObjectVar,
     RunJobTaskFailed,
 )
+from nautobot.extras.models import SavedView
 from nautobot.extras.utils import bulk_delete_with_bulk_change_logging, remove_prefix_from_cf_key
 
 name = "System Jobs"
@@ -32,8 +32,10 @@ class BulkEditObjects(Job):
         description="Type of objects to update",
     )
     form_data = JSONVar(description="BulkEditForm data")
+    pk_list = JSONVar(description="List of objects pks to edit", required=False)
     edit_all = BooleanVar(description="Bulk Edit all object / all filtered objects", required=False)
     filter_query_params = JSONVar(label="Filter Query Params", required=False)
+    saved_view = ObjectVar(model=SavedView, required=False)
 
     class Meta:
         name = "Bulk Edit Objects"
@@ -41,42 +43,14 @@ class BulkEditObjects(Job):
         has_sensitive_variables = False
         soft_time_limit = 1800
         time_limit = 2000
+        hidden = True
+
+    def _update_objects(self, model, form, filter_query_params, pk_list, edit_all, nullified_fields, saved_view_id):
+        base_queryset = model.objects.restrict(self.user, "change")
+        queryset = get_bulk_queryset_from_view(user=self.user, action="change", log=self.logger, **self.key_params)
 
-    def _update_objects(self, model, form, filter_query_params, edit_all, nullified_fields):
         with deferred_change_logging_for_bulk_operation():
-            base_queryset = model.objects.restrict(self.user, "change")
             updated_objects_pk = []
-            filterset_cls = get_filterset_for_model(model)
-
-            if filter_query_params:
-                if not filterset_cls:
-                    self.logger.error(f"Filterset not found for {model._meta.verbose_name}")
-                    raise RunJobTaskFailed(
-                        f"Filter query provided but {model._meta.verbose_name} does not have a filterset."
-                    )
-
-                # Discarding non-filter query params
-                new_filter_query_params = {}
-
-                for key, value in filter_query_params.items():
-                    try:
-                        get_filterset_field(filterset_cls(), key)
-                        new_filter_query_params[key] = value
-                    except exceptions.FilterSetFieldNotFound:
-                        self.logger.debug(
-                            f"Query parameter `{key}` not found in filterset for `{filterset_cls}`, discarding it"
-                        )
-
-                filter_query_params = new_filter_query_params
-
-            if edit_all:
-                if filter_query_params:
-                    queryset = filterset_cls(filter_query_params).qs.restrict(self.user, "change")
-                else:
-                    queryset = model.objects.restrict(self.user, "change")
-            else:
-                queryset = model.objects.restrict(self.user, "change").filter(pk__in=form.cleaned_data["pk"])
-
             form_custom_fields = getattr(form, "custom_fields", [])
             form_relationships = getattr(form, "relationships", [])
             standard_fields = [
@@ -130,14 +104,18 @@ class BulkEditObjects(Job):
                 if hasattr(form, "save_note") and callable(form.save_note):
                     form.save_note(instance=obj, user=self.user)
             total_updated_objs = len(updated_objects_pk)
-            # Enforce object-level permissions
+            # Enforce object-level permissions. This works because we used .restrict() above and if the user
+            # doesn't have permission to change one of the objects after the change, it won't be in base_queryset
+            # filtered to the pks of the objects we just changed.
             if base_queryset.filter(pk__in=updated_objects_pk).count() != total_updated_objs:
                 raise ObjectDoesNotExist
             return total_updated_objs
 
-    def _process_valid_form(self, model, form, filter_query_params, edit_all, nullified_fields):
+    def _process_valid_form(self, model, form, filter_query_params, pk_list, edit_all, nullified_fields, saved_view_id):
         try:
-            total_updated_objs = self._update_objects(model, form, filter_query_params, edit_all, nullified_fields)
+            total_updated_objs = self._update_objects(
+                model, form, filter_query_params, pk_list, edit_all, nullified_fields, saved_view_id
+            )
             msg = f"Updated {total_updated_objs} {model._meta.verbose_name_plural}"
             self.logger.info(msg)
             return msg
@@ -149,12 +127,24 @@ class BulkEditObjects(Job):
         raise RunJobTaskFailed("Bulk Edit not fully successful, see logs")
 
     def run(  # pylint: disable=arguments-differ
-        self, *, content_type, form_data, edit_all=False, filter_query_params=None
+        self, *, content_type, form_data, pk_list=None, edit_all=False, filter_query_params=None, saved_view=None
     ):
+        saved_view_id = saved_view.pk if saved_view is not None else None
+        if not filter_query_params:
+            filter_query_params = {}
+
         if not self.user.has_perm(f"{content_type.app_label}.change_{content_type.model}"):
             self.logger.error('User "%s" does not have permission to update %s objects', self.user, content_type.model)
             raise PermissionDenied("User does not have change permissions on the requested content-type")
 
+        self.key_params = {
+            "content_type": content_type,
+            "edit_all": edit_all,
+            "filter_query_params": filter_query_params,
+            "pk_list": pk_list,
+            "saved_view_id": saved_view_id,
+        }
+
         model = content_type.model_class()
         if model is None:
             self.logger.error(
@@ -178,7 +168,9 @@ class BulkEditObjects(Job):
         if form.is_valid():
             self.logger.debug("Form validation was successful")
             nullified_fields = form_data.get("_nullify")
-            return self._process_valid_form(model, form, filter_query_params, edit_all, nullified_fields)
+            return self._process_valid_form(
+                model, form, filter_query_params, pk_list, edit_all, nullified_fields, saved_view_id
+            )
         else:
             self.logger.error(f"Form validation unsuccessful: {form.errors.as_json()}")
 
@@ -197,6 +189,7 @@ class BulkDeleteObjects(Job):
     pk_list = JSONVar(description="List of objects pks to delete", required=False)
     delete_all = BooleanVar(description="Delete all (filtered) objects instead of a list of PKs", required=False)
     filter_query_params = JSONVar(label="Filter Query Params", required=False)
+    saved_view = ObjectVar(model=SavedView, required=False)
 
     class Meta:
         name = "Bulk Delete Objects"
@@ -204,14 +197,26 @@ class BulkDeleteObjects(Job):
         has_sensitive_variables = False
         soft_time_limit = 1800
         time_limit = 2000
+        hidden = True
 
     def run(  # pylint: disable=arguments-differ
-        self, *, content_type, pk_list=None, delete_all=False, filter_query_params=None
+        self, *, content_type, pk_list=None, delete_all=False, filter_query_params=None, saved_view=None
     ):
+        saved_view_id = saved_view.pk if saved_view is not None else None
+        if not filter_query_params:
+            filter_query_params = {}
         if not self.user.has_perm(f"{content_type.app_label}.delete_{content_type.model}"):
             self.logger.error('User "%s" does not have permission to delete %s objects', self.user, content_type.model)
             raise PermissionDenied("User does not have delete permissions on the requested content-type")
 
+        key_params = {
+            "content_type": content_type,
+            "delete_all": delete_all,
+            "filter_query_params": filter_query_params,
+            "pk_list": pk_list,
+            "saved_view_id": saved_view_id,
+        }
+
         model = content_type.model_class()
         if model is None:
             self.logger.error(
@@ -221,49 +226,7 @@ class BulkDeleteObjects(Job):
             )
             raise RunJobTaskFailed("Model not found")
 
-        filterset_cls = get_filterset_for_model(model)
-
-        if filter_query_params:
-            if not filterset_cls:
-                self.logger.error(f"Filterset not found for {model._meta.verbose_name}")
-                raise RunJobTaskFailed(
-                    f"Filter query provided but {model._meta.verbose_name} does not have a filterset."
-                )
-
-            # Discarding non-filter query params
-            new_filter_query_params = {}
-
-            for key, value in filter_query_params.items():
-                try:
-                    get_filterset_field(filterset_cls(), key)
-                    new_filter_query_params[key] = value
-                except exceptions.FilterSetFieldNotFound:
-                    self.logger.debug(f"Query parameter `{key}` not found in `{filterset_cls}`, discarding it")
-
-            filter_query_params = new_filter_query_params
-
-        if delete_all:
-            # Case for selecting all objects (or all filtered objects) to delete
-            if filter_query_params:
-                # If there is filter query params, we need to apply it to the queryset
-                queryset = filterset_cls(filter_query_params).qs.restrict(self.user, "delete")
-                # 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 = model.objects.filter(pk__in=queryset)
-            else:
-                # If there is not, we can just restrict the queryset to the user's permissions
-                queryset = model.objects.restrict(self.user, "delete")
-        elif pk_list:
-            # Case for selecting specific objects to delete, delete_all overrides this option
-            queryset = model.objects.restrict(self.user, "delete").filter(pk__in=pk_list)
-            if queryset.count() < len(pk_list):
-                # We do not check ObjectPermission error for `delete_all` case because user is trying to
-                # delete all objs they have permission to which would not raise any issue.
-                self.logger.error("You do not have permissions to delete some of the objects provided in `pk_list`.")
-                raise RunJobTaskFailed("Caught ObjectPermission error while attempting to delete objects")
-        elif not pk_list and not delete_all:
-            self.logger.error("You must select at least one object instance to delete.")
-            raise RunJobTaskFailed("Either `pk_list` or `delete_all` is required.")
+        queryset = get_bulk_queryset_from_view(user=self.user, action="delete", log=self.logger, **key_params)
 
         verbose_name_plural = model._meta.verbose_name_plural
 

nautobot/core/models/querysets.py

@@ -122,7 +122,8 @@ class RestrictedQuerySet(CompositeKeyQuerySetMixin, QuerySet):
 
         # Bypass restriction for superusers and exempt views
         if user.is_superuser or permissions.permission_is_exempt(permission_required):
-            qs = self
+            # This is a cache buster to ensure that we always return a new QuerySet
+            qs = self.all()
 
         # User is anonymous or has not been granted the requisite permission
         elif not user.is_authenticated or permission_required not in user.get_all_permissions():

nautobot/core/settings.py

@@ -157,6 +157,7 @@ METRICS_AUTHENTICATED = is_truthy(os.getenv("NAUTOBOT_METRICS_AUTHENTICATED", "F
 METRICS_DISABLED_APPS = []
 if "NAUTOBOT_METRICS_DISABLED_APPS" in os.environ and os.environ["NAUTOBOT_METRICS_DISABLED_APPS"] != "":
     METRICS_DISABLED_APPS = os.getenv("NAUTOBOT_METRICS_DISABLED_APPS", "").split(_CONFIG_SETTING_SEPARATOR)
+METRICS_EXPERIMENTAL_CACHING_DURATION = int(os.getenv("NAUTOBOT_METRICS_EXPERIMENTAL_CACHING_DURATION", "0"))
 
 # Napalm
 NAPALM_ARGS = {}

nautobot/core/settings.yaml

@@ -1377,6 +1377,15 @@ properties:
     see_also:
       "Guide to Nautobot Prometheus metrics": "../guides/prometheus-metrics.md"
     type: "boolean"
+  METRICS_EXPERIMENTAL_CACHING_DURATION:
+    default: 0
+    description: >-
+      The number of seconds to cache Nautobot App metrics before refreshing them.
+      A value of `0` means no caching (i.e. always recompute metrics on each request). This feature is experimental
+      and may change or be removed in a future release, including patch releases.
+    environment_variable: "NAUTOBOT_METRICS_EXPERIMENTAL_CACHING_DURATION"
+    type: "integer"
+    version_added: "2.4.18"
   NAPALM_ARGS:
     additionalProperties: true
     default: {}

nautobot/core/tables.py

@@ -17,7 +17,6 @@ import django_tables2
 from django_tables2.data import TableData, TableQuerysetData
 from django_tables2.rows import BoundRows
 from django_tables2.utils import Accessor, OrderBy, OrderByTuple
-from tree_queries.models import TreeNode
 
 from nautobot.core.models.querysets import count_related
 from nautobot.core.templatetags import helpers
@@ -107,6 +106,12 @@ class BaseTable(django_tables2.Table):
         if order_by is None and saved_view is not None:
             order_by = saved_view.config.get("sort_order", None)
 
+        # Don't show hierarchy if we're sorted
+        if order_by is not None and hide_hierarchy_ui is None:
+            hide_hierarchy_ui = True
+
+        self.hide_hierarchy_ui = hide_hierarchy_ui
+
         # Init table
         super().__init__(*args, order_by=order_by, **kwargs)
 
@@ -118,12 +123,6 @@ class BaseTable(django_tables2.Table):
                 *[column.name for column in self.columns if isinstance(column.column, LinkedCountColumn)],
             ]
 
-        # Don't show hierarchy if we're sorted
-        if order_by is not None and hide_hierarchy_ui is None:
-            hide_hierarchy_ui = True
-
-        self.hide_hierarchy_ui = hide_hierarchy_ui
-
         # Set default empty_text if none was provided
         if self.empty_text is None:
             self.empty_text = f"No {self._meta.model._meta.verbose_name_plural} found"
@@ -304,6 +303,10 @@ class BaseTable(django_tables2.Table):
         Arguments:
             value: iterable or comma separated string of order by aliases.
         """
+        # The below block of code is copied from Table.order_by()
+        # due to limitations in directly calling parent class methods within a property setter.
+        # See Python bug report: https://bugs.python.org/issue14965
+
         # collapse empty values to ()
         order_by = () if not value else value
         # accept string
@@ -316,22 +319,17 @@ class BaseTable(django_tables2.Table):
                 valid.append(alias)
         self._order_by = OrderByTuple(valid)
 
-        # The above block of code is copied from super().order_by
-        # due to limitations in directly calling parent class methods within a property setter.
-        # See Python bug report: https://bugs.python.org/issue14965
-        model = getattr(self.Meta, "model", None)
-        if model and issubclass(model, TreeNode):
-            # Use the TreeNode model's approach to sorting
-            queryset = self.data.data
-            # If the data passed into the Table is a list (as in cases like BulkImport post),
-            # convert this list to a queryset.
-            # This ensures consistent behavior regardless of the input type.
-            if isinstance(self.data.data, list):
-                queryset = model.objects.filter(pk__in=[instance.pk for instance in self.data.data])
-            self.data.data = queryset.extra(order_by=self._order_by)
-        else:
-            # Otherwise, use the default sorting method
-            self.data.order_by(self._order_by)
+        # Nautobot-specific logic begins here
+        if self._order_by:
+            self.hide_hierarchy_ui = True
+            if isinstance(self.data.data, QuerySet) and hasattr(self.data.data, "without_tree_fields"):
+                self.data.data = self.data.data.without_tree_fields()
+        elif not self.hide_hierarchy_ui:
+            if isinstance(self.data.data, QuerySet) and hasattr(self.data.data, "with_tree_fields"):
+                self.data.data = self.data.data.with_tree_fields()
+
+        # Resume base class implementation
+        self.data.order_by(self._order_by)
 
     def add_conditional_prefetch(self, table_field, db_column=None, prefetch=None):
         """Conditionally prefetch the specified database column if the related table field is visible.

nautobot/core/templates/40x.html

@@ -2,22 +2,22 @@
 {% load helpers %}
 
 {% block content %}
-<div class="row" style="margin-top: 150px;">
-    <div class="col-sm-4 col-sm-offset-4">
-        <div class="panel panel-default">
-            <div class="panel-heading">
-                <strong>{% block icon %}{% endblock %} {% block title %}{% endblock %}</strong>
-            </div>
-            <div class="panel-body">
-                <p>
-                    {% block message %}{% endblock %}
-                </p>
-                {% support_message %}
-            </div>
-            <div class="panel-footer text-right">
-                <a href="{% url 'home' %}" class="btn btn-xs btn-primary">Home Page</a>
+    <div class="row" style="margin-top: 150px;">
+        <div class="col-sm-4 col-sm-offset-4">
+            <div class="panel panel-default">
+                <div class="panel-heading">
+                    <strong>{% block icon %}{% endblock %} {% block title %}{% endblock %}</strong>
+                </div>
+                <div class="panel-body">
+                    <p>
+                        {% block message %}{% endblock %}
+                    </p>
+                    {% support_message %}
+                </div>
+                <div class="panel-footer text-right">
+                    <a href="{% url 'home' %}" class="btn btn-xs btn-primary">Home Page</a>
+                </div>
             </div>
         </div>
     </div>
-</div>
 {% endblock %}

nautobot/core/templates/500.html

@@ -4,34 +4,34 @@
 {% block title %}Server Error{% endblock %}
 
 {% block content %}
-<div class="row" style="margin-top: 150px;">
-    <div class="col-sm-4 col-sm-offset-4">
-        <div class="panel panel-default">
-            <div class="panel-heading">
-                <strong><i class="mdi mdi-alert"></i>Server Error</strong>
-            </div>
-            <div class="panel-body">
-                {% block message %}
-                <p>
-                    There was a problem with your request. Please contact an administrator.
-                </p>
-                {% endblock %}
-                <hr />
-                <p>
-                    The complete exception is provided below:
-                </p>
+    <div class="row" style="margin-top: 150px;">
+        <div class="col-sm-4 col-sm-offset-4">
+            <div class="panel panel-default">
+                <div class="panel-heading">
+                    <strong><i class="mdi mdi-alert"></i>Server Error</strong>
+                </div>
+                <div class="panel-body">
+                    {% block message %}
+                        <p>
+                            There was a problem with your request. Please contact an administrator.
+                        </p>
+                    {% endblock %}
+                    <hr />
+                    <p>
+                        The complete exception is provided below:
+                    </p>
 <pre><strong>{{ exception }}</strong><br />
 {{ error }}
 
 Python version: {{ python_version }}
 Nautobot version: {{ nautobot_version }}
 </pre>
-                {% support_message %}
-            </div>
-            <div class="panel-footer text-right">
-                <a href="{% url 'home' %}" class="btn btn-xs btn-primary">Home Page</a>
+                    {% support_message %}
+                </div>
+                <div class="panel-footer text-right">
+                    <a href="{% url 'home' %}" class="btn btn-xs btn-primary">Home Page</a>
+                </div>
             </div>
         </div>
     </div>
-</div>
 {% endblock %}

nautobot/core/templates/admin/app_index.html

@@ -4,14 +4,14 @@
 {% block bodyclass %}{{ block.super }} app-{{ app_label }}{% endblock %}
 
 {% if not is_popup %}
-{% block breadcrumbs %}
-  <ol class="breadcrumb">
-    <li><a href="{% url 'admin:index' %}">{% trans 'Admin Home' %}</a></li>
-    {% for app in app_list %}
-      <li>{{ app.name }}</li>
-    {% endfor %}
-  </ol>
-  {% endblock %}
+    {% block breadcrumbs %}
+        <ol class="breadcrumb">
+            <li><a href="{% url 'admin:index' %}">{% trans 'Admin Home' %}</a></li>
+            {% for app in app_list %}
+                <li>{{ app.name }}</li>
+            {% endfor %}
+        </ol>
+    {% endblock %}
 {% endif %}
 
 {% block sidebar %}{% endblock %}