nautobot 2.0.4__py3-none-any.whl → 2.1.0b1__py3-none-any.whl

nautobot/extras/signals.py

@@ -5,9 +5,13 @@ import shutil
 import logging
 from datetime import timedelta
 
+from db_file_storage.model_utils import delete_file
+from db_file_storage.storage import DatabaseFileStorage
+from django.conf import settings
 from django.contrib.contenttypes.models import ContentType
 from django.core.cache import cache
 from django.core.exceptions import ValidationError
+from django.core.files.storage import get_storage_class
 from django.db import transaction
 from django.db.models.signals import m2m_changed, pre_delete, post_save, pre_save, post_delete
 from django.dispatch import receiver
@@ -16,13 +20,19 @@ from django_prometheus.models import model_deletes, model_inserts, model_updates
 
 from nautobot.core.celery import app, import_jobs_as_celery_tasks
 from nautobot.core.utils.config import get_settings_or_config
+from nautobot.extras.constants import CHANGELOG_MAX_CHANGE_CONTEXT_DETAIL
+from nautobot.extras.choices import JobResultStatusChoices, ObjectChangeActionChoices
+from nautobot.extras.models import (
+    CustomField,
+    DynamicGroup,
+    DynamicGroupMembership,
+    GitRepository,
+    JobResult,
+    ObjectChange,
+)
+from nautobot.extras.querysets import NotesQuerySet
 from nautobot.extras.tasks import delete_custom_field_data, provision_field
 from nautobot.extras.utils import refresh_job_model_from_job_class
-from nautobot.extras.constants import CHANGELOG_MAX_CHANGE_CONTEXT_DETAIL
-from .choices import JobResultStatusChoices, ObjectChangeActionChoices
-from .models import CustomField, DynamicGroup, DynamicGroupMembership, GitRepository, JobResult, ObjectChange
-from .querysets import NotesQuerySet
-from .webhooks import enqueue_webhooks
 
 
 # thread safe change context state variable
@@ -31,11 +41,11 @@ logger = logging.getLogger(__name__)
 
 
 #
-# Change logging/webhooks
+# Change logging
 #
 
 
