nautobot 2.4.0b1__py3-none-any.whl → 2.4.2__py3-none-any.whl

nautobot/ipam/utils/__init__.py

@@ -1,22 +1,29 @@
+from collections.abc import Iterable
+
 from django.core.exceptions import ValidationError
 import netaddr
 
 from nautobot.core.forms.utils import compress_range
 from nautobot.dcim.models import Interface
 from nautobot.extras.models import RelationshipAssociation
-from nautobot.ipam.models import Prefix, VLAN
+from nautobot.ipam.choices import PrefixTypeChoices
+from nautobot.ipam.models import IPAddress, Namespace, Prefix, VLAN, VLANGroup
 from nautobot.ipam.querysets import IPAddressQuerySet
 from nautobot.virtualization.models import VMInterface
 
 
-def add_available_prefixes(parent, prefix_list):
+def add_available_prefixes(parent: netaddr.IPNetwork, namespace: Namespace, prefix_list: Iterable[Prefix]):
     """
     Create fake Prefix objects for all unallocated space within a prefix.
     """
 
     # Find all unallocated space
-    available_prefixes = netaddr.IPSet(parent) ^ netaddr.IPSet([p.prefix for p in prefix_list])
-    available_prefixes = [Prefix(prefix=p, status=None) for p in available_prefixes.iter_cidrs()]
+    available_prefixes = netaddr.IPSet(parent) ^ netaddr.IPSet(
+        [p.prefix for p in prefix_list if p.type != PrefixTypeChoices.TYPE_CONTAINER or not p.descendants().exists()]
+    )
+    available_prefixes = [
+        Prefix(prefix=p, namespace=namespace, type=None, status=None) for p in available_prefixes.iter_cidrs()
+    ]
 
     # Concatenate and sort complete list of children
     prefix_list = list(prefix_list) + available_prefixes
@@ -25,22 +32,36 @@ def add_available_prefixes(parent, prefix_list):
     return prefix_list
 
 
-def add_available_ipaddresses(prefix, ipaddress_list, is_pool=False):
-    """
-    Annotate ranges of available IP addresses within a given prefix. If is_pool is True, the first and last IP will be
-    considered usable (regardless of mask length).
+def get_add_available_prefixes_callback(show_available: bool, parent: Prefix):
+    """Conditionally provide a callback for add_available_prefixes()."""
+    if show_available:
+        return lambda prefixes: add_available_prefixes(parent.prefix, parent.namespace, prefixes)
+    return lambda prefixes: prefixes
+
+
+def add_available_ipaddresses(prefix: netaddr.IPNetwork, ipaddress_list: Iterable[IPAddress], is_pool: bool = False):
     """
+    Annotate ranges of available IP addresses within a given prefix.
+
+    Args:
+        prefix (netaddr.IPNetwork): The network to calculate available addresses within.
+        ipaddress_list (Iterable[IPAddress]): List or QuerySet of extant IPAddress objects.
+        is_pool (bool): If True, the first/last IPs in the prefix will be considered usable, regardless of mask length.
 
