nautobot 2.2.2__py3-none-any.whl → 2.2.4__py3-none-any.whl

nautobot/dcim/urls.py

@@ -84,6 +84,11 @@ urlpatterns = [
         name="location_notes",
         kwargs={"model": Location},
     ),
+    path(
+        "locations/<uuid:pk>/migrate-data-to-contact/",
+        views.MigrateLocationDataToContactView.as_view(),
+        name="location_migrate_data_to_contact",
+    ),
     path(
         "locations/<uuid:object_id>/images/add/",
         ImageAttachmentEditView.as_view(),

nautobot/dcim/views.py

@@ -1,8 +1,10 @@
 from collections import OrderedDict
+import logging
 import uuid
 
 from django.contrib import messages
 from django.contrib.contenttypes.models import ContentType
+from django.core.exceptions import ObjectDoesNotExist, PermissionDenied
 from django.core.paginator import EmptyPage, PageNotAnInteger
 from django.db import transaction
 from django.db.models import F, Prefetch
@@ -12,15 +14,19 @@ from django.forms import (
     MultipleHiddenInput,
 )
 from django.shortcuts import get_object_or_404, HttpResponse, redirect, render
+from django.utils.encoding import iri_to_uri
 from django.utils.functional import cached_property
 from django.utils.html import format_html
+from django.utils.http import url_has_allowed_host_and_scheme
 from django.views.generic import View
 from django_tables2 import RequestConfig
 
 from nautobot.circuits.models import Circuit
-from nautobot.core.forms import ConfirmationForm
+from nautobot.core.forms import ConfirmationForm, restrict_form_fields
 from nautobot.core.models.querysets import count_related
+from nautobot.core.templatetags.helpers import has_perms
 from nautobot.core.utils.permissions import get_permission_for_model
+from nautobot.core.utils.requests import normalize_querydict
 from nautobot.core.views import generic
 from nautobot.core.views.mixins import (
     GetReturnURLMixin,
@@ -30,7 +36,10 @@ from nautobot.core.views.mixins import (
 )
 from nautobot.core.views.paginator import EnhancedPaginator, get_paginate_count
 from nautobot.core.views.viewsets import NautobotUIViewSet
+from nautobot.dcim.choices import LocationDataToContactActionChoices
+from nautobot.dcim.forms import LocationMigrateDataToContactForm
 from nautobot.dcim.utils import get_all_network_driver_mappings, get_network_driver_mapping_tool_names
+from nautobot.extras.models import Contact, ContactAssociation, Role, Status, Team
 from nautobot.extras.views import ObjectChangeLogView, ObjectConfigContextView, ObjectDynamicGroupsView
 from nautobot.ipam.models import IPAddress, Prefix, Service, VLAN
 from nautobot.ipam.tables import InterfaceIPAddressTable, InterfaceVLANTable, VRFDeviceAssignmentTable
@@ -83,6 +92,8 @@ from .models import (
     VirtualChassis,
 )
 
+logger = logging.getLogger(__name__)
+
 
 class BulkDisconnectView(GetReturnURLMixin, ObjectPermissionRequiredMixin, View):
     """
@@ -188,6 +199,7 @@ class LocationTypeView(generic.ObjectView):
         return {
             "children_table": children_table,
             "locations_table": locations_table,
+            **super().get_extra_context(request, instance),
         }
 
 
@@ -283,6 +295,10 @@ class LocationView(generic.ObjectView):
             "children_table": children_table,
             "rack_groups": rack_groups,
             "stats": stats,
+            "contact_association_permission": ["extras.add_contactassociation"],
+            # show the button if any of these fields have non-empty value.
+            "show_convert_to_contact_button": instance.contact_name or instance.contact_phone or instance.contact_email,
+            **super().get_extra_context(request, instance),
         }
 
 
@@ -314,6 +330,140 @@ class LocationBulkDeleteView(generic.BulkDeleteView):
     table = tables.LocationTable
 
 
+class MigrateLocationDataToContactView(generic.ObjectEditView):
+    queryset = Location.objects.all()
+    model_form = LocationMigrateDataToContactForm
+    template_name = "dcim/location_migrate_data_to_contact.html"
+
+    def get(self, request, *args, **kwargs):
+        obj = self.alter_obj(self.get_object(kwargs), request, args, kwargs)
+
+        initial_data = normalize_querydict(request.GET, form_class=self.model_form)
+        # remove status from the location itself
+        initial_data["status"] = None
+        initial_data["location"] = obj.pk
+
+        # populate contact tab fields initial data
+        initial_data["name"] = obj.contact_name
+        initial_data["phone"] = obj.contact_phone
+        initial_data["email"] = obj.contact_email
+        form = self.model_form(instance=obj, initial=initial_data)
+        restrict_form_fields(form, request.user)
+        return render(
+            request,
+            self.template_name,
+            {
+                "obj": obj,
+                "obj_type": self.queryset.model._meta.verbose_name,
+                "form": form,
+                "return_url": self.get_return_url(request, obj),
+                "editing": obj.present_in_database,
+                "active_tab": "assign",
+                **self.get_extra_context(request, obj),
+            },
+        )
+
+    def post(self, request, *args, **kwargs):
+        obj = self.alter_obj(self.get_object(kwargs), request, args, kwargs)
+        form = self.model_form(data=request.POST, files=request.FILES, instance=obj)
+        restrict_form_fields(form, request.user)
+
+        associated_object_id = obj.pk
+        associated_object_content_type = ContentType.objects.get_for_model(Location)
+        action = request.POST.get("action")
+        try:
+            with transaction.atomic():
+                if not has_perms(request.user, ["extras.add_contactassociation"]):
+                    raise PermissionDenied(
+                        "ObjectPermission extras.add_contactassociation is needed to perform this action"
+                    )
+                contact = None
+                team = None
+                if action == LocationDataToContactActionChoices.CREATE_AND_ASSIGN_NEW_CONTACT:
+                    if not has_perms(request.user, ["extras.add_contact"]):
+                        raise PermissionDenied("ObjectPermission extras.add_contact is needed to perform this action")
+                    contact = Contact(
+                        name=request.POST.get("name"),
+                        phone=request.POST.get("phone"),
+                        email=request.POST.get("email"),
+                    )
+                    contact.validated_save()
+                    # Trigger permission check
+                    Contact.objects.restrict(request.user, "view").get(pk=contact.pk)
+                elif action == LocationDataToContactActionChoices.CREATE_AND_ASSIGN_NEW_TEAM:
+                    if not has_perms(request.user, ["extras.add_team"]):
+                        raise PermissionDenied("ObjectPermission extras.add_team is needed to perform this action")
+                    team = Team(
+                        name=request.POST.get("name"),
+                        phone=request.POST.get("phone"),
+                        email=request.POST.get("email"),
+                    )
+                    team.validated_save()
+                    # Trigger permission check
+                    Team.objects.restrict(request.user, "view").get(pk=team.pk)
+                elif action == LocationDataToContactActionChoices.ASSOCIATE_EXISTING_CONTACT:
+                    contact = Contact.objects.restrict(request.user, "view").get(pk=request.POST.get("contact"))
+                elif action == LocationDataToContactActionChoices.ASSOCIATE_EXISTING_TEAM:
+                    team = Team.objects.restrict(request.user, "view").get(pk=request.POST.get("team"))
+                else:
+                    raise ValueError(f"Invalid action {action} passed from the form")
+
+                association = ContactAssociation(
+                    contact=contact,
+                    team=team,
+                    associated_object_type=associated_object_content_type,
+                    associated_object_id=associated_object_id,
+                    status=Status.objects.get(pk=request.POST.get("status")),
+                    role=Role.objects.get(pk=request.POST.get("role")),
+                )
+                association.validated_save()
+                # Trigger permission check
+                ContactAssociation.objects.restrict(request.user, "view").get(pk=association.pk)
+
+                # Clear out contact fields from location
+                location = self.get_object(kwargs)
+                location.contact_name = ""
+                location.contact_phone = ""
+                location.contact_email = ""
+                location.validated_save()
+
+                object_created = not form.instance.present_in_database
+
+            self.successful_post(request, obj, object_created, logger)
+
+            return_url = request.POST.get("return_url")
+            if url_has_allowed_host_and_scheme(url=return_url, allowed_hosts=request.get_host()):
+                return redirect(iri_to_uri(return_url))
+            else:
+                return redirect(self.get_return_url(request, obj))
+
+        except ObjectDoesNotExist:
+            msg = "Object save failed due to object-level permissions violation"
+            logger.debug(msg)
+            form.add_error(None, msg)
+        except PermissionDenied as e:
+            msg = e
+            logger.debug(msg)
+            form.add_error(None, msg)
+        except ValueError:
+            msg = f"Invalid action {action} passed from the form"
+            logger.debug(msg)
+            form.add_error(None, msg)
+
+        return render(
+            request,
+            self.template_name,
+            {
+                "obj": obj,
+                "obj_type": self.queryset.model._meta.verbose_name,
+                "form": form,
+                "return_url": self.get_return_url(request, obj),
+                "editing": obj.present_in_database,
+                **self.get_extra_context(request, obj),
+            },
+        )
+
+
 #
 # Rack groups
 #
@@ -346,9 +496,7 @@ class RackGroupView(generic.ObjectView):
         }
         RequestConfig(request, paginate).configure(rack_table)
 
-        return {
-            "rack_table": rack_table,
-        }
+        return {"rack_table": rack_table, **super().get_extra_context(request, instance)}
 
 
 class RackGroupEditView(generic.ObjectEditView):
@@ -467,6 +615,7 @@ class RackView(generic.ObjectView):
             "nonracked_devices": nonracked_devices,
             "next_rack": next_rack,
             "prev_rack": prev_rack,
+            **super().get_extra_context(request, instance),
         }
 
 
@@ -583,9 +732,7 @@ class ManufacturerView(generic.ObjectView):
         }
         RequestConfig(request, paginate).configure(device_table)
 
-        return {
-            "device_table": device_table,
-        }
+        return {"device_table": device_table, **super().get_extra_context(request, instance)}
 
 
 class ManufacturerEditView(generic.ObjectEditView):
@@ -691,6 +838,7 @@ class DeviceTypeView(generic.ObjectView):
             "rear_port_table": rear_port_table,
             "devicebay_table": devicebay_table,
             "software_image_files_table": software_image_files_table,
+            **super().get_extra_context(request, instance),
         }
 
 
@@ -1089,6 +1237,7 @@ class PlatformView(generic.ObjectView):
         return {
             "device_table": device_table,
             "network_driver_tool_names": get_network_driver_mapping_tool_names(),
+            **super().get_extra_context(request, instance),
         }
 
 
@@ -1098,7 +1247,10 @@ class PlatformEditView(generic.ObjectEditView):
     template_name = "dcim/platform_edit.html"
 
     def get_extra_context(self, request, instance):
-        return {"network_driver_names": sorted(get_all_network_driver_mappings().keys())}
+        return {
+            "network_driver_names": sorted(get_all_network_driver_mappings().keys()),
+            **super().get_extra_context(request, instance),
+        }
 
 
 class PlatformDeleteView(generic.ObjectDeleteView):
@@ -1489,7 +1641,7 @@ class ConsolePortView(generic.ObjectView):
     queryset = ConsolePort.objects.all()
 
     def get_extra_context(self, request, instance):
-        return {"breadcrumb_url": "dcim:device_consoleports"}
+        return {"breadcrumb_url": "dcim:device_consoleports", **super().get_extra_context(request, instance)}
 
 
 class ConsolePortCreateView(generic.ComponentCreateView):
@@ -1551,7 +1703,7 @@ class ConsoleServerPortView(generic.ObjectView):
     queryset = ConsoleServerPort.objects.all()
 
     def get_extra_context(self, request, instance):
-        return {"breadcrumb_url": "dcim:device_consoleserverports"}
+        return {"breadcrumb_url": "dcim:device_consoleserverports", **super().get_extra_context(request, instance)}
 
 
 class ConsoleServerPortCreateView(generic.ComponentCreateView):
@@ -1613,7 +1765,7 @@ class PowerPortView(generic.ObjectView):
     queryset = PowerPort.objects.all()
 
     def get_extra_context(self, request, instance):
-        return {"breadcrumb_url": "dcim:device_powerports"}
+        return {"breadcrumb_url": "dcim:device_powerports", **super().get_extra_context(request, instance)}
 
 
 class PowerPortCreateView(generic.ComponentCreateView):
@@ -1675,7 +1827,7 @@ class PowerOutletView(generic.ObjectView):
     queryset = PowerOutlet.objects.all()
 
     def get_extra_context(self, request, instance):
-        return {"breadcrumb_url": "dcim:device_poweroutlets"}
+        return {"breadcrumb_url": "dcim:device_poweroutlets", **super().get_extra_context(request, instance)}
 
 
 class PowerOutletCreateView(generic.ComponentCreateView):
@@ -1771,6 +1923,7 @@ class InterfaceView(generic.ObjectView):
             "breadcrumb_url": "dcim:device_interfaces",
             "child_interfaces_table": child_interfaces_tables,
             "redundancy_table": redundancy_table,
+            **super().get_extra_context(request, instance),
         }
 
     def _get_interface_redundancy_groups_table(self, request, instance):
@@ -1857,7 +2010,7 @@ class FrontPortView(generic.ObjectView):
     queryset = FrontPort.objects.all()
 
     def get_extra_context(self, request, instance):
-        return {"breadcrumb_url": "dcim:device_frontports"}
+        return {"breadcrumb_url": "dcim:device_frontports", **super().get_extra_context(request, instance)}
 
 
 class FrontPortCreateView(generic.ComponentCreateView):
@@ -1919,7 +2072,7 @@ class RearPortView(generic.ObjectView):
     queryset = RearPort.objects.all()
 
     def get_extra_context(self, request, instance):
-        return {"breadcrumb_url": "dcim:device_rearports"}
+        return {"breadcrumb_url": "dcim:device_rearports", **super().get_extra_context(request, instance)}
 
 
 class RearPortCreateView(generic.ComponentCreateView):
@@ -1981,7 +2134,7 @@ class DeviceBayView(generic.ObjectView):
     queryset = DeviceBay.objects.all()
 
     def get_extra_context(self, request, instance):
-        return {"breadcrumb_url": "dcim:device_devicebays"}
+        return {"breadcrumb_url": "dcim:device_devicebays", **super().get_extra_context(request, instance)}
 
 
 class DeviceBayCreateView(generic.ComponentCreateView):
@@ -2133,6 +2286,7 @@ class InventoryItemView(generic.ObjectView):
         return {
             "breadcrumb_url": "dcim:device_inventory",
             "software_version_images": software_version_images,
+            **super().get_extra_context(request, instance),
         }
 
 
@@ -2340,6 +2494,7 @@ class PathTraceView(generic.ObjectView):
             "path": path,
             "related_paths": related_paths,
             "total_length": path.get_total_length() if path else None,
+            **super().get_extra_context(request, instance),
         }
 
 
@@ -2550,9 +2705,7 @@ class VirtualChassisView(generic.ObjectView):
     def get_extra_context(self, request, instance):
         members = Device.objects.restrict(request.user).filter(virtual_chassis=instance)
 
-        return {
-            "members": members,
-        }
+        return {"members": members, **super().get_extra_context(request, instance)}
 
 
 class VirtualChassisCreateView(generic.ObjectEditView):
@@ -2790,9 +2943,7 @@ class PowerPanelView(generic.ObjectView):
         powerfeed_table = tables.PowerFeedTable(data=power_feeds, orderable=False)
         powerfeed_table.exclude = ["power_panel"]
 
-        return {
-            "powerfeed_table": powerfeed_table,
-        }
+        return {"powerfeed_table": powerfeed_table, **super().get_extra_context(request, instance)}
 
 
 class PowerPanelEditView(generic.ObjectEditView):

nautobot/extras/api/serializers.py

@@ -223,17 +223,28 @@ class ContactAssociationSerializer(NautobotModelSerializer):
         }
 
     def validate(self, data):
-        # Validate uniqueness of (contact/team, role)
+        # Validate uniqueness of (associated object, associated object type, contact/team, role)
+        unique_together_fields = None
+
         if data.get("contact") and data.get("role"):
-            validator = UniqueTogetherValidator(
-                queryset=ContactAssociation.objects.all(),
-                fields=("contact", "role"),
+            unique_together_fields = (
+                "associated_object_type",
+                "associated_object_id",
+                "contact",
+                "role",
             )
-            validator(data, self)
         elif data.get("team") and data.get("role"):
+            unique_together_fields = (
+                "associated_object_type",
+                "associated_object_id",
+                "team",
+                "role",
+            )
+
+        if unique_together_fields is not None:
             validator = UniqueTogetherValidator(
                 queryset=ContactAssociation.objects.all(),
-                fields=("team", "role"),
+                fields=unique_together_fields,
             )
             validator(data, self)
 

nautobot/extras/api/views.py

@@ -33,6 +33,7 @@ from nautobot.core.models.querysets import count_related
 from nautobot.extras import filters
 from nautobot.extras.choices import JobExecutionType
 from nautobot.extras.filters import RoleFilterSet
+from nautobot.extras.jobs import get_job
 from nautobot.extras.models import (
     ComputedField,
     ConfigContext,
@@ -484,7 +485,7 @@ def _create_schedule(serializer, data, job_model, user, approval_required, task_
     # scheduled for.
     scheduled_job = ScheduledJob(
         name=name,
-        task=job_model.job_class.registered_name,
+        task=job_model.class_path,
         job_model=job_model,
         start_time=time,
         description=f"Nautobot job {name} scheduled by {user} for {time}",
@@ -520,7 +521,7 @@ class JobViewSetBase(
     def variables(self, request, *args, **kwargs):
         """Get details of the input variables that may/must be specified to run a particular Job."""
         job_model = self.get_object()
-        job_class = job_model.job_class
+        job_class = get_job(job_model.class_path, reload=True)
         if job_class is None:
             raise Http404
         variables_dict = job_class._get_vars()
@@ -602,14 +603,15 @@ class JobViewSetBase(
                     "One of these two flags must be removed before this job can be scheduled or run."
                 )
 
-        job_class = job_model.job_class
+        job_class = get_job(job_model.class_path, reload=True)
         if job_class is None:
             raise MethodNotAllowed(
                 request.method, detail="This job's source code could not be located and cannot be run"
             )
 
         valid_queues = job_model.task_queues if job_model.task_queues else [settings.CELERY_TASK_DEFAULT_QUEUE]
-        # Get a default queue from either the job model's specified task queue or system default to fall back on if request doesn't provide one
+        # Get a default queue from either the job model's specified task queue or
+        # the system default to fall back on if request doesn't provide one
         default_valid_queue = valid_queues[0]
 
         # We need to call request.data for both cases as this is what pulls and caches the request data
@@ -621,7 +623,8 @@ class JobViewSetBase(
         # - Job Form data (for submission to the job itself)
         # - Schedule data
         # - Desired task queue
-        # Depending on request content type (largely for backwards compatibility) the keys at which these are found are different
+        # Depending on request content type (largely for backwards compatibility) the keys at which these are found
+        # are different
         if "multipart/form-data" in request.content_type:
             data = request._data.dict()  # .data will return data and files, we just want the data
             files = request.FILES
@@ -639,7 +642,8 @@ class JobViewSetBase(
             for non_job_key in non_job_keys:
                 data.pop(non_job_key, None)
 
-            # List of keys in serializer that are effectively exploded versions of the schedule dictionary from JobInputSerializer
+            # List of keys in serializer that are effectively exploded versions of the schedule dictionary
+            # from JobInputSerializer
             schedule_keys = ("_schedule_name", "_schedule_start_time", "_schedule_interval", "_schedule_crontab")
 
             # Assign the key from the validated_data output to dictionary without prefixed "_schedule_"
@@ -666,7 +670,7 @@ class JobViewSetBase(
         cleaned_data = None
         try:
             cleaned_data = job_class.validate_data(data, files=files)
-            cleaned_data = job_model.job_class.prepare_job_kwargs(cleaned_data)
+            cleaned_data = job_class.prepare_job_kwargs(cleaned_data)
 
         except FormsValidationError as e:
             # message_dict can only be accessed if ValidationError got a dict
@@ -948,7 +952,13 @@ class ScheduledJobViewSet(ReadOnlyModelViewSet):
         responses={"200": serializers.JobResultSerializer},
         request=None,
     )
-    @action(detail=True, url_path="dry-run", methods=["post"], permission_classes=[ScheduledJobViewPermissions])
+    @action(
+        detail=True,
+        name="Dry Run",
+        url_path="dry-run",
+        methods=["post"],
+        permission_classes=[ScheduledJobViewPermissions],
+    )
     def dry_run(self, request, pk):
         scheduled_job = get_object_or_404(ScheduledJob, pk=pk)
         job_model = scheduled_job.job_model
@@ -960,13 +970,14 @@ class ScheduledJobViewSet(ReadOnlyModelViewSet):
             raise PermissionDenied("You do not have permission to run this job.")
 
         # Immediately enqueue the job
-        job_kwargs = job_model.job_class.prepare_job_kwargs(scheduled_job.kwargs.get("data", {}))
+        job_class = get_job(job_model.class_path, reload=True)
+        job_kwargs = job_class.prepare_job_kwargs(scheduled_job.kwargs or {})
         job_kwargs["dryrun"] = True
         job_result = JobResult.enqueue_job(
             job_model,
             request.user,
             celery_kwargs=scheduled_job.celery_kwargs or {},
-            **job_model.job_class.serialize_data(job_kwargs),
+            **job_class.serialize_data(job_kwargs),
         )
         serializer = serializers.JobResultSerializer(job_result, context={"request": request})
 

nautobot/extras/constants.py

@@ -5,16 +5,16 @@ HTTP_CONTENT_TYPE_JSON = "application/json"
 EXTRAS_FEATURES = [
     "cable_terminations",
     "config_context_owners",
-    "custom_fields",
+    "custom_fields",  # Deprecated - see nautobot.extras.utils.populate_model_features_registry
     "custom_links",
     "custom_validators",
     "dynamic_groups",
     "export_template_owners",
     "export_templates",
     "graphql",
-    "job_results",
+    "job_results",  # No longer used
     "locations",
-    "relationships",
+    "relationships",  # Deprecated - see nautobot.extras.utils.populate_model_features_registry
     "statuses",
     "webhooks",
 ]