-def _get_user_if_authenticated(user, objectchange):
+def _get_user_if_authenticated(user, instance):
     """Return the user object associated with the request if the user is defined.
 
     If the user is not defined, log a warning to indicate that the user couldn't be retrived from the request
@@ -45,7 +55,7 @@ def _get_user_if_authenticated(user, objectchange):
     if user.is_authenticated:
         return user
     else:
-        logger.warning(f"Unable to retrieve the user while creating the changelog for {objectchange.changed_object}")
+        logger.warning(f"Unable to retrieve the user while creating the changelog for {instance}")
         return None
 
 
@@ -55,7 +65,6 @@ def _handle_changed_object(sender, instance, raw=False, **kwargs):
     """
     Fires when an object is created or updated.
     """
-    from .jobs import enqueue_job_hooks  # avoid circular import
 
     if raw:
         return
@@ -63,8 +72,6 @@ def _handle_changed_object(sender, instance, raw=False, **kwargs):
     if change_context_state.get() is None:
         return
 
-    object_m2m_changed = False
-
     # Determine the type of change being made
     if kwargs.get("created"):
         action = ObjectChangeActionChoices.ACTION_CREATE
@@ -72,38 +79,36 @@ def _handle_changed_object(sender, instance, raw=False, **kwargs):
         action = ObjectChangeActionChoices.ACTION_UPDATE
     elif kwargs.get("action") in ["post_add", "post_remove"] and kwargs["pk_set"]:
         # m2m_changed with objects added or removed
-        object_m2m_changed = True
         action = ObjectChangeActionChoices.ACTION_UPDATE
     else:
         return
 
     # Record an ObjectChange if applicable
     if hasattr(instance, "to_objectchange"):
+        user = _get_user_if_authenticated(change_context_state.get().get_user(), instance)
         # save a copy of this instance's field cache so it can be restored after serialization
         # to prevent unexpected behavior when chaining multiple signal handlers
         original_cache = instance._state.fields_cache.copy()
-        if object_m2m_changed:
-            related_changes = ObjectChange.objects.filter(
-                changed_object_type=ContentType.objects.get_for_model(instance),
-                changed_object_id=instance.pk,
-                request_id=change_context_state.get().change_id,
-            )
-            m2m_changes = instance.to_objectchange(action)
-            if related_changes.exists():
-                related_changes.update(object_data=m2m_changes.object_data, object_data_v2=m2m_changes.object_data_v2)
-                objectchange = related_changes.first()
-            else:
-                objectchange = m2m_changes
-                objectchange.user = _get_user_if_authenticated(change_context_state.get().get_user(), objectchange)
-                objectchange.request_id = change_context_state.get().change_id
-                objectchange.change_context = change_context_state.get().context
-                objectchange.change_context_detail = change_context_state.get().context_detail[
-                    :CHANGELOG_MAX_CHANGE_CONTEXT_DETAIL
-                ]
-                objectchange.save()
+
+        # If a change already exists for this change_id, user, and object, update it instead of creating a new one.
+        # If the object was deleted then recreated with the same pk (don't do this), change the action to update.
+        related_changes = ObjectChange.objects.filter(
+            changed_object_type=ContentType.objects.get_for_model(instance),
+            changed_object_id=instance.pk,
+            user=user,
+            request_id=change_context_state.get().change_id,
+        )
+        objectchange = instance.to_objectchange(action)
+        if related_changes.exists():
+            most_recent_change = related_changes.order_by("-time").first()
+            if most_recent_change.action == ObjectChangeActionChoices.ACTION_DELETE:
+                most_recent_change.action = ObjectChangeActionChoices.ACTION_UPDATE
+            most_recent_change.object_data = objectchange.object_data
+            most_recent_change.object_data_v2 = objectchange.object_data_v2
+            most_recent_change.save()
+            objectchange = most_recent_change
         else:
-            objectchange = instance.to_objectchange(action)
-            objectchange.user = _get_user_if_authenticated(change_context_state.get().get_user(), objectchange)
+            objectchange.user = user
             objectchange.request_id = change_context_state.get().change_id
             objectchange.change_context = change_context_state.get().context
             objectchange.change_context_detail = change_context_state.get().context_detail[
@@ -114,12 +119,6 @@ def _handle_changed_object(sender, instance, raw=False, **kwargs):
         # restore field cache
         instance._state.fields_cache = original_cache
 
-        # Enqueue job hooks
-        enqueue_job_hooks(objectchange)
-
-    # Enqueue webhooks
-    enqueue_webhooks(instance, change_context_state.get().get_user(), change_context_state.get().change_id, action)
-
     # Increment metric counters
     if action == ObjectChangeActionChoices.ACTION_CREATE:
         model_inserts.labels(instance._meta.model_name).inc()
@@ -138,8 +137,6 @@ def _handle_deleted_object(sender, instance, **kwargs):
     """
     Fires when an object is deleted.
     """
-    from .jobs import enqueue_job_hooks  # avoid circular import
-
     if change_context_state.get() is None:
         return
 
@@ -149,32 +146,45 @@ def _handle_deleted_object(sender, instance, **kwargs):
 
     # Record an ObjectChange if applicable
     if hasattr(instance, "to_objectchange"):
+        user = _get_user_if_authenticated(change_context_state.get().get_user(), instance)
+
         # save a copy of this instance's field cache so it can be restored after serialization
         # to prevent unexpected behavior when chaining multiple signal handlers
         original_cache = instance._state.fields_cache.copy()
+
+        # if a change already exists for this change_id, user, and object, update it instead of creating a new one
+        # except in the case that the object was created and deleted in the same change_id
+        # we don't want to create a delete change for an object that never existed
+        related_changes = ObjectChange.objects.filter(
+            changed_object_type=ContentType.objects.get_for_model(instance),
+            changed_object_id=instance.pk,
+            user=user,
+            request_id=change_context_state.get().change_id,
+        )
         objectchange = instance.to_objectchange(ObjectChangeActionChoices.ACTION_DELETE)
-        objectchange.user = _get_user_if_authenticated(change_context_state.get().get_user(), objectchange)
-        objectchange.request_id = change_context_state.get().change_id
-        objectchange.change_context = change_context_state.get().context
-        objectchange.change_context_detail = change_context_state.get().context_detail[
-            :CHANGELOG_MAX_CHANGE_CONTEXT_DETAIL
-        ]
-        objectchange.save()
+        save_new_objectchange = True
+        if related_changes.exists():
+            most_recent_change = related_changes.order_by("-time").first()
+            if most_recent_change.action != ObjectChangeActionChoices.ACTION_CREATE:
+                most_recent_change.action = ObjectChangeActionChoices.ACTION_DELETE
+                most_recent_change.object_data = objectchange.object_data
+                most_recent_change.object_data_v2 = objectchange.object_data_v2
+                most_recent_change.save()
+                objectchange = most_recent_change
+                save_new_objectchange = False
+
+        if save_new_objectchange:
+            objectchange.user = user
+            objectchange.request_id = change_context_state.get().change_id
+            objectchange.change_context = change_context_state.get().context
+            objectchange.change_context_detail = change_context_state.get().context_detail[
+                :CHANGELOG_MAX_CHANGE_CONTEXT_DETAIL
+            ]
+            objectchange.save()
 
         # restore field cache
         instance._state.fields_cache = original_cache
 
-        # Enqueue job hooks
-        enqueue_job_hooks(objectchange)
-
-    # Enqueue webhooks
-    enqueue_webhooks(
-        instance,
-        change_context_state.get().get_user(),
-        change_context_state.get().change_id,
-        ObjectChangeActionChoices.ACTION_DELETE,
-    )
-
     # Increment metric counters
     model_deletes.labels(instance._meta.model_name).inc()
 
@@ -340,6 +350,17 @@ post_save.connect(dynamic_group_update_cached_members, sender=DynamicGroupMember
 #
 
 
+@receiver(pre_delete, sender=JobResult)
+def job_result_delete_associated_files(instance, **kwargs):
+    """For each related FileProxy, make sure its file gets deleted correctly from disk or database."""
+    if get_storage_class(settings.JOB_FILE_IO_STORAGE) == DatabaseFileStorage:
+        for file_proxy in instance.files.all():
+            delete_file(file_proxy, "file")
+    else:
+        for file_proxy in instance.files.all():
+            file_proxy.file.delete()
+
+
 def refresh_job_models(sender, *, apps, **kwargs):
     """
     Callback for the nautobot_database_ready signal; updates Jobs in the database based on Job source file availability.