+    Returns:
+        The contents of `ipaddress_list` interleaved with tuples of the form
+        `(number_of_available_addresses, first_such_address)`.
+    """
     output = []
     prev_ip = None
 
     # Ignore the network and broadcast addresses for non-pool IPv4 prefixes larger than /31.
     if prefix.version == 4 and prefix.prefixlen < 31 and not is_pool:
-        first_ip_in_prefix = netaddr.IPAddress(prefix.first + 1)
-        last_ip_in_prefix = netaddr.IPAddress(prefix.last - 1)
+        first_ip_in_prefix = netaddr.IPAddress(prefix.first + 1, version=prefix.version)
+        last_ip_in_prefix = netaddr.IPAddress(prefix.last - 1, version=prefix.version)
     else:
-        first_ip_in_prefix = netaddr.IPAddress(prefix.first)
-        last_ip_in_prefix = netaddr.IPAddress(prefix.last)
+        first_ip_in_prefix = netaddr.IPAddress(prefix.first, version=prefix.version)
+        last_ip_in_prefix = netaddr.IPAddress(prefix.last, version=prefix.version)
 
     if not ipaddress_list:
         return [
@@ -57,15 +78,15 @@ def add_available_ipaddresses(prefix, ipaddress_list, is_pool=False):
         ipaddress_list.sort(key=lambda ip: ip.host)
 
     # Account for any available IPs before the first real IP
-    if ipaddress_list[0].address.ip > first_ip_in_prefix:
-        skipped_count = int(ipaddress_list[0].address.ip - first_ip_in_prefix)
+    if ipaddress_list[0].address.ip.value > first_ip_in_prefix.value:
+        skipped_count = ipaddress_list[0].address.ip.value - first_ip_in_prefix.value
         first_skipped = f"{first_ip_in_prefix}/{prefix.prefixlen}"
         output.append((skipped_count, first_skipped))
 
     # Iterate through existing IPs and annotate free ranges
     for ip in ipaddress_list:
         if prev_ip:
-            diff = int(ip.address.ip - prev_ip.address.ip)
+            diff = ip.address.ip.value - prev_ip.address.ip.value
             if diff > 1:
                 first_skipped = f"{prev_ip.address.ip + 1}/{prefix.prefixlen}"
                 output.append((diff - 1, first_skipped))
@@ -74,14 +95,23 @@ def add_available_ipaddresses(prefix, ipaddress_list, is_pool=False):
 
     # Include any remaining available IPs
     if prev_ip.address.ip < last_ip_in_prefix:
-        skipped_count = int(last_ip_in_prefix - prev_ip.address.ip)
+        skipped_count = last_ip_in_prefix.value - prev_ip.address.ip.value
         first_skipped = f"{prev_ip.address.ip + 1}/{prefix.prefixlen}"
         output.append((skipped_count, first_skipped))
 
     return output
 
 
-def add_available_vlans(vlan_group, vlans):
+def get_add_available_ipaddresses_callback(show_available: bool, parent: Prefix):
+    """Conditionally provide a callback for add_available_ipaddresses()."""
+    if show_available:
+        return lambda ip_addresses: add_available_ipaddresses(
+            parent.prefix, ip_addresses, is_pool=(parent.type == PrefixTypeChoices.TYPE_POOL)
+        )
+    return lambda ip_addresses: ip_addresses
+
+
+def add_available_vlans(vlan_group: VLANGroup, vlans: list[VLAN]):
     """
     Create fake records for all gaps between used VLANs
     """
@@ -99,6 +129,13 @@ def add_available_vlans(vlan_group, vlans):
     return vlans
 
 
+def get_add_available_vlans_callback(show_available: bool, vlan_group: VLANGroup):
+    """Conditionally provide a callback for add_available_vlans()."""
+    if show_available:
+        return lambda vlans: add_available_vlans(vlan_group=vlan_group, vlans=vlans)
+    return lambda vlans: vlans
+
+
 def handle_relationship_changes_when_merging_ips(merged_ip, merged_attributes, collapsed_ips):
     """
     Update/Delete RelationshipAssociation instances after we collapsed the IPs.

nautobot/ipam/views.py

@@ -2,7 +2,9 @@ import logging
 
 from django.conf import settings
 from django.contrib import messages
+from django.contrib.auth.models import AnonymousUser
 from django.core.cache import cache
+from django.core.exceptions import ObjectDoesNotExist
 from django.db import models, transaction
 from django.db.models import Prefetch, ProtectedError, Q
 from django.forms.models import model_to_dict
@@ -27,7 +29,7 @@ from nautobot.core.views.paginator import EnhancedPaginator, get_paginate_count
 from nautobot.core.views.utils import handle_protectederror
 from nautobot.core.views.viewsets import NautobotUIViewSet
 from nautobot.dcim.models import Device, Interface, Location
-from nautobot.extras.models import Role, Status, Tag
+from nautobot.extras.models import Role, SavedView, Status, Tag
 from nautobot.ipam import choices, constants
 from nautobot.ipam.api import serializers
 from nautobot.tenancy.models import Tenant
@@ -47,9 +49,9 @@ from .models import (
     VRF,
 )
 from .utils import (
-    add_available_ipaddresses,
-    add_available_prefixes,
-    add_available_vlans,
+    get_add_available_ipaddresses_callback,
+    get_add_available_prefixes_callback,
+    get_add_available_vlans_callback,
     handle_relationship_changes_when_merging_ips,
     retrieve_interface_or_vminterface_from_request,
 )