nautobot/extras/tables.py

@@ -1,7 +1,6 @@
 import django_tables2 as tables
 from django.conf import settings
 from django.utils.html import format_html
-from django.utils.safestring import mark_safe
 from django_tables2.utils import Accessor
 from jsonschema.exceptions import ValidationError as JSONSchemaValidationError
 
@@ -27,6 +26,7 @@ from .models import (
     DynamicGroup,
     DynamicGroupMembership,
     ExportTemplate,
+    ExternalIntegration,
     GitRepository,
     GraphQLQuery,
     Job as JobModel,
@@ -236,7 +236,7 @@ class CustomFieldTable(BaseTable):
 
     def render_description(self, record):
         if record.description:
-            return mark_safe(render_markdown(record.description))
+            return render_markdown(record.description)
         return self.default
 
 
@@ -408,6 +408,32 @@ class ExportTemplateTable(BaseTable):
         )
 
 
+class ExternalIntegrationTable(BaseTable):
+    pk = ToggleColumn()
+    name = tables.Column(linkify=True)
+    remote_url = tables.Column(linkify=False)
+    secrets_group = tables.Column(linkify=True)
+
+    class Meta(BaseTable.Meta):
+        model = ExternalIntegration
+        fields = (
+            "pk",
+            "name",
+            "remote_url",
+            "secrets_group",
+            "verify_ssl",
+            "timeout",
+        )
+        default_columns = (
+            "pk",
+            "name",
+            "remote_url",
+            "secrets_group",
+            "verify_ssl",
+            "timeout",
+        )
+
+
 class GitRepositoryTable(BaseTable):
     pk = ToggleColumn()
     name = tables.LinkColumn()

nautobot/extras/templates/extras/externalintegration_retrieve.html

@@ -0,0 +1,37 @@
+{% extends 'generic/object_retrieve.html' %}
+{% load helpers %}
+
+{% block content_left_page %}
+        <div class="panel panel-default">
+            <div class="panel-heading">
+                <strong>External Integration</strong>
+            </div>
+
+            <table class="table table-hover panel-body attr-table">
+                <tr>
+                    <td>Name</td>
+                    <td>{{ object.name }}</td>
+                </tr>
+                <tr>
+                    <td>Remote URL</td>
+                    <td>{{ object.remote_url }}</td>
+                </tr>
+                <tr>
+                    <td>Verify SSL</td>
+                    <td>{{ object.verify_ssl | render_boolean }}</td>
+                </tr>
+                <tr>
+                    <td>Secrets Group</td>
+                    <td>{{ object.secrets_group | hyperlinked_object }}</td>
+                </tr>
+                <tr>
+                    <td>Timeout</td>
+                    <td>{{ object.timeout }}</td>
+                </tr>
+                <tr>
+                    <td>Extra Config</td>
+                    <td><pre>{{ object.extra_config | render_json }}</pre></td>
+                </tr>
+            </table>
+        </div>
+{% endblock content_left_page %}

nautobot/extras/templates/extras/inc/jobresult.html

@@ -50,6 +50,30 @@
             {% endif %}
             </td>
         </tr>
+        {% if result.files.exists %}
+            <tr>
+                <td>File Output(s)</td>
+                <td>
+                    <ul>
+                        {% for file_proxy in result.files.all %}
+                            {% if file_proxy.file %}
+                                <li>
+                                    <a
+                                    {% if settings.JOB_FILE_IO_STORAGE == "db_file_storage.storage.DatabaseFileStorage" %}
+                                        href="{% url "db_file_storage.download_file" %}?name={{ file_proxy.file }}"
+                                    {% else %}
+                                        href="{{ file_proxy.file.url }}"
+                                    {% endif %}
+                                        download="{{ file_proxy.name }}">
+                                        {{ file_proxy.name }}
+                                    </a>
+                                </li>
+                            {% endif %}
+                        {% endfor %}
+                    </ul>
+                </td>
+            </tr>
+        {% endif %}
     </table>
 </div>
 

nautobot/extras/templates/extras/jobresult.html

@@ -118,6 +118,30 @@
                         {% include 'extras/inc/json_data.html' with data=result.result format="json" %}
                     </div>
                 </div>
+                <div class="panel panel-default">
+                    <div class="panel-heading">
+                        <strong>File Output(s)</strong>
+                    </div>
+                    <div class="panel-body">
+                        <ul>
+                            {% for file_proxy in result.files.all %}
+                                {% if file_proxy.file %}
+                                    <li>
+                                        <a
+                                        {% if settings.JOB_FILE_IO_STORAGE == "db_file_storage.storage.DatabaseFileStorage" %}
+                                            href="{% url "db_file_storage.download_file" %}?name={{ file_proxy.file }}"
+                                        {% else %}
+                                            href="{{ file_proxy.file.url }}"
+                                        {% endif %}
+                                            download="{{ file_proxy.name }}">
+                                            {{ file_proxy.name }}
+                                        </a>
+                                    </li>
+                                {% endif %}
+                            {% endfor %}
+                        </ul>
+                    </div>
+                </div>
                 <div class="panel panel-default">
                     <div class="panel-heading">
                         <strong>Traceback</strong>

nautobot/extras/templatetags/computed_fields.py

@@ -1,7 +1,6 @@
 from django import template
 from django.contrib.contenttypes.models import ContentType
-from django.utils.html import escape
-from django.utils.safestring import mark_safe
+from django.utils.html import format_html_join
 
 from nautobot.extras.models import ComputedField
 
@@ -27,14 +26,8 @@ def computed_fields(context, obj, advanced_ui=None):
     if not computed_fields:
         return ""
 
-    template_code = ""
-
-    for label, value in fields.items():
-        escaped_label = escape(label)
-        template_code += f"""
-            <tr>
-                <td><span title="{escaped_label}">{escaped_label}</span></td>
-                <td>{escape(value)}</td>
-            <tr>
-            """
-    return mark_safe(template_code)
+    return format_html_join(
+        "\n",
+        '<tr><td><span title="{}">{}</span></td><td>{}</td></tr>',
+        ((label, label, value) for label, value in fields.items()),
+    )

nautobot/extras/templatetags/custom_links.py