@@ -105,23 +107,12 @@ class NamespaceIPAddressesView(generic.ObjectView):
 
     def get_extra_context(self, request, instance):
         # Find all IPAddresses belonging to this Namespace
-        ip_addresses = (
-            instance.ip_addresses.restrict(request.user, "view")
-            .select_related("role", "status", "tenant")
-            .annotate(
-                interface_count=count_related(Interface, "ip_addresses"),
-                interface_parent_count=count_related(Device, "interfaces__ip_addresses", distinct=True),
-                vm_interface_count=count_related(VMInterface, "ip_addresses"),
-                vm_interface_parent_count=count_related(VirtualMachine, "interfaces__ip_addresses", distinct=True),
-            )
-        )
+        ip_addresses = instance.ip_addresses.restrict(request.user, "view").select_related("role", "status", "tenant")
 
-        ip_address_table = tables.IPAddressTable(ip_addresses)
+        ip_address_table = tables.IPAddressTable(ip_addresses, exclude=["namespace"])
         if request.user.has_perm("ipam.change_ipaddress") or request.user.has_perm("ipam.delete_ipaddress"):
             ip_address_table.columns.show("pk")
 
-        ip_address_table.exclude = ("namespace",)
-
         paginate = {
             "paginator_class": EnhancedPaginator,
             "per_page": get_paginate_count(request),
@@ -158,12 +149,10 @@ class NamespacePrefixesView(generic.ObjectView):
         # Find all Prefixes belonging to this Namespace
         prefixes = instance.prefixes.restrict(request.user, "view").select_related("status")
 
-        prefix_table = tables.PrefixTable(prefixes)
+        prefix_table = tables.PrefixTable(prefixes, exclude=["namespace"])
         if request.user.has_perm("ipam.change_prefix") or request.user.has_perm("ipam.delete_prefix"):
             prefix_table.columns.show("pk")
 
-        prefix_table.exclude = ("namespace",)
-
         paginate = {
             "paginator_class": EnhancedPaginator,
             "per_page": get_paginate_count(request),
@@ -200,12 +189,10 @@ class NamespaceVRFsView(generic.ObjectView):
         # Find all VRFs belonging to this Namespace
         vrfs = instance.vrfs.restrict(request.user, "view")
 
-        vrf_table = tables.VRFTable(vrfs)
+        vrf_table = tables.VRFTable(vrfs, exclude=["namespace"])
         if request.user.has_perm("ipam.change_vrf") or request.user.has_perm("ipam.delete_vrf"):
             vrf_table.columns.show("pk")
 
-        vrf_table.exclude = ("namespace",)
-
         paginate = {
             "paginator_class": EnhancedPaginator,
             "per_page": get_paginate_count(request),
@@ -293,12 +280,6 @@ class VRFUIViewSet(NautobotUIViewSet):
         ),
     )
 
-    def extra_post_save_action(self, obj, form):
-        if form.cleaned_data.get("add_prefixes", None):
-            obj.prefixes.add(*form.cleaned_data["add_prefixes"])
-        if form.cleaned_data.get("remove_prefixes", None):
-            obj.prefixes.remove(*form.cleaned_data["remove_prefixes"])
-
 
 #
 # Route targets
@@ -416,8 +397,7 @@ class PrefixView(generic.ObjectView):
     def get_extra_context(self, request, instance):
         # Parent prefixes table
         parent_prefixes = instance.ancestors().restrict(request.user, "view")
-        parent_prefix_table = tables.PrefixTable(parent_prefixes)
-        parent_prefix_table.exclude = ("namespace",)
+        parent_prefix_table = tables.PrefixTable(parent_prefixes, exclude=["namespace"])
 
         vrfs = instance.vrf_assignments.restrict(request.user, "view")
         vrf_table = tables.VRFPrefixAssignmentTable(vrfs, orderable=False)
@@ -448,19 +428,18 @@ class PrefixPrefixesView(generic.ObjectView):
 
     def get_extra_context(self, request, instance):
         # Child prefixes table
-        child_prefixes = (
-            instance.descendants()
-            .restrict(request.user, "view")
-            .select_related("parent", "status", "role", "vlan", "namespace")
-            .annotate(location_count=count_related(Location, "prefixes"))
-        )
+        child_prefixes = instance.descendants().restrict(request.user, "view")
 
         # Add available prefixes to the table if requested
-        if child_prefixes and request.GET.get("show_available", "true") == "true":
-            child_prefixes = add_available_prefixes(instance.prefix, child_prefixes)
+        data_transform_callback = get_add_available_prefixes_callback(
+            show_available=request.GET.get("show_available", "true") == "true", parent=instance
+        )
 
-        prefix_table = tables.PrefixDetailTable(child_prefixes, hide_hierarchy_ui=True)
-        prefix_table.exclude = ("namespace",)
+        prefix_table = tables.PrefixDetailTable(
+            child_prefixes,
+            exclude=["namespace"],
+            data_transform_callback=data_transform_callback,
+        )
         if request.user.has_perm("ipam.change_prefix") or request.user.has_perm("ipam.delete_prefix"):
             prefix_table.columns.show("pk")
 
@@ -481,6 +460,7 @@ class PrefixPrefixesView(generic.ObjectView):
 
         return {
             "first_available_prefix": instance.get_first_available_prefix(),
+            "base_tree_depth": instance.ancestors().count(),
             "prefix_table": prefix_table,
             "permissions": permissions,
             "bulk_querystring": bulk_querystring,
@@ -495,26 +475,16 @@ class PrefixIPAddressesView(generic.ObjectView):
 
     def get_extra_context(self, request, instance):
         # Find all IPAddresses belonging to this Prefix
-        ipaddresses = (
-            instance.get_all_ips()
-            .restrict(request.user, "view")
-            .select_related("role", "status", "tenant")
-            .prefetch_related("primary_ip4_for", "primary_ip6_for")
-            .annotate(
-                interface_count=count_related(Interface, "ip_addresses"),
-                interface_parent_count=count_related(Device, "interfaces__ip_addresses", distinct=True),
-                vm_interface_count=count_related(VMInterface, "ip_addresses"),
-                vm_interface_parent_count=count_related(VirtualMachine, "interfaces__ip_addresses", distinct=True),
-            )
-        )
+        ipaddresses = instance.get_all_ips().restrict(request.user, "view")
 
         # Add available IP addresses to the table if requested
-        if request.GET.get("show_available", "true") == "true":
-            ipaddresses = add_available_ipaddresses(
-                instance.prefix, ipaddresses, instance.type == choices.PrefixTypeChoices.TYPE_POOL
-            )
+        data_transform_callback = get_add_available_ipaddresses_callback(
+            show_available=request.GET.get("show_available", "true") == "true", parent=instance
+        )
 
-        ip_table = tables.IPAddressTable(ipaddresses)
+        ip_table = tables.IPAddressTable(
+            ipaddresses, exclude=["parent__namespace"], data_transform_callback=data_transform_callback
+        )
         if request.user.has_perm("ipam.change_ipaddress") or request.user.has_perm("ipam.delete_ipaddress"):
             ip_table.columns.show("pk")
 
@@ -688,16 +658,6 @@ class PrefixBulkEditView(generic.BulkEditView):
     table = tables.PrefixTable
     form = forms.PrefixBulkEditForm
 
-    def extra_post_save_action(self, obj, form):
-        if form.cleaned_data.get("add_locations", None):
-            obj.locations.add(*form.cleaned_data["add_locations"])
-        if form.cleaned_data.get("remove_locations", None):
-            obj.locations.remove(*form.cleaned_data["remove_locations"])
-        if form.cleaned_data.get("add_vrfs", None):
-            obj.vrfs.add(*form.cleaned_data["add_vrfs"])
-        if form.cleaned_data.get("remove_vrfs", None):
-            obj.vrfs.remove(*form.cleaned_data["remove_vrfs"])
-
 
 class PrefixBulkDeleteView(generic.BulkDeleteView):
     queryset = Prefix.objects.all()
@@ -711,18 +671,38 @@ class PrefixBulkDeleteView(generic.BulkDeleteView):
 
 
 class IPAddressListView(generic.ObjectListView):
-    queryset = IPAddress.objects.annotate(
-        interface_count=count_related(Interface, "ip_addresses"),
-        interface_parent_count=count_related(Device, "interfaces__ip_addresses", distinct=True),
-        vm_interface_count=count_related(VMInterface, "ip_addresses"),
-        vm_interface_parent_count=count_related(VirtualMachine, "interfaces__ip_addresses", distinct=True),
-        assigned_count=count_related(Interface, "ip_addresses") + count_related(VMInterface, "ip_addresses"),
-    )
+    queryset = IPAddress.objects.all()
     filterset = filters.IPAddressFilterSet
     filterset_form = forms.IPAddressFilterForm
     table = tables.IPAddressDetailTable
     template_name = "ipam/ipaddress_list.html"
 
+    def alter_queryset(self, request):
+        queryset = super().alter_queryset(request)
+
+        # All of the below is just to determine whether we are displaying the "assigned_count" column, and if so,
+        # perform the relevant queryset annotation. Ref: nautobot/nautobot#6605
+        if request.user is None or isinstance(request.user, AnonymousUser):
+            table_columns = None
+        else:
+            table_columns = request.user.get_config("tables.IPAddressDetailTable.columns")
+        current_saved_view_pk = request.GET.get("saved_view", None)
+        if current_saved_view_pk:
+            try:
+                current_saved_view = SavedView.objects.get(view="ipam:ipaddress_list", pk=current_saved_view_pk)
+                view_table_config = current_saved_view.config.get("table_config", {}).get("IPAddressDetailTable", None)
+                if view_table_config is not None:
+                    table_columns = view_table_config.get("columns", table_columns)
+            except ObjectDoesNotExist:
+                pass
+
+        # column name is "assigned", not "assigned_count", and it's shown by default if there is no table config
+        if (table_columns and "assigned" in table_columns) or not table_columns:
+            queryset = queryset.annotate(
+                assigned_count=count_related(Interface, "ip_addresses") + count_related(VMInterface, "ip_addresses"),
+            )
+        return queryset
+
 
 class IPAddressView(generic.ObjectView):
     queryset = IPAddress.objects.select_related("tenant", "status", "role")
@@ -1213,17 +1193,18 @@ class VLANGroupView(generic.ObjectView):
     def get_extra_context(self, request, instance):
         vlans = (
             VLAN.objects.restrict(request.user, "view")
-            .annotate(location_count=count_related(Location, "vlans"))
             .filter(vlan_group=instance)
             .prefetch_related(Prefetch("prefixes", queryset=Prefix.objects.restrict(request.user)))
         )
         vlans_count = vlans.count()
-        vlans = add_available_vlans(vlan_group=instance, vlans=vlans)
 
-        vlan_table = tables.VLANDetailTable(vlans)
+        data_transform_callback = get_add_available_vlans_callback(show_available=True, vlan_group=instance)
+
+        vlan_table = tables.VLANDetailTable(
+            vlans, exclude=["vlan_group"], data_transform_callback=data_transform_callback
+        )
         if request.user.has_perm("ipam.change_vlan") or request.user.has_perm("ipam.delete_vlan"):
             vlan_table.columns.show("pk")
-        vlan_table.columns.hide("vlan_group")
 
         paginate = {
             "paginator_class": EnhancedPaginator,
@@ -1298,8 +1279,7 @@ class VLANView(generic.ObjectView):
                 "namespace",
             )
         )
-        prefix_table = tables.PrefixTable(list(prefixes), hide_hierarchy_ui=True)
-        prefix_table.exclude = ("vlan",)
+        prefix_table = tables.PrefixTable(list(prefixes), hide_hierarchy_ui=True, exclude=["vlan"])
 
         paginate = {
             "paginator_class": EnhancedPaginator,
@@ -1376,12 +1356,6 @@ class VLANBulkEditView(generic.BulkEditView):
     table = tables.VLANTable
     form = forms.VLANBulkEditForm
 
-    def extra_post_save_action(self, obj, form):
-        if form.cleaned_data.get("add_locations", None):
-            obj.locations.add(*form.cleaned_data["add_locations"])
-        if form.cleaned_data.get("remove_locations", None):
-            obj.locations.remove(*form.cleaned_data["remove_locations"])
-
 
 class VLANBulkDeleteView(generic.BulkDeleteView):
     queryset = VLAN.objects.select_related(