@@ -2,6 +2,7 @@ from collections import OrderedDict
 
 from django import template
 from django.contrib.contenttypes.models import ContentType
+from django.utils.html import format_html
 from django.utils.safestring import mark_safe
 
 from nautobot.core.utils.data import render_jinja2
@@ -40,7 +41,7 @@ def custom_links(context, obj):
         "user": context["user"],  # django.contrib.auth.context_processors.auth
         "perms": context["perms"],  # django.contrib.auth.context_processors.auth
     }
-    template_code = ""
+    template_code = mark_safe("")  # noqa: S308
     group_names = OrderedDict()
 
     for cl in links:
@@ -57,16 +58,20 @@ def custom_links(context, obj):
                 if text_rendered:
                     link_rendered = render_jinja2(cl.target_url, link_context)
                     link_target = ' target="_blank"' if cl.new_window else ""
-                    template_code += LINK_BUTTON.format(link_rendered, link_target, cl.button_class, text_rendered)
+                    template_code += format_html(
+                        LINK_BUTTON, link_rendered, link_target, cl.button_class, text_rendered
+                    )
             except Exception as e:
-                template_code += (
-                    f'<a class="btn btn-sm btn-default" disabled="disabled" title="{e}">'
-                    f'<i class="mdi mdi-alert"></i> {cl.name}</a>\n'
+                template_code += format_html(
+                    '<a class="btn btn-sm btn-default" disabled="disabled" title="{}">'
+                    '<i class="mdi mdi-alert"></i> {}</a>\n',
+                    e,
+                    cl.name,
                 )
 
     # Add grouped links to template
     for group, links in group_names.items():
-        links_rendered = []
+        links_rendered = mark_safe("")  # noqa: S308
 
         for cl in links:
             try:
@@ -74,14 +79,16 @@ def custom_links(context, obj):
                 if text_rendered:
                     link_target = ' target="_blank"' if cl.new_window else ""
                     link_rendered = render_jinja2(cl.target_url, link_context)
-                    links_rendered.append(GROUP_LINK.format(link_rendered, link_target, text_rendered))
+                    links_rendered += format_html(GROUP_LINK, link_rendered, link_target, text_rendered)
             except Exception as e:
-                links_rendered.append(
-                    f'<li><a disabled="disabled" title="{e}"><span class="text-muted">'
-                    f'<i class="mdi mdi-alert"></i> {cl.name}</span></a></li>'
+                links_rendered += format_html(
+                    '<li><a disabled="disabled" title="{}"><span class="text-muted">'
+                    '<i class="mdi mdi-alert"></i> {}</span></a></li>',
+                    e,
+                    cl.name,
                 )
 
         if links_rendered:
-            template_code += GROUP_BUTTON.format(links[0].button_class, group, "".join(links_rendered))
+            template_code += format_html(GROUP_BUTTON, links[0].button_class, group, links_rendered)
 
-    return mark_safe(template_code)
+    return template_code

nautobot/extras/templatetags/job_buttons.py

@@ -3,6 +3,7 @@ from collections import OrderedDict
 from django import template
 from django.contrib.contenttypes.models import ContentType
 from django.urls import reverse
+from django.utils.html import format_html
 from django.utils.safestring import mark_safe
 
 from nautobot.extras.models import JobButton
@@ -87,10 +88,11 @@ def job_buttons(context, obj):
         "user": context["user"],  # django.contrib.auth.context_processors.auth
         "perms": context["perms"],  # django.contrib.auth.context_processors.auth
     }
-    buttons_html = forms_html = ""
+    buttons_html = forms_html = mark_safe("")  # noqa: S308
     group_names = OrderedDict()
 
-    hidden_inputs = HIDDEN_INPUTS.format(
+    hidden_inputs = format_html(
+        HIDDEN_INPUTS,
         csrf_token=context["csrf_token"],
         object_pk=obj.pk,
         object_model_name=f"{content_type.app_label}.{content_type.model}",
@@ -121,22 +123,24 @@ def job_buttons(context, obj):
                 if text_rendered:
                     template_args["button_text"] = text_rendered
                     if jb.confirmation:
-                        buttons_html += CONFIRM_BUTTON.format(**template_args)
-                        forms_html += CONFIRM_MODAL.format(**template_args)
+                        buttons_html += format_html(CONFIRM_BUTTON, **template_args)
+                        forms_html += format_html(CONFIRM_MODAL, **template_args)
                     else:
-                        buttons_html += NO_CONFIRM_BUTTON.format(**template_args)
-                        forms_html += NO_CONFIRM_FORM.format(**template_args)
+                        buttons_html += format_html(NO_CONFIRM_BUTTON, **template_args)
+                        forms_html += format_html(NO_CONFIRM_FORM, **template_args)
             except Exception as e:
-                buttons_html += (
-                    f'<a class="btn btn-sm btn-default" disabled="disabled" title="{e}">'
-                    f'<i class="mdi mdi-alert"></i> {jb.name}</a>\n'
+                buttons_html += format_html(
+                    '<a class="btn btn-sm btn-default" disabled="disabled" title="{}">'
+                    '<i class="mdi mdi-alert"></i> {}</a>\n',
+                    e,
+                    jb.name,
                 )
 
     # Add grouped buttons to template
     for group_name, buttons in group_names.items():
         group_button_class = buttons[0].button_class
 
-        buttons_rendered = ""
+        buttons_rendered = mark_safe("")  # noqa: S308
 
         for jb in buttons:
             template_args = {
@@ -154,23 +158,34 @@ def job_buttons(context, obj):
                 if text_rendered:
                     template_args["button_text"] = text_rendered
                     if jb.confirmation:
-                        buttons_rendered += "<li>" + CONFIRM_BUTTON.format(**template_args) + "</li>"
-                        forms_html += CONFIRM_MODAL.format(**template_args)
+                        buttons_rendered += (
+                            mark_safe("<li>")  # noqa: S308
+                            + format_html(CONFIRM_BUTTON, **template_args)
+                            + mark_safe("</li>")  # noqa: S308
+                        )
+                        forms_html += format_html(CONFIRM_MODAL, **template_args)
                     else:
-                        buttons_rendered += "<li>" + NO_CONFIRM_BUTTON.format(**template_args) + "</li>"
-                        forms_html += NO_CONFIRM_FORM.format(**template_args)
+                        buttons_rendered += (
+                            mark_safe("<li>")  # noqa: S308
+                            + format_html(NO_CONFIRM_BUTTON, **template_args)
+                            + mark_safe("</li>")  # noqa: S308
+                        )
+                        forms_html += format_html(NO_CONFIRM_FORM, **template_args)
             except Exception as e:
-                buttons_rendered += (
-                    f'<li><a disabled="disabled" title="{e}"><span class="text-muted">'
-                    f'<i class="mdi mdi-alert"></i> {jb.name}</span></a></li>'
+                buttons_rendered += format_html(
+                    '<li><a disabled="disabled" title="{}"><span class="text-muted">'
+                    '<i class="mdi mdi-alert"></i> {}</span></a></li>',
+                    e,
+                    jb.name,
                 )
 
         if buttons_rendered:
-            buttons_html += GROUP_DROPDOWN.format(
+            buttons_html += format_html(
+                GROUP_DROPDOWN,
                 group_button_class=group_button_class,
                 group_name=group_name,
                 grouped_buttons=buttons_rendered,
             )
 
     # We want all of the buttons first and then any modals and forms so the buttons render properly
-    return mark_safe(buttons_html + forms_html)
+    return buttons_html + forms_html

nautobot/extras/templatetags/plugins.py

@@ -52,7 +52,7 @@ def _get_registered_content(obj, method, template_context, return_html=True):
     if not return_html:
         return objects
 
-    return mark_safe(html)
+    return mark_safe(html)  # noqa: S308
 
 
 @register.simple_tag(takes_context=True)

nautobot/extras/test_jobs/file_output.py

@@ -0,0 +1,16 @@
+from nautobot.core.celery import register_jobs
+from nautobot.extras.jobs import IntegerVar, Job
+
+
+class FileOutputJob(Job):
+    lines = IntegerVar()
+
+    class Meta:
+        name = "File Output job"
+        description = "Creates a text file as output."
+
+    def run(self, lines):
+        self.create_file("output.txt", "Hello World!\n" * lines)
+
+
+register_jobs(FileOutputJob)