From 8274903985428c752d0f1d73b1a9b3d5e87392c7 Mon Sep 17 00:00:00 2001 From: John Anderson Date: Wed, 29 Jan 2020 16:46:44 -0500 Subject: [PATCH 001/124] version bump for v2.8.0 --- netbox/netbox/settings.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/netbox/netbox/settings.py b/netbox/netbox/settings.py index 8cdbb60a3..c9e62100c 100644 --- a/netbox/netbox/settings.py +++ b/netbox/netbox/settings.py @@ -12,7 +12,7 @@ from django.core.exceptions import ImproperlyConfigured # Environment setup # -VERSION = '2.7.4-dev' +VERSION = '2.8.0-dev' # Hostname HOSTNAME = platform.node() From 8cb6aed8fa47da3671864df63137fe0b3602eb28 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Fri, 14 Feb 2020 13:59:07 -0500 Subject: [PATCH 002/124] Closes #3753: Remove rack units endpoint (replaced with elevation) --- docs/release-notes/version-2.8.md | 5 +++++ netbox/dcim/api/views.py | 27 --------------------------- netbox/dcim/tests/test_api.py | 7 ------- 3 files changed, 5 insertions(+), 34 deletions(-) create mode 100644 docs/release-notes/version-2.8.md diff --git a/docs/release-notes/version-2.8.md b/docs/release-notes/version-2.8.md new file mode 100644 index 000000000..a29768189 --- /dev/null +++ b/docs/release-notes/version-2.8.md @@ -0,0 +1,5 @@ +# v2.8.0 (FUTURE) + +## API Changes + +* dcim.Rack: The `/api/dcim/racks//units/` endpoint has been replaced with `/api/dcim/racks//elevation/`. diff --git a/netbox/dcim/api/views.py b/netbox/dcim/api/views.py index 8bb127f67..9e7935293 100644 --- a/netbox/dcim/api/views.py +++ b/netbox/dcim/api/views.py @@ -176,33 +176,6 @@ class RackViewSet(CustomFieldModelViewSet): serializer_class = serializers.RackSerializer filterset_class = filters.RackFilterSet - @swagger_auto_schema(deprecated=True) - @action(detail=True) - def units(self, request, pk=None): - """ - List rack units (by rack) - """ - # TODO: Remove this action detail route in v2.8 - rack = get_object_or_404(Rack, pk=pk) - face = request.GET.get('face', 'front') - exclude_pk = request.GET.get('exclude', None) - if exclude_pk is not None: - try: - exclude_pk = int(exclude_pk) - except ValueError: - exclude_pk = None - elevation = rack.get_rack_units(face, exclude_pk) - - # Enable filtering rack units by ID - q = request.GET.get('q', None) - if q: - elevation = [u for u in elevation if q in str(u['id'])] - - page = self.paginate_queryset(elevation) - if page is not None: - rack_units = serializers.RackUnitSerializer(page, many=True, context={'request': request}) - return self.get_paginated_response(rack_units.data) - @swagger_auto_schema( responses={200: serializers.RackUnitSerializer(many=True)}, query_serializer=serializers.RackElevationDetailFilterSerializer diff --git a/netbox/dcim/tests/test_api.py b/netbox/dcim/tests/test_api.py index a3a072bc9..c0ea5eca7 100644 --- a/netbox/dcim/tests/test_api.py +++ b/netbox/dcim/tests/test_api.py @@ -589,13 +589,6 @@ class RackTest(APITestCase): self.assertEqual(response.data['name'], self.rack1.name) - def test_get_rack_units(self): - - url = reverse('dcim-api:rack-units', kwargs={'pk': self.rack1.pk}) - response = self.client.get(url, **self.header) - - self.assertEqual(response.data['count'], 42) - def test_get_rack_elevation(self): url = reverse('dcim-api:rack-elevation', kwargs={'pk': self.rack1.pk}) From b475a575e43003143ae80f858995934a89319860 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Fri, 14 Feb 2020 15:04:33 -0500 Subject: [PATCH 003/124] Drop family column from Aggregate, Prefix, and IPAddress models --- netbox/ipam/fields.py | 2 + netbox/ipam/filters.py | 6 +- netbox/ipam/lookups.py | 9 +++ netbox/ipam/managers.py | 2 +- netbox/ipam/migrations/0035_drop_ip_family.py | 38 ++++++++++++ netbox/ipam/models.py | 58 +++++++++---------- netbox/ipam/views.py | 2 +- netbox/templates/ipam/aggregate.html | 2 +- netbox/templates/ipam/ipaddress.html | 2 +- netbox/templates/ipam/prefix.html | 2 +- 10 files changed, 83 insertions(+), 40 deletions(-) create mode 100644 netbox/ipam/migrations/0035_drop_ip_family.py diff --git a/netbox/ipam/fields.py b/netbox/ipam/fields.py index 456a7debc..7d28127a4 100644 --- a/netbox/ipam/fields.py +++ b/netbox/ipam/fields.py @@ -63,6 +63,7 @@ IPNetworkField.register_lookup(lookups.NetContained) IPNetworkField.register_lookup(lookups.NetContainedOrEqual) IPNetworkField.register_lookup(lookups.NetContains) IPNetworkField.register_lookup(lookups.NetContainsOrEquals) +IPNetworkField.register_lookup(lookups.NetFamily) IPNetworkField.register_lookup(lookups.NetMaskLength) @@ -90,4 +91,5 @@ IPAddressField.register_lookup(lookups.NetContainsOrEquals) IPAddressField.register_lookup(lookups.NetHost) IPAddressField.register_lookup(lookups.NetIn) IPAddressField.register_lookup(lookups.NetHostContained) +IPAddressField.register_lookup(lookups.NetFamily) IPAddressField.register_lookup(lookups.NetMaskLength) diff --git a/netbox/ipam/filters.py b/netbox/ipam/filters.py index 5f8bcabff..e773fed27 100644 --- a/netbox/ipam/filters.py +++ b/netbox/ipam/filters.py @@ -91,7 +91,7 @@ class AggregateFilterSet(CustomFieldFilterSet, CreatedUpdatedFilterSet): class Meta: model = Aggregate - fields = ['family', 'date_added'] + fields = ('date_added',) def search(self, queryset, name, value): if not value.strip(): @@ -211,7 +211,7 @@ class PrefixFilterSet(TenancyFilterSet, CustomFieldFilterSet, CreatedUpdatedFilt class Meta: model = Prefix - fields = ['family', 'is_pool'] + fields = ('is_pool',) def search(self, queryset, name, value): if not value.strip(): @@ -350,7 +350,7 @@ class IPAddressFilterSet(TenancyFilterSet, CustomFieldFilterSet, CreatedUpdatedF class Meta: model = IPAddress - fields = ['family', 'dns_name'] + fields = ('dns_name',) def search(self, queryset, name, value): if not value.strip(): diff --git a/netbox/ipam/lookups.py b/netbox/ipam/lookups.py index 62b356c5d..306e1e925 100644 --- a/netbox/ipam/lookups.py +++ b/netbox/ipam/lookups.py @@ -154,6 +154,15 @@ class NetHostContained(Lookup): return 'CAST(HOST(%s) AS INET) << %s' % (lhs, rhs), params +class NetFamily(Transform): + lookup_name = 'family' + function = 'FAMILY' + + @property + def output_field(self): + return IntegerField() + + class NetMaskLength(Transform): lookup_name = 'net_mask_length' function = 'MASKLEN' diff --git a/netbox/ipam/managers.py b/netbox/ipam/managers.py index 8aebc60ce..47dd08251 100644 --- a/netbox/ipam/managers.py +++ b/netbox/ipam/managers.py @@ -13,4 +13,4 @@ class IPAddressManager(models.Manager): IP address as a /32 or /128. """ qs = super().get_queryset() - return qs.annotate(host=RawSQL('INET(HOST(ipam_ipaddress.address))', [])).order_by('family', 'host') + return qs.annotate(host=RawSQL('INET(HOST(ipam_ipaddress.address))', [])).order_by('host') diff --git a/netbox/ipam/migrations/0035_drop_ip_family.py b/netbox/ipam/migrations/0035_drop_ip_family.py new file mode 100644 index 000000000..e0142973f --- /dev/null +++ b/netbox/ipam/migrations/0035_drop_ip_family.py @@ -0,0 +1,38 @@ +# Generated by Django 2.2.9 on 2020-02-14 19:36 + +from django.db import migrations +import django.db.models.expressions + + +class Migration(migrations.Migration): + + dependencies = [ + ('ipam', '0034_fix_ipaddress_status_dhcp'), + ] + + operations = [ + migrations.AlterModelOptions( + name='aggregate', + options={'ordering': ('prefix', 'pk')}, + ), + migrations.AlterModelOptions( + name='ipaddress', + options={'ordering': ('address', 'pk'), 'verbose_name': 'IP address', 'verbose_name_plural': 'IP addresses'}, + ), + migrations.AlterModelOptions( + name='prefix', + options={'ordering': (django.db.models.expressions.OrderBy(django.db.models.expressions.F('vrf'), nulls_first=True), 'prefix', 'pk'), 'verbose_name_plural': 'prefixes'}, + ), + migrations.RemoveField( + model_name='aggregate', + name='family', + ), + migrations.RemoveField( + model_name='ipaddress', + name='family', + ), + migrations.RemoveField( + model_name='prefix', + name='family', + ), + ] diff --git a/netbox/ipam/models.py b/netbox/ipam/models.py index b4ba92fb5..025c4c8af 100644 --- a/netbox/ipam/models.py +++ b/netbox/ipam/models.py @@ -150,9 +150,6 @@ class Aggregate(ChangeLoggedModel, CustomFieldModel): An aggregate exists at the root level of the IP address space hierarchy in NetBox. Aggregates are used to organize the hierarchy and track the overall utilization of available address space. Each Aggregate is assigned to a RIR. """ - family = models.PositiveSmallIntegerField( - choices=IPAddressFamilyChoices - ) prefix = IPNetworkField() rir = models.ForeignKey( to='ipam.RIR', @@ -182,7 +179,7 @@ class Aggregate(ChangeLoggedModel, CustomFieldModel): ] class Meta: - ordering = ('family', 'prefix', 'pk') # (family, prefix) may be non-unique + ordering = ('prefix', 'pk') # prefix may be non-unique def __str__(self): return str(self.prefix) @@ -225,12 +222,6 @@ class Aggregate(ChangeLoggedModel, CustomFieldModel): ) }) - def save(self, *args, **kwargs): - if self.prefix: - # Infer address family from IPNetwork object - self.family = self.prefix.version - super().save(*args, **kwargs) - def to_csv(self): return ( self.prefix, @@ -239,6 +230,12 @@ class Aggregate(ChangeLoggedModel, CustomFieldModel): self.description, ) + @property + def family(self): + if self.prefix: + return self.prefix.version + return None + def get_utilization(self): """ Determine the prefix utilization of the aggregate and return it as a percentage. @@ -291,10 +288,6 @@ class Prefix(ChangeLoggedModel, CustomFieldModel): VRFs. A Prefix must be assigned a status and may optionally be assigned a used-define Role. A Prefix can also be assigned to a VLAN where appropriate. """ - family = models.PositiveSmallIntegerField( - choices=IPAddressFamilyChoices, - editable=False - ) prefix = IPNetworkField( help_text='IPv4 or IPv6 network with mask' ) @@ -376,7 +369,7 @@ class Prefix(ChangeLoggedModel, CustomFieldModel): } class Meta: - ordering = (F('vrf').asc(nulls_first=True), 'family', 'prefix', 'pk') # (vrf, family, prefix) may be non-unique + ordering = (F('vrf').asc(nulls_first=True), 'prefix', 'pk') # (vrf, prefix) may be non-unique verbose_name_plural = 'prefixes' def __str__(self): @@ -423,9 +416,6 @@ class Prefix(ChangeLoggedModel, CustomFieldModel): # Clear host bits from prefix self.prefix = self.prefix.cidr - # Record address family - self.family = self.prefix.version - super().save(*args, **kwargs) def to_csv(self): @@ -442,6 +432,12 @@ class Prefix(ChangeLoggedModel, CustomFieldModel): self.description, ) + @property + def family(self): + if self.prefix: + return self.prefix.version + return None + def _set_prefix_length(self, value): """ Expose the IPNetwork object's prefixlen attribute on the parent model so that it can be manipulated directly, @@ -501,9 +497,9 @@ class Prefix(ChangeLoggedModel, CustomFieldModel): # All IP addresses within a point-to-point prefix (IPv4 /31 or IPv6 /127) are considered usable if ( - self.family == 4 and self.prefix.prefixlen == 31 # RFC 3021 + self.prefix.version == 4 and self.prefix.prefixlen == 31 # RFC 3021 ) or ( - self.family == 6 and self.prefix.prefixlen == 127 # RFC 6164 + self.prefix.version == 6 and self.prefix.prefixlen == 127 # RFC 6164 ): return available_ips @@ -546,7 +542,7 @@ class Prefix(ChangeLoggedModel, CustomFieldModel): # Compile an IPSet to avoid counting duplicate IPs child_count = netaddr.IPSet([ip.address.ip for ip in self.get_child_ips()]).size prefix_size = self.prefix.size - if self.family == 4 and self.prefix.prefixlen < 31 and not self.is_pool: + if self.prefix.version == 4 and self.prefix.prefixlen < 31 and not self.is_pool: prefix_size -= 2 return int(float(child_count) / prefix_size * 100) @@ -562,10 +558,6 @@ class IPAddress(ChangeLoggedModel, CustomFieldModel): for example, when mapping public addresses to private addresses. When an Interface has been assigned an IPAddress which has a NAT outside IP, that Interface's Device can use either the inside or outside IP as its primary IP. """ - family = models.PositiveSmallIntegerField( - choices=IPAddressFamilyChoices, - editable=False - ) address = IPAddressField( help_text='IPv4 or IPv6 address (with mask)' ) @@ -659,7 +651,7 @@ class IPAddress(ChangeLoggedModel, CustomFieldModel): } class Meta: - ordering = ('family', 'address', 'pk') # (family, address) may be non-unique + ordering = ('address', 'pk') # address may be non-unique verbose_name = 'IP address' verbose_name_plural = 'IP addresses' @@ -727,10 +719,6 @@ class IPAddress(ChangeLoggedModel, CustomFieldModel): def save(self, *args, **kwargs): - # Record address family - if isinstance(self.address, netaddr.IPNetwork): - self.family = self.address.version - # Force dns_name to lowercase self.dns_name = self.dns_name.lower() @@ -754,9 +742,9 @@ class IPAddress(ChangeLoggedModel, CustomFieldModel): def to_csv(self): # Determine if this IP is primary for a Device - if self.family == 4 and getattr(self, 'primary_ip4_for', False): + if self.address.version == 4 and getattr(self, 'primary_ip4_for', False): is_primary = True - elif self.family == 6 and getattr(self, 'primary_ip6_for', False): + elif self.address.version == 6 and getattr(self, 'primary_ip6_for', False): is_primary = True else: is_primary = False @@ -775,6 +763,12 @@ class IPAddress(ChangeLoggedModel, CustomFieldModel): self.description, ) + @property + def family(self): + if self.address: + return self.address.version + return None + def _set_mask_length(self, value): """ Expose the IPNetwork object's prefixlen attribute on the parent model so that it can be manipulated directly, diff --git a/netbox/ipam/views.py b/netbox/ipam/views.py index 053098f0b..faf349222 100644 --- a/netbox/ipam/views.py +++ b/netbox/ipam/views.py @@ -207,7 +207,7 @@ class RIRListView(PermissionRequiredMixin, ObjectListView): 'deprecated': 0, 'available': 0, } - aggregate_list = Aggregate.objects.filter(family=family, rir=rir) + aggregate_list = Aggregate.objects.filter(prefix__family=family, rir=rir) for aggregate in aggregate_list: queryset = Prefix.objects.filter(prefix__net_contained_or_equal=str(aggregate.prefix)) diff --git a/netbox/templates/ipam/aggregate.html b/netbox/templates/ipam/aggregate.html index 66281aace..c34380722 100644 --- a/netbox/templates/ipam/aggregate.html +++ b/netbox/templates/ipam/aggregate.html @@ -64,7 +64,7 @@ - + diff --git a/netbox/templates/ipam/ipaddress.html b/netbox/templates/ipam/ipaddress.html index 50bd90610..167d3fddf 100644 --- a/netbox/templates/ipam/ipaddress.html +++ b/netbox/templates/ipam/ipaddress.html @@ -65,7 +65,7 @@
Family{{ aggregate.get_family_display }}IPv{{ aggregate.family }}
RIR
- + diff --git a/netbox/templates/ipam/prefix.html b/netbox/templates/ipam/prefix.html index 324bd927d..f14cab259 100644 --- a/netbox/templates/ipam/prefix.html +++ b/netbox/templates/ipam/prefix.html @@ -85,7 +85,7 @@
Family{{ ipaddress.get_family_display }}IPv{{ ipaddress.family }}
VRF
- + From 047f13ac5d47038568f49ea55d0861222a93e4b0 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Fri, 14 Feb 2020 15:07:59 -0500 Subject: [PATCH 004/124] Update tests --- netbox/dcim/tests/test_filters.py | 4 +- netbox/ipam/tests/test_filters.py | 52 +++++----- netbox/ipam/tests/test_models.py | 95 +++++++++--------- netbox/ipam/tests/test_ordering.py | 154 ++++++++++++++--------------- netbox/ipam/tests/test_views.py | 18 ++-- 5 files changed, 161 insertions(+), 162 deletions(-) diff --git a/netbox/dcim/tests/test_filters.py b/netbox/dcim/tests/test_filters.py index 83f40fe56..16c1ca58d 100644 --- a/netbox/dcim/tests/test_filters.py +++ b/netbox/dcim/tests/test_filters.py @@ -1144,8 +1144,8 @@ class DeviceTestCase(TestCase): # Assign primary IPs for filtering ipaddresses = ( - IPAddress(family=4, address='192.0.2.1/24', interface=interfaces[0]), - IPAddress(family=4, address='192.0.2.2/24', interface=interfaces[1]), + IPAddress(address='192.0.2.1/24', interface=interfaces[0]), + IPAddress(address='192.0.2.2/24', interface=interfaces[1]), ) IPAddress.objects.bulk_create(ipaddresses) Device.objects.filter(pk=devices[0].pk).update(primary_ip4=ipaddresses[0]) diff --git a/netbox/ipam/tests/test_filters.py b/netbox/ipam/tests/test_filters.py index 4737a0f53..f523b1d20 100644 --- a/netbox/ipam/tests/test_filters.py +++ b/netbox/ipam/tests/test_filters.py @@ -96,12 +96,12 @@ class AggregateTestCase(TestCase): RIR.objects.bulk_create(rirs) aggregates = ( - Aggregate(family=4, prefix='10.1.0.0/16', rir=rirs[0], date_added='2020-01-01'), - Aggregate(family=4, prefix='10.2.0.0/16', rir=rirs[0], date_added='2020-01-02'), - Aggregate(family=4, prefix='10.3.0.0/16', rir=rirs[1], date_added='2020-01-03'), - Aggregate(family=6, prefix='2001:db8:1::/48', rir=rirs[1], date_added='2020-01-04'), - Aggregate(family=6, prefix='2001:db8:2::/48', rir=rirs[2], date_added='2020-01-05'), - Aggregate(family=6, prefix='2001:db8:3::/48', rir=rirs[2], date_added='2020-01-06'), + Aggregate(prefix='10.1.0.0/16', rir=rirs[0], date_added='2020-01-01'), + Aggregate(prefix='10.2.0.0/16', rir=rirs[0], date_added='2020-01-02'), + Aggregate(prefix='10.3.0.0/16', rir=rirs[1], date_added='2020-01-03'), + Aggregate(prefix='2001:db8:1::/48', rir=rirs[1], date_added='2020-01-04'), + Aggregate(prefix='2001:db8:2::/48', rir=rirs[2], date_added='2020-01-05'), + Aggregate(prefix='2001:db8:3::/48', rir=rirs[2], date_added='2020-01-06'), ) Aggregate.objects.bulk_create(aggregates) @@ -199,16 +199,16 @@ class PrefixTestCase(TestCase): Role.objects.bulk_create(roles) prefixes = ( - Prefix(family=4, prefix='10.0.0.0/24', site=None, vrf=None, vlan=None, role=None, is_pool=True), - Prefix(family=4, prefix='10.0.1.0/24', site=sites[0], vrf=vrfs[0], vlan=vlans[0], role=roles[0]), - Prefix(family=4, prefix='10.0.2.0/24', site=sites[1], vrf=vrfs[1], vlan=vlans[1], role=roles[1], status=PrefixStatusChoices.STATUS_DEPRECATED), - Prefix(family=4, prefix='10.0.3.0/24', site=sites[2], vrf=vrfs[2], vlan=vlans[2], role=roles[2], status=PrefixStatusChoices.STATUS_RESERVED), - Prefix(family=6, prefix='2001:db8::/64', site=None, vrf=None, vlan=None, role=None, is_pool=True), - Prefix(family=6, prefix='2001:db8:0:1::/64', site=sites[0], vrf=vrfs[0], vlan=vlans[0], role=roles[0]), - Prefix(family=6, prefix='2001:db8:0:2::/64', site=sites[1], vrf=vrfs[1], vlan=vlans[1], role=roles[1], status=PrefixStatusChoices.STATUS_DEPRECATED), - Prefix(family=6, prefix='2001:db8:0:3::/64', site=sites[2], vrf=vrfs[2], vlan=vlans[2], role=roles[2], status=PrefixStatusChoices.STATUS_RESERVED), - Prefix(family=4, prefix='10.0.0.0/16'), - Prefix(family=6, prefix='2001:db8::/32'), + Prefix(prefix='10.0.0.0/24', site=None, vrf=None, vlan=None, role=None, is_pool=True), + Prefix(prefix='10.0.1.0/24', site=sites[0], vrf=vrfs[0], vlan=vlans[0], role=roles[0]), + Prefix(prefix='10.0.2.0/24', site=sites[1], vrf=vrfs[1], vlan=vlans[1], role=roles[1], status=PrefixStatusChoices.STATUS_DEPRECATED), + Prefix(prefix='10.0.3.0/24', site=sites[2], vrf=vrfs[2], vlan=vlans[2], role=roles[2], status=PrefixStatusChoices.STATUS_RESERVED), + Prefix(prefix='2001:db8::/64', site=None, vrf=None, vlan=None, role=None, is_pool=True), + Prefix(prefix='2001:db8:0:1::/64', site=sites[0], vrf=vrfs[0], vlan=vlans[0], role=roles[0]), + Prefix(prefix='2001:db8:0:2::/64', site=sites[1], vrf=vrfs[1], vlan=vlans[1], role=roles[1], status=PrefixStatusChoices.STATUS_DEPRECATED), + Prefix(prefix='2001:db8:0:3::/64', site=sites[2], vrf=vrfs[2], vlan=vlans[2], role=roles[2], status=PrefixStatusChoices.STATUS_RESERVED), + Prefix(prefix='10.0.0.0/16'), + Prefix(prefix='2001:db8::/32'), ) Prefix.objects.bulk_create(prefixes) @@ -333,16 +333,16 @@ class IPAddressTestCase(TestCase): Interface.objects.bulk_create(interfaces) ipaddresses = ( - IPAddress(family=4, address='10.0.0.1/24', vrf=None, interface=None, status=IPAddressStatusChoices.STATUS_ACTIVE, dns_name='ipaddress-a'), - IPAddress(family=4, address='10.0.0.2/24', vrf=vrfs[0], interface=interfaces[0], status=IPAddressStatusChoices.STATUS_ACTIVE, dns_name='ipaddress-b'), - IPAddress(family=4, address='10.0.0.3/24', vrf=vrfs[1], interface=interfaces[1], status=IPAddressStatusChoices.STATUS_RESERVED, role=IPAddressRoleChoices.ROLE_VIP, dns_name='ipaddress-c'), - IPAddress(family=4, address='10.0.0.4/24', vrf=vrfs[2], interface=interfaces[2], status=IPAddressStatusChoices.STATUS_DEPRECATED, role=IPAddressRoleChoices.ROLE_SECONDARY, dns_name='ipaddress-d'), - IPAddress(family=4, address='10.0.0.1/25', vrf=None, interface=None, status=IPAddressStatusChoices.STATUS_ACTIVE), - IPAddress(family=6, address='2001:db8::1/64', vrf=None, interface=None, status=IPAddressStatusChoices.STATUS_ACTIVE, dns_name='ipaddress-a'), - IPAddress(family=6, address='2001:db8::2/64', vrf=vrfs[0], interface=interfaces[3], status=IPAddressStatusChoices.STATUS_ACTIVE, dns_name='ipaddress-b'), - IPAddress(family=6, address='2001:db8::3/64', vrf=vrfs[1], interface=interfaces[4], status=IPAddressStatusChoices.STATUS_RESERVED, role=IPAddressRoleChoices.ROLE_VIP, dns_name='ipaddress-c'), - IPAddress(family=6, address='2001:db8::4/64', vrf=vrfs[2], interface=interfaces[5], status=IPAddressStatusChoices.STATUS_DEPRECATED, role=IPAddressRoleChoices.ROLE_SECONDARY, dns_name='ipaddress-d'), - IPAddress(family=6, address='2001:db8::1/65', vrf=None, interface=None, status=IPAddressStatusChoices.STATUS_ACTIVE), + IPAddress(address='10.0.0.1/24', vrf=None, interface=None, status=IPAddressStatusChoices.STATUS_ACTIVE, dns_name='ipaddress-a'), + IPAddress(address='10.0.0.2/24', vrf=vrfs[0], interface=interfaces[0], status=IPAddressStatusChoices.STATUS_ACTIVE, dns_name='ipaddress-b'), + IPAddress(address='10.0.0.3/24', vrf=vrfs[1], interface=interfaces[1], status=IPAddressStatusChoices.STATUS_RESERVED, role=IPAddressRoleChoices.ROLE_VIP, dns_name='ipaddress-c'), + IPAddress(address='10.0.0.4/24', vrf=vrfs[2], interface=interfaces[2], status=IPAddressStatusChoices.STATUS_DEPRECATED, role=IPAddressRoleChoices.ROLE_SECONDARY, dns_name='ipaddress-d'), + IPAddress(address='10.0.0.1/25', vrf=None, interface=None, status=IPAddressStatusChoices.STATUS_ACTIVE), + IPAddress(address='2001:db8::1/64', vrf=None, interface=None, status=IPAddressStatusChoices.STATUS_ACTIVE, dns_name='ipaddress-a'), + IPAddress(address='2001:db8::2/64', vrf=vrfs[0], interface=interfaces[3], status=IPAddressStatusChoices.STATUS_ACTIVE, dns_name='ipaddress-b'), + IPAddress(address='2001:db8::3/64', vrf=vrfs[1], interface=interfaces[4], status=IPAddressStatusChoices.STATUS_RESERVED, role=IPAddressRoleChoices.ROLE_VIP, dns_name='ipaddress-c'), + IPAddress(address='2001:db8::4/64', vrf=vrfs[2], interface=interfaces[5], status=IPAddressStatusChoices.STATUS_DEPRECATED, role=IPAddressRoleChoices.ROLE_SECONDARY, dns_name='ipaddress-d'), + IPAddress(address='2001:db8::1/65', vrf=None, interface=None, status=IPAddressStatusChoices.STATUS_ACTIVE), ) IPAddress.objects.bulk_create(ipaddresses) diff --git a/netbox/ipam/tests/test_models.py b/netbox/ipam/tests/test_models.py index 235fae67f..6091aa70e 100644 --- a/netbox/ipam/tests/test_models.py +++ b/netbox/ipam/tests/test_models.py @@ -15,22 +15,22 @@ class TestAggregate(TestCase): # 25% utilization Prefix.objects.bulk_create(( - Prefix(family=4, prefix=netaddr.IPNetwork('10.0.0.0/12')), - Prefix(family=4, prefix=netaddr.IPNetwork('10.16.0.0/12')), - Prefix(family=4, prefix=netaddr.IPNetwork('10.32.0.0/12')), - Prefix(family=4, prefix=netaddr.IPNetwork('10.48.0.0/12')), + Prefix(prefix=netaddr.IPNetwork('10.0.0.0/12')), + Prefix(prefix=netaddr.IPNetwork('10.16.0.0/12')), + Prefix(prefix=netaddr.IPNetwork('10.32.0.0/12')), + Prefix(prefix=netaddr.IPNetwork('10.48.0.0/12')), )) self.assertEqual(aggregate.get_utilization(), 25) # 50% utilization Prefix.objects.bulk_create(( - Prefix(family=4, prefix=netaddr.IPNetwork('10.64.0.0/10')), + Prefix(prefix=netaddr.IPNetwork('10.64.0.0/10')), )) self.assertEqual(aggregate.get_utilization(), 50) # 100% utilization Prefix.objects.bulk_create(( - Prefix(family=4, prefix=netaddr.IPNetwork('10.128.0.0/9')), + Prefix(prefix=netaddr.IPNetwork('10.128.0.0/9')), )) self.assertEqual(aggregate.get_utilization(), 100) @@ -39,9 +39,9 @@ class TestPrefix(TestCase): def test_get_duplicates(self): prefixes = Prefix.objects.bulk_create(( - Prefix(family=4, prefix=netaddr.IPNetwork('192.0.2.0/24')), - Prefix(family=4, prefix=netaddr.IPNetwork('192.0.2.0/24')), - Prefix(family=4, prefix=netaddr.IPNetwork('192.0.2.0/24')), + Prefix(prefix=netaddr.IPNetwork('192.0.2.0/24')), + Prefix(prefix=netaddr.IPNetwork('192.0.2.0/24')), + Prefix(prefix=netaddr.IPNetwork('192.0.2.0/24')), )) duplicate_prefix_pks = [p.pk for p in prefixes[0].get_duplicates()] @@ -54,11 +54,11 @@ class TestPrefix(TestCase): VRF(name='VRF 3'), )) prefixes = Prefix.objects.bulk_create(( - Prefix(family=4, prefix=netaddr.IPNetwork('10.0.0.0/16'), status=PrefixStatusChoices.STATUS_CONTAINER), - Prefix(family=4, prefix=netaddr.IPNetwork('10.0.0.0/24'), vrf=None), - Prefix(family=4, prefix=netaddr.IPNetwork('10.0.1.0/24'), vrf=vrfs[0]), - Prefix(family=4, prefix=netaddr.IPNetwork('10.0.2.0/24'), vrf=vrfs[1]), - Prefix(family=4, prefix=netaddr.IPNetwork('10.0.3.0/24'), vrf=vrfs[2]), + Prefix(prefix=netaddr.IPNetwork('10.0.0.0/16'), status=PrefixStatusChoices.STATUS_CONTAINER), + Prefix(prefix=netaddr.IPNetwork('10.0.0.0/24'), vrf=None), + Prefix(prefix=netaddr.IPNetwork('10.0.1.0/24'), vrf=vrfs[0]), + Prefix(prefix=netaddr.IPNetwork('10.0.2.0/24'), vrf=vrfs[1]), + Prefix(prefix=netaddr.IPNetwork('10.0.3.0/24'), vrf=vrfs[2]), )) child_prefix_pks = {p.pk for p in prefixes[0].get_child_prefixes()} @@ -79,13 +79,13 @@ class TestPrefix(TestCase): VRF(name='VRF 3'), )) parent_prefix = Prefix.objects.create( - family=4, prefix=netaddr.IPNetwork('10.0.0.0/16'), status=PrefixStatusChoices.STATUS_CONTAINER + prefix=netaddr.IPNetwork('10.0.0.0/16'), status=PrefixStatusChoices.STATUS_CONTAINER ) ips = IPAddress.objects.bulk_create(( - IPAddress(family=4, address=netaddr.IPNetwork('10.0.0.1/24'), vrf=None), - IPAddress(family=4, address=netaddr.IPNetwork('10.0.1.1/24'), vrf=vrfs[0]), - IPAddress(family=4, address=netaddr.IPNetwork('10.0.2.1/24'), vrf=vrfs[1]), - IPAddress(family=4, address=netaddr.IPNetwork('10.0.3.1/24'), vrf=vrfs[2]), + IPAddress(address=netaddr.IPNetwork('10.0.0.1/24'), vrf=None), + IPAddress(address=netaddr.IPNetwork('10.0.1.1/24'), vrf=vrfs[0]), + IPAddress(address=netaddr.IPNetwork('10.0.2.1/24'), vrf=vrfs[1]), + IPAddress(address=netaddr.IPNetwork('10.0.3.1/24'), vrf=vrfs[2]), )) child_ip_pks = {p.pk for p in parent_prefix.get_child_ips()} @@ -102,10 +102,10 @@ class TestPrefix(TestCase): def test_get_available_prefixes(self): prefixes = Prefix.objects.bulk_create(( - Prefix(family=4, prefix=netaddr.IPNetwork('10.0.0.0/16')), # Parent prefix - Prefix(family=4, prefix=netaddr.IPNetwork('10.0.0.0/20')), - Prefix(family=4, prefix=netaddr.IPNetwork('10.0.32.0/20')), - Prefix(family=4, prefix=netaddr.IPNetwork('10.0.128.0/18')), + Prefix(prefix=netaddr.IPNetwork('10.0.0.0/16')), # Parent prefix + Prefix(prefix=netaddr.IPNetwork('10.0.0.0/20')), + Prefix(prefix=netaddr.IPNetwork('10.0.32.0/20')), + Prefix(prefix=netaddr.IPNetwork('10.0.128.0/18')), )) missing_prefixes = netaddr.IPSet([ netaddr.IPNetwork('10.0.16.0/20'), @@ -119,15 +119,15 @@ class TestPrefix(TestCase): def test_get_available_ips(self): - parent_prefix = Prefix.objects.create(family=4, prefix=netaddr.IPNetwork('10.0.0.0/28')) + parent_prefix = Prefix.objects.create(prefix=netaddr.IPNetwork('10.0.0.0/28')) IPAddress.objects.bulk_create(( - IPAddress(family=4, address=netaddr.IPNetwork('10.0.0.1/26')), - IPAddress(family=4, address=netaddr.IPNetwork('10.0.0.3/26')), - IPAddress(family=4, address=netaddr.IPNetwork('10.0.0.5/26')), - IPAddress(family=4, address=netaddr.IPNetwork('10.0.0.7/26')), - IPAddress(family=4, address=netaddr.IPNetwork('10.0.0.9/26')), - IPAddress(family=4, address=netaddr.IPNetwork('10.0.0.11/26')), - IPAddress(family=4, address=netaddr.IPNetwork('10.0.0.13/26')), + IPAddress(address=netaddr.IPNetwork('10.0.0.1/26')), + IPAddress(address=netaddr.IPNetwork('10.0.0.3/26')), + IPAddress(address=netaddr.IPNetwork('10.0.0.5/26')), + IPAddress(address=netaddr.IPNetwork('10.0.0.7/26')), + IPAddress(address=netaddr.IPNetwork('10.0.0.9/26')), + IPAddress(address=netaddr.IPNetwork('10.0.0.11/26')), + IPAddress(address=netaddr.IPNetwork('10.0.0.13/26')), )) missing_ips = netaddr.IPSet([ '10.0.0.2/32', @@ -145,40 +145,39 @@ class TestPrefix(TestCase): def test_get_first_available_prefix(self): prefixes = Prefix.objects.bulk_create(( - Prefix(family=4, prefix=netaddr.IPNetwork('10.0.0.0/16')), # Parent prefix - Prefix(family=4, prefix=netaddr.IPNetwork('10.0.0.0/24')), - Prefix(family=4, prefix=netaddr.IPNetwork('10.0.1.0/24')), - Prefix(family=4, prefix=netaddr.IPNetwork('10.0.2.0/24')), + Prefix(prefix=netaddr.IPNetwork('10.0.0.0/16')), # Parent prefix + Prefix(prefix=netaddr.IPNetwork('10.0.0.0/24')), + Prefix(prefix=netaddr.IPNetwork('10.0.1.0/24')), + Prefix(prefix=netaddr.IPNetwork('10.0.2.0/24')), )) self.assertEqual(prefixes[0].get_first_available_prefix(), netaddr.IPNetwork('10.0.3.0/24')) - Prefix.objects.create(family=4, prefix=netaddr.IPNetwork('10.0.3.0/24')) + Prefix.objects.create(prefix=netaddr.IPNetwork('10.0.3.0/24')) self.assertEqual(prefixes[0].get_first_available_prefix(), netaddr.IPNetwork('10.0.4.0/22')) def test_get_first_available_ip(self): - parent_prefix = Prefix.objects.create(family=4, prefix=netaddr.IPNetwork('10.0.0.0/24')) + parent_prefix = Prefix.objects.create(prefix=netaddr.IPNetwork('10.0.0.0/24')) IPAddress.objects.bulk_create(( - IPAddress(family=4, address=netaddr.IPNetwork('10.0.0.1/24')), - IPAddress(family=4, address=netaddr.IPNetwork('10.0.0.2/24')), - IPAddress(family=4, address=netaddr.IPNetwork('10.0.0.3/24')), + IPAddress(address=netaddr.IPNetwork('10.0.0.1/24')), + IPAddress(address=netaddr.IPNetwork('10.0.0.2/24')), + IPAddress(address=netaddr.IPNetwork('10.0.0.3/24')), )) self.assertEqual(parent_prefix.get_first_available_ip(), '10.0.0.4/24') - IPAddress.objects.create(family=4, address=netaddr.IPNetwork('10.0.0.4/24')) + IPAddress.objects.create(address=netaddr.IPNetwork('10.0.0.4/24')) self.assertEqual(parent_prefix.get_first_available_ip(), '10.0.0.5/24') def test_get_utilization(self): # Container Prefix prefix = Prefix.objects.create( - family=4, prefix=netaddr.IPNetwork('10.0.0.0/24'), status=PrefixStatusChoices.STATUS_CONTAINER ) Prefix.objects.bulk_create(( - Prefix(family=4, prefix=netaddr.IPNetwork('10.0.0.0/26')), - Prefix(family=4, prefix=netaddr.IPNetwork('10.0.0.128/26')), + Prefix(prefix=netaddr.IPNetwork('10.0.0.0/26')), + Prefix(prefix=netaddr.IPNetwork('10.0.0.128/26')), )) self.assertEqual(prefix.get_utilization(), 50) @@ -187,7 +186,7 @@ class TestPrefix(TestCase): prefix.save() IPAddress.objects.bulk_create( # Create 32 IPAddresses within the Prefix - [IPAddress(family=4, address=netaddr.IPNetwork('10.0.0.{}/24'.format(i))) for i in range(1, 33)] + [IPAddress(address=netaddr.IPNetwork('10.0.0.{}/24'.format(i))) for i in range(1, 33)] ) self.assertEqual(prefix.get_utilization(), 12) # ~= 12% @@ -224,9 +223,9 @@ class TestIPAddress(TestCase): def test_get_duplicates(self): ips = IPAddress.objects.bulk_create(( - IPAddress(family=4, address=netaddr.IPNetwork('192.0.2.1/24')), - IPAddress(family=4, address=netaddr.IPNetwork('192.0.2.1/24')), - IPAddress(family=4, address=netaddr.IPNetwork('192.0.2.1/24')), + IPAddress(address=netaddr.IPNetwork('192.0.2.1/24')), + IPAddress(address=netaddr.IPNetwork('192.0.2.1/24')), + IPAddress(address=netaddr.IPNetwork('192.0.2.1/24')), )) duplicate_ip_pks = [p.pk for p in ips[0].get_duplicates()] diff --git a/netbox/ipam/tests/test_ordering.py b/netbox/ipam/tests/test_ordering.py index 153bedddc..690501e53 100644 --- a/netbox/ipam/tests/test_ordering.py +++ b/netbox/ipam/tests/test_ordering.py @@ -42,45 +42,45 @@ class PrefixOrderingTestCase(OrderingTestBase): # Setup Prefixes prefixes = ( - Prefix(status=PrefixStatusChoices.STATUS_CONTAINER, vrf=None, family=4, prefix=netaddr.IPNetwork('192.168.0.0/16')), - Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=None, family=4, prefix=netaddr.IPNetwork('192.168.0.0/24')), - Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=None, family=4, prefix=netaddr.IPNetwork('192.168.1.0/24')), - Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=None, family=4, prefix=netaddr.IPNetwork('192.168.2.0/24')), - Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=None, family=4, prefix=netaddr.IPNetwork('192.168.3.0/24')), - Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=None, family=4, prefix=netaddr.IPNetwork('192.168.4.0/24')), - Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=None, family=4, prefix=netaddr.IPNetwork('192.168.5.0/24')), + Prefix(status=PrefixStatusChoices.STATUS_CONTAINER, vrf=None, prefix=netaddr.IPNetwork('192.168.0.0/16')), + Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=None, prefix=netaddr.IPNetwork('192.168.0.0/24')), + Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=None, prefix=netaddr.IPNetwork('192.168.1.0/24')), + Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=None, prefix=netaddr.IPNetwork('192.168.2.0/24')), + Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=None, prefix=netaddr.IPNetwork('192.168.3.0/24')), + Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=None, prefix=netaddr.IPNetwork('192.168.4.0/24')), + Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=None, prefix=netaddr.IPNetwork('192.168.5.0/24')), - Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=vrfa, family=4, prefix=netaddr.IPNetwork('10.0.0.0/8')), - Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=vrfa, family=4, prefix=netaddr.IPNetwork('10.0.0.0/16')), - Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=vrfa, family=4, prefix=netaddr.IPNetwork('10.0.0.0/24')), - Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=vrfa, family=4, prefix=netaddr.IPNetwork('10.0.1.0/24')), - Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=vrfa, family=4, prefix=netaddr.IPNetwork('10.0.2.0/24')), - Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=vrfa, family=4, prefix=netaddr.IPNetwork('10.0.3.0/24')), - Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=vrfa, family=4, prefix=netaddr.IPNetwork('10.0.4.0/24')), - Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=vrfa, family=4, prefix=netaddr.IPNetwork('10.1.0.0/16')), - Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=vrfa, family=4, prefix=netaddr.IPNetwork('10.1.1.0/24')), - Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=vrfa, family=4, prefix=netaddr.IPNetwork('10.1.2.0/24')), - Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=vrfa, family=4, prefix=netaddr.IPNetwork('10.1.3.0/24')), - Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=vrfa, family=4, prefix=netaddr.IPNetwork('10.1.4.0/24')), - Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=vrfa, family=4, prefix=netaddr.IPNetwork('10.2.0.0/16')), - Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=vrfa, family=4, prefix=netaddr.IPNetwork('10.2.1.0/24')), - Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=vrfa, family=4, prefix=netaddr.IPNetwork('10.2.2.0/24')), - Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=vrfa, family=4, prefix=netaddr.IPNetwork('10.2.3.0/24')), - Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=vrfa, family=4, prefix=netaddr.IPNetwork('10.2.4.0/24')), + Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=vrfa, prefix=netaddr.IPNetwork('10.0.0.0/8')), + Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=vrfa, prefix=netaddr.IPNetwork('10.0.0.0/16')), + Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=vrfa, prefix=netaddr.IPNetwork('10.0.0.0/24')), + Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=vrfa, prefix=netaddr.IPNetwork('10.0.1.0/24')), + Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=vrfa, prefix=netaddr.IPNetwork('10.0.2.0/24')), + Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=vrfa, prefix=netaddr.IPNetwork('10.0.3.0/24')), + Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=vrfa, prefix=netaddr.IPNetwork('10.0.4.0/24')), + Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=vrfa, prefix=netaddr.IPNetwork('10.1.0.0/16')), + Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=vrfa, prefix=netaddr.IPNetwork('10.1.1.0/24')), + Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=vrfa, prefix=netaddr.IPNetwork('10.1.2.0/24')), + Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=vrfa, prefix=netaddr.IPNetwork('10.1.3.0/24')), + Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=vrfa, prefix=netaddr.IPNetwork('10.1.4.0/24')), + Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=vrfa, prefix=netaddr.IPNetwork('10.2.0.0/16')), + Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=vrfa, prefix=netaddr.IPNetwork('10.2.1.0/24')), + Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=vrfa, prefix=netaddr.IPNetwork('10.2.2.0/24')), + Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=vrfa, prefix=netaddr.IPNetwork('10.2.3.0/24')), + Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=vrfa, prefix=netaddr.IPNetwork('10.2.4.0/24')), - Prefix(status=PrefixStatusChoices.STATUS_CONTAINER, vrf=vrfb, family=4, prefix=netaddr.IPNetwork('172.16.0.0/12')), - Prefix(status=PrefixStatusChoices.STATUS_CONTAINER, vrf=vrfb, family=4, prefix=netaddr.IPNetwork('172.16.0.0/16')), - Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=vrfb, family=4, prefix=netaddr.IPNetwork('172.16.0.0/24')), - Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=vrfb, family=4, prefix=netaddr.IPNetwork('172.16.1.0/24')), - Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=vrfb, family=4, prefix=netaddr.IPNetwork('172.16.2.0/24')), - Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=vrfb, family=4, prefix=netaddr.IPNetwork('172.16.3.0/24')), - Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=vrfb, family=4, prefix=netaddr.IPNetwork('172.16.4.0/24')), - Prefix(status=PrefixStatusChoices.STATUS_CONTAINER, vrf=vrfb, family=4, prefix=netaddr.IPNetwork('172.17.0.0/16')), - Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=vrfb, family=4, prefix=netaddr.IPNetwork('172.17.0.0/24')), - Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=vrfb, family=4, prefix=netaddr.IPNetwork('172.17.1.0/24')), - Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=vrfb, family=4, prefix=netaddr.IPNetwork('172.17.2.0/24')), - Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=vrfb, family=4, prefix=netaddr.IPNetwork('172.17.3.0/24')), - Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=vrfb, family=4, prefix=netaddr.IPNetwork('172.17.4.0/24')), + Prefix(status=PrefixStatusChoices.STATUS_CONTAINER, vrf=vrfb, prefix=netaddr.IPNetwork('172.16.0.0/12')), + Prefix(status=PrefixStatusChoices.STATUS_CONTAINER, vrf=vrfb, prefix=netaddr.IPNetwork('172.16.0.0/16')), + Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=vrfb, prefix=netaddr.IPNetwork('172.16.0.0/24')), + Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=vrfb, prefix=netaddr.IPNetwork('172.16.1.0/24')), + Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=vrfb, prefix=netaddr.IPNetwork('172.16.2.0/24')), + Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=vrfb, prefix=netaddr.IPNetwork('172.16.3.0/24')), + Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=vrfb, prefix=netaddr.IPNetwork('172.16.4.0/24')), + Prefix(status=PrefixStatusChoices.STATUS_CONTAINER, vrf=vrfb, prefix=netaddr.IPNetwork('172.17.0.0/16')), + Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=vrfb, prefix=netaddr.IPNetwork('172.17.0.0/24')), + Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=vrfb, prefix=netaddr.IPNetwork('172.17.1.0/24')), + Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=vrfb, prefix=netaddr.IPNetwork('172.17.2.0/24')), + Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=vrfb, prefix=netaddr.IPNetwork('172.17.3.0/24')), + Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=vrfb, prefix=netaddr.IPNetwork('172.17.4.0/24')), ) Prefix.objects.bulk_create(prefixes) @@ -109,15 +109,15 @@ class PrefixOrderingTestCase(OrderingTestBase): # Setup Prefixes prefixes = [ - Prefix(status=PrefixStatusChoices.STATUS_CONTAINER, vrf=None, family=4, prefix=netaddr.IPNetwork('10.0.0.0/8')), - Prefix(status=PrefixStatusChoices.STATUS_CONTAINER, vrf=None, family=4, prefix=netaddr.IPNetwork('10.0.0.0/16')), - Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=None, family=4, prefix=netaddr.IPNetwork('10.1.0.0/16')), - Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=None, family=4, prefix=netaddr.IPNetwork('192.168.0.0/16')), - Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=vrfa, family=4, prefix=netaddr.IPNetwork('10.0.0.0/24')), - Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=vrfa, family=4, prefix=netaddr.IPNetwork('10.0.1.0/24')), - Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=vrfa, family=4, prefix=netaddr.IPNetwork('10.0.1.0/25')), - Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=vrfa, family=4, prefix=netaddr.IPNetwork('10.1.0.0/24')), - Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=vrfa, family=4, prefix=netaddr.IPNetwork('10.1.1.0/24')), + Prefix(status=PrefixStatusChoices.STATUS_CONTAINER, vrf=None, prefix=netaddr.IPNetwork('10.0.0.0/8')), + Prefix(status=PrefixStatusChoices.STATUS_CONTAINER, vrf=None, prefix=netaddr.IPNetwork('10.0.0.0/16')), + Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=None, prefix=netaddr.IPNetwork('10.1.0.0/16')), + Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=None, prefix=netaddr.IPNetwork('192.168.0.0/16')), + Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=vrfa, prefix=netaddr.IPNetwork('10.0.0.0/24')), + Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=vrfa, prefix=netaddr.IPNetwork('10.0.1.0/24')), + Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=vrfa, prefix=netaddr.IPNetwork('10.0.1.0/25')), + Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=vrfa, prefix=netaddr.IPNetwork('10.1.0.0/24')), + Prefix(status=PrefixStatusChoices.STATUS_ACTIVE, vrf=vrfa, prefix=netaddr.IPNetwork('10.1.1.0/24')), ] Prefix.objects.bulk_create(prefixes) @@ -136,39 +136,39 @@ class IPAddressOrderingTestCase(OrderingTestBase): # Setup Addresses addresses = ( - IPAddress(status=IPAddressStatusChoices.STATUS_ACTIVE, vrf=vrfa, family=4, address=netaddr.IPNetwork('10.0.0.1/24')), - IPAddress(status=IPAddressStatusChoices.STATUS_ACTIVE, vrf=vrfa, family=4, address=netaddr.IPNetwork('10.0.1.1/24')), - IPAddress(status=IPAddressStatusChoices.STATUS_ACTIVE, vrf=vrfa, family=4, address=netaddr.IPNetwork('10.0.2.1/24')), - IPAddress(status=IPAddressStatusChoices.STATUS_ACTIVE, vrf=vrfa, family=4, address=netaddr.IPNetwork('10.0.3.1/24')), - IPAddress(status=IPAddressStatusChoices.STATUS_ACTIVE, vrf=vrfa, family=4, address=netaddr.IPNetwork('10.0.4.1/24')), - IPAddress(status=IPAddressStatusChoices.STATUS_ACTIVE, vrf=vrfa, family=4, address=netaddr.IPNetwork('10.1.0.1/24')), - IPAddress(status=IPAddressStatusChoices.STATUS_ACTIVE, vrf=vrfa, family=4, address=netaddr.IPNetwork('10.1.1.1/24')), - IPAddress(status=IPAddressStatusChoices.STATUS_ACTIVE, vrf=vrfa, family=4, address=netaddr.IPNetwork('10.1.2.1/24')), - IPAddress(status=IPAddressStatusChoices.STATUS_ACTIVE, vrf=vrfa, family=4, address=netaddr.IPNetwork('10.1.3.1/24')), - IPAddress(status=IPAddressStatusChoices.STATUS_ACTIVE, vrf=vrfa, family=4, address=netaddr.IPNetwork('10.1.4.1/24')), - IPAddress(status=IPAddressStatusChoices.STATUS_ACTIVE, vrf=vrfa, family=4, address=netaddr.IPNetwork('10.2.0.1/24')), - IPAddress(status=IPAddressStatusChoices.STATUS_ACTIVE, vrf=vrfa, family=4, address=netaddr.IPNetwork('10.2.1.1/24')), - IPAddress(status=IPAddressStatusChoices.STATUS_ACTIVE, vrf=vrfa, family=4, address=netaddr.IPNetwork('10.2.2.1/24')), - IPAddress(status=IPAddressStatusChoices.STATUS_ACTIVE, vrf=vrfa, family=4, address=netaddr.IPNetwork('10.2.3.1/24')), - IPAddress(status=IPAddressStatusChoices.STATUS_ACTIVE, vrf=vrfa, family=4, address=netaddr.IPNetwork('10.2.4.1/24')), + IPAddress(status=IPAddressStatusChoices.STATUS_ACTIVE, vrf=vrfa, address=netaddr.IPNetwork('10.0.0.1/24')), + IPAddress(status=IPAddressStatusChoices.STATUS_ACTIVE, vrf=vrfa, address=netaddr.IPNetwork('10.0.1.1/24')), + IPAddress(status=IPAddressStatusChoices.STATUS_ACTIVE, vrf=vrfa, address=netaddr.IPNetwork('10.0.2.1/24')), + IPAddress(status=IPAddressStatusChoices.STATUS_ACTIVE, vrf=vrfa, address=netaddr.IPNetwork('10.0.3.1/24')), + IPAddress(status=IPAddressStatusChoices.STATUS_ACTIVE, vrf=vrfa, address=netaddr.IPNetwork('10.0.4.1/24')), + IPAddress(status=IPAddressStatusChoices.STATUS_ACTIVE, vrf=vrfa, address=netaddr.IPNetwork('10.1.0.1/24')), + IPAddress(status=IPAddressStatusChoices.STATUS_ACTIVE, vrf=vrfa, address=netaddr.IPNetwork('10.1.1.1/24')), + IPAddress(status=IPAddressStatusChoices.STATUS_ACTIVE, vrf=vrfa, address=netaddr.IPNetwork('10.1.2.1/24')), + IPAddress(status=IPAddressStatusChoices.STATUS_ACTIVE, vrf=vrfa, address=netaddr.IPNetwork('10.1.3.1/24')), + IPAddress(status=IPAddressStatusChoices.STATUS_ACTIVE, vrf=vrfa, address=netaddr.IPNetwork('10.1.4.1/24')), + IPAddress(status=IPAddressStatusChoices.STATUS_ACTIVE, vrf=vrfa, address=netaddr.IPNetwork('10.2.0.1/24')), + IPAddress(status=IPAddressStatusChoices.STATUS_ACTIVE, vrf=vrfa, address=netaddr.IPNetwork('10.2.1.1/24')), + IPAddress(status=IPAddressStatusChoices.STATUS_ACTIVE, vrf=vrfa, address=netaddr.IPNetwork('10.2.2.1/24')), + IPAddress(status=IPAddressStatusChoices.STATUS_ACTIVE, vrf=vrfa, address=netaddr.IPNetwork('10.2.3.1/24')), + IPAddress(status=IPAddressStatusChoices.STATUS_ACTIVE, vrf=vrfa, address=netaddr.IPNetwork('10.2.4.1/24')), - IPAddress(status=IPAddressStatusChoices.STATUS_ACTIVE, vrf=vrfb, family=4, address=netaddr.IPNetwork('172.16.0.1/24')), - IPAddress(status=IPAddressStatusChoices.STATUS_ACTIVE, vrf=vrfb, family=4, address=netaddr.IPNetwork('172.16.1.1/24')), - IPAddress(status=IPAddressStatusChoices.STATUS_ACTIVE, vrf=vrfb, family=4, address=netaddr.IPNetwork('172.16.2.1/24')), - IPAddress(status=IPAddressStatusChoices.STATUS_ACTIVE, vrf=vrfb, family=4, address=netaddr.IPNetwork('172.16.3.1/24')), - IPAddress(status=IPAddressStatusChoices.STATUS_ACTIVE, vrf=vrfb, family=4, address=netaddr.IPNetwork('172.16.4.1/24')), - IPAddress(status=IPAddressStatusChoices.STATUS_ACTIVE, vrf=vrfb, family=4, address=netaddr.IPNetwork('172.17.0.1/24')), - IPAddress(status=IPAddressStatusChoices.STATUS_ACTIVE, vrf=vrfb, family=4, address=netaddr.IPNetwork('172.17.1.1/24')), - IPAddress(status=IPAddressStatusChoices.STATUS_ACTIVE, vrf=vrfb, family=4, address=netaddr.IPNetwork('172.17.2.1/24')), - IPAddress(status=IPAddressStatusChoices.STATUS_ACTIVE, vrf=vrfb, family=4, address=netaddr.IPNetwork('172.17.3.1/24')), - IPAddress(status=IPAddressStatusChoices.STATUS_ACTIVE, vrf=vrfb, family=4, address=netaddr.IPNetwork('172.17.4.1/24')), + IPAddress(status=IPAddressStatusChoices.STATUS_ACTIVE, vrf=vrfb, address=netaddr.IPNetwork('172.16.0.1/24')), + IPAddress(status=IPAddressStatusChoices.STATUS_ACTIVE, vrf=vrfb, address=netaddr.IPNetwork('172.16.1.1/24')), + IPAddress(status=IPAddressStatusChoices.STATUS_ACTIVE, vrf=vrfb, address=netaddr.IPNetwork('172.16.2.1/24')), + IPAddress(status=IPAddressStatusChoices.STATUS_ACTIVE, vrf=vrfb, address=netaddr.IPNetwork('172.16.3.1/24')), + IPAddress(status=IPAddressStatusChoices.STATUS_ACTIVE, vrf=vrfb, address=netaddr.IPNetwork('172.16.4.1/24')), + IPAddress(status=IPAddressStatusChoices.STATUS_ACTIVE, vrf=vrfb, address=netaddr.IPNetwork('172.17.0.1/24')), + IPAddress(status=IPAddressStatusChoices.STATUS_ACTIVE, vrf=vrfb, address=netaddr.IPNetwork('172.17.1.1/24')), + IPAddress(status=IPAddressStatusChoices.STATUS_ACTIVE, vrf=vrfb, address=netaddr.IPNetwork('172.17.2.1/24')), + IPAddress(status=IPAddressStatusChoices.STATUS_ACTIVE, vrf=vrfb, address=netaddr.IPNetwork('172.17.3.1/24')), + IPAddress(status=IPAddressStatusChoices.STATUS_ACTIVE, vrf=vrfb, address=netaddr.IPNetwork('172.17.4.1/24')), - IPAddress(status=IPAddressStatusChoices.STATUS_ACTIVE, vrf=None, family=4, address=netaddr.IPNetwork('192.168.0.1/24')), - IPAddress(status=IPAddressStatusChoices.STATUS_ACTIVE, vrf=None, family=4, address=netaddr.IPNetwork('192.168.1.1/24')), - IPAddress(status=IPAddressStatusChoices.STATUS_ACTIVE, vrf=None, family=4, address=netaddr.IPNetwork('192.168.2.1/24')), - IPAddress(status=IPAddressStatusChoices.STATUS_ACTIVE, vrf=None, family=4, address=netaddr.IPNetwork('192.168.3.1/24')), - IPAddress(status=IPAddressStatusChoices.STATUS_ACTIVE, vrf=None, family=4, address=netaddr.IPNetwork('192.168.4.1/24')), - IPAddress(status=IPAddressStatusChoices.STATUS_ACTIVE, vrf=None, family=4, address=netaddr.IPNetwork('192.168.5.1/24')), + IPAddress(status=IPAddressStatusChoices.STATUS_ACTIVE, vrf=None, address=netaddr.IPNetwork('192.168.0.1/24')), + IPAddress(status=IPAddressStatusChoices.STATUS_ACTIVE, vrf=None, address=netaddr.IPNetwork('192.168.1.1/24')), + IPAddress(status=IPAddressStatusChoices.STATUS_ACTIVE, vrf=None, address=netaddr.IPNetwork('192.168.2.1/24')), + IPAddress(status=IPAddressStatusChoices.STATUS_ACTIVE, vrf=None, address=netaddr.IPNetwork('192.168.3.1/24')), + IPAddress(status=IPAddressStatusChoices.STATUS_ACTIVE, vrf=None, address=netaddr.IPNetwork('192.168.4.1/24')), + IPAddress(status=IPAddressStatusChoices.STATUS_ACTIVE, vrf=None, address=netaddr.IPNetwork('192.168.5.1/24')), ) IPAddress.objects.bulk_create(addresses) diff --git a/netbox/ipam/tests/test_views.py b/netbox/ipam/tests/test_views.py index 66e649005..82ae18faf 100644 --- a/netbox/ipam/tests/test_views.py +++ b/netbox/ipam/tests/test_views.py @@ -82,9 +82,9 @@ class AggregateTestCase(ViewTestCases.PrimaryObjectViewTestCase): RIR.objects.bulk_create(rirs) Aggregate.objects.bulk_create([ - Aggregate(family=4, prefix=IPNetwork('10.1.0.0/16'), rir=rirs[0]), - Aggregate(family=4, prefix=IPNetwork('10.2.0.0/16'), rir=rirs[0]), - Aggregate(family=4, prefix=IPNetwork('10.3.0.0/16'), rir=rirs[0]), + Aggregate(prefix=IPNetwork('10.1.0.0/16'), rir=rirs[0]), + Aggregate(prefix=IPNetwork('10.2.0.0/16'), rir=rirs[0]), + Aggregate(prefix=IPNetwork('10.3.0.0/16'), rir=rirs[0]), ]) cls.form_data = { @@ -161,9 +161,9 @@ class PrefixTestCase(ViewTestCases.PrimaryObjectViewTestCase): ) Prefix.objects.bulk_create([ - Prefix(family=4, prefix=IPNetwork('10.1.0.0/16'), vrf=vrfs[0], site=sites[0], role=roles[0]), - Prefix(family=4, prefix=IPNetwork('10.2.0.0/16'), vrf=vrfs[0], site=sites[0], role=roles[0]), - Prefix(family=4, prefix=IPNetwork('10.3.0.0/16'), vrf=vrfs[0], site=sites[0], role=roles[0]), + Prefix(prefix=IPNetwork('10.1.0.0/16'), vrf=vrfs[0], site=sites[0], role=roles[0]), + Prefix(prefix=IPNetwork('10.2.0.0/16'), vrf=vrfs[0], site=sites[0], role=roles[0]), + Prefix(prefix=IPNetwork('10.3.0.0/16'), vrf=vrfs[0], site=sites[0], role=roles[0]), ]) cls.form_data = { @@ -209,9 +209,9 @@ class IPAddressTestCase(ViewTestCases.PrimaryObjectViewTestCase): ) IPAddress.objects.bulk_create([ - IPAddress(family=4, address=IPNetwork('192.0.2.1/24'), vrf=vrfs[0]), - IPAddress(family=4, address=IPNetwork('192.0.2.2/24'), vrf=vrfs[0]), - IPAddress(family=4, address=IPNetwork('192.0.2.3/24'), vrf=vrfs[0]), + IPAddress(address=IPNetwork('192.0.2.1/24'), vrf=vrfs[0]), + IPAddress(address=IPNetwork('192.0.2.2/24'), vrf=vrfs[0]), + IPAddress(address=IPNetwork('192.0.2.3/24'), vrf=vrfs[0]), ]) cls.form_data = { From 8687226cc74b2dfb2c1e06ef929f57e0a58b953d Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Fri, 14 Feb 2020 15:11:12 -0500 Subject: [PATCH 005/124] Update family filters in querysets --- netbox/dcim/forms.py | 4 ++-- netbox/virtualization/forms.py | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/netbox/dcim/forms.py b/netbox/dcim/forms.py index 4c8a0821f..ad750404b 100644 --- a/netbox/dcim/forms.py +++ b/netbox/dcim/forms.py @@ -1857,14 +1857,14 @@ class DeviceForm(BootstrapMixin, TenancyForm, CustomFieldModelForm): # Collect interface IPs interface_ips = IPAddress.objects.prefetch_related('interface').filter( - family=family, interface_id__in=interface_ids + address__family=family, interface_id__in=interface_ids ) if interface_ips: ip_list = [(ip.id, '{} ({})'.format(ip.address, ip.interface)) for ip in interface_ips] ip_choices.append(('Interface IPs', ip_list)) # Collect NAT IPs nat_ips = IPAddress.objects.prefetch_related('nat_inside').filter( - family=family, nat_inside__interface__in=interface_ids + address__family=family, nat_inside__interface__in=interface_ids ) if nat_ips: ip_list = [(ip.id, '{} ({})'.format(ip.address, ip.nat_inside.address)) for ip in nat_ips] diff --git a/netbox/virtualization/forms.py b/netbox/virtualization/forms.py index 0dbe38324..d110545c7 100644 --- a/netbox/virtualization/forms.py +++ b/netbox/virtualization/forms.py @@ -408,7 +408,7 @@ class VirtualMachineForm(BootstrapMixin, TenancyForm, CustomFieldModelForm): ip_choices = [(None, '---------')] # Collect interface IPs interface_ips = IPAddress.objects.prefetch_related('interface').filter( - family=family, interface__virtual_machine=self.instance + address__family=family, interface__virtual_machine=self.instance ) if interface_ips: ip_choices.append( @@ -418,7 +418,7 @@ class VirtualMachineForm(BootstrapMixin, TenancyForm, CustomFieldModelForm): ) # Collect NAT IPs nat_ips = IPAddress.objects.prefetch_related('nat_inside').filter( - family=family, nat_inside__interface__virtual_machine=self.instance + address__family=family, nat_inside__interface__virtual_machine=self.instance ) if nat_ips: ip_choices.append( From fcdb05238c5ce46e9dac4fd12e640b4decc9d9ad Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Fri, 14 Feb 2020 15:16:18 -0500 Subject: [PATCH 006/124] Restore filters --- netbox/ipam/filters.py | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/netbox/ipam/filters.py b/netbox/ipam/filters.py index e773fed27..486a33a2e 100644 --- a/netbox/ipam/filters.py +++ b/netbox/ipam/filters.py @@ -73,6 +73,10 @@ class AggregateFilterSet(CustomFieldFilterSet, CreatedUpdatedFilterSet): method='search', label='Search', ) + family = django_filters.NumberFilter( + field_name='prefix', + lookup_expr='family' + ) prefix = django_filters.CharFilter( method='filter_prefix', label='Prefix', @@ -134,6 +138,10 @@ class PrefixFilterSet(TenancyFilterSet, CustomFieldFilterSet, CreatedUpdatedFilt method='search', label='Search', ) + family = django_filters.NumberFilter( + field_name='prefix', + lookup_expr='family' + ) prefix = django_filters.CharFilter( method='filter_prefix', label='Prefix', @@ -282,6 +290,10 @@ class IPAddressFilterSet(TenancyFilterSet, CustomFieldFilterSet, CreatedUpdatedF method='search', label='Search', ) + family = django_filters.NumberFilter( + field_name='address', + lookup_expr='family' + ) parent = django_filters.CharFilter( method='search_by_parent', label='Parent prefix', From f0ced98dc6cbe25df11191fcceb6676ceb2e19c0 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Fri, 14 Feb 2020 15:17:04 -0500 Subject: [PATCH 007/124] Delete unused test data --- netbox/ipam/tests/test_views.py | 1 - 1 file changed, 1 deletion(-) diff --git a/netbox/ipam/tests/test_views.py b/netbox/ipam/tests/test_views.py index 82ae18faf..e168f02a4 100644 --- a/netbox/ipam/tests/test_views.py +++ b/netbox/ipam/tests/test_views.py @@ -88,7 +88,6 @@ class AggregateTestCase(ViewTestCases.PrimaryObjectViewTestCase): ]) cls.form_data = { - 'family': 4, 'prefix': IPNetwork('10.99.0.0/16'), 'rir': rirs[1].pk, 'date_added': datetime.date(2020, 1, 1), From d6ccf131670c321e046b79ed40f68ea5a7c391c2 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Fri, 14 Feb 2020 15:44:52 -0500 Subject: [PATCH 008/124] Changelog for #4081 --- docs/release-notes/version-2.8.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/release-notes/version-2.8.md b/docs/release-notes/version-2.8.md index a29768189..3088bb356 100644 --- a/docs/release-notes/version-2.8.md +++ b/docs/release-notes/version-2.8.md @@ -3,3 +3,7 @@ ## API Changes * dcim.Rack: The `/api/dcim/racks//units/` endpoint has been replaced with `/api/dcim/racks//elevation/`. + +## Other Changes + +* [#4081](https://github.com/netbox-community/netbox/issues/4081) - The `family` field has been removed from the Aggregate, Prefix, and IPAddress models From 01b9d1a4939bcf17cb2c37c6e65d619ffd1388f5 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Tue, 18 Feb 2020 16:03:28 -0500 Subject: [PATCH 009/124] Closes #3848: Upgrade to Django 3.0 --- netbox/dcim/migrations/0097_mptt.py | 28 ++++++++++++++++++++++++++++ requirements.txt | 6 +++--- 2 files changed, 31 insertions(+), 3 deletions(-) create mode 100644 netbox/dcim/migrations/0097_mptt.py diff --git a/netbox/dcim/migrations/0097_mptt.py b/netbox/dcim/migrations/0097_mptt.py new file mode 100644 index 000000000..3011edb53 --- /dev/null +++ b/netbox/dcim/migrations/0097_mptt.py @@ -0,0 +1,28 @@ +# Generated by Django 3.0.3 on 2020-02-18 21:02 + +from django.db import migrations, models + + +class Migration(migrations.Migration): + + dependencies = [ + ('dcim', '0096_interface_ordering'), + ] + + operations = [ + migrations.AlterField( + model_name='region', + name='level', + field=models.PositiveIntegerField(editable=False), + ), + migrations.AlterField( + model_name='region', + name='lft', + field=models.PositiveIntegerField(editable=False), + ), + migrations.AlterField( + model_name='region', + name='rght', + field=models.PositiveIntegerField(editable=False), + ), + ] diff --git a/requirements.txt b/requirements.txt index b0b1b971d..c3b35e8fe 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,9 +1,9 @@ -Django>=2.2,<2.3 +Django>=3.0,<3.1 django-cacheops==4.2 django-cors-headers==3.2.1 -django-debug-toolbar==2.1 +django-debug-toolbar==2.2 django-filter==2.2.0 -django-mptt==0.9.1 +django-mptt==0.11.0 django-pglocks==1.0.4 django-prometheus==1.1.0 django-rq==2.2.0 From f1b042180536092fa99d67f55fe5d5ab280d0f69 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Tue, 18 Feb 2020 18:00:00 -0500 Subject: [PATCH 010/124] Temporary hack to avoid name collision without renaming the secrets app --- netbox/secrets/__init__.py | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/netbox/secrets/__init__.py b/netbox/secrets/__init__.py index e69de29bb..3c1c4eed2 100644 --- a/netbox/secrets/__init__.py +++ b/netbox/secrets/__init__.py @@ -0,0 +1,11 @@ +# TODO: Rename the secrets app, probably +# Python 3.6 introduced a standard library named "secrets," which obviously conflicts with this Django app. To avoid +# renaming the app, we hotwire the components of the standard library that Django calls. (I don't like this any more +# than you do, but it works for now.) The only references to the secrets modules are in django/utils/crypto.py. +# +# First, we copy secrets.compare_digest, which comes from the hmac module: +from hmac import compare_digest + +# Then, we instantiate SystemRandom and map its choice() function: +from random import SystemRandom +choice = SystemRandom().choice From e17597a0a942ecf9d2f5d95f082a5a930c99d672 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Wed, 19 Feb 2020 14:30:49 -0500 Subject: [PATCH 011/124] Update CI build to Python 3.6 and PostgreSQL 9.6 --- .travis.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.travis.yml b/.travis.yml index 872121c21..4ad37604e 100644 --- a/.travis.yml +++ b/.travis.yml @@ -3,10 +3,10 @@ services: - postgresql - redis-server addons: - postgresql: "9.4" + postgresql: "9.6" language: python python: - - "3.5" + - "3.6" install: - pip install -r requirements.txt - pip install pycodestyle From b7d41bc42c0ab5e1bf0ff89ec734eeb5d55052ea Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Wed, 19 Feb 2020 14:46:53 -0500 Subject: [PATCH 012/124] Rename MPTT migration --- .../dcim/migrations/{0097_mptt.py => 0097_mptt_remove_indexes.py} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename netbox/dcim/migrations/{0097_mptt.py => 0097_mptt_remove_indexes.py} (100%) diff --git a/netbox/dcim/migrations/0097_mptt.py b/netbox/dcim/migrations/0097_mptt_remove_indexes.py similarity index 100% rename from netbox/dcim/migrations/0097_mptt.py rename to netbox/dcim/migrations/0097_mptt_remove_indexes.py From 7b93155b06c79ccbbeed404b467d5d542f31c9a5 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Wed, 19 Feb 2020 15:08:15 -0500 Subject: [PATCH 013/124] Fix form field ordering; self.fields no longer an OrderedDict --- netbox/extras/forms.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/netbox/extras/forms.py b/netbox/extras/forms.py index d6a5406b7..b792ec484 100644 --- a/netbox/extras/forms.py +++ b/netbox/extras/forms.py @@ -467,7 +467,8 @@ class ScriptForm(BootstrapMixin, forms.Form): self.fields['_commit'].initial = False # Move _commit to the end of the form - self.fields.move_to_end('_commit', True) + commit = self.fields.pop('_commit') + self.fields['_commit'] = commit @property def requires_input(self): From be232309382ca28fbf190aac285411984baf861f Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Wed, 19 Feb 2020 15:31:15 -0500 Subject: [PATCH 014/124] Update tests to match new string representation of ContentTypes --- netbox/dcim/tests/test_api.py | 2 +- netbox/extras/tests/test_api.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/netbox/dcim/tests/test_api.py b/netbox/dcim/tests/test_api.py index c0ea5eca7..607637d1e 100644 --- a/netbox/dcim/tests/test_api.py +++ b/netbox/dcim/tests/test_api.py @@ -40,7 +40,7 @@ class AppTest(APITestCase): self.assertEqual(choices_to_dict(response.data.get('cable:status')), CableStatusChoices.as_dict()) content_types = ContentType.objects.filter(CABLE_TERMINATION_MODELS) cable_termination_choices = { - "{}.{}".format(ct.app_label, ct.model): ct.name for ct in content_types + "{}.{}".format(ct.app_label, ct.model): str(ct) for ct in content_types } self.assertEqual(choices_to_dict(response.data.get('cable:termination_a_type')), cable_termination_choices) self.assertEqual(choices_to_dict(response.data.get('cable:termination_b_type')), cable_termination_choices) diff --git a/netbox/extras/tests/test_api.py b/netbox/extras/tests/test_api.py index b15553a49..db2861f46 100644 --- a/netbox/extras/tests/test_api.py +++ b/netbox/extras/tests/test_api.py @@ -37,7 +37,7 @@ class AppTest(APITestCase): # Graph content_types = ContentType.objects.filter(GRAPH_MODELS) graph_type_choices = { - "{}.{}".format(ct.app_label, ct.model): ct.name for ct in content_types + "{}.{}".format(ct.app_label, ct.model): str(ct) for ct in content_types } self.assertEqual(choices_to_dict(response.data.get('graph:type')), graph_type_choices) self.assertEqual(choices_to_dict(response.data.get('graph:template_language')), TemplateLanguageChoices.as_dict()) From 5dc956fbe11718dff7f4b4b6284cdaef7ddc2b50 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Fri, 28 Feb 2020 15:07:59 -0500 Subject: [PATCH 015/124] First stab at external authentication support --- docs/configuration/optional-settings.md | 48 +++++++++++++++++++++++++ netbox/netbox/configuration.example.py | 8 +++++ netbox/netbox/settings.py | 16 +++++++-- netbox/utilities/auth_backends.py | 47 +++++++++++++++++++++++- netbox/utilities/middleware.py | 9 +++++ 5 files changed, 124 insertions(+), 4 deletions(-) diff --git a/docs/configuration/optional-settings.md b/docs/configuration/optional-settings.md index cbe01728c..5b4fd1d14 100644 --- a/docs/configuration/optional-settings.md +++ b/docs/configuration/optional-settings.md @@ -291,6 +291,54 @@ When determining the primary IP address for a device, IPv6 is preferred over IPv --- +## REMOTE_AUTH_ENABLED + +Default: `False` + +NetBox can be configured to support remote user authentication by inferring user authentication from an HTTP header set by the HTTP reverse proxy (e.g. nginx or Apache). Set this to `True` to enable this functionality. (Local authenitcation will still take effect as a fallback.) + +--- + +## REMOTE_AUTH_BACKEND + +Default: `'utilities.auth_backends.RemoteUserBackend'` + +Python path to the custom [Django authentication backend]() to use for external user authentication, if not using NetBox's built-in backend. (Requires `REMOTE_AUTH_ENABLED`.) + +--- + +## REMOTE_AUTH_HEADER + +Default: `'HTTP_REMOTE_USER'` + +When remote user authentication is in use, this is the name of the HTTP header which informs NetBox of the currently authenticated user. (Requires `REMOTE_AUTH_ENABLED`.) + +--- + +## REMOTE_AUTH_AUTO_CREATE_USER + +Default: `True` + +If true, NetBox will automatically create local accounts for users authenticated via a remote service. (Requires `REMOTE_AUTH_ENABLED`.) + +--- + +## REMOTE_AUTH_DEFAULT_GROUPS + +Default: `[]` (Empty list) + +The list of groups to assign a new user account when created using remote authentication. (Requires `REMOTE_AUTH_ENABLED`.) + +--- + +## REMOTE_AUTH_DEFAULT_PERMISSIONS + +Default: `[]` (Empty list) + +The list of permissions to assign a new user account when created using remote authentication. (Requires `REMOTE_AUTH_ENABLED`.) + +--- + ## REPORTS_ROOT Default: $BASE_DIR/netbox/reports/ diff --git a/netbox/netbox/configuration.example.py b/netbox/netbox/configuration.example.py index 7002def9b..1aada7c2d 100644 --- a/netbox/netbox/configuration.example.py +++ b/netbox/netbox/configuration.example.py @@ -179,6 +179,14 @@ PAGINATE_COUNT = 50 # prefer IPv4 instead. PREFER_IPV4 = False +# Remote authentication support +REMOTE_AUTH_ENABLED = False +REMOTE_AUTH_BACKEND = 'utilities.auth_backends.RemoteUserBackend' +REMOTE_AUTH_HEADER = 'HTTP_REMOTE_USER' +REMOTE_AUTH_AUTO_CREATE_USER = True +REMOTE_AUTH_DEFAULT_GROUPS = [] +REMOTE_AUTH_DEFAULT_PERMISSIONS = [] + # The file path where custom reports will be stored. A trailing slash is not needed. Note that the default value of # this setting is derived from the installed location. # REPORTS_ROOT = '/opt/netbox/netbox/reports' diff --git a/netbox/netbox/settings.py b/netbox/netbox/settings.py index bdd83723d..ed3974312 100644 --- a/netbox/netbox/settings.py +++ b/netbox/netbox/settings.py @@ -93,6 +93,12 @@ NAPALM_TIMEOUT = getattr(configuration, 'NAPALM_TIMEOUT', 30) NAPALM_USERNAME = getattr(configuration, 'NAPALM_USERNAME', '') PAGINATE_COUNT = getattr(configuration, 'PAGINATE_COUNT', 50) PREFER_IPV4 = getattr(configuration, 'PREFER_IPV4', False) +REMOTE_AUTH_AUTO_CREATE_USER = getattr(configuration, 'REMOTE_AUTH_AUTO_CREATE_USER', False) +REMOTE_AUTH_BACKEND = getattr(configuration, 'REMOTE_AUTH_BACKEND', 'utilities.auth_backends.RemoteUserBackend') +REMOTE_AUTH_DEFAULT_GROUPS = getattr(configuration, 'REMOTE_AUTH_DEFAULT_GROUPS', []) +REMOTE_AUTH_DEFAULT_PERMISSIONS = getattr(configuration, 'REMOTE_AUTH_DEFAULT_PERMISSIONS', []) +REMOTE_AUTH_ENABLED = getattr(configuration, 'REMOTE_AUTH_ENABLED', False) +REMOTE_AUTH_HEADER = getattr(configuration, 'REMOTE_AUTH_HEADER', 'HTTP_REMOTE_USER') REPORTS_ROOT = getattr(configuration, 'REPORTS_ROOT', os.path.join(BASE_DIR, 'reports')).rstrip('/') SCRIPTS_ROOT = getattr(configuration, 'SCRIPTS_ROOT', os.path.join(BASE_DIR, 'scripts')).rstrip('/') SESSION_FILE_PATH = getattr(configuration, 'SESSION_FILE_PATH', None) @@ -258,7 +264,7 @@ INSTALLED_APPS = [ ] # Middleware -MIDDLEWARE = ( +MIDDLEWARE = [ 'debug_toolbar.middleware.DebugToolbarMiddleware', 'django_prometheus.middleware.PrometheusBeforeMiddleware', 'corsheaders.middleware.CorsMiddleware', @@ -274,7 +280,9 @@ MIDDLEWARE = ( 'utilities.middleware.APIVersionMiddleware', 'extras.middleware.ObjectChangeMiddleware', 'django_prometheus.middleware.PrometheusAfterMiddleware', -) +] +if REMOTE_AUTH_ENABLED: + MIDDLEWARE.append('utilities.middleware.RemoteUserMiddleware') ROOT_URLCONF = 'netbox.urls' @@ -297,10 +305,12 @@ TEMPLATES = [ }, ] -# Authentication +# Set up authentication backends AUTHENTICATION_BACKENDS = [ 'utilities.auth_backends.ViewExemptModelBackend', ] +if REMOTE_AUTH_ENABLED: + AUTHENTICATION_BACKENDS.insert(0, REMOTE_AUTH_BACKEND) # Internationalization LANGUAGE_CODE = 'en-us' diff --git a/netbox/utilities/auth_backends.py b/netbox/utilities/auth_backends.py index 54541b0b5..52c3454f1 100644 --- a/netbox/utilities/auth_backends.py +++ b/netbox/utilities/auth_backends.py @@ -1,5 +1,8 @@ +import logging + from django.conf import settings -from django.contrib.auth.backends import ModelBackend +from django.contrib.auth.backends import ModelBackend, RemoteUserBackend as RemoteUserBackend_ +from django.contrib.auth.models import Group, Permission class ViewExemptModelBackend(ModelBackend): @@ -26,3 +29,45 @@ class ViewExemptModelBackend(ModelBackend): pass return super().has_perm(user_obj, perm, obj) + + +class RemoteUserBackend(ViewExemptModelBackend, RemoteUserBackend_): + """ + Custom implementation of Django's RemoteUserBackend which provides configuration hooks for basic customization. + """ + @property + def create_unknown_user(self): + return bool(settings.REMOTE_AUTH_AUTO_CREATE_USER) + + def configure_user(self, request, user): + logger = logging.getLogger('netbox.authentication.RemoteUserBackend') + + # Assign default groups to the user + group_list = [] + for name in settings.REMOTE_AUTH_DEFAULT_GROUPS: + try: + group_list.append(Group.objects.get(name=name)) + except Group.DoesNotExist: + logging.error("Could not assign group {name} to remotely-authenticated user {user}: Group not found") + if group_list: + user.groups.add(*group_list) + logger.debug(f"Assigned groups to remotely-authenticated user {user}: {group_list}") + + # Assign default permissions to the user + permissions_list = [] + for permission_name in settings.REMOTE_AUTH_DEFAULT_PERMISSIONS: + try: + app_label, codename = permission_name.split('.') + permissions_list.append( + Permission.objects.get(content_type__app_label=app_label, codename=codename) + ) + except (ValueError, Permission.DoesNotExist): + logging.error( + "Invalid permission name: '{permission_name}'. Permissions must be in the form " + "._. (Example: dcim.add_site)" + ) + if permissions_list: + user.user_permissions.add(*permissions_list) + logger.debug(f"Assigned permissions to remotely-authenticated user {user}: {permissions_list}") + + return user diff --git a/netbox/utilities/middleware.py b/netbox/utilities/middleware.py index 564771821..a4fd1a254 100644 --- a/netbox/utilities/middleware.py +++ b/netbox/utilities/middleware.py @@ -1,6 +1,7 @@ from urllib import parse from django.conf import settings +from django.contrib.auth.middleware import RemoteUserMiddleware as RemoteUserMiddleware_ from django.db import ProgrammingError from django.http import Http404, HttpResponseRedirect from django.urls import reverse @@ -30,6 +31,14 @@ class LoginRequiredMiddleware(object): return self.get_response(request) +class RemoteUserMiddleware(RemoteUserMiddleware_): + """ + Custom implementation of Django's RemoteUserMiddleware which allows for a user-configurable HTTP header name. + """ + force_logout_if_no_header = False + header = settings.REMOTE_AUTH_HEADER + + class APIVersionMiddleware(object): """ If the request is for an API endpoint, include the API version as a response header. From a17c22746d7cccdab70ef61ca67a9a3ede6aa8ab Mon Sep 17 00:00:00 2001 From: John Anderson Date: Sat, 29 Feb 2020 02:23:01 -0500 Subject: [PATCH 016/124] initial work on #3351 --- netbox/netbox/settings.py | 55 +++++++++++++++++++++++++++++++++++++++ netbox/netbox/urls.py | 18 +++++++++++++ 2 files changed, 73 insertions(+) diff --git a/netbox/netbox/settings.py b/netbox/netbox/settings.py index bdd83723d..b65d0abe7 100644 --- a/netbox/netbox/settings.py +++ b/netbox/netbox/settings.py @@ -1,3 +1,4 @@ +import importlib import logging import os import platform @@ -6,6 +7,7 @@ import warnings from django.contrib.messages import constants as messages from django.core.exceptions import ImproperlyConfigured +from pkg_resources import iter_entry_points # @@ -92,6 +94,7 @@ NAPALM_PASSWORD = getattr(configuration, 'NAPALM_PASSWORD', '') NAPALM_TIMEOUT = getattr(configuration, 'NAPALM_TIMEOUT', 30) NAPALM_USERNAME = getattr(configuration, 'NAPALM_USERNAME', '') PAGINATE_COUNT = getattr(configuration, 'PAGINATE_COUNT', 50) +PLUGINS_CONFIG = getattr(configuration, 'PLUGINS_CONFIG', {}) PREFER_IPV4 = getattr(configuration, 'PREFER_IPV4', False) REPORTS_ROOT = getattr(configuration, 'REPORTS_ROOT', os.path.join(BASE_DIR, 'reports')).rstrip('/') SCRIPTS_ROOT = getattr(configuration, 'SCRIPTS_ROOT', os.path.join(BASE_DIR, 'scripts')).rstrip('/') @@ -591,3 +594,55 @@ PER_PAGE_DEFAULTS = [ if PAGINATE_COUNT not in PER_PAGE_DEFAULTS: PER_PAGE_DEFAULTS.append(PAGINATE_COUNT) PER_PAGE_DEFAULTS = sorted(PER_PAGE_DEFAULTS) + + +# +# Plugins +# + +PLUGINS = [] +for entry_point in iter_entry_points(group='netbox.plugin', name=None): + plugin = entry_point.module_name + PLUGINS.append(plugin) + INSTALLED_APPS.append(plugin) + + try: + module = importlib.import_module(plugin) + default_app_config = getattr(module, 'default_app_config') + module, app_config = default_app_config.rsplit('.', 1) + app_config = getattr(importlib.import_module(module), app_config) + except ImportError: + raise ImproperlyConfigured('Plugin config for {} could not be imported!'.format(plugin)) + + app_config_meta = getattr(app_config, 'NetBoxPluginMeta', None) + if not app_config_meta: + raise ImproperlyConfigured( + 'The app config for plugin {} does not contain an inner meta class'.format(plugin) + ) + + # Add middleware + plugin_middleware = getattr(app_config_meta, 'middleware', []) + if plugin_middleware: + MIDDLEWARE.extend(plugin_middleware) + + # Add middleware + plugin_installed_apps = getattr(app_config_meta, 'installed_apps', []) + if plugin_installed_apps: + INSTALLED_APPS.extend(plugin_installed_apps) + + # Verify required configuration settings + if plugin not in PLUGINS_CONFIG: + PLUGINS_CONFIG[plugin] = {} + for setting in getattr(app_config_meta, 'required_settings', []): + if setting not in PLUGINS_CONFIG[plugin]: + raise ImproperlyConfigured( + "Plugin {} requires '{}' to be present in the PLUGINS_CONFIG section of configuration.py.".format( + plugin, + setting + ) + ) + + # Set defined default setting values + for setting, value in getattr(app_config_meta, 'default_settings', {}).items(): + if setting not in PLUGINS_CONFIG[plugin]: + PLUGINS_CONFIG[plugin][setting] = value diff --git a/netbox/netbox/urls.py b/netbox/netbox/urls.py index 2c4d504b2..93bb84e06 100644 --- a/netbox/netbox/urls.py +++ b/netbox/netbox/urls.py @@ -1,3 +1,6 @@ +import importlib + +from django.apps import apps from django.conf import settings from django.conf.urls import include from django.urls import path, re_path @@ -65,6 +68,21 @@ _patterns = [ ] +# Plugins +plugin_patterns = [] +for app in apps.get_app_configs(): + if hasattr(app, 'NetBoxPluginMeta'): + if importlib.util.find_spec('{}.urls'.format(app.name)): + urls = importlib.import_module('{}.urls'.format(app.name)) + url_slug = getattr(app.NetBoxPluginMeta, 'url_slug', app.label) + plugin_patterns.append( + path('{}/'.format(url_slug), include((urls.urlpatterns, app.label))) + ) + +_patterns.append( + path('plugins/', include((plugin_patterns, 'plugins'))) +) + if settings.DEBUG: import debug_toolbar _patterns += [ From 71a8a13644ea4643202a626d7860ab6f6ac5351d Mon Sep 17 00:00:00 2001 From: John Anderson Date: Sun, 1 Mar 2020 03:24:17 -0500 Subject: [PATCH 017/124] add api urls and signals interface for detail route buttons --- netbox/extras/plugins/__init__.py | 0 netbox/extras/plugins/signals.py | 34 +++++++++++++++++++ .../extras/plugins/templatetags/__init__.py | 0 netbox/extras/templatetags/plugins.py | 27 +++++++++++++++ netbox/netbox/settings.py | 12 +++---- netbox/netbox/urls.py | 19 +++++++++-- netbox/templates/dcim/device.html | 2 ++ netbox/templates/dcim/site.html | 2 ++ 8 files changed, 87 insertions(+), 9 deletions(-) create mode 100644 netbox/extras/plugins/__init__.py create mode 100644 netbox/extras/plugins/signals.py create mode 100644 netbox/extras/plugins/templatetags/__init__.py create mode 100644 netbox/extras/templatetags/plugins.py diff --git a/netbox/extras/plugins/__init__.py b/netbox/extras/plugins/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/netbox/extras/plugins/signals.py b/netbox/extras/plugins/signals.py new file mode 100644 index 000000000..7d0567b1b --- /dev/null +++ b/netbox/extras/plugins/signals.py @@ -0,0 +1,34 @@ +import django.dispatch +from django.dispatch.dispatcher import NO_RECEIVERS + + +class PluginSignal(django.dispatch.Signal): + + def _sorted_receivers(self, sender): + orig_list = self._live_receivers(sender) + sorted_list = sorted( + orig_list, + key=lambda receiver: ( + receiver.__module__, + receiver.__name__, + ) + ) + return sorted_list + + def send(self, sender, **kwargs): + responses = [] + if not self.receivers or self.sender_receivers_cache.get(sender) is NO_RECEIVERS: + return responses + + for receiver in self._sorted_receivers(sender): + response = receiver(signal=self, sender=sender, **kwargs) + responses.append((receiver, response)) + return responses + + +""" +This signal collects templates which render buttons for object detail pages +""" +register_detail_page_buttons = PluginSignal( + providing_args=[] +) diff --git a/netbox/extras/plugins/templatetags/__init__.py b/netbox/extras/plugins/templatetags/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/netbox/extras/templatetags/plugins.py b/netbox/extras/templatetags/plugins.py new file mode 100644 index 000000000..dc3443d0c --- /dev/null +++ b/netbox/extras/templatetags/plugins.py @@ -0,0 +1,27 @@ +from django import template as template_ +from django.template.loader import get_template +from django.utils.safestring import mark_safe + +from extras.plugins.signals import register_detail_page_buttons + + +register = template_.Library() + + +@register.simple_tag() +def plugin_buttons(obj): + """ + Fire signal to collect all buttons registered by plugins + """ + html = '' + responses = register_detail_page_buttons.send(obj) + for receiver, response in responses: + if not isinstance(response, list): + response = [response] + for template in response: + if isinstance(template, str): + template_text = get_template(template).render({'obj': obj}) + html += template_text + + return mark_safe(html) + diff --git a/netbox/netbox/settings.py b/netbox/netbox/settings.py index b65d0abe7..8f1678b95 100644 --- a/netbox/netbox/settings.py +++ b/netbox/netbox/settings.py @@ -261,7 +261,7 @@ INSTALLED_APPS = [ ] # Middleware -MIDDLEWARE = ( +MIDDLEWARE = [ 'debug_toolbar.middleware.DebugToolbarMiddleware', 'django_prometheus.middleware.PrometheusBeforeMiddleware', 'corsheaders.middleware.CorsMiddleware', @@ -277,7 +277,7 @@ MIDDLEWARE = ( 'utilities.middleware.APIVersionMiddleware', 'extras.middleware.ObjectChangeMiddleware', 'django_prometheus.middleware.PrometheusAfterMiddleware', -) +] ROOT_URLCONF = 'netbox.urls' @@ -622,12 +622,12 @@ for entry_point in iter_entry_points(group='netbox.plugin', name=None): # Add middleware plugin_middleware = getattr(app_config_meta, 'middleware', []) - if plugin_middleware: + if plugin_middleware and isinstance(plugin_middleware, list): MIDDLEWARE.extend(plugin_middleware) - # Add middleware + # Add installed apps plugin_installed_apps = getattr(app_config_meta, 'installed_apps', []) - if plugin_installed_apps: + if plugin_installed_apps and isinstance(plugin_installed_apps, list): INSTALLED_APPS.extend(plugin_installed_apps) # Verify required configuration settings @@ -637,7 +637,7 @@ for entry_point in iter_entry_points(group='netbox.plugin', name=None): if setting not in PLUGINS_CONFIG[plugin]: raise ImproperlyConfigured( "Plugin {} requires '{}' to be present in the PLUGINS_CONFIG section of configuration.py.".format( - plugin, + plugin, setting ) ) diff --git a/netbox/netbox/urls.py b/netbox/netbox/urls.py index 93bb84e06..8d59a33d1 100644 --- a/netbox/netbox/urls.py +++ b/netbox/netbox/urls.py @@ -70,18 +70,31 @@ _patterns = [ # Plugins plugin_patterns = [] +plugin_api_patterns = [] for app in apps.get_app_configs(): if hasattr(app, 'NetBoxPluginMeta'): if importlib.util.find_spec('{}.urls'.format(app.name)): urls = importlib.import_module('{}.urls'.format(app.name)) url_slug = getattr(app.NetBoxPluginMeta, 'url_slug', app.label) - plugin_patterns.append( - path('{}/'.format(url_slug), include((urls.urlpatterns, app.label))) - ) + if hasattr(urls, 'urlpatterns'): + plugin_patterns.append( + path('{}/'.format(url_slug), include((urls.urlpatterns, app.label))) + ) + if importlib.util.find_spec('{}.api'.format(app.name)): + if importlib.util.find_spec('{}.api.urls'.format(app.name)): + urls = importlib.import_module('{}.api.urls'.format(app.name)) + if hasattr(urls, 'urlpatterns'): + url_slug = getattr(app.NetBoxPluginMeta, 'url_slug', app.label) + plugin_api_patterns.append( + path('{}/'.format(url_slug), include((urls.urlpatterns, app.label))) + ) _patterns.append( path('plugins/', include((plugin_patterns, 'plugins'))) ) +_patterns.append( + path('api/plugins/', include((plugin_api_patterns, 'plugins-api'))) +) if settings.DEBUG: import debug_toolbar diff --git a/netbox/templates/dcim/device.html b/netbox/templates/dcim/device.html index 8c457121f..74e2549bd 100644 --- a/netbox/templates/dcim/device.html +++ b/netbox/templates/dcim/device.html @@ -3,6 +3,7 @@ {% load static %} {% load helpers %} {% load custom_links %} +{% load plugins %} {% block title %}{{ device }}{% endblock %} @@ -36,6 +37,7 @@
+ {% plugin_buttons device %} {% if show_graphs %}
+ {% plugin_buttons site %} {% if show_graphs %}
+ + +
Family{{ prefix.get_family_display }}IPv{{ prefix.family }}
VRF
Description + {{ tag.description }} +
-
-
- Comments -
-
- {% if tag.comments %} - {{ tag.comments|render_markdown }} - {% else %} - None - {% endif %} -
-
{% include 'panel_table.html' with table=items_table heading='Tagged Objects' %} diff --git a/netbox/templates/extras/tag_edit.html b/netbox/templates/extras/tag_edit.html index 800db1d26..87b9a2e53 100644 --- a/netbox/templates/extras/tag_edit.html +++ b/netbox/templates/extras/tag_edit.html @@ -8,12 +8,7 @@ {% render_field form.name %} {% render_field form.slug %} {% render_field form.color %} -
- -
-
Comments
-
- {% render_field form.comments %} + {% render_field form.description %}
{% endblock %} From 6ea15cec6f3917028d8226f5760a08be7c981bc3 Mon Sep 17 00:00:00 2001 From: John Anderson Date: Sun, 15 Mar 2020 00:24:05 -0400 Subject: [PATCH 049/124] Revert "refactor extras registry" This reverts commit c189895f6c17bd64de21e419a2f6678342d62477. --- netbox/dcim/models/__init__.py | 4 +-- netbox/extras/api/serializers.py | 6 ++-- netbox/extras/models.py | 12 +++---- netbox/extras/tests/test_api.py | 3 +- netbox/extras/tests/test_filters.py | 5 +-- netbox/extras/utils.py | 54 +++++++++++++---------------- 6 files changed, 40 insertions(+), 44 deletions(-) diff --git a/netbox/dcim/models/__init__.py b/netbox/dcim/models/__init__.py index 40f022fa4..f702f8dff 100644 --- a/netbox/dcim/models/__init__.py +++ b/netbox/dcim/models/__init__.py @@ -21,7 +21,7 @@ from dcim.constants import * from dcim.fields import ASNField from dcim.elevations import RackElevationSVG from extras.models import ConfigContextModel, CustomFieldModel, ObjectChange, TaggedItem -from extras.utils import extras_features +from extras.utils import extras_functionality from utilities.fields import ColorField, NaturalOrderingField from utilities.models import ChangeLoggedModel from utilities.utils import serialize_object, to_meters @@ -1221,7 +1221,7 @@ class Platform(ChangeLoggedModel): ) -@extras_features(['webhooks', 'custom_fields', 'export_templates', 'custom_links', 'graphs']) +@extras_functionality(['webhooks', 'custom_fields', 'export_templates', 'custom_links', 'graphs']) class Device(ChangeLoggedModel, ConfigContextModel, CustomFieldModel): """ A Device represents a piece of physical hardware mounted within a Rack. Each Device is assigned a DeviceType, diff --git a/netbox/extras/api/serializers.py b/netbox/extras/api/serializers.py index 774e183ec..9830cdd51 100644 --- a/netbox/extras/api/serializers.py +++ b/netbox/extras/api/serializers.py @@ -14,7 +14,7 @@ from extras.constants import * from extras.models import ( ConfigContext, ExportTemplate, Graph, ImageAttachment, ObjectChange, ReportResult, Tag, ) -from extras.utils import FeatureQuerySet +from extras.utils import FunctionalityQueryset from tenancy.api.nested_serializers import NestedTenantSerializer, NestedTenantGroupSerializer from tenancy.models import Tenant, TenantGroup from users.api.nested_serializers import NestedUserSerializer @@ -33,7 +33,7 @@ from .nested_serializers import * class GraphSerializer(ValidatedModelSerializer): type = ContentTypeField( - queryset=ContentType.objects.filter(FeatureQuerySet('graphs').get_queryset()), + queryset=ContentType.objects.filter(FunctionalityQueryset('graphs').get_queryset()), ) class Meta: @@ -69,7 +69,7 @@ class RenderedGraphSerializer(serializers.ModelSerializer): class ExportTemplateSerializer(ValidatedModelSerializer): content_type = ContentTypeField( - queryset=ContentType.objects.filter(FeatureQuerySet('export_templates').get_queryset()), + queryset=ContentType.objects.filter(Q(FunctionalityQueryset('export_templates').get_queryset())), ) template_language = ChoiceField( choices=TemplateLanguageChoices, diff --git a/netbox/extras/models.py b/netbox/extras/models.py index 21809c35b..47c05667c 100644 --- a/netbox/extras/models.py +++ b/netbox/extras/models.py @@ -22,7 +22,7 @@ from utilities.utils import deepmerge, render_jinja2 from .choices import * from .constants import * from .querysets import ConfigContextQuerySet -from .utils import FeatureQuerySet +from .utils import FunctionalityQueryset __all__ = ( @@ -59,7 +59,7 @@ class Webhook(models.Model): to=ContentType, related_name='webhooks', verbose_name='Object types', - limit_choices_to=FeatureQuerySet('webhooks'), + limit_choices_to=FunctionalityQueryset('webhooks'), help_text="The object(s) to which this Webhook applies." ) name = models.CharField( @@ -224,7 +224,7 @@ class CustomField(models.Model): to=ContentType, related_name='custom_fields', verbose_name='Object(s)', - limit_choices_to=FeatureQuerySet('custom_fields'), + limit_choices_to=FunctionalityQueryset('custom_fields'), help_text='The object(s) to which this field applies.' ) type = models.CharField( @@ -471,7 +471,7 @@ class CustomLink(models.Model): content_type = models.ForeignKey( to=ContentType, on_delete=models.CASCADE, - limit_choices_to=FeatureQuerySet('custom_links') + limit_choices_to=FunctionalityQueryset('custom_links') ) name = models.CharField( max_length=100, @@ -519,7 +519,7 @@ class Graph(models.Model): type = models.ForeignKey( to=ContentType, on_delete=models.CASCADE, - limit_choices_to=FeatureQuerySet('graphs') + limit_choices_to=FunctionalityQueryset('graphs') ) weight = models.PositiveSmallIntegerField( default=1000 @@ -582,7 +582,7 @@ class ExportTemplate(models.Model): content_type = models.ForeignKey( to=ContentType, on_delete=models.CASCADE, - limit_choices_to=FeatureQuerySet('export_templates') + limit_choices_to=FunctionalityQueryset('export_templates') ) name = models.CharField( max_length=100 diff --git a/netbox/extras/tests/test_api.py b/netbox/extras/tests/test_api.py index b52091f62..6871b2654 100644 --- a/netbox/extras/tests/test_api.py +++ b/netbox/extras/tests/test_api.py @@ -8,6 +8,7 @@ from rest_framework import status from dcim.models import Device, DeviceRole, DeviceType, Manufacturer, Platform, Rack, RackGroup, RackRole, Region, Site from extras.api.views import ScriptViewSet from extras.choices import * +from extras.constants import GRAPH_MODELS from extras.models import ConfigContext, Graph, ExportTemplate, Tag from extras.scripts import BooleanVar, IntegerVar, Script, StringVar from tenancy.models import Tenant, TenantGroup @@ -34,7 +35,7 @@ class AppTest(APITestCase): self.assertEqual(choices_to_dict(response.data.get('export-template:template_language')), TemplateLanguageChoices.as_dict()) # Graph - content_types = ContentType.objects.filter(FeatureQuerySet('graphs').get_queryset()) + content_types = ContentType.objects.filter(GRAPH_MODELS) graph_type_choices = { "{}.{}".format(ct.app_label, ct.model): str(ct) for ct in content_types } diff --git a/netbox/extras/tests/test_filters.py b/netbox/extras/tests/test_filters.py index 9b02293eb..126414cfd 100644 --- a/netbox/extras/tests/test_filters.py +++ b/netbox/extras/tests/test_filters.py @@ -3,6 +3,7 @@ from django.test import TestCase from dcim.models import DeviceRole, Platform, Region, Site from extras.choices import * +from extras.constants import GRAPH_MODELS from extras.filters import * from extras.models import ConfigContext, ExportTemplate, Graph from tenancy.models import Tenant, TenantGroup @@ -17,7 +18,7 @@ class GraphTestCase(TestCase): def setUpTestData(cls): # Get the first three available types - content_types = ContentType.objects.filter(FeatureQuerySet('graphs').get_queryset())[:3] + content_types = ContentType.objects.filter(GRAPH_MODELS)[:3] graphs = ( Graph(name='Graph 1', type=content_types[0], template_language=TemplateLanguageChoices.LANGUAGE_DJANGO, source='http://example.com/1'), @@ -31,7 +32,7 @@ class GraphTestCase(TestCase): self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) def test_type(self): - content_type = ContentType.objects.filter(FeatureQuerySet('graphs').get_queryset()).first() + content_type = ContentType.objects.filter(GRAPH_MODELS).first() params = {'type': content_type.pk} self.assertEqual(self.filterset(params, self.queryset).qs.count(), 1) diff --git a/netbox/extras/utils.py b/netbox/extras/utils.py index 31a312333..d6e55e6f6 100644 --- a/netbox/extras/utils.py +++ b/netbox/extras/utils.py @@ -22,61 +22,55 @@ def is_taggable(obj): class Registry: """ - The registry is a place to hook into for data storage across components + Singleton object used to store important data """ + instance = None - def add_store(self, store_name, initial_value=None): - """ - Given the name of some new data parameter and an optional initial value, setup the registry store - """ - if not hasattr(Registry, store_name): - setattr(Registry, store_name, initial_value) - -registry = Registry() + def __new__(cls): + if cls.instance is not None: + return cls.instance + else: + cls.instance = super().__new__(cls) + cls.model_functionality_store = {f: collections.defaultdict(list) for f in EXTRAS_FUNCTIONALITIES} + return cls.instance -# -# Dynamic feature registration -# - -class FeatureQuerySet: +class FunctionalityQueryset: """ Helper class that delays evaluation of the registry contents for the functionaility store until it has been populated. """ - def __init__(self, feature): - self.feature = feature + def __init__(self, functionality): + self.functionality = functionality def __call__(self): return self.get_queryset() def get_queryset(self): """ - Given an extras feature, return a Q object for content type lookup + Given an extras functionality, return a Q object for content type lookup """ query = Q() - #registry = Registry() - for app_label, models in registry.model_feature_store[self.feature].items(): + registry = Registry() + for app_label, models in registry.model_functionality_store[self.functionality].items(): query |= Q(app_label=app_label, model__in=models) return query -registry.add_store('model_feature_store', {f: collections.defaultdict(list) for f in EXTRAS_FUNCTIONALITIES}) - - -def extras_features(features): +def extras_functionality(functionalities): """ - Decorator used to register extras provided features to a model + Decorator used to register extras provided functionalities to a model """ def wrapper(model_class): - if isinstance(features, list) and features: - #registry = Registry() - model_class._extras_feature = [] - for feature in features: - if feature in EXTRAS_FUNCTIONALITIES: + if isinstance(functionalities, list) and functionalities: + registry = Registry() + model_class._extras_functionality = [] + for functionality in functionalities: + if functionality in EXTRAS_FUNCTIONALITIES: + model_class._extras_functionality.append(functionality) app_label, model_name = model_class._meta.label_lower.split('.') - registry.model_feature_store[feature][app_label].append(model_name) + registry.model_functionality_store[functionality][app_label].append(model_name) return model_class return wrapper From 2dc31c0edd51f130051c9ac95dfe142fee57ecf7 Mon Sep 17 00:00:00 2001 From: John Anderson Date: Sun, 15 Mar 2020 00:25:46 -0400 Subject: [PATCH 050/124] Revert "implemented registry for extras model functionality" This reverts commit 235d99021bbc329888df924fdec568166c4a264b. --- netbox/dcim/models/__init__.py | 2 - netbox/extras/api/serializers.py | 6 +- netbox/extras/constants.py | 342 +++++++++++++++---------------- netbox/extras/models.py | 11 +- netbox/extras/utils.py | 61 ------ 5 files changed, 173 insertions(+), 249 deletions(-) diff --git a/netbox/dcim/models/__init__.py b/netbox/dcim/models/__init__.py index f702f8dff..1dbfdb76b 100644 --- a/netbox/dcim/models/__init__.py +++ b/netbox/dcim/models/__init__.py @@ -21,7 +21,6 @@ from dcim.constants import * from dcim.fields import ASNField from dcim.elevations import RackElevationSVG from extras.models import ConfigContextModel, CustomFieldModel, ObjectChange, TaggedItem -from extras.utils import extras_functionality from utilities.fields import ColorField, NaturalOrderingField from utilities.models import ChangeLoggedModel from utilities.utils import serialize_object, to_meters @@ -1221,7 +1220,6 @@ class Platform(ChangeLoggedModel): ) -@extras_functionality(['webhooks', 'custom_fields', 'export_templates', 'custom_links', 'graphs']) class Device(ChangeLoggedModel, ConfigContextModel, CustomFieldModel): """ A Device represents a piece of physical hardware mounted within a Rack. Each Device is assigned a DeviceType, diff --git a/netbox/extras/api/serializers.py b/netbox/extras/api/serializers.py index 9830cdd51..40606ed8e 100644 --- a/netbox/extras/api/serializers.py +++ b/netbox/extras/api/serializers.py @@ -1,6 +1,5 @@ from django.contrib.contenttypes.models import ContentType from django.core.exceptions import ObjectDoesNotExist -from django.db.models import Q from drf_yasg.utils import swagger_serializer_method from rest_framework import serializers @@ -14,7 +13,6 @@ from extras.constants import * from extras.models import ( ConfigContext, ExportTemplate, Graph, ImageAttachment, ObjectChange, ReportResult, Tag, ) -from extras.utils import FunctionalityQueryset from tenancy.api.nested_serializers import NestedTenantSerializer, NestedTenantGroupSerializer from tenancy.models import Tenant, TenantGroup from users.api.nested_serializers import NestedUserSerializer @@ -33,7 +31,7 @@ from .nested_serializers import * class GraphSerializer(ValidatedModelSerializer): type = ContentTypeField( - queryset=ContentType.objects.filter(FunctionalityQueryset('graphs').get_queryset()), + queryset=ContentType.objects.filter(GRAPH_MODELS), ) class Meta: @@ -69,7 +67,7 @@ class RenderedGraphSerializer(serializers.ModelSerializer): class ExportTemplateSerializer(ValidatedModelSerializer): content_type = ContentTypeField( - queryset=ContentType.objects.filter(Q(FunctionalityQueryset('export_templates').get_queryset())), + queryset=ContentType.objects.filter(EXPORTTEMPLATE_MODELS), ) template_language = ChoiceField( choices=TemplateLanguageChoices, diff --git a/netbox/extras/constants.py b/netbox/extras/constants.py index 5b893b5ad..7bb026d34 100644 --- a/netbox/extras/constants.py +++ b/netbox/extras/constants.py @@ -2,127 +2,127 @@ from django.db.models import Q # Models which support custom fields -#CUSTOMFIELD_MODELS = Q( -# Q(app_label='circuits', model__in=[ -# 'circuit', -# 'provider', -# ]) | -# Q(app_label='dcim', model__in=[ -# 'device', -# 'devicetype', -# 'powerfeed', -# 'rack', -# 'site', -# ]) | -# Q(app_label='ipam', model__in=[ -# 'aggregate', -# 'ipaddress', -# 'prefix', -# 'service', -# 'vlan', -# 'vrf', -# ]) | -# Q(app_label='secrets', model__in=[ -# 'secret', -# ]) | -# Q(app_label='tenancy', model__in=[ -# 'tenant', -# ]) | -# Q(app_label='virtualization', model__in=[ -# 'cluster', -# 'virtualmachine', -# ]) -#) -# -## Custom links -#CUSTOMLINK_MODELS = Q( -# Q(app_label='circuits', model__in=[ -# 'circuit', -# 'provider', -# ]) | -# Q(app_label='dcim', model__in=[ -# 'cable', -# 'device', -# 'devicetype', -# 'powerpanel', -# 'powerfeed', -# 'rack', -# 'site', -# ]) | -# Q(app_label='ipam', model__in=[ -# 'aggregate', -# 'ipaddress', -# 'prefix', -# 'service', -# 'vlan', -# 'vrf', -# ]) | -# Q(app_label='secrets', model__in=[ -# 'secret', -# ]) | -# Q(app_label='tenancy', model__in=[ -# 'tenant', -# ]) | -# Q(app_label='virtualization', model__in=[ -# 'cluster', -# 'virtualmachine', -# ]) -#) -# -## Models which can have Graphs associated with them -#GRAPH_MODELS = Q( -# Q(app_label='circuits', model__in=[ -# 'provider', -# ]) | -# Q(app_label='dcim', model__in=[ -# 'device', -# 'interface', -# 'site', -# ]) -#) -# -## Models which support export templates -#EXPORTTEMPLATE_MODELS = Q( -# Q(app_label='circuits', model__in=[ -# 'circuit', -# 'provider', -# ]) | -# Q(app_label='dcim', model__in=[ -# 'cable', -# 'consoleport', -# 'device', -# 'devicetype', -# 'interface', -# 'inventoryitem', -# 'manufacturer', -# 'powerpanel', -# 'powerport', -# 'powerfeed', -# 'rack', -# 'rackgroup', -# 'region', -# 'site', -# 'virtualchassis', -# ]) | -# Q(app_label='ipam', model__in=[ -# 'aggregate', -# 'ipaddress', -# 'prefix', -# 'service', -# 'vlan', -# 'vrf', -# ]) | -# Q(app_label='secrets', model__in=[ -# 'secret', -# ]) | -# Q(app_label='tenancy', model__in=[ -# 'tenant', -# ]) | -# Q(app_label='virtualization', model__in=[ -# 'cluster', -# 'virtualmachine', -# ]) -#) +CUSTOMFIELD_MODELS = Q( + Q(app_label='circuits', model__in=[ + 'circuit', + 'provider', + ]) | + Q(app_label='dcim', model__in=[ + 'device', + 'devicetype', + 'powerfeed', + 'rack', + 'site', + ]) | + Q(app_label='ipam', model__in=[ + 'aggregate', + 'ipaddress', + 'prefix', + 'service', + 'vlan', + 'vrf', + ]) | + Q(app_label='secrets', model__in=[ + 'secret', + ]) | + Q(app_label='tenancy', model__in=[ + 'tenant', + ]) | + Q(app_label='virtualization', model__in=[ + 'cluster', + 'virtualmachine', + ]) +) + +# Custom links +CUSTOMLINK_MODELS = Q( + Q(app_label='circuits', model__in=[ + 'circuit', + 'provider', + ]) | + Q(app_label='dcim', model__in=[ + 'cable', + 'device', + 'devicetype', + 'powerpanel', + 'powerfeed', + 'rack', + 'site', + ]) | + Q(app_label='ipam', model__in=[ + 'aggregate', + 'ipaddress', + 'prefix', + 'service', + 'vlan', + 'vrf', + ]) | + Q(app_label='secrets', model__in=[ + 'secret', + ]) | + Q(app_label='tenancy', model__in=[ + 'tenant', + ]) | + Q(app_label='virtualization', model__in=[ + 'cluster', + 'virtualmachine', + ]) +) + +# Models which can have Graphs associated with them +GRAPH_MODELS = Q( + Q(app_label='circuits', model__in=[ + 'provider', + ]) | + Q(app_label='dcim', model__in=[ + 'device', + 'interface', + 'site', + ]) +) + +# Models which support export templates +EXPORTTEMPLATE_MODELS = Q( + Q(app_label='circuits', model__in=[ + 'circuit', + 'provider', + ]) | + Q(app_label='dcim', model__in=[ + 'cable', + 'consoleport', + 'device', + 'devicetype', + 'interface', + 'inventoryitem', + 'manufacturer', + 'powerpanel', + 'powerport', + 'powerfeed', + 'rack', + 'rackgroup', + 'region', + 'site', + 'virtualchassis', + ]) | + Q(app_label='ipam', model__in=[ + 'aggregate', + 'ipaddress', + 'prefix', + 'service', + 'vlan', + 'vrf', + ]) | + Q(app_label='secrets', model__in=[ + 'secret', + ]) | + Q(app_label='tenancy', model__in=[ + 'tenant', + ]) | + Q(app_label='virtualization', model__in=[ + 'cluster', + 'virtualmachine', + ]) +) # Report logging levels LOG_DEFAULT = 0 @@ -141,58 +141,48 @@ LOG_LEVEL_CODES = { HTTP_CONTENT_TYPE_JSON = 'application/json' # Models which support registered webhooks -#WEBHOOK_MODELS = Q( -# Q(app_label='circuits', model__in=[ -# 'circuit', -# 'provider', -# ]) | -# Q(app_label='dcim', model__in=[ -# 'cable', -# 'consoleport', -# 'consoleserverport', -# 'device', -# 'devicebay', -# 'devicetype', -# 'frontport', -# 'interface', -# 'inventoryitem', -# 'manufacturer', -# 'poweroutlet', -# 'powerpanel', -# 'powerport', -# 'powerfeed', -# 'rack', -# 'rearport', -# 'region', -# 'site', -# 'virtualchassis', -# ]) | -# Q(app_label='ipam', model__in=[ -# 'aggregate', -# 'ipaddress', -# 'prefix', -# 'service', -# 'vlan', -# 'vrf', -# ]) | -# Q(app_label='secrets', model__in=[ -# 'secret', -# ]) | -# Q(app_label='tenancy', model__in=[ -# 'tenant', -# ]) | -# Q(app_label='virtualization', model__in=[ -# 'cluster', -# 'virtualmachine', -# ]) -#) - - -# Registerable extras functionalities -EXTRAS_FUNCTIONALITIES = [ - 'custom_fields', - 'custom_links', - 'graphs', - 'export_templates', - 'webhooks' -] +WEBHOOK_MODELS = Q( + Q(app_label='circuits', model__in=[ + 'circuit', + 'provider', + ]) | + Q(app_label='dcim', model__in=[ + 'cable', + 'consoleport', + 'consoleserverport', + 'device', + 'devicebay', + 'devicetype', + 'frontport', + 'interface', + 'inventoryitem', + 'manufacturer', + 'poweroutlet', + 'powerpanel', + 'powerport', + 'powerfeed', + 'rack', + 'rearport', + 'region', + 'site', + 'virtualchassis', + ]) | + Q(app_label='ipam', model__in=[ + 'aggregate', + 'ipaddress', + 'prefix', + 'service', + 'vlan', + 'vrf', + ]) | + Q(app_label='secrets', model__in=[ + 'secret', + ]) | + Q(app_label='tenancy', model__in=[ + 'tenant', + ]) | + Q(app_label='virtualization', model__in=[ + 'cluster', + 'virtualmachine', + ]) +) diff --git a/netbox/extras/models.py b/netbox/extras/models.py index 47c05667c..d81fbeab9 100644 --- a/netbox/extras/models.py +++ b/netbox/extras/models.py @@ -22,7 +22,6 @@ from utilities.utils import deepmerge, render_jinja2 from .choices import * from .constants import * from .querysets import ConfigContextQuerySet -from .utils import FunctionalityQueryset __all__ = ( @@ -59,7 +58,7 @@ class Webhook(models.Model): to=ContentType, related_name='webhooks', verbose_name='Object types', - limit_choices_to=FunctionalityQueryset('webhooks'), + limit_choices_to=WEBHOOK_MODELS, help_text="The object(s) to which this Webhook applies." ) name = models.CharField( @@ -224,7 +223,7 @@ class CustomField(models.Model): to=ContentType, related_name='custom_fields', verbose_name='Object(s)', - limit_choices_to=FunctionalityQueryset('custom_fields'), + limit_choices_to=CUSTOMFIELD_MODELS, help_text='The object(s) to which this field applies.' ) type = models.CharField( @@ -471,7 +470,7 @@ class CustomLink(models.Model): content_type = models.ForeignKey( to=ContentType, on_delete=models.CASCADE, - limit_choices_to=FunctionalityQueryset('custom_links') + limit_choices_to=CUSTOMLINK_MODELS ) name = models.CharField( max_length=100, @@ -519,7 +518,7 @@ class Graph(models.Model): type = models.ForeignKey( to=ContentType, on_delete=models.CASCADE, - limit_choices_to=FunctionalityQueryset('graphs') + limit_choices_to=GRAPH_MODELS ) weight = models.PositiveSmallIntegerField( default=1000 @@ -582,7 +581,7 @@ class ExportTemplate(models.Model): content_type = models.ForeignKey( to=ContentType, on_delete=models.CASCADE, - limit_choices_to=FunctionalityQueryset('export_templates') + limit_choices_to=EXPORTTEMPLATE_MODELS ) name = models.CharField( max_length=100 diff --git a/netbox/extras/utils.py b/netbox/extras/utils.py index d6e55e6f6..ca3a72526 100644 --- a/netbox/extras/utils.py +++ b/netbox/extras/utils.py @@ -1,11 +1,6 @@ -import collections - -from django.db.models import Q from taggit.managers import _TaggableManager from utilities.querysets import DummyQuerySet -from extras.constants import EXTRAS_FUNCTIONALITIES - def is_taggable(obj): """ @@ -18,59 +13,3 @@ def is_taggable(obj): if isinstance(obj.tags, DummyQuerySet): return True return False - - -class Registry: - """ - Singleton object used to store important data - """ - instance = None - - def __new__(cls): - if cls.instance is not None: - return cls.instance - else: - cls.instance = super().__new__(cls) - cls.model_functionality_store = {f: collections.defaultdict(list) for f in EXTRAS_FUNCTIONALITIES} - return cls.instance - - -class FunctionalityQueryset: - """ - Helper class that delays evaluation of the registry contents for the functionaility store - until it has been populated. - """ - - def __init__(self, functionality): - self.functionality = functionality - - def __call__(self): - return self.get_queryset() - - def get_queryset(self): - """ - Given an extras functionality, return a Q object for content type lookup - """ - query = Q() - registry = Registry() - for app_label, models in registry.model_functionality_store[self.functionality].items(): - query |= Q(app_label=app_label, model__in=models) - - return query - - -def extras_functionality(functionalities): - """ - Decorator used to register extras provided functionalities to a model - """ - def wrapper(model_class): - if isinstance(functionalities, list) and functionalities: - registry = Registry() - model_class._extras_functionality = [] - for functionality in functionalities: - if functionality in EXTRAS_FUNCTIONALITIES: - model_class._extras_functionality.append(functionality) - app_label, model_name = model_class._meta.label_lower.split('.') - registry.model_functionality_store[functionality][app_label].append(model_name) - return model_class - return wrapper From 0574ac7530209d07f1ab0775b28763cb958cd25e Mon Sep 17 00:00:00 2001 From: John Anderson Date: Sun, 15 Mar 2020 00:48:05 -0400 Subject: [PATCH 051/124] fixed migration order --- ...andardize_description.py => 0040_standardize_description.py} | 2 +- .../{0040_tag_description.py => 0041_tag_description.py} | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) rename netbox/extras/migrations/{0039_standardize_description.py => 0040_standardize_description.py} (90%) rename netbox/extras/migrations/{0040_tag_description.py => 0041_tag_description.py} (90%) diff --git a/netbox/extras/migrations/0039_standardize_description.py b/netbox/extras/migrations/0040_standardize_description.py similarity index 90% rename from netbox/extras/migrations/0039_standardize_description.py rename to netbox/extras/migrations/0040_standardize_description.py index e56f3e1eb..fdc5da2da 100644 --- a/netbox/extras/migrations/0039_standardize_description.py +++ b/netbox/extras/migrations/0040_standardize_description.py @@ -6,7 +6,7 @@ from django.db import migrations, models class Migration(migrations.Migration): dependencies = [ - ('extras', '0038_webhook_template_support'), + ('extras', '0039_update_features_content_types'), ] operations = [ diff --git a/netbox/extras/migrations/0040_tag_description.py b/netbox/extras/migrations/0041_tag_description.py similarity index 90% rename from netbox/extras/migrations/0040_tag_description.py rename to netbox/extras/migrations/0041_tag_description.py index 9d17b205f..63ac5c49a 100644 --- a/netbox/extras/migrations/0040_tag_description.py +++ b/netbox/extras/migrations/0041_tag_description.py @@ -6,7 +6,7 @@ from django.db import migrations, models class Migration(migrations.Migration): dependencies = [ - ('extras', '0039_standardize_description'), + ('extras', '0040_standardize_description'), ] operations = [ From 8364694fb4bf606bf920cc81e7592b868576d10e Mon Sep 17 00:00:00 2001 From: John Anderson Date: Sun, 15 Mar 2020 23:45:18 -0400 Subject: [PATCH 052/124] added plugin template content injection to primary model detail views --- netbox/extras/plugins/__init__.py | 87 +++++++++++++++++++ netbox/extras/plugins/signals.py | 4 +- .../extras/plugins/templatetags/__init__.py | 0 netbox/extras/templatetags/plugins.py | 55 +++++++++--- netbox/templates/circuits/circuit.html | 9 ++ netbox/templates/circuits/provider.html | 9 ++ netbox/templates/dcim/cable.html | 9 ++ netbox/templates/dcim/device.html | 7 ++ netbox/templates/dcim/devicetype.html | 9 ++ netbox/templates/dcim/powerfeed.html | 9 ++ netbox/templates/dcim/powerpanel.html | 9 ++ netbox/templates/dcim/rack.html | 9 ++ netbox/templates/dcim/rackreservation.html | 9 ++ netbox/templates/dcim/site.html | 8 ++ netbox/templates/ipam/aggregate.html | 9 ++ netbox/templates/ipam/ipaddress.html | 9 ++ netbox/templates/ipam/prefix.html | 9 ++ netbox/templates/ipam/service.html | 13 ++- netbox/templates/ipam/vlan.html | 9 ++ netbox/templates/ipam/vrf.html | 9 ++ netbox/templates/secrets/secret.html | 9 ++ netbox/templates/tenancy/tenant.html | 9 ++ netbox/templates/virtualization/cluster.html | 9 ++ .../virtualization/virtualmachine.html | 9 ++ 24 files changed, 313 insertions(+), 14 deletions(-) delete mode 100644 netbox/extras/plugins/templatetags/__init__.py diff --git a/netbox/extras/plugins/__init__.py b/netbox/extras/plugins/__init__.py index e69de29bb..46ca58336 100644 --- a/netbox/extras/plugins/__init__.py +++ b/netbox/extras/plugins/__init__.py @@ -0,0 +1,87 @@ +import collections +import inspect + +from django.core.exceptions import ImproperlyConfigured +from django.template.loader import get_template + +from extras.utils import registry +from .signals import register_detail_page_content_classes + + +class PluginTemplateContent: + """ + This class is used to register plugin content to be injected into core NetBox templates. + It contains methods that are overriden by plugin authors to return template content. + + The `model` attribute on the class defines the which model detail page this class renders + content for. It should be set as a string in the form '.'. + """ + model = None + + def __init__(self, obj): + self.obj = obj + + def render(self, template, extra_context=None): + """ + Convenience menthod for rendering the provided template name. The detail page object is automatically + passed into the template context as `obj` but an additional context dictionary may be passed as `extra_context`. + """ + context = {'obj': self.obj} + if isinstance(extra_context, dict): + context.update(extra_context) + + return get_template(template).render(context) + + def left_page(self): + """ + Content that will be rendered on the left of the detail page view. Content should be returned as an + HTML string. Note that content does not need to be marked as safe because this is automatically handled. + """ + raise NotImplementedError + + def right_page(self): + """ + Content that will be rendered on the right of the detail page view. Content should be returned as an + HTML string. Note that content does not need to be marked as safe because this is automatically handled. + """ + raise NotImplementedError + + def full_width_page(self): + """ + Content that will be rendered within the full width of the detail page view. Content should be returned as an + HTML string. Note that content does not need to be marked as safe because this is automatically handled. + """ + raise NotImplementedError + + def buttons(self): + """ + Buttons that will be rendered and added to the existing list of buttons on the detail page view. Content + should be returned as an HTML string. Note that content does not need to be marked as safe because this is + automatically handled. + """ + raise NotImplementedError + + +def register_content_classes(): + registry.plugin_template_content_classes = collections.defaultdict(list) + + responses = register_detail_page_content_classes.send('registration_event') + for receiver, response in responses: + if not isinstance(response, list): + response = [response] + for template_class in response: + if not inspect.isclass(template_class): + raise TypeError('Plugin content class {} was passes as an instance!'.format(template_class)) + if not issubclass(template_class, PluginTemplateContent): + raise TypeError('{} is not a subclass of extras.plugins.PluginTemplateContent!'.format(template_class)) + if template_class.model is None: + raise TypeError('Plugin content class {} does not define a valid model!'.format(template_class)) + + registry.plugin_template_content_classes[template_class.model].append(template_class) + + +def get_content_classes(model): + if not hasattr(registry, 'plugin_template_content_classes'): + register_content_classes() + + return registry.plugin_template_content_classes.get(model, []) diff --git a/netbox/extras/plugins/signals.py b/netbox/extras/plugins/signals.py index 7d0567b1b..0e5576b67 100644 --- a/netbox/extras/plugins/signals.py +++ b/netbox/extras/plugins/signals.py @@ -27,8 +27,8 @@ class PluginSignal(django.dispatch.Signal): """ -This signal collects templates which render buttons for object detail pages +This signal collects templates which render content for object detail pages """ -register_detail_page_buttons = PluginSignal( +register_detail_page_content_classes = PluginSignal( providing_args=[] ) diff --git a/netbox/extras/plugins/templatetags/__init__.py b/netbox/extras/plugins/templatetags/__init__.py deleted file mode 100644 index e69de29bb..000000000 diff --git a/netbox/extras/templatetags/plugins.py b/netbox/extras/templatetags/plugins.py index dc3443d0c..c4a3002e7 100644 --- a/netbox/extras/templatetags/plugins.py +++ b/netbox/extras/templatetags/plugins.py @@ -2,26 +2,59 @@ from django import template as template_ from django.template.loader import get_template from django.utils.safestring import mark_safe -from extras.plugins.signals import register_detail_page_buttons +from extras.plugins import get_content_classes register = template_.Library() +def _get_registered_content(obj, method): + """ + Given an object and a PluginTemplateContent method name, return all the registered content for the + object's model. + """ + html = '' + + plugin_template_classes = get_content_classes(obj._meta.label_lower) + for plugin_template_class in plugin_template_classes: + plugin_template_renderer = plugin_template_class(obj) + try: + content = getattr(plugin_template_renderer, method)() + except NotImplementedError: + # This content renderer class does not define content for this method + continue + html += content + + return mark_safe(html) + + @register.simple_tag() def plugin_buttons(obj): """ Fire signal to collect all buttons registered by plugins """ - html = '' - responses = register_detail_page_buttons.send(obj) - for receiver, response in responses: - if not isinstance(response, list): - response = [response] - for template in response: - if isinstance(template, str): - template_text = get_template(template).render({'obj': obj}) - html += template_text + return _get_registered_content(obj, 'buttons') - return mark_safe(html) +@register.simple_tag() +def plugin_left_page(obj): + """ + Fire signal to collect all left page content registered by plugins + """ + return _get_registered_content(obj, 'left_page') + + +@register.simple_tag() +def plugin_right_page(obj): + """ + Fire signal to collect all right page content registered by plugins + """ + return _get_registered_content(obj, 'right_page') + + +@register.simple_tag() +def plugin_full_width_page(obj): + """ + Fire signal to collect all full width page content registered by plugins + """ + return _get_registered_content(obj, 'full_width_page') diff --git a/netbox/templates/circuits/circuit.html b/netbox/templates/circuits/circuit.html index 4d7fe9fe2..6b380dc38 100644 --- a/netbox/templates/circuits/circuit.html +++ b/netbox/templates/circuits/circuit.html @@ -2,6 +2,7 @@ {% load buttons %} {% load custom_links %} {% load helpers %} +{% load plugins %} {% block title %}{{ circuit }}{% endblock %} @@ -28,6 +29,7 @@
+ {% plugin_buttons circuit %} {% if perms.circuits.add_circuit %} {% clone_button circuit %} {% endif %} @@ -125,10 +127,17 @@ {% endif %}
+ {% plugin_left_page circuit %}
{% include 'circuits/inc/circuit_termination.html' with termination=termination_a side='A' %} {% include 'circuits/inc/circuit_termination.html' with termination=termination_z side='Z' %} + {% plugin_right_page circuit %} +
+ +
+
+ {% plugin_full_width_page circuit %}
{% endblock %} diff --git a/netbox/templates/circuits/provider.html b/netbox/templates/circuits/provider.html index faeb516ee..c8b6cd66f 100644 --- a/netbox/templates/circuits/provider.html +++ b/netbox/templates/circuits/provider.html @@ -3,6 +3,7 @@ {% load static %} {% load custom_links %} {% load helpers %} +{% load plugins %} {% block title %}{{ provider }}{% endblock %} @@ -28,6 +29,7 @@
+ {% plugin_buttons provider %} {% if show_graphs %}
+ {% plugin_left_page provider %}
@@ -132,9 +135,15 @@ {% endif %}
{% include 'inc/paginator.html' with paginator=circuits_table.paginator page=circuits_table.page %} + {% plugin_right_page provider %}
{% include 'inc/modal.html' with name='graphs' title='Graphs' %} +
+
+ {% plugin_full_width_page provider %} +
+
{% endblock %} {% block javascript %} diff --git a/netbox/templates/dcim/cable.html b/netbox/templates/dcim/cable.html index a78879b23..a74debfe9 100644 --- a/netbox/templates/dcim/cable.html +++ b/netbox/templates/dcim/cable.html @@ -2,6 +2,7 @@ {% load buttons %} {% load custom_links %} {% load helpers %} +{% load plugins %} {% block header %}
@@ -13,6 +14,7 @@
+ {% plugin_buttons cable %} {% if perms.dcim.change_cable %} {% edit_button cable %} {% endif %} @@ -79,6 +81,7 @@
+ {% plugin_left_page cable %}
@@ -93,6 +96,12 @@
{% include 'dcim/inc/cable_termination.html' with termination=cable.termination_b %}
+ {% plugin_right_page cable %} + + +
+
+ {% plugin_full_width_page cable %}
{% endblock %} diff --git a/netbox/templates/dcim/device.html b/netbox/templates/dcim/device.html index 523e3383d..34eee3f55 100644 --- a/netbox/templates/dcim/device.html +++ b/netbox/templates/dcim/device.html @@ -333,6 +333,7 @@ {% endif %} + {% plugin_left_page device %}
{% if console_ports or power_ports %} @@ -499,6 +500,12 @@
None found
{% endif %}
+ {% plugin_right_page device %} + + +
+
+ {% plugin_full_width_page device %}
diff --git a/netbox/templates/dcim/devicetype.html b/netbox/templates/dcim/devicetype.html index 352141a9a..4d401da88 100644 --- a/netbox/templates/dcim/devicetype.html +++ b/netbox/templates/dcim/devicetype.html @@ -2,6 +2,7 @@ {% load buttons %} {% load custom_links %} {% load helpers %} +{% load plugins %} {% block title %}{{ devicetype.manufacturer }} {{ devicetype.model }}{% endblock %} @@ -16,6 +17,7 @@
+ {% plugin_buttons devicetype %} {% if perms.dcim.change_devicetype %}
+ {% plugin_left_page devicetype %}
{% include 'inc/custom_fields_panel.html' with obj=devicetype %} @@ -155,6 +158,7 @@ {% endif %}
+ {% plugin_right_page devicetype %} {% if devicetype.consoleport_templates.exists or devicetype.powerport_templates.exists %} @@ -167,6 +171,11 @@ {% endif %} +
+
+ {% plugin_full_width_page devicetype %} +
+
{% if devicetype.is_parent_device or devicebay_table.rows %}
diff --git a/netbox/templates/dcim/powerfeed.html b/netbox/templates/dcim/powerfeed.html index ca717b5e1..026d97313 100644 --- a/netbox/templates/dcim/powerfeed.html +++ b/netbox/templates/dcim/powerfeed.html @@ -3,6 +3,7 @@ {% load static %} {% load custom_links %} {% load helpers %} +{% load plugins %} {% block header %}
@@ -31,6 +32,7 @@
+ {% plugin_buttons powerfeed %} {% if perms.dcim.add_powerfeed %} {% clone_button powerfeed %} {% endif %} @@ -123,6 +125,7 @@
{% include 'inc/custom_fields_panel.html' with obj=powerfeed %} {% include 'extras/inc/tags_panel.html' with tags=powerfeed.tags.all url='dcim:powerfeed_list' %} + {% plugin_left_page powerfeed %}
@@ -164,6 +167,12 @@ {% endif %}
+ {% plugin_right_page powerfeed %} + + +
+
+ {% plugin_full_width_page powerfeed %}
{% endblock %} diff --git a/netbox/templates/dcim/powerpanel.html b/netbox/templates/dcim/powerpanel.html index 6d47e08b1..a2d3376d7 100644 --- a/netbox/templates/dcim/powerpanel.html +++ b/netbox/templates/dcim/powerpanel.html @@ -3,6 +3,7 @@ {% load custom_links %} {% load helpers %} {% load static %} +{% load plugins %} {% block header %}
@@ -30,6 +31,7 @@
+ {% plugin_buttons powerpanel %} {% if perms.dcim.change_powerpanel %} {% edit_button powerpanel %} {% endif %} @@ -80,9 +82,16 @@
+ {% plugin_left_page powerpanel %}
{% include 'panel_table.html' with table=powerfeed_table heading='Connected Feeds' %} + {% plugin_right_page powerpanel %} +
+ +
+
+ {% plugin_full_width_page powerpanel %}
{% endblock %} diff --git a/netbox/templates/dcim/rack.html b/netbox/templates/dcim/rack.html index ecd17172b..756f9619e 100644 --- a/netbox/templates/dcim/rack.html +++ b/netbox/templates/dcim/rack.html @@ -3,6 +3,7 @@ {% load custom_links %} {% load helpers %} {% load static %} +{% load plugins %} {% block header %}
@@ -27,6 +28,7 @@
+ {% plugin_buttons rack %} Previous Rack @@ -312,6 +314,7 @@
{% endif %} + {% plugin_left_page rack %}
@@ -369,6 +372,12 @@
{% endif %}
+ {% plugin_right_page rack %} + + +
+
+ {% plugin_full_width_page rack %}
{% endblock %} diff --git a/netbox/templates/dcim/rackreservation.html b/netbox/templates/dcim/rackreservation.html index ef9e49d23..81592904f 100644 --- a/netbox/templates/dcim/rackreservation.html +++ b/netbox/templates/dcim/rackreservation.html @@ -3,6 +3,7 @@ {% load custom_links %} {% load helpers %} {% load static %} +{% load plugins %} {% block header %}
@@ -27,6 +28,7 @@
+ {% plugin_buttons rackreservation %} {% if perms.dcim.change_rackreservation %} {% edit_button rackreservation %} {% endif %} @@ -119,6 +121,7 @@
+ {% plugin_left_page rackreservation %}
{% with rack=rackreservation.rack %} @@ -137,6 +140,12 @@
{% endwith %} + {% plugin_right_page rackreservation %} + + +
+
+ {% plugin_full_width_page rackreservation %}
{% endblock %} diff --git a/netbox/templates/dcim/site.html b/netbox/templates/dcim/site.html index 6a0b836f8..16cee782c 100644 --- a/netbox/templates/dcim/site.html +++ b/netbox/templates/dcim/site.html @@ -5,6 +5,7 @@ {% load plugins %} {% load static %} {% load tz %} +{% load plugins %} {% block header %}
@@ -214,6 +215,7 @@ {% endif %}
+ {% plugin_left_page site %}
@@ -288,9 +290,15 @@
{% endif %}
+ {% plugin_right_page site %} {% include 'inc/modal.html' with name='graphs' title='Graphs' %} +
+
+ {% plugin_full_width_page site %} +
+
{% endblock %} {% block javascript %} diff --git a/netbox/templates/ipam/aggregate.html b/netbox/templates/ipam/aggregate.html index 43cfb10a0..9810e3689 100644 --- a/netbox/templates/ipam/aggregate.html +++ b/netbox/templates/ipam/aggregate.html @@ -2,6 +2,7 @@ {% load buttons %} {% load custom_links %} {% load helpers %} +{% load plugins %} {% block header %}
@@ -26,6 +27,7 @@
+ {% plugin_buttons aggregate %} {% if perms.ipam.add_aggregate %} {% clone_button aggregate %} {% endif %} @@ -88,10 +90,17 @@
+ {% plugin_left_page aggregate %}
{% include 'inc/custom_fields_panel.html' with obj=aggregate %} {% include 'extras/inc/tags_panel.html' with tags=aggregate.tags.all url='ipam:aggregate_list' %} + {% plugin_right_page aggregate %} +
+ +
+
+ {% plugin_full_width_page aggregate %}
diff --git a/netbox/templates/ipam/ipaddress.html b/netbox/templates/ipam/ipaddress.html index 83c34cd6b..a627b8d69 100644 --- a/netbox/templates/ipam/ipaddress.html +++ b/netbox/templates/ipam/ipaddress.html @@ -2,6 +2,7 @@ {% load buttons %} {% load custom_links %} {% load helpers %} +{% load plugins %} {% block header %}
@@ -28,6 +29,7 @@
+ {% plugin_buttons ipaddress %} {% if perms.ipam.add_ipaddress %} {% clone_button ipaddress %} {% endif %} @@ -152,6 +154,7 @@
{% include 'inc/custom_fields_panel.html' with obj=ipaddress %} {% include 'extras/inc/tags_panel.html' with tags=ipaddress.tags.all url='ipam:ipaddress_list' %} + {% plugin_left_page ipaddress %}
{% include 'panel_table.html' with table=parent_prefixes_table heading='Parent Prefixes' %} @@ -159,6 +162,12 @@ {% include 'panel_table.html' with table=duplicate_ips_table heading='Duplicate IP Addresses' panel_class='danger' %} {% endif %} {% include 'utilities/obj_table.html' with table=related_ips_table table_template='panel_table.html' heading='Related IP Addresses' panel_class='default noprint' %} + {% plugin_right_page ipaddress %}
+
+
+ {% plugin_full_width_page ipaddress %} +
+
{% endblock %} diff --git a/netbox/templates/ipam/prefix.html b/netbox/templates/ipam/prefix.html index 5d5490937..d6d7ef4d8 100644 --- a/netbox/templates/ipam/prefix.html +++ b/netbox/templates/ipam/prefix.html @@ -2,6 +2,7 @@ {% load buttons %} {% load custom_links %} {% load helpers %} +{% load plugins %} {% block header %}
@@ -28,6 +29,7 @@
+ {% plugin_buttons prefix %} {% if perms.ipam.add_prefix and active_tab == 'prefixes' and first_available_prefix %} Add Child Prefix @@ -187,12 +189,19 @@
{% include 'inc/custom_fields_panel.html' with obj=prefix %} {% include 'extras/inc/tags_panel.html' with tags=prefix.tags.all url='ipam:prefix_list' %} + {% plugin_left_page prefix %}
{% if duplicate_prefix_table.rows %} {% include 'panel_table.html' with table=duplicate_prefix_table heading='Duplicate Prefixes' panel_class='danger' %} {% endif %} {% include 'panel_table.html' with table=parent_prefix_table heading='Parent Prefixes' panel_class='default' %} + {% plugin_right_page prefix %} +
+ +
+
+ {% plugin_full_width_page prefix %}
{% endblock %} diff --git a/netbox/templates/ipam/service.html b/netbox/templates/ipam/service.html index b845aca17..2d4e69fa5 100644 --- a/netbox/templates/ipam/service.html +++ b/netbox/templates/ipam/service.html @@ -2,6 +2,7 @@ {% load buttons %} {% load custom_links %} {% load helpers %} +{% load plugins %} {% block content %}
@@ -26,6 +27,7 @@
+ {% plugin_buttons service %} {% if perms.dcim.change_service %} {% edit_button service %} {% endif %} @@ -81,6 +83,15 @@
{% include 'inc/custom_fields_panel.html' with obj=service %} {% include 'extras/inc/tags_panel.html' with tags=service.tags.all url='ipam:service_list' %} - + {% plugin_left_page service %} + +
+ {% plugin_right_page service %} +
+ +
+
+ {% plugin_full_width_page service %} +
{% endblock %} diff --git a/netbox/templates/ipam/vlan.html b/netbox/templates/ipam/vlan.html index 246f3c866..6b867762b 100644 --- a/netbox/templates/ipam/vlan.html +++ b/netbox/templates/ipam/vlan.html @@ -2,6 +2,7 @@ {% load buttons %} {% load custom_links %} {% load helpers %} +{% load plugins %} {% block header %}
@@ -31,6 +32,7 @@
+ {% plugin_buttons vlan %} {% if perms.ipam.add_vlan %} {% clone_button vlan %} {% endif %} @@ -139,6 +141,7 @@
{% include 'inc/custom_fields_panel.html' with obj=vlan %} {% include 'extras/inc/tags_panel.html' with tags=vlan.tags.all url='ipam:vlan_list' %} + {% plugin_left_page vlan %}
@@ -155,6 +158,12 @@
{% endif %}
+ {% plugin_right_page vlan %} + + +
+
+ {% plugin_full_width_page vlan %}
{% endblock %} diff --git a/netbox/templates/ipam/vrf.html b/netbox/templates/ipam/vrf.html index 7bb2dea25..e448743f1 100644 --- a/netbox/templates/ipam/vrf.html +++ b/netbox/templates/ipam/vrf.html @@ -2,6 +2,7 @@ {% load buttons %} {% load custom_links %} {% load helpers %} +{% load plugins %} {% block header %}
@@ -25,6 +26,7 @@
+ {% plugin_buttons vrf %} {% if perms.ipam.add_vrf %} {% clone_button vrf %} {% endif %} @@ -97,9 +99,16 @@
{% include 'extras/inc/tags_panel.html' with tags=vrf.tags.all url='ipam:vrf_list' %} + {% plugin_left_page vrf %}
{% include 'inc/custom_fields_panel.html' with obj=vrf %} + {% plugin_right_page vrf %} +
+ +
+
+ {% plugin_full_width_page vrf %}
{% endblock %} diff --git a/netbox/templates/secrets/secret.html b/netbox/templates/secrets/secret.html index 6045897c9..6de32b72c 100644 --- a/netbox/templates/secrets/secret.html +++ b/netbox/templates/secrets/secret.html @@ -4,6 +4,7 @@ {% load helpers %} {% load secret_helpers %} {% load static %} +{% load plugins %} {% block header %}
@@ -16,6 +17,7 @@
+ {% plugin_buttons secret %} {% if perms.secrets.change_secret %} {% edit_button secret %} {% endif %} @@ -65,6 +67,7 @@
{% include 'inc/custom_fields_panel.html' with obj=secret %} + {% plugin_left_page secret %}
{% if secret|decryptable_by:request.user %} @@ -100,6 +103,12 @@
{% endif %} {% include 'extras/inc/tags_panel.html' with tags=secret.tags.all url='secrets:secret_list' %} + {% plugin_right_page secret %} + + +
+
+ {% plugin_full_width_page secret %}
diff --git a/netbox/templates/tenancy/tenant.html b/netbox/templates/tenancy/tenant.html index 4ef26c451..5232d1a86 100644 --- a/netbox/templates/tenancy/tenant.html +++ b/netbox/templates/tenancy/tenant.html @@ -2,6 +2,7 @@ {% load buttons %} {% load custom_links %} {% load helpers %} +{% load plugins %} {% block header %}
@@ -28,6 +29,7 @@
+ {% plugin_buttons tenant %} {% if perms.tenancy.add_tenant %} {% clone_button tenant %} {% endif %} @@ -93,6 +95,7 @@ {% endif %}
+ {% plugin_left_page tenant %}
@@ -146,6 +149,12 @@
+ {% plugin_right_page tenant %} + + +
+
+ {% plugin_full_width_page tenant %}
{% endblock %} diff --git a/netbox/templates/virtualization/cluster.html b/netbox/templates/virtualization/cluster.html index 4070977bc..5a9d26837 100644 --- a/netbox/templates/virtualization/cluster.html +++ b/netbox/templates/virtualization/cluster.html @@ -2,6 +2,7 @@ {% load buttons %} {% load custom_links %} {% load helpers %} +{% load plugins %} {% block header %}
@@ -28,6 +29,7 @@
+ {% plugin_buttons cluster %} {% if perms.virtualization.add_cluster %} {% clone_button cluster %} {% endif %} @@ -121,6 +123,7 @@ {% endif %}
+ {% plugin_left_page cluster %}
@@ -148,6 +151,12 @@ {% endif %}
+ {% plugin_right_page cluster %}
+
+
+ {% plugin_full_width_page cluster %} +
+
{% endblock %} diff --git a/netbox/templates/virtualization/virtualmachine.html b/netbox/templates/virtualization/virtualmachine.html index 33dd8130a..ba6a4d33e 100644 --- a/netbox/templates/virtualization/virtualmachine.html +++ b/netbox/templates/virtualization/virtualmachine.html @@ -3,6 +3,7 @@ {% load custom_links %} {% load static %} {% load helpers %} +{% load plugins %} {% block header %}
@@ -28,6 +29,7 @@
+ {% plugin_buttons virtualmachine %} {% if perms.virtualization.add_virtualmachine %} {% clone_button virtualmachine %} {% endif %} @@ -158,6 +160,7 @@ {% endif %}
+ {% plugin_left_page virtualmachine %}
@@ -235,6 +238,12 @@
{% endif %}
+ {% plugin_right_page virtualmachine %} + + +
+
+ {% plugin_full_width_page virtualmachine %}
From 457354c244676b7586e82bb8ba8cd58e98b7c2c6 Mon Sep 17 00:00:00 2001 From: John Anderson Date: Tue, 17 Mar 2020 00:03:58 -0400 Subject: [PATCH 053/124] inject origional context as obj_context --- netbox/extras/plugins/__init__.py | 11 ++++++--- netbox/extras/templatetags/plugins.py | 32 +++++++++++++-------------- 2 files changed, 24 insertions(+), 19 deletions(-) diff --git a/netbox/extras/plugins/__init__.py b/netbox/extras/plugins/__init__.py index 46ca58336..af94b9373 100644 --- a/netbox/extras/plugins/__init__.py +++ b/netbox/extras/plugins/__init__.py @@ -18,15 +18,20 @@ class PluginTemplateContent: """ model = None - def __init__(self, obj): + def __init__(self, obj, context): self.obj = obj + self.context = context def render(self, template, extra_context=None): """ Convenience menthod for rendering the provided template name. The detail page object is automatically - passed into the template context as `obj` but an additional context dictionary may be passed as `extra_context`. + passed into the template context as `obj` and the origional detail page's context is available as + `obj_context`. An additional context dictionary may be passed as `extra_context`. """ - context = {'obj': self.obj} + context = { + 'obj': self.obj, + 'obj_context': self.context + } if isinstance(extra_context, dict): context.update(extra_context) diff --git a/netbox/extras/templatetags/plugins.py b/netbox/extras/templatetags/plugins.py index c4a3002e7..384b08b6a 100644 --- a/netbox/extras/templatetags/plugins.py +++ b/netbox/extras/templatetags/plugins.py @@ -8,16 +8,16 @@ from extras.plugins import get_content_classes register = template_.Library() -def _get_registered_content(obj, method): +def _get_registered_content(obj, method, context): """ - Given an object and a PluginTemplateContent method name, return all the registered content for the - object's model. + Given an object and a PluginTemplateContent method name and the template context, return all the + registered content for the object's model. """ html = '' plugin_template_classes = get_content_classes(obj._meta.label_lower) for plugin_template_class in plugin_template_classes: - plugin_template_renderer = plugin_template_class(obj) + plugin_template_renderer = plugin_template_class(obj, context) try: content = getattr(plugin_template_renderer, method)() except NotImplementedError: @@ -28,33 +28,33 @@ def _get_registered_content(obj, method): return mark_safe(html) -@register.simple_tag() -def plugin_buttons(obj): +@register.simple_tag(takes_context=True) +def plugin_buttons(context, obj): """ Fire signal to collect all buttons registered by plugins """ - return _get_registered_content(obj, 'buttons') + return _get_registered_content(obj, 'buttons', context) -@register.simple_tag() -def plugin_left_page(obj): +@register.simple_tag(takes_context=True) +def plugin_left_page(context, obj): """ Fire signal to collect all left page content registered by plugins """ - return _get_registered_content(obj, 'left_page') + return _get_registered_content(obj, 'left_page', context) -@register.simple_tag() -def plugin_right_page(obj): +@register.simple_tag(takes_context=True) +def plugin_right_page(context, obj): """ Fire signal to collect all right page content registered by plugins """ - return _get_registered_content(obj, 'right_page') + return _get_registered_content(obj, 'right_page', context) -@register.simple_tag() -def plugin_full_width_page(obj): +@register.simple_tag(takes_context=True) +def plugin_full_width_page(context, obj): """ Fire signal to collect all full width page content registered by plugins """ - return _get_registered_content(obj, 'full_width_page') + return _get_registered_content(obj, 'full_width_page', context) From 981c98223707f066dcdac5fb4f43b27e953da4a8 Mon Sep 17 00:00:00 2001 From: John Anderson Date: Tue, 17 Mar 2020 02:35:12 -0400 Subject: [PATCH 054/124] added support for plugin nav bar links --- netbox/extras/plugins/__init__.py | 89 ++++++++++++++++++- netbox/extras/plugins/context_processors.py | 12 +++ netbox/extras/plugins/signals.py | 10 ++- netbox/templates/inc/nav_menu.html | 3 + .../templates/inc/plugin_nav_menu_items.html | 29 ++++++ netbox/utilities/choices.py | 26 ++++++ 6 files changed, 167 insertions(+), 2 deletions(-) create mode 100644 netbox/extras/plugins/context_processors.py create mode 100644 netbox/templates/inc/plugin_nav_menu_items.html diff --git a/netbox/extras/plugins/__init__.py b/netbox/extras/plugins/__init__.py index af94b9373..f3ce7dcad 100644 --- a/netbox/extras/plugins/__init__.py +++ b/netbox/extras/plugins/__init__.py @@ -1,13 +1,18 @@ import collections +import importlib import inspect from django.core.exceptions import ImproperlyConfigured from django.template.loader import get_template from extras.utils import registry -from .signals import register_detail_page_content_classes +from .signals import register_detail_page_content_classes, register_nav_menu_link_classes +# +# Template content injection +# + class PluginTemplateContent: """ This class is used to register plugin content to be injected into core NetBox templates. @@ -68,6 +73,9 @@ class PluginTemplateContent: def register_content_classes(): + """ + Helper method that populates the registry with all template content classes that have been registered by plugins + """ registry.plugin_template_content_classes = collections.defaultdict(list) responses = register_detail_page_content_classes.send('registration_event') @@ -86,7 +94,86 @@ def register_content_classes(): def get_content_classes(model): + """ + Given a model string, return the list of all registered template content classes. + Populate the registry if it is empty. + """ if not hasattr(registry, 'plugin_template_content_classes'): register_content_classes() return registry.plugin_template_content_classes.get(model, []) + + +# +# Nav menu links +# + +class PluginNavMenuLink: + """ + This class represents a nav menu item. This constitutes primary link and its text, but also allows for + specifying additional link buttons that appear to the right of the item in the van menu. + + Links are specified as Django reverse URL strings. + Buttons are each specified as a list of PluginNavMenuButton instances. + """ + link = None + link_text = None + link_permission = None + buttons = [] + + +class PluginNavMenuButton: + """ + This class represents a button which is a part of the nav menu link item. + Note that button colors should come from ButtonColorChoices + """ + def __init__(self, link, title, icon_class, color, permission=None): + self.link = link + self.title = title + self.icon_class = icon_class + self.color = color + self.permission = permission + + +def register_nav_menu_links(): + """ + Helper method that populates the registry with all nav menu link classes that have been registered by plugins + """ + registry.plugin_nav_menu_link_classes = {} + + responses = register_nav_menu_link_classes.send('registration_event') + for receiver, response in responses: + + # Import the app config for the plugin to get the name to be used as the nav menu section text + module = importlib.import_module(receiver.__module__.split('.')[0]) + default_app_config = getattr(module, 'default_app_config') + module, app_config = default_app_config.rsplit('.', 1) + app_config = getattr(importlib.import_module(module), app_config) + section_name = app_config.NetBoxPluginMeta.name + + if not isinstance(response, list): + response = [response] + for link_class in response: + if not inspect.isclass(link_class): + raise TypeError('Plugin nav menu link class {} was passes as an instance!'.format(link_class)) + if not issubclass(link_class, PluginNavMenuLink): + raise TypeError('{} is not a subclass of extras.plugins.PluginNavMenuLink!'.format(link_class)) + if link_class.link is None or link_class.link_text is None: + raise TypeError('Plugin nav menu link {} must specify at least link and link_text'.format(link_class)) + + for button in link_class.buttons: + if not isinstance(button, PluginNavMenuButton): + raise TypeError('{} must be an instance of PluginNavMenuButton!'.format(button)) + + registry.plugin_nav_menu_link_classes[section_name] = response + + +def get_nav_menu_link_classes(): + """ + Return the list of all registered nav menu link classes. + Populate the registry if it is empty. + """ + if not hasattr(registry, 'plugin_nav_menu_link_classes'): + register_nav_menu_links() + + return registry.plugin_nav_menu_link_classes diff --git a/netbox/extras/plugins/context_processors.py b/netbox/extras/plugins/context_processors.py new file mode 100644 index 000000000..14b05b874 --- /dev/null +++ b/netbox/extras/plugins/context_processors.py @@ -0,0 +1,12 @@ +from . import get_nav_menu_link_classes + + +def nav_menu_links(request): + """ + Retrieve and expose all plugin registered nav links + """ + nav_menu_links = get_nav_menu_link_classes() + + return { + 'plugin_nav_menu_links': nav_menu_links + } diff --git a/netbox/extras/plugins/signals.py b/netbox/extras/plugins/signals.py index 0e5576b67..7ebb549db 100644 --- a/netbox/extras/plugins/signals.py +++ b/netbox/extras/plugins/signals.py @@ -27,8 +27,16 @@ class PluginSignal(django.dispatch.Signal): """ -This signal collects templates which render content for object detail pages +This signal collects template content classes which render content for object detail pages """ register_detail_page_content_classes = PluginSignal( providing_args=[] ) + + +""" +This signal collects nav menu link classes +""" +register_nav_menu_link_classes = PluginSignal( + providing_args=[] +) diff --git a/netbox/templates/inc/nav_menu.html b/netbox/templates/inc/nav_menu.html index e65d42623..d42bb7737 100644 --- a/netbox/templates/inc/nav_menu.html +++ b/netbox/templates/inc/nav_menu.html @@ -504,6 +504,9 @@ + {% if plugin_nav_menu_links %} + {% include 'inc/plugin_nav_menu_items.html' %} + {% endif %} {% endif %}
    diff --git a/netbox/templates/inc/plugin_nav_menu_items.html b/netbox/templates/inc/plugin_nav_menu_items.html new file mode 100644 index 000000000..b79044273 --- /dev/null +++ b/netbox/templates/inc/plugin_nav_menu_items.html @@ -0,0 +1,29 @@ +
  • + +
      + {% for section_name, link_items in plugin_nav_menu_links.items %} +
    • {{ section_name }}
      • + {% for link_item in link_items %} + {% if link_item.link_permission %} + + {% else %} +
    • + {% endif %} + {% if link_item.buttons %} +
      + {% for button in link_item.buttons %} + {% if not button.permission or button.permission in perms %} + + {% endif %} + {% endfor %} +
      + {% endif %} + {{ link_item.link_text }} +
      • + {% endfor %} + {% if not forloop.last %} +
    • + {% endif %} + {% endfor %} +
    +
    • diff --git a/netbox/utilities/choices.py b/netbox/utilities/choices.py index 19082dbb6..c38b2d1bf 100644 --- a/netbox/utilities/choices.py +++ b/netbox/utilities/choices.py @@ -78,3 +78,29 @@ def unpack_grouped_choices(choices): else: unpacked_choices.append((key, value)) return unpacked_choices + + +# +# Button color choices +# + +class ButtonColorChoices(ChoiceSet): + """ + Map standard button color choices to Bootstrap color classes + """ + + BLUE = 'primary' + GREY = 'secondary' + GREEN = 'success' + RED = 'danger' + YELLOW = 'warning' + BLACK = 'dark' + + CHOICES = ( + (BLUE, 'Blue'), + (GREY, 'Grey'), + (GREEN, 'Green'), + (RED, 'Red'), + (YELLOW, 'Yellow'), + (BLACK, 'Black') + ) From 2f37357a1b67175864fa74b42fea00116c2b9b2d Mon Sep 17 00:00:00 2001 From: John Anderson Date: Tue, 17 Mar 2020 02:35:34 -0400 Subject: [PATCH 055/124] added support for prepending elements to middleware --- netbox/netbox/settings.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/netbox/netbox/settings.py b/netbox/netbox/settings.py index 7666b24d8..2d0fdaed0 100644 --- a/netbox/netbox/settings.py +++ b/netbox/netbox/settings.py @@ -298,6 +298,7 @@ TEMPLATES = [ 'django.contrib.auth.context_processors.auth', 'django.contrib.messages.context_processors.messages', 'utilities.context_processors.settings', + 'extras.plugins.context_processors.nav_menu_links', ], }, }, @@ -629,6 +630,9 @@ if PLUGINS_ENABLED: plugin_middleware = getattr(app_config_meta, 'middleware', []) if plugin_middleware and isinstance(plugin_middleware, list): MIDDLEWARE.extend(plugin_middleware) + plugin_middleware_prepend = getattr(app_config_meta, 'middleware_prepend', []) + if plugin_middleware_prepend and isinstance(plugin_middleware_prepend, list): + MIDDLEWARE[:0] = plugin_middleware_prepend # Add installed apps plugin_installed_apps = getattr(app_config_meta, 'installed_apps', []) From ced6fe313a6019c157c3ee5c6c02415443b40452 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Wed, 18 Mar 2020 15:41:23 -0400 Subject: [PATCH 056/124] Fix RackGroupForm field --- netbox/dcim/forms.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/netbox/dcim/forms.py b/netbox/dcim/forms.py index 54357a2dc..f34a0c819 100644 --- a/netbox/dcim/forms.py +++ b/netbox/dcim/forms.py @@ -378,7 +378,8 @@ class RackGroupForm(BootstrapMixin, forms.ModelForm): queryset=Site.objects.all() ) parent = DynamicModelChoiceField( - queryset=RackGroup.objects.all() + queryset=RackGroup.objects.all(), + required=False ) slug = SlugField() From c7fb2ff894b23b82ab47b248a603da60750ec709 Mon Sep 17 00:00:00 2001 From: John Anderson Date: Wed, 18 Mar 2020 18:28:27 -0400 Subject: [PATCH 057/124] add version contraints and cacheops config --- netbox/extras/plugins/__init__.py | 18 +++++++-------- netbox/netbox/settings.py | 38 +++++++++++++++++++++++-------- netbox/netbox/urls.py | 7 ++++++ 3 files changed, 45 insertions(+), 18 deletions(-) diff --git a/netbox/extras/plugins/__init__.py b/netbox/extras/plugins/__init__.py index f3ce7dcad..c0ac4259d 100644 --- a/netbox/extras/plugins/__init__.py +++ b/netbox/extras/plugins/__init__.py @@ -5,7 +5,7 @@ import inspect from django.core.exceptions import ImproperlyConfigured from django.template.loader import get_template -from extras.utils import registry +from extras.registry import registry from .signals import register_detail_page_content_classes, register_nav_menu_link_classes @@ -76,7 +76,7 @@ def register_content_classes(): """ Helper method that populates the registry with all template content classes that have been registered by plugins """ - registry.plugin_template_content_classes = collections.defaultdict(list) + registry['plugin_template_content_classes'] = collections.defaultdict(list) responses = register_detail_page_content_classes.send('registration_event') for receiver, response in responses: @@ -90,7 +90,7 @@ def register_content_classes(): if template_class.model is None: raise TypeError('Plugin content class {} does not define a valid model!'.format(template_class)) - registry.plugin_template_content_classes[template_class.model].append(template_class) + registry['plugin_template_content_classes'][template_class.model].append(template_class) def get_content_classes(model): @@ -98,10 +98,10 @@ def get_content_classes(model): Given a model string, return the list of all registered template content classes. Populate the registry if it is empty. """ - if not hasattr(registry, 'plugin_template_content_classes'): + if 'plugin_template_content_classes' not in registry: register_content_classes() - return registry.plugin_template_content_classes.get(model, []) + return registry['plugin_template_content_classes'].get(model, []) # @@ -139,7 +139,7 @@ def register_nav_menu_links(): """ Helper method that populates the registry with all nav menu link classes that have been registered by plugins """ - registry.plugin_nav_menu_link_classes = {} + registry['plugin_nav_menu_link_classes'] = {} responses = register_nav_menu_link_classes.send('registration_event') for receiver, response in responses: @@ -165,7 +165,7 @@ def register_nav_menu_links(): if not isinstance(button, PluginNavMenuButton): raise TypeError('{} must be an instance of PluginNavMenuButton!'.format(button)) - registry.plugin_nav_menu_link_classes[section_name] = response + registry['plugin_nav_menu_link_classes'][section_name] = response def get_nav_menu_link_classes(): @@ -173,7 +173,7 @@ def get_nav_menu_link_classes(): Return the list of all registered nav menu link classes. Populate the registry if it is empty. """ - if not hasattr(registry, 'plugin_nav_menu_link_classes'): + if 'plugin_nav_menu_link_classes' not in registry: register_nav_menu_links() - return registry.plugin_nav_menu_link_classes + return registry['plugin_nav_menu_link_classes'] diff --git a/netbox/netbox/settings.py b/netbox/netbox/settings.py index 926501498..e3fa4e924 100644 --- a/netbox/netbox/settings.py +++ b/netbox/netbox/settings.py @@ -10,7 +10,7 @@ from urllib.parse import urlsplit from django.contrib.messages import constants as messages from django.core.exceptions import ImproperlyConfigured, ValidationError from django.core.validators import URLValidator -from pkg_resources import iter_entry_points +from pkg_resources import iter_entry_points, parse_version # @@ -645,6 +645,7 @@ if PLUGINS_ENABLED: PLUGINS.append(plugin) INSTALLED_APPS.append(plugin) + # Import the app config and locate the inner meta class try: module = importlib.import_module(plugin) default_app_config = getattr(module, 'default_app_config') @@ -659,18 +660,22 @@ if PLUGINS_ENABLED: 'The app config for plugin {} does not contain an inner meta class'.format(plugin) ) + # Check version contraints + min_version = getattr(app_config_meta, 'min_version', None) + max_version = getattr(app_config_meta, 'max_version', None) + parsed_min_version = parse_version(min_version or VERSION) + parsed_max_version = parse_version(max_version or VERSION) + if min_version and max_version and parsed_min_version > parsed_max_version: + raise ImproperlyConfigured('Plugin {} specifies invalid version contraints!'.format(plugin)) + if min_version and parsed_min_version > parse_version(VERSION): + raise ImproperlyConfigured('Plugin {} requires NetBox minimum version {}!'.format(plugin, min_version)) + if max_version and parsed_max_version < parse_version(VERSION): + raise ImproperlyConfigured('Plugin {} requires NetBox maximum version {}!'.format(plugin, max_version)) + # Add middleware plugin_middleware = getattr(app_config_meta, 'middleware', []) if plugin_middleware and isinstance(plugin_middleware, list): MIDDLEWARE.extend(plugin_middleware) - plugin_middleware_prepend = getattr(app_config_meta, 'middleware_prepend', []) - if plugin_middleware_prepend and isinstance(plugin_middleware_prepend, list): - MIDDLEWARE[:0] = plugin_middleware_prepend - - # Add installed apps - plugin_installed_apps = getattr(app_config_meta, 'installed_apps', []) - if plugin_installed_apps and isinstance(plugin_installed_apps, list): - INSTALLED_APPS.extend(plugin_installed_apps) # Verify required configuration settings if plugin not in PLUGINS_CONFIG: @@ -688,3 +693,18 @@ if PLUGINS_ENABLED: for setting, value in getattr(app_config_meta, 'default_settings', {}).items(): if setting not in PLUGINS_CONFIG[plugin]: PLUGINS_CONFIG[plugin][setting] = value + + # Apply cacheops config + plugin_cacheops = getattr(app_config_meta, 'caching_config', {}) + if plugin_cacheops and isinstance(plugin_cacheops, dict): + for key in plugin_cacheops.keys(): + # Validate config is only being set for the given plugin + try: + app = key.split('.')[0] + except IndexError: + raise ImproperlyConfigured('Plugin {} caching_config is invalid!'.format(plugin)) + if app != plugin: + raise ImproperlyConfigured( + 'Plugin {} may not modify caching config for another app!'.format(plugin) + ) + CACHEOPS.update(plugin_cacheops) diff --git a/netbox/netbox/urls.py b/netbox/netbox/urls.py index 0c8845f5e..651aef14a 100644 --- a/netbox/netbox/urls.py +++ b/netbox/netbox/urls.py @@ -75,26 +75,33 @@ _patterns = [ plugin_patterns = [] plugin_api_patterns = [] for app in apps.get_app_configs(): + # Loop over all apps look for installed plugins if hasattr(app, 'NetBoxPluginMeta'): + # Check if the plugin specifies any URLs if importlib.util.find_spec('{}.urls'.format(app.name)): urls = importlib.import_module('{}.urls'.format(app.name)) url_slug = getattr(app.NetBoxPluginMeta, 'url_slug', app.label) if hasattr(urls, 'urlpatterns'): + # Mount URLs at `/` plugin_patterns.append( path('{}/'.format(url_slug), include((urls.urlpatterns, app.label))) ) + # Check if the plugin specifies any API URLs if importlib.util.find_spec('{}.api'.format(app.name)): if importlib.util.find_spec('{}.api.urls'.format(app.name)): urls = importlib.import_module('{}.api.urls'.format(app.name)) if hasattr(urls, 'urlpatterns'): url_slug = getattr(app.NetBoxPluginMeta, 'url_slug', app.label) + # Mount URLs at `/` plugin_api_patterns.append( path('{}/'.format(url_slug), include((urls.urlpatterns, app.label))) ) +# Mount all plugin URLs within the `plugins` namespace _patterns.append( path('plugins/', include((plugin_patterns, 'plugins'))) ) +# Mount all plugin API URLs within the `plugins-api` namespace _patterns.append( path('api/plugins/', include((plugin_api_patterns, 'plugins-api'))) ) From 33ca352fd937111c3718d8faafaf21497d3b414b Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Fri, 20 Mar 2020 12:20:25 -0400 Subject: [PATCH 058/124] Initial documentation for plugins framework --- docs/configuration/optional-settings.md | 18 +++++++ docs/plugins/development.md | 58 ++++++++++++++++++++++ docs/plugins/index.md | 64 +++++++++++++++++++++++++ mkdocs.yml | 4 +- 4 files changed, 143 insertions(+), 1 deletion(-) create mode 100644 docs/plugins/development.md create mode 100644 docs/plugins/index.md diff --git a/docs/configuration/optional-settings.md b/docs/configuration/optional-settings.md index 576065434..a678ac26d 100644 --- a/docs/configuration/optional-settings.md +++ b/docs/configuration/optional-settings.md @@ -299,6 +299,24 @@ Determine how many objects to display per page within each list of objects. --- +## PLUGINS_CONFIG + +Default: Empty + +This parameter holds configuration settings for individual NetBox plugins. It is defined as a dictionary, with each key using the name of an installed plugin. The specific parameters supported are unique to each plugin: Reference the plugin's documentation to determine the supported parameters. + +Note that `PLUGINS_ENABLED` must be set to True for this to take effect. + +--- + +## PLUGINS_ENABLED + +Default: `False` + +Enable [NetBox plugins](../../plugins/). + +--- + ## PREFER_IPV4 Default: False diff --git a/docs/plugins/development.md b/docs/plugins/development.md new file mode 100644 index 000000000..babaf0711 --- /dev/null +++ b/docs/plugins/development.md @@ -0,0 +1,58 @@ +# Plugin Development + +This documentation covers the development of custom plugins for NetBox. Plugins are essentially self-contained [Django apps](https://docs.djangoproject.com/en/stable/) which integrate with NetBox to provide custom functionality. Since the development of Django apps is already very well-documented, we'll only be covering the aspects that are specific to NetBox. + +## Initial Setup + +### Plugin Structure + +Although the specific structure of a plugin is largely left to the discretion of its authors, a typical NetBox plugin might look like this: + +```no-highlight +plugin_name/ + - plugin_name/ + - templates/ + - *.html + - __init__.py + - middleware.py + - navigation.py + - signals.py + - template_content.py + - urls.py + - views.py + - setup.py +``` + +The top level is the project root, which is typically synonymous with the git repository. A file named `setup.py` must exist at the top level to register the plugin within NetBox and to define meta data. You might also find miscellaneous other files within the project root, such as `.gitignore`. + +The second level directory houses the actual plugin code, arranged in a set of Python files. These are arbitrary, however the plugin _must_ include a `__init__.py` file which provides an AppConfig subclass. + +### Create setup.py + +The first step is to write our Python [setup script](https://docs.python.org/3.6/distutils/setupscript.html), which facilitates the installation of the plugin. This is standard practice for Python applications, with the only really noteworthy bit being the declared `entry_points`: The plugin must define an entry point for `netbox.plugin` pointing to the NetBoxPluginMeta class. + +```python +from setuptools import setup, find_packages + +setup( + name='netbox-animal-sounds', + version='0.1', + description='Show animals and the sounds they make', + url='https://github.com/organization/animal-sounds', + author='Author Name', + author_email='author@example.com', + license='Apache 2.0', + + install_requires=[], + packages=find_packages(exclude=['tests', 'tests.*']), + include_package_data=True, + entry_points={ + 'netbox.plugin': 'netbox_animal_sounds=netbox_animal_sounds:NetBoxPluginMeta' + } +) + +``` + +### Define an AppConfig + + diff --git a/docs/plugins/index.md b/docs/plugins/index.md new file mode 100644 index 000000000..7e6913329 --- /dev/null +++ b/docs/plugins/index.md @@ -0,0 +1,64 @@ +# Plugins + +Plugins are packaged [Django](https://docs.djangoproject.com/) apps that can be installed alongside NetBox to provide custom functionality not present in the core application. Plugins can introduce their own models and views, but cannot interfere with existing components. A NetBox user may opt to install plugins provided by the community or build his or her own. + +Plugins are supported on NetBox v2.8 and later. + +## Capabilities + +The NetBox plugin architecture allows for the following: + +* **Add new data models.** A plugin can introduce one or more models to hold data. (A model is essentially a SQL table.) +* **Add new URLs and views.** Plugins can register URLS under the `/plugins` root path to provide browsable views for users. +* **Add content to existing model templates.** A template content class can be used to inject custom HTML content within the view of a core NetBox model. This content can appear in the left side, right side, or bottom of the page. +* **Add navigation menu items.** Each plugin can register new links in the navigation menu. Each link may have a set of buttons for specific actions, similar to the built-in navigation items. +* **Add custom middleware.** Custom Django middleware can be registered by each plugin. +* **Declare configuration parameters.** Each plugin can define required, optional, and default configuration parameters within its unique namespace. +* **Limit installation by NetBox version.** A plugin can specify a minimum and/or maximum NetBox version with which it is compatible. + +## Limitations + +Either by policy or by technical limitation, the interaction of plugins with NetBox core is restricted in certain ways. These include: + +* **Modify core models.** Plugins may not alter, remove, or override core NetBox models in any way. This rule is in place to ensure the integrity of the core data model. +* **Register URLs outside the `/plugins` root.`** All plugin URLs are restricted to this path to prevent name/path collisions. +* **Override core templates.** The only avenue available for injecting content into core templates is the provided +* **Modify core settings.** A configuration registry is provided for plugins, however they cannot alter or delete the core configuration. +* **Disable core components.** Plugins are not permitted to disable or hide core NetBox components. + +## Installing Plugins + +The instructions below detail the process for installing and enabling a NetBox plugin. + +### Install Package + +TODO + +### Enable Plugins + +In `configuration.py`, set the `PLUGINS_ENABLED` parameter to True (if not already set): + +```python +PLUGINS_ENABLED = True +``` + +### Configure Plugin + +If the plugin requires any configuration, define it in `configuration.py` under the `PLUGINS_CONFIG` parameter. The available configuration parameters should be detailed in the plugin's README file. + +```no-highlight +PLUGINS_CONFIG = { + 'plugin_name': { + 'foo': 'bar', + 'buzz': 'bazz' + } +} +``` + +### Restart WSGI Service + +Restart the WSGI service to detect the new plugin: + +```no-highlight +# sudo systemctl restart netbox +``` diff --git a/mkdocs.yml b/mkdocs.yml index d980cc80c..d7e803149 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -11,7 +11,6 @@ markdown_extensions: - admonition: - markdown_include.include: headingOffset: 1 - nav: - Introduction: 'index.md' - Installation: @@ -53,6 +52,9 @@ nav: - Reports: 'additional-features/reports.md' - Tags: 'additional-features/tags.md' - Webhooks: 'additional-features/webhooks.md' + - Plugins: + - Using Plugins: 'plugins/index.md' + - Developing Plugins: 'plugins/development.md' - Administration: - Replicating NetBox: 'administration/replicating-netbox.md' - NetBox Shell: 'administration/netbox-shell.md' From 28b5e88c50d6aba9ba08bb1be961e7f315965dfd Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Fri, 20 Mar 2020 14:35:54 -0400 Subject: [PATCH 059/124] Rename entry point group; simplify import --- netbox/netbox/settings.py | 11 ++--------- 1 file changed, 2 insertions(+), 9 deletions(-) diff --git a/netbox/netbox/settings.py b/netbox/netbox/settings.py index e3fa4e924..8527b737c 100644 --- a/netbox/netbox/settings.py +++ b/netbox/netbox/settings.py @@ -640,19 +640,12 @@ if PAGINATE_COUNT not in PER_PAGE_DEFAULTS: PLUGINS = [] if PLUGINS_ENABLED: - for entry_point in iter_entry_points(group='netbox.plugin', name=None): + for entry_point in iter_entry_points(group='netbox_plugins', name=None): plugin = entry_point.module_name PLUGINS.append(plugin) INSTALLED_APPS.append(plugin) - # Import the app config and locate the inner meta class - try: - module = importlib.import_module(plugin) - default_app_config = getattr(module, 'default_app_config') - module, app_config = default_app_config.rsplit('.', 1) - app_config = getattr(importlib.import_module(module), app_config) - except ImportError: - raise ImproperlyConfigured('Plugin config for {} could not be imported!'.format(plugin)) + app_config = entry_point.load() app_config_meta = getattr(app_config, 'NetBoxPluginMeta', None) if not app_config_meta: From bc50c2aa551091fa48428fbc00c112d42de4dd46 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Fri, 20 Mar 2020 15:13:25 -0400 Subject: [PATCH 060/124] Introduce PluginConfig --- netbox/extras/plugins/__init__.py | 35 +++++++++++++++++++++- netbox/netbox/settings.py | 50 ++++++++++++------------------- 2 files changed, 53 insertions(+), 32 deletions(-) diff --git a/netbox/extras/plugins/__init__.py b/netbox/extras/plugins/__init__.py index c0ac4259d..12e79d2dc 100644 --- a/netbox/extras/plugins/__init__.py +++ b/netbox/extras/plugins/__init__.py @@ -2,13 +2,46 @@ import collections import importlib import inspect -from django.core.exceptions import ImproperlyConfigured +from django.apps import AppConfig from django.template.loader import get_template from extras.registry import registry from .signals import register_detail_page_content_classes, register_nav_menu_link_classes +# +# Plugin AppConfig class +# + +class PluginConfig(AppConfig): + """ + Subclass of Django's built-in AppConfig class, to be used for NetBox plugins. + """ + # Plugin metadata + author = '' + description = '' + version = '' + + # Root URL path under /plugins. If not set, the plugin's label will be used. + url_slug = None + + # Minimum/maximum compatible versions of NetBox + min_version = None + max_version = None + + # Default configuration parameters + default_settings = {} + + # Mandatory configuration parameters + required_settings = [] + + # Middleware classes provided by the plugin + middleware = [] + + # Caching configuration + caching_config = {} + + # # Template content injection # diff --git a/netbox/netbox/settings.py b/netbox/netbox/settings.py index 8527b737c..6fed9dafe 100644 --- a/netbox/netbox/settings.py +++ b/netbox/netbox/settings.py @@ -642,62 +642,50 @@ PLUGINS = [] if PLUGINS_ENABLED: for entry_point in iter_entry_points(group='netbox_plugins', name=None): plugin = entry_point.module_name + app_config = entry_point.load() + PLUGINS.append(plugin) INSTALLED_APPS.append(plugin) - app_config = entry_point.load() - - app_config_meta = getattr(app_config, 'NetBoxPluginMeta', None) - if not app_config_meta: - raise ImproperlyConfigured( - 'The app config for plugin {} does not contain an inner meta class'.format(plugin) - ) - - # Check version contraints - min_version = getattr(app_config_meta, 'min_version', None) - max_version = getattr(app_config_meta, 'max_version', None) - parsed_min_version = parse_version(min_version or VERSION) - parsed_max_version = parse_version(max_version or VERSION) - if min_version and max_version and parsed_min_version > parsed_max_version: - raise ImproperlyConfigured('Plugin {} specifies invalid version contraints!'.format(plugin)) - if min_version and parsed_min_version > parse_version(VERSION): - raise ImproperlyConfigured('Plugin {} requires NetBox minimum version {}!'.format(plugin, min_version)) - if max_version and parsed_max_version < parse_version(VERSION): - raise ImproperlyConfigured('Plugin {} requires NetBox maximum version {}!'.format(plugin, max_version)) + # Check version constraints + parsed_min_version = parse_version(app_config.min_version or VERSION) + parsed_max_version = parse_version(app_config.max_version or VERSION) + if app_config.min_version and app_config.max_version and parsed_min_version > parsed_max_version: + raise ImproperlyConfigured(f"Plugin {plugin} specifies invalid version constraints!") + if app_config.min_version and parsed_min_version > parse_version(VERSION): + raise ImproperlyConfigured(f"Plugin {plugin} requires NetBox minimum version {app_config.min_version}!") + if app_config.max_version and parsed_max_version < parse_version(VERSION): + raise ImproperlyConfigured(f"Plugin {plugin} requires NetBox maximum version {app_config.max_version}!") # Add middleware - plugin_middleware = getattr(app_config_meta, 'middleware', []) + plugin_middleware = app_config.middleware if plugin_middleware and isinstance(plugin_middleware, list): MIDDLEWARE.extend(plugin_middleware) # Verify required configuration settings if plugin not in PLUGINS_CONFIG: PLUGINS_CONFIG[plugin] = {} - for setting in getattr(app_config_meta, 'required_settings', []): + for setting in app_config.required_settings: if setting not in PLUGINS_CONFIG[plugin]: raise ImproperlyConfigured( - "Plugin {} requires '{}' to be present in the PLUGINS_CONFIG section of configuration.py.".format( - plugin, - setting - ) + f"Plugin {plugin} requires '{setting}' to be present in the PLUGINS_CONFIG section of " + f"configuration.py." ) # Set defined default setting values - for setting, value in getattr(app_config_meta, 'default_settings', {}).items(): + for setting, value in app_config.default_settings.items(): if setting not in PLUGINS_CONFIG[plugin]: PLUGINS_CONFIG[plugin][setting] = value # Apply cacheops config - plugin_cacheops = getattr(app_config_meta, 'caching_config', {}) + plugin_cacheops = app_config.caching_config if plugin_cacheops and isinstance(plugin_cacheops, dict): for key in plugin_cacheops.keys(): # Validate config is only being set for the given plugin try: app = key.split('.')[0] except IndexError: - raise ImproperlyConfigured('Plugin {} caching_config is invalid!'.format(plugin)) + raise ImproperlyConfigured(f"Plugin {plugin} caching_config is invalid!") if app != plugin: - raise ImproperlyConfigured( - 'Plugin {} may not modify caching config for another app!'.format(plugin) - ) + raise ImproperlyConfigured(f"Plugin {plugin} may not modify caching config for another app!") CACHEOPS.update(plugin_cacheops) From ad1522f42802dc3e08ade11022c4685fc32ce8d9 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Fri, 20 Mar 2020 15:51:14 -0400 Subject: [PATCH 061/124] Update plugin URL loading logic --- netbox/netbox/urls.py | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/netbox/netbox/urls.py b/netbox/netbox/urls.py index 651aef14a..657e3d6b4 100644 --- a/netbox/netbox/urls.py +++ b/netbox/netbox/urls.py @@ -8,6 +8,7 @@ from django.views.static import serve from drf_yasg import openapi from drf_yasg.views import get_schema_view +from extras.plugins import PluginConfig from netbox.views import APIRootView, HomeView, StaticMediaFailureView, SearchView from users.views import LoginView, LogoutView from .admin import admin_site @@ -76,11 +77,11 @@ plugin_patterns = [] plugin_api_patterns = [] for app in apps.get_app_configs(): # Loop over all apps look for installed plugins - if hasattr(app, 'NetBoxPluginMeta'): + if isinstance(app, PluginConfig): # Check if the plugin specifies any URLs if importlib.util.find_spec('{}.urls'.format(app.name)): urls = importlib.import_module('{}.urls'.format(app.name)) - url_slug = getattr(app.NetBoxPluginMeta, 'url_slug', app.label) + url_slug = getattr(app, 'url_slug') or app.label if hasattr(urls, 'urlpatterns'): # Mount URLs at `/` plugin_patterns.append( @@ -91,7 +92,7 @@ for app in apps.get_app_configs(): if importlib.util.find_spec('{}.api.urls'.format(app.name)): urls = importlib.import_module('{}.api.urls'.format(app.name)) if hasattr(urls, 'urlpatterns'): - url_slug = getattr(app.NetBoxPluginMeta, 'url_slug', app.label) + url_slug = getattr(app, 'url_slug') or app.label # Mount URLs at `/` plugin_api_patterns.append( path('{}/'.format(url_slug), include((urls.urlpatterns, app.label))) From 4e84e8048f05f614dab35644f082eb611f30ef13 Mon Sep 17 00:00:00 2001 From: John Anderson Date: Fri, 20 Mar 2020 20:10:02 -0400 Subject: [PATCH 062/124] added admin and api views for listing all plugins, and refactored urls import --- netbox/extras/plugins/__init__.py | 3 +- netbox/extras/plugins/urls.py | 53 +++++++++++ netbox/extras/plugins/views.py | 95 +++++++++++++++++++ netbox/netbox/admin.py | 2 +- netbox/netbox/settings.py | 7 +- netbox/netbox/urls.py | 40 +------- netbox/netbox/views.py | 1 + netbox/templates/admin/index.html | 6 ++ .../templates/extras/admin/plugins_index.html | 14 +++ .../templates/extras/admin/plugins_list.html | 60 ++++++++++++ 10 files changed, 242 insertions(+), 39 deletions(-) create mode 100644 netbox/extras/plugins/urls.py create mode 100644 netbox/extras/plugins/views.py create mode 100644 netbox/templates/admin/index.html create mode 100644 netbox/templates/extras/admin/plugins_index.html create mode 100644 netbox/templates/extras/admin/plugins_list.html diff --git a/netbox/extras/plugins/__init__.py b/netbox/extras/plugins/__init__.py index 12e79d2dc..bab798f2f 100644 --- a/netbox/extras/plugins/__init__.py +++ b/netbox/extras/plugins/__init__.py @@ -19,6 +19,7 @@ class PluginConfig(AppConfig): """ # Plugin metadata author = '' + author_email = '' description = '' version = '' @@ -182,7 +183,7 @@ def register_nav_menu_links(): default_app_config = getattr(module, 'default_app_config') module, app_config = default_app_config.rsplit('.', 1) app_config = getattr(importlib.import_module(module), app_config) - section_name = app_config.NetBoxPluginMeta.name + section_name = getattr(app_config, 'verbose_name', app_config.name) if not isinstance(response, list): response = [response] diff --git a/netbox/extras/plugins/urls.py b/netbox/extras/plugins/urls.py new file mode 100644 index 000000000..1dc36befb --- /dev/null +++ b/netbox/extras/plugins/urls.py @@ -0,0 +1,53 @@ +import importlib + +from django.apps import apps +from django.conf import settings +from django.conf.urls import include +from django.core.exceptions import ImproperlyConfigured +from django.urls import path +from django.utils.module_loading import import_string + +from . import views + +# Plugins +plugin_patterns = [] +plugin_api_patterns = [] + +for plugin in settings.PLUGINS: + app = apps.get_app_config(plugin) + + url_slug = getattr(app, 'url_slug') or app.label + + # Check if the plugin specifies any URLs + try: + urlpatterns = import_string(f"{plugin}.urls.urlpatterns") + except ImportError: + # No urls defined + urlpatterns = None + if urlpatterns: + plugin_patterns.append( + path(f"{url_slug}/", include((urlpatterns, app.label))) + ) + + # Check if the plugin specifies any API URLs + try: + urlpatterns = import_string(f"{plugin}.api.urls.urlpatterns") + app_name = import_string(f"{plugin}.api.urls.app_name") + except ImportError: + # No urls defined + urlpatterns = None + if urlpatterns: + plugin_api_patterns.append( + path(f"{url_slug}/", include((urlpatterns, app_name))) + ) + +# Plugin list admin view +admin_plugin_patterns = [ + path('', views.installed_plugins_admin_view, name='plugins_list') +] + +# Plugin list API view +plugin_api_patterns += [ + path('', views.PluginsAPIRootView.as_view(), name='api-root'), + path('installed-plugins/', views.InstalledPluginsAPIView.as_view(), name='plugins-list') +] diff --git a/netbox/extras/plugins/views.py b/netbox/extras/plugins/views.py new file mode 100644 index 000000000..690a708b6 --- /dev/null +++ b/netbox/extras/plugins/views.py @@ -0,0 +1,95 @@ +from collections import OrderedDict + +from django.apps import apps +from django.conf import settings +from django.contrib import admin +from django.contrib.admin.views.decorators import staff_member_required +from django.urls.exceptions import NoReverseMatch +from django.utils.module_loading import import_string +from django.shortcuts import render +from django.views.generic import View +from rest_framework import authentication, permissions, routers +from rest_framework.response import Response +from rest_framework.reverse import reverse +from rest_framework.views import APIView + + +@staff_member_required +def installed_plugins_admin_view(request): + """ + Admin view for listing all installed plugins + """ + context_data = { + 'plugins': [apps.get_app_config(plugin) for plugin in settings.PLUGINS] + } + return render(request, 'extras/admin/plugins_list.html', context_data) + + +class InstalledPluginsAPIView(APIView): + """ + API view for listing all installed plugins + """ + permission_classes = [permissions.IsAdminUser] + _ignore_model_permissions = True + exclude_from_schema = True + swagger_schema = None + + def get_view_name(self): + return "Installed Plugins" + + @staticmethod + def _get_plugin_data(plugin_app_config): + return { + 'name': plugin_app_config.verbose_name, + 'package': plugin_app_config.name, + 'author': plugin_app_config.author, + 'author_email': plugin_app_config.author_email, + 'description': plugin_app_config.description, + 'verison': plugin_app_config.version + } + + def get(self, request, format=None): + return Response([self._get_plugin_data(apps.get_app_config(plugin)) for plugin in settings.PLUGINS]) + + +class PluginsAPIRootView(APIView): + _ignore_model_permissions = True + exclude_from_schema = True + swagger_schema = None + + def get_view_name(self): + return "Plugins" + + @staticmethod + def _get_plugin_entry(plugin, app_config, request, format): + try: + api_app_name = import_string(f"{plugin}.api.urls.app_name") + except (ImportError, ModuleNotFoundError): + # Plugin does not expose an API + return None + + try: + entry = (getattr(app_config, 'url_slug', app_config.label), reverse( + f"plugins-api:{api_app_name}:api-root", + request=request, + format=format + )) + except NoReverseMatch: + # The plugin does not include an api-root + entry = None + + return entry + + def get(self, request, format=None): + + entries = [] + for plugin in settings.PLUGINS: + app_config = apps.get_app_config(plugin) + entry = self._get_plugin_entry(plugin, app_config, request, format) + if entry is not None: + entries.append(entry) + + return Response(OrderedDict(( + ('installed-plugins', reverse('plugins-api:plugins-list', request=request, format=format)), + *entries + ))) diff --git a/netbox/netbox/admin.py b/netbox/netbox/admin.py index 222c6ffc5..63fcac550 100644 --- a/netbox/netbox/admin.py +++ b/netbox/netbox/admin.py @@ -11,7 +11,7 @@ class NetBoxAdminSite(AdminSite): site_header = 'NetBox Administration' site_title = 'NetBox' site_url = '/{}'.format(settings.BASE_PATH) - index_template = 'django_rq/index.html' + index_template = 'admin/index.html' admin_site = NetBoxAdminSite(name='admin') diff --git a/netbox/netbox/settings.py b/netbox/netbox/settings.py index 6fed9dafe..c86a088cc 100644 --- a/netbox/netbox/settings.py +++ b/netbox/netbox/settings.py @@ -638,13 +638,13 @@ if PAGINATE_COUNT not in PER_PAGE_DEFAULTS: # Plugins # -PLUGINS = [] +PLUGINS = set() if PLUGINS_ENABLED: for entry_point in iter_entry_points(group='netbox_plugins', name=None): plugin = entry_point.module_name app_config = entry_point.load() - PLUGINS.append(plugin) + PLUGINS.add(plugin) INSTALLED_APPS.append(plugin) # Check version constraints @@ -688,4 +688,7 @@ if PLUGINS_ENABLED: raise ImproperlyConfigured(f"Plugin {plugin} caching_config is invalid!") if app != plugin: raise ImproperlyConfigured(f"Plugin {plugin} may not modify caching config for another app!") + else: + # Apply the default config like all other core apps + plugin_cacheops = {f"{plugin}.*": {'ops': 'all'}} CACHEOPS.update(plugin_cacheops) diff --git a/netbox/netbox/urls.py b/netbox/netbox/urls.py index 657e3d6b4..4a535ad31 100644 --- a/netbox/netbox/urls.py +++ b/netbox/netbox/urls.py @@ -8,7 +8,7 @@ from django.views.static import serve from drf_yasg import openapi from drf_yasg.views import get_schema_view -from extras.plugins import PluginConfig +from extras.plugins.urls import admin_plugin_patterns, plugin_patterns, plugin_api_patterns from netbox.views import APIRootView, HomeView, StaticMediaFailureView, SearchView from users.views import LoginView, LogoutView from .admin import admin_site @@ -70,42 +70,12 @@ _patterns = [ # Errors path('media-failure/', StaticMediaFailureView.as_view(), name='media_failure'), + # Plugins + path('plugins/', include((plugin_patterns, 'plugins'))), + path('api/plugins/', include((plugin_api_patterns, 'plugins-api'))), + path('admin/plugins/installed-plugins/', include(admin_plugin_patterns)) ] -# Plugins -plugin_patterns = [] -plugin_api_patterns = [] -for app in apps.get_app_configs(): - # Loop over all apps look for installed plugins - if isinstance(app, PluginConfig): - # Check if the plugin specifies any URLs - if importlib.util.find_spec('{}.urls'.format(app.name)): - urls = importlib.import_module('{}.urls'.format(app.name)) - url_slug = getattr(app, 'url_slug') or app.label - if hasattr(urls, 'urlpatterns'): - # Mount URLs at `/` - plugin_patterns.append( - path('{}/'.format(url_slug), include((urls.urlpatterns, app.label))) - ) - # Check if the plugin specifies any API URLs - if importlib.util.find_spec('{}.api'.format(app.name)): - if importlib.util.find_spec('{}.api.urls'.format(app.name)): - urls = importlib.import_module('{}.api.urls'.format(app.name)) - if hasattr(urls, 'urlpatterns'): - url_slug = getattr(app, 'url_slug') or app.label - # Mount URLs at `/` - plugin_api_patterns.append( - path('{}/'.format(url_slug), include((urls.urlpatterns, app.label))) - ) - -# Mount all plugin URLs within the `plugins` namespace -_patterns.append( - path('plugins/', include((plugin_patterns, 'plugins'))) -) -# Mount all plugin API URLs within the `plugins-api` namespace -_patterns.append( - path('api/plugins/', include((plugin_api_patterns, 'plugins-api'))) -) if settings.DEBUG: import debug_toolbar diff --git a/netbox/netbox/views.py b/netbox/netbox/views.py index bc87a825b..25c32338b 100644 --- a/netbox/netbox/views.py +++ b/netbox/netbox/views.py @@ -341,6 +341,7 @@ class APIRootView(APIView): ('dcim', reverse('dcim-api:api-root', request=request, format=format)), ('extras', reverse('extras-api:api-root', request=request, format=format)), ('ipam', reverse('ipam-api:api-root', request=request, format=format)), + ('plugins', reverse('plugins-api:api-root', request=request, format=format)), ('secrets', reverse('secrets-api:api-root', request=request, format=format)), ('tenancy', reverse('tenancy-api:api-root', request=request, format=format)), ('virtualization', reverse('virtualization-api:api-root', request=request, format=format)), diff --git a/netbox/templates/admin/index.html b/netbox/templates/admin/index.html new file mode 100644 index 000000000..00f720738 --- /dev/null +++ b/netbox/templates/admin/index.html @@ -0,0 +1,6 @@ +{% extends "django_rq/index.html" %} + +{% block sidebar %} + {{ block.super }} + {% include 'extras/admin/plugins_index.html' %} +{% endblock %} diff --git a/netbox/templates/extras/admin/plugins_index.html b/netbox/templates/extras/admin/plugins_index.html new file mode 100644 index 000000000..d34d55c23 --- /dev/null +++ b/netbox/templates/extras/admin/plugins_index.html @@ -0,0 +1,14 @@ +
    +
    + + + + + + + +
    Plugins
    + Installed plugins +
    +
    +
    diff --git a/netbox/templates/extras/admin/plugins_list.html b/netbox/templates/extras/admin/plugins_list.html new file mode 100644 index 000000000..ecc003ccc --- /dev/null +++ b/netbox/templates/extras/admin/plugins_list.html @@ -0,0 +1,60 @@ +{% extends "admin/base_site.html" %} + +{% block title %}Installed Plugins {{ block.super }}{% endblock %} + + +{% block breadcrumbs %} +
    + Home › + Installed Plugins +
    +{% endblock %} + +{% block content_title %}

    Installed Plugins{{ queue.name }}

    {% endblock %} + +{% block content %} + +
    +
    +
    + + + + + + + + + + + + + {% for plugin in plugins %} + + + + + + + + + {% endfor %} + +
    Name
    Package Name
    Author
    Author Email
    Description
    Version
    + {{ plugin.verbose_name }} + + {{ plugin.name }} + + {{ plugin.author }} + + {{ plugin.author_email }} + + {{ plugin.description }} + + {{ plugin.version }} +
    +
    +
    +
    + +{% endblock %} \ No newline at end of file From 60b6c487757963514eafb0c8f155f6c9957e4edc Mon Sep 17 00:00:00 2001 From: John Anderson Date: Fri, 20 Mar 2020 22:21:00 -0400 Subject: [PATCH 063/124] remove duplicate import --- netbox/templates/dcim/site.html | 1 - 1 file changed, 1 deletion(-) diff --git a/netbox/templates/dcim/site.html b/netbox/templates/dcim/site.html index 16cee782c..915588e4d 100644 --- a/netbox/templates/dcim/site.html +++ b/netbox/templates/dcim/site.html @@ -5,7 +5,6 @@ {% load plugins %} {% load static %} {% load tz %} -{% load plugins %} {% block header %}
    From 2188b0982c5a92f74d0a5bae3e378c2456124640 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Mon, 23 Mar 2020 12:00:10 -0400 Subject: [PATCH 064/124] More work on plugins development docs --- docs/plugins/development.md | 60 +++++++++++++++++++++++++++++-------- 1 file changed, 48 insertions(+), 12 deletions(-) diff --git a/docs/plugins/development.md b/docs/plugins/development.md index babaf0711..300522d67 100644 --- a/docs/plugins/development.md +++ b/docs/plugins/development.md @@ -4,9 +4,9 @@ This documentation covers the development of custom plugins for NetBox. Plugins ## Initial Setup -### Plugin Structure +## Plugin Structure -Although the specific structure of a plugin is largely left to the discretion of its authors, a typical NetBox plugin might look like this: +Although the specific structure of a plugin is largely left to the discretion of its authors, a typical NetBox plugin looks something like this: ```no-highlight plugin_name/ @@ -20,39 +20,75 @@ plugin_name/ - template_content.py - urls.py - views.py + - README - setup.py ``` -The top level is the project root, which is typically synonymous with the git repository. A file named `setup.py` must exist at the top level to register the plugin within NetBox and to define meta data. You might also find miscellaneous other files within the project root, such as `.gitignore`. +The top level is the project root, which is typically synonymous with the git repository. Within the root should exist several files: -The second level directory houses the actual plugin code, arranged in a set of Python files. These are arbitrary, however the plugin _must_ include a `__init__.py` file which provides an AppConfig subclass. +* `setup.py` - This is a standard Python installation script used to install the plugin package within the Python environment. +* `README` - A brief introduction to your plugin, how to install and configure it, where to find help, and any other pertinent information. It is recommended to write README files using a markup language such as Markdown. +* The plugin source directory, with the same name as your plugin. + +The plugin source directory contains all of the actual Python code and other resources used by your plugin. Its structure is left to the author's discretion, however it is recommended to follow best practices as outlined in the [Django documentation](https://docs.djangoproject.com/en/stable/intro/reusable-apps/). At a minimum, this directory **must** contain an `__init__.py` file containing an instance of NetBox's `PluginConfig` class. ### Create setup.py -The first step is to write our Python [setup script](https://docs.python.org/3.6/distutils/setupscript.html), which facilitates the installation of the plugin. This is standard practice for Python applications, with the only really noteworthy bit being the declared `entry_points`: The plugin must define an entry point for `netbox.plugin` pointing to the NetBoxPluginMeta class. +`setup.py` is the [setup script](https://docs.python.org/3.6/distutils/setupscript.html) we'll use to install our plugin once it's finished. This script essentially just calls the setuptools library's `setup()` function to create a Python distribution package. We can pass a number of keyword arguments to information the package creation as well as to provide metadata about the plugin. An example `setup.py` is below: ```python -from setuptools import setup, find_packages +from setuptools import find_packages, setup setup( name='netbox-animal-sounds', version='0.1', description='Show animals and the sounds they make', - url='https://github.com/organization/animal-sounds', + url='https://github.com/example-org/animal-sounds', author='Author Name', author_email='author@example.com', license='Apache 2.0', - install_requires=[], - packages=find_packages(exclude=['tests', 'tests.*']), + packages=find_packages(), include_package_data=True, entry_points={ - 'netbox.plugin': 'netbox_animal_sounds=netbox_animal_sounds:NetBoxPluginMeta' + 'netbox_plugins': 'netbox_animal_sounds=netbox_animal_sounds:AnimalSoundsConfig' } ) - ``` -### Define an AppConfig +Many of these are self-explanatory, but for more information, see the [setuptools documentation](https://setuptools.readthedocs.io/en/latest/setuptools.html). +The key requirement for a NetBox plugin is the presence of an entry point for `netbox_plugins` pointing to the `PluginConfig` subclass, which we'll define next. +### Define a PluginConfig + +The `PluginConfig` class is a NetBox-specific wrapper around Django's built-in [`AppConfig`](https://docs.djangoproject.com/en/stable/ref/applications/). It is used to declare NetBox plugin functionality within a Python package. Each plugin should provide its own subclass, defining its name, metadata, and default and required configuration parameters. An example is below: + +```python +from extras.plugins import PluginConfig + +class AnimalSoundsConfig(PluginConfig): + name = 'netbox_animal_sounds' + verbose_name = 'Animal Sounds Plugin' + version = '0.1' + author = 'Author Name' + description = 'Show animals and the sounds they make' + url_slug = 'animal-sounds' + required_settings = [] + default_settings = { + 'loud': False + } +``` + +#### PluginConfig Attributes + +* `name` - Raw plugin name; same as the plugin's source directory +* `author_name` - Name of plugin's author +* `verbose_name` - Human-friendly name +* `version` - Plugin version +* `description` - Brief description of the plugin's purpose +* `url_slug` - Base path to use for plugin URLs (optional). If not specified, the project's `name` will be used. +* `required_settings`: A list of configuration parameters that **must** be defined by the user +* `default_settings`: A dictionary of configuration parameter names and their default values +* `middleware`: A list of middleware classes to append after NetBox's build-in middleware. +* `caching_config`: Plugin-specific cache configuration From 2732e7c3d9c48be3ae6035b985e268a03f5c8b85 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Mon, 23 Mar 2020 12:01:24 -0400 Subject: [PATCH 065/124] Specify path to PluginConfig in INSTALLED_APPS --- netbox/netbox/settings.py | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/netbox/netbox/settings.py b/netbox/netbox/settings.py index c86a088cc..fb8d760fc 100644 --- a/netbox/netbox/settings.py +++ b/netbox/netbox/settings.py @@ -641,11 +641,14 @@ if PAGINATE_COUNT not in PER_PAGE_DEFAULTS: PLUGINS = set() if PLUGINS_ENABLED: for entry_point in iter_entry_points(group='netbox_plugins', name=None): + # Append plugin name to PLUGINS plugin = entry_point.module_name - app_config = entry_point.load() - PLUGINS.add(plugin) - INSTALLED_APPS.append(plugin) + + # Append plugin to INSTALLED_APPS. Specify the path to the PluginConfig so that we don't + # have to define default_app_config. + app_config = entry_point.load() + INSTALLED_APPS.append('{}.{}'.format(app_config.__module__, app_config.__name__)) # Check version constraints parsed_min_version = parse_version(app_config.min_version or VERSION) From 0b77702626f6f4fc65da67a15d0bf3e0229d871d Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Mon, 23 Mar 2020 13:28:56 -0400 Subject: [PATCH 066/124] Add docs for plugin models, views --- docs/media/plugins/plugin_admin_ui.png | Bin 0 -> 23831 bytes docs/plugins/development.md | 102 +++++++++++++++++++++++++ 2 files changed, 102 insertions(+) create mode 100644 docs/media/plugins/plugin_admin_ui.png diff --git a/docs/media/plugins/plugin_admin_ui.png b/docs/media/plugins/plugin_admin_ui.png new file mode 100644 index 0000000000000000000000000000000000000000..44802c5fca3eb41f7f84cfe50f25de6ca0cf55e6 GIT binary patch literal 23831 zcmeFZcT`hf*De}BKm|lmssa&3q)Q1%M^TD2>AgrV0#YKqiGoTCB_JK?B!NhmE+Q@T z5<&;*5Q@~$IU9fP_nr5ianC>Ze&?Jq?znp}Mpky#US-a?p83qR=H}B&H3h1xOjki5 z5S5bRGffbP1PlTZHC-kH?!*wLZ9pI}Na@)VZLid|v~?{lLe?gs_SAMl=6Az#%6iJ2 zN2_?5x`ex0?^?Cgae7R45l34d^Puzh$wgheCi2g!8f%%fWw-f0TRgXarBx7_qWC2E z-Ahe@cCB16(R*3p_PCvT{#aR-yO~Nu0n$Plh4&2{Plqw@&KmH9-P%N%#}A%eT)(sr zYCY&dH!iL~2^!h!7X<<9|GkBPxdvxnqlT$^j2{{1-ACZ!Z&0EHhv|$p$Tbub;;REs zdp8SxlpFSW>JNXloof3!9ed0#=L<|v83Q#vw(!R?aPk_cME- z>o7F8mT&qSvqB1>EkFN!`8%wuksK2^M~;1mZ?;u@EWCcDg6lE`AxmADE@dpCvb8>` z$}F-c%`IIbHT3w(g(#p8WP&Ky`ev%CeVo#IW$Hn*=+s&+OTGF1;k8(_Bl;SPRA&8M zoAeQMw$3I7TPv5oPq=wib;a$tp8yg3Cf5*bqHcUe-2`;_OyN%L!V#YW8qlz*L^`J} zjsL-++5Z>VB|&5Ohgq&doaQq68NL zrx1S*MHKr8FQ;b6XKM5YcMNE|HA!lFuK}6LVEM$9yIo_&(^q)83+7^8!LwNRaYOc) zdf5VZEmC5?jb#T$_-g3m*s=>ME&(G&G3k_tKAsMLj%vB2G`?vr;-Uiz z!movp`3lbCyZaQ6C2H&>?#%g~X)6Sb-0k&b4Xe|ASSBUM;u}>N__BaGzf{}vlsA&F z0n7JHG>#%bzk%gDM*)q}Y}FrC*hTO8Ln@C5zxjJvusVx&VPYpI7Lg=ZZ)>?fRxS>% z@+i)HiDsRwGUQX}S*`Z>cu9_&0_3FTP4*ULoZ&wFaYuc5>O_BkirKZH6Bx2Z#<}mu z$7oT@553I>ZhITL_DuryC;ddsh29E$OTc4-!c!Fr&?UDFuRGTOh0NNhDuKKYLo9tx zf7LQEj^x(dEUC3b9F$I`3eayx9=vlxV=ou z?>bsM;sYd#pWXU{nR8T_#?AatgUIV}QFzRUrEOQ(I`oE;)zL36??u2iUVXrvyiJtE zbvtT5q=>hiW;fe3azKso@AQX^x$jys7y9Y(EwPxK3||)tI;fc%jB)oB9ylw0;lxVb z+TmB=F0&TvVxG9Fc5As?$i?wjwZe32r^aGG$(XOCfP)rg!fH1Rx%gw%Ke4Z#kw3@}(Um;8O}VD25NRN$KT=nQH5t9Gn^^;FOI3Ya70Ch)%z_kl0Tpw8z0;EqhXt-} z#yOfN@`dVvZ&HG998WZyYt?(7$oUV}2%Xp;lDF+{lhY-wq#-X=`c_Hnb{KM_H=plhIZKwf6e>O@tpK}K$(MQDrj4GB51c}-RY1_aL9|R z=NEDCqc_Fi-MtE8MK4(jf0>(Sp|M_(p{1-%nJv|;RdVP7iUgT%Qt8?RtNHAzt zlHO4lL2NzNC8$6eH{*F$vg+dr0GqeJ2!m`Fxkvv>WBzQV?uAE?4PE;>{XBCmWNV{D zvP_)pEn?%KbwlRDW#_+gAZaH*gWQoPd)pDfb<*+L15~n{c~9=%jqxyF+3CkZL$A0m zd-Dc^Xv$;)%%x!a1gogE0gE$zsMHo$HnPE>T4Hf#Z#_Y!+Q$>o?;{IfAg8)7D&Yf^ zQd`~<{%Ya72Jhu#EQ66T|yni3hFtewF~{LT74;N7{(UZT{2QNXjkp3GA>3qE|9)R@1Tx#4)pe=;)*29 z`xW`K2CCnycjY>5`nwGTrlAeT7a!PJD&tZ+mTnwv+dm z4}GQ$JQK>KAhq+3lljb764O8zOlC!hifI0e=~M>NB~?P$*~}!KPdw;OpJ)%W8+JaF z{KG?;{@bh{bn7xan5LetKQ2>9@52N&N^Gf zw!xYz?Hv8Zn#V@3;Eh=-Xx7u$v^Yw8Lq{3U2RNAaIb+Alf^Kpcj_3F!q|fN|m90w? z$5@PBrs($7-PYfyr7|DrU^pjVnq)Sykr%r*@2ok3z<`q%S5*fc&U`VII7<%GOi=(!raG~D}zvFroZ-YZnoMJ9cq&^ODwF66*WzzX-xJG z@7)X3LqLr}*xEEN8OaV`R^vAWT{&l=C|??q9vv5&cW=lJ(I|WFBp7t5?Rdm}_R`P% zK~l$DQmeELA76W-CxCS?wU?8^5@o(U+!>#t)c7Dk{IT)pYVFypp`g7A|EomvA?n1| zy?f_(?vT*ve5DkfVt|RFHtp(gnFGY(Qz+r~!5y`T(d^mdP^W0g`pxA6>&OIfxItw7 zjk#C*O9dsOmffEhDVSy7kr6i^0DeE3dh|6&?5IJWj2Qp=m*nCg6UlZ%BdKGW09auz zg6QsrY-Y>sm`K_M0`*YE%uJqs1*yr)2H&Q>t;g7!6Uf?BBqQmr2hQkEhCLVC*Vj4= zb-tNO%5Cwg=>h~hU}f9i&Y?R`;FY$hp3fD<83o@V@(W^^r%8?DjA!>H`yic`y$0Fu zSZ$eMOI$&IT<+cD4uuho1#?p__t4!XvQ^(zFTnt`^sG3Z`4Wg(%zs2?1*Jnl=#Y|Y zE@|QEq~U)Jtv7Fl3e0+m9^cvbQRrT)IQZ;EeZG{Cg`sidI7OF39m}C<=1-RVfyw|- ziJdz9?sdPXre+4@^X3tlQuZEkFsXoTyZAOpQIxK%{sjr`oUcQQbw2e9A+tsA z?W62i7gjB51F!pdgpV2$7RT^Gem5&Q{i0Vh?Z|>GfiF>XF?E`FERE{f`yUg6+nuGcm@_26yDqNBQ+=p9O-*ybv8cnBu)bL)5te7!3*F~kb|Dah!jYx$fmnf8~7)7T!m#y8$1pHiAyqU*-h^uHuYD9G84IW5)@IE3)eontjS< zG6mJwwM_78hdxuEOf{sgUzS|oTxs6|sLAf1)h|&H?yV1FMzp2khg&2V$(U>)CTPc& zY4srd5%_I%^Nk9V319ajcpudTM^KJ5Sj;Bh%UcK%EHZFd!@znEi?7M2(-U0+Xn)45 zj9`%4>)hOX&Yi!`nlXhF$f$i2rp?K_W}AG~0VBxSo1`VRd22G67Hu2w-cYrS+kwn5 z%18-MiA%@cAb9S-@F7n^U~y|*b>vAglHamM^lq2EMO zQPd%MvxKFN)m&}=N26EZO5d_mqKs-Qo*ja+DsLdTc#u`seHFJ0Y9Bx?1st^%}TW`2NV0p7L=q+;P>T z4xQabQGQAi-l(kK-PXTEOPGqFmp#F)MBY5!?WV4U48+}djFu|ZTaOm1{g(_(;u!vk zNN+T=Uo1obrZD&aj}}hS4&B242FW+H?*3I25TQNzUskY*C04AuGu6g)x?(fr+vdAe zzFdv$O%IM!ACeQbt@tj946nF7u@9_I>0})pe?bgXd7UB}ikDv_l%Xdy;(XPntnFRB zpJZoeb0J++2O%d0s?@B=s?#>r35BbcuCGiz0~v?5l7AI9%cJc(n@J}fChf#T&2{pR`6BlCe6tTD%M!FiEGK)2l0UQ32-u!uo5|65hxmu>8~Y zJ#D{I5Dkdr(W66*mR)WSDSrr5^=Qmwb8f#XR7n$n(jVEAYkZI z#)ji=za=jpzn#Ty@r(4CLf0mBQ(iSH#0m<;r6tvg5&om=2;a4$%B5;sw*2YIEwZ3JCj?G-m2Pws=V>Zixe zIs78fQJSj~AcW-x2WPeAjeCKk@`2Si?PC70;t#rKJRhNJLkJ#t4LeYEVX1WV13DJv zPUYk`(Z!}^&o;8ro6E!7v12K0Xt~5y$!I9SrhVx)$Gl0proo@3BU6ZKm!s=p$zq)r z0-rW8aj#14naN-ZVoP#(aw-8_^2u`SV%|pK+Nvt8@w!gx>eeObk#6yCYRw7ibp;+{Mj5WB5A%J*FiSsg~u!H(p<hq z`lfs5vbJ4d4dd44jPwzJMf&E_WhL!~>d( z`WM)tlYhce*7B}+CoVzpi@eN@+hsijZwN=xCD^-^GDAP%TtsLJ*LOFgs86|%iJiSd-sbX-i>Olj!$%SpfI~xOAtxup*@wY^S6b=6%a`$Zg-!3FLOi*Zc4cF@W z`}oV|P8XRdo&UiEF*y^E-w@AP$MnwE0~<~9Q=K7uQ#yxOHD=WMKw*ytM9hVJqkkDR zFeHV>kNjH zC!?Da*g~ej!)D_4s(M7@4zkCrzOXJiMSNHs>Lmy1DL`)c73G=LcTzam>-(R3P1nscQ`tYME-L=ew(8&z(}?Vib)GyBun1&H zi$=V!D*U#thdp^CG|%brK3F%}{QF_o;mh!JGu@0`atv4&m&Nl|bz1y(2_5lIEQG zD2_Jb^_tV3FeA4!jI=2falJ=g3sbJE+i3ziV|tq{b*-;VD9FB`$KhtjmhJT{6K2RP z;&wO@WcONe)fK#%9hS|4vK<~U>2sj(K4nlrxQ1ABsB`5k30X@eG$4vA zTff`jFTrjTD!xCup}9e4T~*91`?DvziFdP9VQEhL*G?cqLVa^J(^a;O3e1%6kpugi z0}>@UUoh+vv7(dZ@v6w4f9W*iz?K(L&dw67IBXJ8CxqCUE@Bbtb@hY<89VEw*XzN1 zZa{XUR>slNt@@!S8Or!*QFM!iEJI|9+@u|r-5lwsQp50pk z6KjuYTSH_fu<-qj5p@*F!W-exs+ss*sUeGRJEU#d5yN4+O$$4wp~mWol+tq!V=gIhfUkn(d>NCh)8 z;JA#-ce8L{D$j}>79vB5A5)jYPy{rra`@BcQ|L~?S>Ph?JycO=2GbLaI^Hz-9P&Wa zF&$;k`aYn4oz>3dZHo*;jlF}C`^Fje$@1;BN{pK54a#O`^Zg#E;ATkG zZe*GI2iKpU0#lzV5|EjC8xF!F;;<34eli1+*S2Cls)Rtzt_%^_TW@=`UD8FO}| zz}zUtzKH?v>cS~|9Q%FE=x;kCG8>GR0+T4N=zf}1Sp0%R>9B`T81B}PgmfKaXT5of zD4!D0D}ths8o|q_!^t6iH>toyN99ocY2ntD7yEm?HGWH`?OxH?^{9$zEx9nQQKf6( z(fucoi9?+w^jprx2BUm&d5@y$qE5Z>Ta2=$>m&}}g-~wCstee1tViET6%I{3-Y#!OVjx;>9;Mo>26y9h$fo(@lSWK`{j=7tkBLeSaW^<(G<1Uc`-5Zv#E)u-I;jwXaoUX0UsZ)J(PU!5As>IrrcnvOH>*Q*4pZ6pT;b%yVVd+}!6?(H^sta8P->v9FP;7KLHF zFyW0ZufNvs!9T-O`|8cyz-Xh)>eP!UbR}h+83rn*`WVr=rx#9cgL35n*TF)voqg5i zB#YZ~!eRAPClNiZX}^T7SzCVTL5~uleN3jC_uJ{9Xhh zw(aM#xz2!(zKCZmO8+;6Gbd@li6d}nULv~mPl4?J69xHLlJ*GWs4^~$P^Xn}ySZ>j zs$Ndn+x!RgqP5ClJo4dpgw!iCds&*H7@>ugfj3N@f9j0!!B>;YUc2Si-nkIPH@*%E zaJXfuk&58L==_^&jsr_^y`tFydSyL}DOMQt;18Rpil4b!ipvZz;wi0MMZN64A58en zjy}WwRBZ4h2pq=_B)~6&FWTy*QlbFIT?>yGr7e+bo&C1D9f6tZnme6-0rI8;2VGS8 zq4hwC$VwxPT|SAMY&PI0PWOIxwZ$AQ{-gWWXuaf}mthbU^X>^Y`K5M%xbW7VUll;)m$r#Z3I z`VqrV;l*)C^>7ED8pc2`>tv0Gk&28_)d0hdcsZ{BtDl_9N+bjOV>ZGV%8n6Du@Yvm z##Ao99`{)iKE zOtk)_CF~%-n>1dGZbJWZqb_?%Z7XjS z1dn1r5G&hOUY$?9vlHl&7Q=eYk9_e5^wW20B0##P+Oc%9bmUy|PQu6>F?rHQba75x zA}Kn?OG6`FS#BuNtU>pHrhD_o)*}T=LeTuvlMSnYVn>=XHn51y1y@ySNb*^SVfr z7Mtwt)lgAAokpoL(7$p4rZ}94l3we&CMbD}gc--3;iVSc+7oOwbv1Ts?pnEy6#Ho< zd|nm5*Ps{269p@}&>w9_LLbyg%T-r*#$B41j}Id%mT6;@Ub>Bc+S9};yX|Ca-N79* zDTZRqP#3aHtFaR3&>p(OLid2V^ot6HdJQKkR2W=&)nI!Eo z+PROnoZ42mtuR%NJli1+YP7aVv}2Y$zd?eFFH06;jWzNs3wmhcwpX7KfZ z+;0S1XK(tqIoL08S`-hzJ?NHBYmEv`$% z)`R;?Z*G}Q9FOCMmnNX6Q4Ji|pZeq%LyUfwBsgeZ_k+$+eO`AG#3Nh#y=-X+J)>1S zm#&eO00%yv{;i4MD$iEfNc$<@HK3=vl0hnCJJwNKCLOrK*pJ88ff>&{zjufaI%plT zmqBLL0SiYyX-C0K4|fma?=qWj$ov)-mwe_f^cpxv%3sk6S>m8pR`j zvKc9=?$}2VF%~@Pv~mw^0GAc&mwbL?-UqvZpLST9zX9cK@6N-ee)buvz=pd*vbY`h;UIX zs8hc#ODCcH)5w&K5tyDGxBL+2sFh$wWTXGX+ttOf^S8Ceb7>5=yD)-DR)S=`(*;@Z zTQ`^A(Pmq#x~;s{RdnpgG4a;GJyv`M+JbaiJZfjy41h4j(@Jyz^8wXe&#`6qm=0Rq z)~iJwjD5E1Duy}Q$P2mdwyeB^|EUz}F8$@7#iBY(WTolUVq?9Kp;PAgx+3-SAaU$I zs5E$6S_x#&9V>w5tEn|=zc`mzmR6?8FmSww!!E`1j_0h=)TUYr-8HFv#|uum3~o-0 zcjAeEGuBXE6VkEIDZp7`gUs9clA$k&K9;5NJUc?O}20WI-qrdVr zB3~0Jd5pJ+&~khwwd%LmN*H}$8}VYUj6qgJdx~S_-2zVxr*EWvLfbH+T-j|j9{!#V z7JRi#rKHtNQVDd$c~DZV;hmEUQ=)5BWQ+?P%36<=igy zz2u*mNMe^Og9X5@4s~&AwPT@rj<8Q;u#y@{#_(~Ap4|oUl)Wxe7!{nr8A0^PATUvQ z@U>Frhx=0{w)1YnofXMkGA9^?>Mp0Qj*_Cfgl4wlSl2u)A)4 za&NG%aT;XV8U~|uqia2oHu4XpkB9S=TfEPX+w5Y+0wdvlmakc*D2B5hNN{V%uV>JW zeSzm^m0hDcpo6^WU{f~vlQLxvx)Q&KVwZShQWmf0r<7(%QWMWC7(R{(<5)nIeLxwq zIzrw8QwySx-tBrv`p4*1f1}N1A^gR35AFtmB&lpdA=k4F+Lp>Wxi_9BU6@Iu6u|1# zi82Nsxa&4>jgg&9cGCTK0wFX<3)GPX@}que{S=+)8_j}kae24Y42dziV=RH6f~L7H zU3d`?NRjdXFZ|yN0d~LS+qcZKvjC{4C$hetc`K=`w$|wM^wdya-z#t9_a256kYBIp zCD{FMK*gROwaDmbtxxaDXWmA$FH1q+zLlTMZ}J^kf7`jVWAEy!5gs0HXlOVvFc6!N zn5gG>a~7Hg zU|?Xp{QUW~41aDv=m%+PYGw)9_7v3CO1wS>emeA%mh#!P>%LCI{qerV@_xzBwrqvy z-I=D40yh9kf9y~b-M>;^Rh3_R`Oj_Jdqg=oIrmr7om^aS6BDT{Qay$o>#N1t}40Cxa&?BSEt}hqIxuJ}?b`#4jO_+P>50q0||@ZJRVe z`xKXf_Fvk+^Vkt4Zf_2wwhV<;yi?4QCyUnqJ@>mg%>LLUnRQ*;-?|#Z%>+pvxOeP< z#2{9U8sb?X@f`_Q4c6uCC8Pm=dmt%9^lQ+dP)npXG=XN?CSV}9r$LESG-(Z`ZQ!4= z7^nI3*WDo58gE0Q`@-*kQLr`o1!`}e9&?Xv4=9h7?&(;cU=g_O?){gBmagh zi=p#`0tg%$0743u?cmnWr>Ad(&by^G|K*n3SGqD%_V;qU2V@oTc0JwT}T@rrkj3r7;2<#r11cWMU-NEptU6D68mqF7{j7P=UT2#l(;po9<8=ua?N2l{N#_#0bocXI^`;%#_w(5<4nSL@Pkv* z5WU1sn+lAsX)c*wX2lO*WvmENElr#q*`2q&$iVziM=;AFy#-3X45@(adNd%57A`<$Lf9^OL%p7>)2&3`FM*8 zZ5$5F7c!J^Lly{#3MEO1tW4$h7D}nRm6NrVtqikJo{BH*fRt+D}cQFmR4^K+hx91`xJduc! zi9AGt#$iIvVTTcdmz&~*YM_P}tSq-znxKO~lp0%GFCa=iJDIZ!U)hgrxWrsJS+CJ? zG&&q#aK|E06UEY-vBI0Ww$MkCAIM=9(l|Y{JU8Er6Dnyrhk|c~!wb`V+b(m4$FA5h zZQVfSxE*D~?Q4Z4KVN`|KtVaNXP{a4!pba-?BJsYf^G#@@?@~6)GDeRAyQ8En|YWw z(P+m|BItWcr!|E=Rg9mTj*$*_-Nc^AV6w<4azO<0%SXHB$}n13XC-o)oI9iucROQk z`26zO$#K!q^7)zisq{;YlhgAqJ*R->-gCXMs84WauNl{V$;c^uf=LD)GSSwE)RpW4RqE&Q-ZM?L{|1Ad`1QbGj8g(xu}ZZ zElWHpOerxrr4}N&0{3)N4dK~arD{aK@&vh?9%;=GGB6}7Um+}lwu ziG?c^U`M|mPi5>d7c@+m{&<3Kk|~l_c6g+>PPt z%1A3#wGHIJun0s6N`=Zb@2dfK5GB^AxzvxmYTGrIqcBtB5#nQ&cW?`hmj%ceIVO_L(4Zm7Fq{r=OoqrOUi3dV}nvrgc{Q!GQY+ z0$ggxgKi+o;)T;Xur3^K|J=Q zXe0l)yO8q^I-Or%np`^YF>Ul-t{vIZzSXZQ{F4(E(%>T4w$wNGgo999Vj0{BQmYOL zPET{1s6UO7j%&6J>J>MR0gecgEmd*^8MuieB(vDShZ!%&989)3ACcvhj-JoI=|FxB z-G(PQ`4u}Da2wr1QM`{Pve(Eh((FE?T3~i~`Ju?L>YXK!5C=9Tz$VlmU7;enG|)ZB z@IK)D>=b^ThUwYU=JsEEaz{9sld{sDiN3yhlnqCi$6S}G({Xc(xX?T`XN7N-{rD7x zn_7><+ucyLhC}tErRY1!A1^aE&D@}5C2USl5Ao>x1F2E)wscZ%U}!bInme%xl6+Vf zbIOnTWtx=;we#=MKV07hqS<6@sm|61>f~>8>pqPNd~FmGDyh7E?(d*6SER)IJc7so z?_O+}g1H?Ec)vifxAiE70oD#kWIZ1}ocFo))j2fT6Pf#201N`bj0YHG6NF#$YZ+KZ zoawweP4Q=P-tWC{SphE`2vCmWzQ=uR#b1SSK;ruRc6s!tzS>}QM}Q@CQf3|*+WU@H zBFO6tDMh+(x;!W;HFfCpn4tGg(T?E?)qRp~-K6Ogz0*Nf(*fnck-R{EA+11n%HsF& zNilEJI!?^S_SFOXSkG26_7)Wq_XfSZW-fb0l)f~-}-F^+oAr&bu}9P+`Lp@%Z^92O|cIXZI$}V%v+9A za}G72!+Hf>4)6-p)4jB82#R)VkT7gFkz8+tpVg|l)w=H^J0XCRgLO`*X3WT53cmv6&etyPtb8{L`?h8k} zXJUFd%jgKuII?J3Ns&fnfNAox04!KG_X=P%m%)~nmTt9^z@Nse`+~67!+ocu(KjR) zM@AU_sSEzMx`d6%!I2St{p(k#?v*@M%97u>=W*U-IaTW!J5GY)`6K_QuA>w{-~#3Fzij{iBd3upsQ0kf1)mE*oRoB6#S5AxWNJmyMMT3~ZEF zm_wysh7nI}2vk&56qUb0S_1q(mz|v*`}IpyR9Cm&br`me zNxPlP$;kLkVhLC7!n% z;lY5dziDl*mU)n%TeJoux1^uSDQd*9uhUZlhgdgmh}w+(9f-)k=CgGuv`+L3zvqm} zxde-f6J(^sl)ts(`eUemD9uQzF#pBybmAqnn362}YD%7NRhnBtpE<1QoBD#(-Qzoj zgLgxokTnOGFc?aO-qnuNne6@19Rx_L7g@IIt`D`!P?8VP$UFVO<-%;>Jw56ABxA`2 zV@Fws6V4f}u7>-(aNc`4Q|9a+_zT?J;I`KlS-^(_hit)C<%!#_40-Ou3GaveDFqo+ zFkPp{Smt}2lD2-Ps=lD4w6xLq4oWc4H=NMr;LN8BS{eLsdS)gvcOz_~$w@BY3IV>4 zT653YcsWBaBpk#5EvQo}Dk=()IMOAi29!G+y3VPS*Ocj>fh#P;ex>-3B*@^VBPE<) z-9Ui>wkN%FjHe|Ua36m93o`6?j7g>Fg9I3?xL$ALye%$W*LqcvoP3A-n0Gy0^?dJ# z?N~Ya_2{-T&bZsMl!7dX!9L>%(12F4KUv&W85y?hEm%Xe7aOeFB_kp!cQrk2aAM-) zs$1k4j*Yl|NmVO3Ep6|Za^f-|xPue%@uTVp;5laJbH@#5v4(R~=6mj|l{UbUjB!zC z*W2Zs4zT5`xI7@kolGtd#jGVj(%!J0{v)7PC)plW@@Srj*Mf48MK&)#U(|Y=_@l;$ zh1@gPZ-!4-!BV-$R_)~o%U@rgTDJ4Qo=JRERjwTtk#x2zqg`Y?Ck;=am%jx2!>6zC zE|BNKj6~;NXCR`#SUqB>*z8j>d9!=zsVw;AT4QDdyf?Z45N*XXV#Q*eTm_Xg+=SyL zST(2ERVqQN1O&$@$nfN9L&D!dE{~l z$XoQAO4BrROnX5==(Kv&9`E}^>cWnel}HpTLPJ+Q+U>NRy$hqR%l^3n*h_U_pqthM z(V#B-p7obsIY(anrUsXlkil;67uLD(ttIxYKaB5>M^5<5FX&R+&mZ5@Aey&wJZkj2 z=t$s>Lrvy@Tic8FHxgH^g&ClwduI;xs2P&pK7bExLfg&z&M5qY{Yjs;ol&e(P=Vdc zRyn5|HP1icNIPH9^Qim)lA}91KB*?{f&`aXWu1+$fVCV>C+>%=xMQK7NMN^Ql9}G4 zoq@rFWtgK>>4SVTW(FOzN&TGqX=5Ld3Q!;NWck82F4d$+Cw7=?JFgHNoSZZ#myWF- zSs}`8)!hBDcSHI@LRv^H#oxu@tyua=72@t-GaNGj1J9jIrlJ75C#S5!pk^K*0a{&T z1^mhKm+$t}U}u69uo>g%H<6Y(=T_UMNh7;xbL??f^t!D4$=9DAr4XyW@8i={+=GaX zKIs^DEr+9t`^{g)BfDCzf>oNsfkCMca_;%DriS9cmNvy|!+R*n84pjrFqLNCXSq%G zUQ3I@5(7EFZiJN}lhvd3!MjK~f9|-I_kgXK_kDs;p*51KGw{TNe=LXrz)F?&*Gx-e zW@7c^kleTQn<(n(Nhvi{&pVyHdjZI^ttyV7YM;H&JsC2{+oH+X;o(@AsIxHsSLyv6tdHh&;CWhWYwN(jL*(CV%G!04t7ZK$Y7Ha6|&@b%uJgAGrNgz8D`4QFC0-xAPE@}i>!G=K=6#;jnZ4IR} z)TvpeRTMLN^MUai6q)6G%h_?L^)n5W)XYCxxy3>UJOC!`!Zjj!11s$xPLc*sU$UnH zKYyM;^&z_Nx~8_3w-0HO9kw`iaIA7R@hI^p8v4yuUn@3;9cprDc<%c1>x0cfiHqHP z*=+`$+*h@f@N9fQEQq-9{yNcoQwVvAAScm$`!qD?h@82o0nvCXpwLMyzXFf>PM1Cv zb1`7e)*PfsamSvF0w`D;IRBa5^AWYyByLZv_qp!ZJ)Z69uI6a;8@gw2dj9ZObKH$@ z<>dYS!=bken@7>jW~2F+ zc_%hUN#|^dj*;v1O3rEa`jKc^_xWgIr5(O8Nk{6|h=Ltx>n;8uqiVG`;jKnluoY|{ zBq$;A7ylE4hv)hNfetEfszpA(1S?E|9wnv@9$EgLhVG8D>KZEl%`<>$E{;Q&D~gVK z=hl-`6YGj!)Ytmgc2Su=Cx;dJ*dLo|uWUO61ZZOeM~jOV$-24k2X)nIJC79Ox~N`c z{=Q_cbrHf!rmH4R2!M%p8V33$b~N=tNqYXHiDL;naJA_jm$Mlg=D#T-nmvAH21Zq^ zn!fFha+NZUowa-0t#(A->n{nIr8+E`(_yb$B-eG>v-NuhQqGF`dqXVmDEmq^TdnF?%bBJOH9zP-8|{rtR^y5IaMd%tGtb(|GKYB=VjIXoN37g^6&5>C*bp%ts08${ zoZ=Gc1hfk*B7oyLoId>@f$nI0xJ$}RO~U?XpLJ2*NjwF6iPJv(7EsU3zjyyKtJ^WU4U!2bd4fN;Lc%6`p+ zDKF#x#nV50av*@wut0=ItSbV(X0a(hJzIA%EBN{wA<3ft@3?WH4G<{6=)as`|7U~$ zBhxPZ_U(c>{?{;VV9&kS(D`vL<{a&T}^-2cdGjQ{VetZdF* z3U-${xk_`^*rb+=ajXCm*)~5LYkYJ8{Ir3bTCE9_HGYBFCi(1xEpd(e!#-5AM7V2d|i z9TKEcU4GtY@6;)l?a7tA>#b9NhQIh)pUJ=R_y0a@F~ULbdcOi*zN}0rWxJ3JCV|_{ z2P|>UAd%&gsk^7yAb>L5=ZixxK!?-0=Y3~cnx_IlzqRFBGKa+Dy;Il^R|D}Ktkh|P z$2$H@rus|uqee&IrSeKztV7@yN4J_{P>3kquDe90ESf^%cRsP+nLlqA4Gwb zHMa!_gh|$h9DbhENIHLta5ia_D5H5sN2hBfTgi;jG*yk;{;XWVyX4|?-Wowim#4kg z0thW%dsACvrEGxW$g;=&RIhntY?G8kaf5W-WqJ4mg6mWnxZ6L*OAvZv2{`^)_Zfa` zjF)}5VANEf6k3lUfhqUJb06U$Xga!$LJNX!eZWle1}{%LzMRXl6Di(T0uBUuD;aqj zLFdx-rhIYnr>k`94SxKmOYiyX06_z$0SKDJ4@dEv%kv;bNJ$$1}%+@A>7D+Ko2%JRd zQKYWOaQOYc2$qs-8ad-cD2CVG2fTJ1I0ky*T}qW^O$}!u5%h9`1nr(!vX{R%_(OgA zeb^UZzQGR4>W)TgaK1jOi&Wy90`j10%TrG$@6F9^K0q3EC}PV{)4)BQ`lD6kSPgps zsCpk)_`V*i?7MafQ z^D{m3cg>3kK!VZ*`J`5k`w(89iN0Vx(|+H?&Gy=FnR|w^m%(4S zfWQLS77|&|aw1}M!UZlIwORVTgvyx>`Jp|p0t`T{aJz;T#Vkwrz~k<^jmWEU?+yv3#9f>f-Fi3(Xo;DW&G zt@ngv>FAdr(53kO+o8r%l-El|$I07&{;bRDFUacuU_yue`84NEAbHMKY-+ml5x?0> z+g3Ki7wd0sPvOWEUld}`mkn{M{$tCDJK>#2Yug_~v+#{)Bds8@n?q(P)f9Aq9v5Ej zQ?`F{=UaEbRoGslUi_oEyVhI^UxaIt3Z=A+-e;v)j(5zsX6DaEc6l_Zh~(F1W5K6S zVV~vc-}5R$$1Lq^AY^B<$jFXpBjugW7f$mS zz!w~O_l6Dr?*qUS++=_IxM4s?av`*jA9=!wF5WSJ_AKF_M%mapErR~;cf?o=$o{R; zUiwcv&#Vk6uU`ZWY^6N^^Ja8lL^RQDpZ-2Mg#eTMb$f4r{^jQ8jAX#^BnZ^`NcQ4G zKa}W#7W@#T1WpA(poCXJ7a!j!|2`9B{hAq!Hmx6MZ~sOd9KL;6SIc$XZn(W&s@`W0 z(<4U?RE3ckk+%bPChHE1RNSGsUV(0%yj+DUj8=@6w9rj<=xOqrhctUY$BYCJl)4Z6(Dwd3_5=l&w_S|jEcZ|*;-K~3TOb8 zMZ^V#016}!WYty-BrMGmLfBhH6a|q*3~MWfkRXIbmavK_D2tIz2&=LO!kz>HA@78l z`KIU1d^7L8d4J@)x%a#0RMkn7PPeKmCIaC3$C6I5##UD`=C%FZOY+FWmXSP3(pZX>?_MD+E2ccH)5^EIX_j z4+!MjQo59#tUj{mh=vXk={1%TSVkl;?)2}GxKPSWJ-4SqqYI+QE2zkQZDCR6HMk~7(-r5P+RhltAkRsmG?TT zOuvT`v%!9(comwp>A?MG`Z(01cS8;Zqx}ORy`g4NnZR#l<*w?dEL2~Xj7Xx-_NZ&( zaazaKF7mV-Vj}K9%k*=RNmxCMNv^eh(!m_zQ1D z$e0tV=7%#VvM85Ma9|TIOz;M#sf8}mjPC3*y^ zOb}4vzc(koFxHN=sD>LA7`zm0Sw`6nW24Mq>OG$et&2eb?aqHSlu4g6HIe#OmlWrAEHJ_n{9~+ur2CF zDK6@pKeeYl4$kukywcknaW-cMxOrxgnl@(?2;LCVFTzDhNJ~>oOI>nuuEfP{R_32O z-#Ekm>e$%$v!S#Sc*R5tfM08Ct9Z2N?r(L$A)a|E7%w9})Uyne3l%gPB6Z89woy|> z?tg=+KdOSULWdgvDIDjjLe!KW>=GoQA8PGRiJC!Ew&8wH$bXnN%B2#xT%4q|bjt!C zZk&xrt!>Kb87X$IuUF008*R%7sRtGV`~M2%H1D+h8P=Np>U^{pe_~sujtzGJ)f?Iv zf_~xIJx}DcUD;G{4K~uM=Rf_sd5p7HYnz&RKa8#rKpqqf4wul37Yz)Iq`+4*KTI!t z3Z8zDIS0As?X5{(HZYky$0asvqstQ!y_~7^q;>aqTYM8iQsnWh$#5luAA|GIEB9dD zCzaQ8&>KQWtaQlYFq8M+;3hY&=(*J8)+*O$phdZtd$#yyf??(EycTyh>eIW0PY%;J z-|~b@s;UwZBJ!%gMS5tY*h0$+BcrSAMwe#07WNWp=0+&~Y6XW$vG9-ZyOb?*PIvcE z<*wdXWsV5fb8KIVu4|WD^^N}7rP+(Csa||(OCUkTCr6!^$9dhzZeE!&@bYl`WX>B? z7iZ(A`;-tABz&cDYP`SV{Ov0qjIEri^l!!S)A_LAqWIf0R%R(UNlf?~9Y~iNroDpD~ToaepT@_Ka7AIgzx`&_F4@t~) zX@B+4lK*(|ZnA8Xk0-5}mdKV*W-y!+leQU!$a_WO{molZSUQO)On$OZ_`xIdlxnooUlMCW*f`88$!#D?!U$JxGdOa@ei<`)=x zdVIr`zRo_)ZL%U$_r_HTr)b|B2ESLUmGUtg5zad068~i~XMLvF>crbZ4>5P>u5>(Q8jrLULnljfS& zRNQ`)Y+)_Ut`zILRDS}L(P@SepF}#p&6rA_61a*%(;f>tTxCtW&BdqZE+)_X+N%?n zb)csqpOFkF1y1EX37^V!4W0K0pPX}AIT7QoSVKh*DC>l}IH7HU+$kXU-o4@sC`X7{ zB|3f*?wutp-=WQH#v4Iksf7DF0j!~%Gopn_`@CE1b{9_Gb4i|bN>@;_S#~MUV zVwJO?DPw&DXcL}qhOov7Qp|v>PJrmM7#&q)0+_zIZzTiT=2GOtYFphqFnF8}V<;nB@=8@_(`jt_{h(zpt=p7cyV zzmOT}ERcM*z7$~O_BW2-{}WsP7t;WQ8(liSt#OBw%(W;%;&^%CUnY=$&gbtJK*oFW zQ3~?%_Nu?y2;g7jPwfiwbTW$O%KRG%mj_SMkJYDm7S6Bh=hCTJS-vt-BL_b{6m<0u zd;>}y)ep}nCMtK{z2#aHT$~TCqf3>5-2WkE{sH(`LJxZ)_HJ$(`14{x%I^>58HTT2 zcC}dB6r4|edA=Q>a(Ve9#F~=ocX44|TI6Qh#k!eZ)~AFm|1H33?Uh(=Na%x+ZMy!L z`S0nvZOEmYCpoMSEPMT*3a71SA#tzW;H*oT#;nwpd<|1IQr2LPD?=uH?F&f_am*2b zXH7am5-^6av{`GC4P|T?lVT_#9}lyuh}I)i+oZg?9V-#jg00reY>No@cWf9-fwo3? z+l_g*@2hatk~OByEdL^Z`^jjmBhE4{=qvKeOQ5Aa3gr*YhFqJop=Bu7OL4X9cx%Z- z>(`c0QtG;Xp9Yz1C+4^?d%6fErT|o^rDb=SOS*cels<9W>&cqB%(H|uYHV5Z;e<|F zVm`myaX23AQmA49M>dtR!&$ai?w9##m0FW$_NGTE?PwDGee}4N4l;Zo`5JUw%ia$c zv){_R*gTUKnAc`Vd8TGnL3w3U*z_SI5ssNGcXE%%h)l6Je^~ll{0ExefESb&%b%1E zMvi&CWp0FIoJd;w5_3WS1d20}l**jK&%E+NZmoczf6+qV{ie*g{{DH*3J!Qi#63`1 zDAxQ10o>v*1|=j<&r%LeF~ z6s1GokEhNFNY7OAKD5clBuA%6jRHQR4CFk`2gkJGZVIhNWS-6GG=@Z6zsmgV9kL5~ zVW?M_fy>;%yB=dcECo)xUv8Cxymp%Wu(bFw_0}L$7}k|5p5s`NWOy<%AkRxDqQ=2J zE-89TWAUND=D(2icT#r}AGP5W6Q8jM$QkMjfTNE|yoH>2Z(Oq}ai?>|ARHDtImSt7 z`Z$G~59D1fzYc#ym0Rf+O5XzPb$4f||Ev(t{jKq8x*ESj=Vkj58WCy{&r`;q=C6z)LU5^A$6;Y zX0a!qc8GwRPLf4?kg@?-rzk~G_TP>X>tQkrJ35M*nj!}60M*6?MHGDgoRAqK*vwNE z1FUpn!ae#lMEskyi4_9A2aFewp2rXf%)hl4wmJQS?Lti`%KiU687bHD?Y6sR+znjQNExMD#&e*`-j+?IN!p zeLx%0s;GA9S_?HjVgg=>8U$6~&MVo@!@{Qa_Ag3Go~ESS+Q~ACxEW}9F}o?5k$No( zye32k{(g2{0oi-B>>lmD=hN1M_&5tKRHlOCZQXPinJ#Y})t7}x?JY=yrebECcE@{+ zo$BdvXGFag?HS@t2gUehi7R#YJZN{1E-;=lX>f-DE$=mbXLZANtPti&DE=XUQ!!^vmVH({rC@j;%0gJoEabEt1_n`k=+MDFo2uZfwf4$aDnTYX ze4xqZ7yEE4ExqkdV^l>SU-mgWGZ*7bthOZ#GzW!k*oFj|X-ew((=p>d7=&9jiYo_0 z!^OF>&-)zG(`Js&SM`v!+-hqeKh%O}z4MRk$hqZ(!E>4md}r!U|5FL`1Y^Z)<= literal 0 HcmV?d00001 diff --git a/docs/plugins/development.md b/docs/plugins/development.md index 300522d67..584e00cae 100644 --- a/docs/plugins/development.md +++ b/docs/plugins/development.md @@ -90,5 +90,107 @@ class AnimalSoundsConfig(PluginConfig): * `url_slug` - Base path to use for plugin URLs (optional). If not specified, the project's `name` will be used. * `required_settings`: A list of configuration parameters that **must** be defined by the user * `default_settings`: A dictionary of configuration parameter names and their default values +* `min_version`: Minimum version of NetBox with which the plugin is compatible +* `max_version`: Maximum version of NetBox with which the plugin is compatible * `middleware`: A list of middleware classes to append after NetBox's build-in middleware. * `caching_config`: Plugin-specific cache configuration + +## Database Models + +Plugins can define their own Django models to record user data. A model is a Python representation of a database table. Model instances can be created, manipulated, and deleted using the [Django ORM](https://docs.djangoproject.com/en/stable/topics/db/). Models are typically defined within a plugin's `models.py` file, though this is not a strict requirement. + +Below is a simple example `models.py` file showing a model with two character fields: + +```python +from django.db import models + +class Animal(models.Model): + name = models.CharField(max_length=50) + sound = models.CharField(max_length=50) + + def __str__(self): + return self.name +``` + +Once you have defined the model(s) for your plugin, you'll need to create the necessary database schema migrations as well. This can be done using the Django `makemigrations` management command: + +```no-highlight +$ ./manage.py makemigrations netbox_animal_sounds +Migrations for 'netbox_animal_sounds': + /home/jstretch/animal_sounds/netbox_animal_sounds/migrations/0001_initial.py + - Create model Animal +``` + +Once the migration has been created, we can apply it locally with the `migrate` command: + +```no-highlight +$ ./manage.py migrate netbox_animal_sounds +Operations to perform: + Apply all migrations: netbox_animal_sounds +Running migrations: + Applying netbox_animal_sounds.0001_initial... OK +``` + +For more information on database migrations, see the [Django documentation](https://docs.djangoproject.com/en/stable/topics/migrations/). + +### Using the Django Admin Interface + +Plugins can optionally expose their models via Django's built-in [administrative interface](https://docs.djangoproject.com/en/stable/ref/contrib/admin/). This can greatly improve troubleshooting ability, particularly during development. An example `admin.py` file for the above model is shown below: + +```python +from django.contrib import admin +from .models import Animal + +@admin.register(Animal) +class AnimalAdmin(admin.ModelAdmin): + list_display = ('name', 'sound') +``` + +This will display the plugin and its model in the admin UI. Staff users can create, change, and delete model instances via the admin UI without needing to create a custom view. + +![NetBox plugin in the admin UI](../media/plugins/plugin_admin_ui.png) + +## Views + +A view is a particular page tied to a URL within NetBox. Views are typically defined in `views.py`, and URL patterns in `urls.py`. As an example, let's write a view which displays a random animal and the sound it makes. First, we'll create the view in `views.py`: + +```python +from django.shortcuts import render +from django.views.generic import View +from .models import Animal + +class RandomAnimalSoundView(View): + + def get(self, request): + animal = Animal.objects.order_by('?').first() + + return render(request, 'animal_sound.html', { + 'animal': animal, + }) +``` + +This view retrieves a random animal from the database and and passes it as a context variable when rendering ta template named `animal_sound.html`. To create this template, create a `templates/` directory within the plugin source directory and save the following: + +```jinja2 +{% extends '_base.html' %} + +{% block content %} +The {{ animal.name }} says {{ animal.sound }} +{% endblock %} +``` + +!!! note + Django renders templates with its own custom [template language](https://docs.djangoproject.com/en/stable/topics/templates/#the-django-template-language). This is very similar to Jinja2, however there are some important differences to be aware of. + +Finally, to make the view accessible to users, we need to register a URL for it. We do this in `urls.py`: + +```python +from django.urls import path +from .views import RandomAnimalSoundView + +urlpatterns = [ + path('random-sound/', RandomAnimalSoundView.as_view()) +] +``` + +This makes our view accessible at the URL `/plugins/animal-sounds/random-sound/`. (Remember, our `AnimalSoundsConfig` class sets our plugin's base URL to `animal-sounds`.) Viewing this URL should show the base NetBox template with our custom content inside it. From 0a8b09a11a7d9ce437e52a5d24a755fce3033d52 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Mon, 23 Mar 2020 13:58:45 -0400 Subject: [PATCH 067/124] Add docs for plugin API endpoints --- .../plugins/plugin_rest_api_endpoint.png | Bin 0 -> 30034 bytes docs/plugins/development.md | 47 ++++++++++++++++++ 2 files changed, 47 insertions(+) create mode 100644 docs/media/plugins/plugin_rest_api_endpoint.png diff --git a/docs/media/plugins/plugin_rest_api_endpoint.png b/docs/media/plugins/plugin_rest_api_endpoint.png new file mode 100644 index 0000000000000000000000000000000000000000..7cdf34cc85b20184e3276dbbdb458138c6c225f2 GIT binary patch literal 30034 zcmd431z42tyDqAtAT83;2m;cgfYPNPN{2KIB1j5DrwSrn5~DPTNOyM(IWTm03`ooX z0}RdnM*qLH)>;2pd!K#IUVARRxR|fr_lf(tpZEw?Q+Y;AaEIW^l`F(bit-v)u3SR^ z|L@$y1-`NE4ida_h53q-yo{E6($?&(rlwny$i)RAM$c<+dF77Elcbr@FD}zxowvd> z6|!4JZ_IXlz8aUl5H1=nmo=4v>?!<|GZcO!BwTwJpXR#P2SfG+zV*5HZp4!BWZ2)o ze=i=u%;&V-fWn|m3)r|>@Ktw}o2!J1zP1ve^1WHd5BkR)bmm&FUBdeN`SyRvT#C|1 zM6CpDc#m0=tnu9Y45s?h_BgbAF$uczt{>ziYAN_Q32X(P^U!ShaIu3=@%Kl|AoTru zFG$wtr|7BBkG}og)&J*?C%Ms+;00knRu+y>?{LJw?clF9{I$W)!k_)sE5ArU*QXip@=L?{s4XjlS^m= zHSRr5`p;)$l_Zx~wgtM_L-=;ZG(waoyn8~Vvs*xnwSXq#;QtRD{&h9|RFVZ1TE=h= zY1G56^s#(V^cxOuaj5$>2L9c>tT!oj27Ri`p~pRI|4?=$cKv%H9&38-bv@NAjJtG( zt26IkgkExlsG6=jy@KgV{xkcDSBF`eNmNW45fSTAJxty8=FOgMRhD|}eeJ*4-abfj zI*iBP@{@S)1HxCTW@R=vjOM}<{lVa)>w$cL7FWT)ZS=4G{kw)Oy8&4y;`@8iDaTi4 z&x8miN_h2EnH2YR?_#cR5F#!N3SC_BY~u+j_YRmQZETx3{0Yq$uaHB)}64BJL&2} zHxCKHAyNWl08<(OxcvH_V_H@2wi_<+&&-3a( zqe2tbX7DQsY&GFaq3A}DO~l#4*PAXqLTljXcA|4zRY%v7Md_M~Nmaik+o7jSnl2GD zHbWD9wwTv;k~jRsj19quvuzH$V1s|j>-cf*$Q*eL9#0 zD&A~ew)O(hWI-2`Lkc()N{POH^y?5Q)u(r|Ep(NU|NZ17R}p&3`wjA5;$(ubv;Ope zZ4R{HjluhmMLw9-ms@W0DA%U7u76=m=zc(2R7iH~2jU9aDuvBy^V2WW2fuTd*TIV4 zcG8n{CQV;9i1vf0Ck)H`z>Ib^B`M&pYJaZOWnK=DxPi7x`SqrzYH#Q3HAN(|K1z&wcF zy->uR=eEA7r<(8T%hQLg6$}jMrl!6PPD}(L5N{req>lD^3Z3yZgQ4O?e?sMd*8gW= zOLeIC&Yu13sO%Za>+o#1@kfn~O{X{1u)iGU#Wz=FVl0^O(v8a3L=RlmSAD_r1JYDJ z*ZLJUJ7K#6;}E4nzw7&FK(0W6CMgn;-6%3*T#xjv(3^TkU{^-SiO`GpfU}oF>m6G# zs}53ioAB0uOM0K4nxLPDO_Od-Bkj(x-`Sbtt9qRfw|LjSn(k>en91BogQM`p zHCq{{E2d*HtLI7?JP5O||B$*oE`JP&)W5pkpo)RLz;&*d_9W@{w@5F7@8t()Ng5}@ z6yPH6DcdIcoi8s(Io{n8!FWmL2SLTX|7l#h0L^(&?VgCd!)R4WqUE57zc zVm=TgX^{BqSQoF&@gW|~GT=70BA8Rd8Veki9cgSPo4B_E4gBv2ul4v5nnfgx#RrX7*UwO9X^X*I~ zz3KZR^d4INvUivW*GzC&94mN((P92q>raEun01fXb?u2Cnt}flv2l@ zpHabMC8$fmadPr>=j323B$bm4_zdbFVx#djb?kva-7~geY`Qd7dm|rG1|i3u(eRcB z@%z4J@1aT9gPcUge~x^*N(KIXXMtvr%I_!R%4)!}Yi**v-tjM0*>=RY%XK+;7c$gE z&K&hkR1ZGW;q9pHjaoWA4^J#{G^dYvq{5H<@WOdf=hF?o#~gVW*7Ts-RHXXMS_%>~z>D&_6hp)mNE5>;{8! zza9)ljg>>m8Ax(8!h89R?TpivP67f)9xf8P*;Qq3M29Vf5r3ykLWd>f&Srb^=4!R? zIS0LveMblH+pf_F5&qojhNtsQ+6xH7BbT!M#0JU{4PE*vhZ z%9+5{B*rZu>+%+#ZWyI|wq(9YJM9)C`g9_GDN49(paI+V(|=b|NWPr@Btc{!lYOc& z^&sR}!?y_#x=xb?H9803aI48tNP|y8vkCK^>c$NVtF4s4ItUZbGn3{pGcCrMuyBJ$ z8MFpt`-J&SesySyZVD>ABA$i&EywL}v1mxF|E8)T_s(!Nn1@79p(+Z{)9qz9)?cp+ zvIoM?1HS~P=5iOy=#X_@UWgd}MD4|9a!9do{o*O4wz%6}O}^W4m(x0V=lHQ7)ca0& z=Tel*GOR8sMif7<72Pw0lBfkboDs)?UGDyn9?E>txM;@cmzvQV-QcA+~anSwd zjlPsqh^G@Fhvs1`#Q93cce$>HbC{~2S9r<~f*J3he)RBn9GF{S!N6jxsqxULTIEBv zRWcgY_{E`aTY5?ND;=>y)yuvg4(Q`PyRk}MXxi@T2{P3shsT;*I_@o8Wm}EUd~kU) zChRTeiJVt|ATncN$C&LNQa(eFxTY$#&qpO*4R(r5g0_5b5V*JfNl@X^tsTuT9ozx@ z$}o6NsJ64ly-qX(U%mRBUeaIrcn&H)alG!Q`z<$j;NkaEciKyJ#xAuFB-69?A0I=h(IsM&L8@GBU${78(@(opL)zlMVAiC@k*QJT7W__$ zMvor{xiyJ?Yfd&7bIez-gO{9g_B1@gltjF8tXOhGQH#4d-Adj2;wfp4iME*uJ(C(S zmy3H=%r1!M7C6#5`mK&y=|-|7+UA-4(hR7PJ&R~o6XW>6m%}MBd(elASV>_6UWq^j z2v#v@hLCIeQLu7d&^uB0b`D$&8;0GM$hb7FK_5)NSl^=63g^XkF)Hv@UTfLfWi3z%ZK3 z*C^0~&-|d!AI3#a-<>a4jA*ib<;JK~2Q_#bAyo)e61Z@ekQWhbIk0h2OT^V7d$w2$ z{~{Lcyho*9=c9Wdv35{?aqoWW#2S6#w;_p?d{O$k%zn?Gdp9fTPy3ASeZC(FlNi4O zHEb}#BM93lDVd%WKzQkVk+^XnsnWqDn}yQJ268--6*>&-=82Cu?VjHDHlN({GZ8CS zseS+^F0{Pn+pdLpyr+G*<|&mhtAOXsjgaZ@Tpb0E=#Hd~s+ti$OuZq&aW%waY#ZN& zO6ik(hJ*^-OX}LWug4KDV%9=YN&I6*hYHb+3C2|nCNwB$owsBQH0O36RSA*|FF}%& z3nwh@P^E%WoN=q@P#Gn=e0S(j%cMoEwId+=&bHdb>I1iVR-tgDm}Rt!05KQWTScX* zoYQR2idPI{lzEMtZwa~ULdbix_^lnzC`r99j~h-ozSF?1q2u_vGJC#XmX|_3mb+CQ zi-&|RKT&ZXcoRshEo;M))jFOy)-mI81v>_bFv>K-b>e@0@Tz`wz(lj-b0)W4?YtNC zWIXmE&GK?o7Lf6S>1rExK!sEzBos8G)Iuj9$-_?G6~?iY-q?m93!>JxM122pAjMybz-$EmeEP!q=y0bVuDd{M<%e>H zTg4&!5q-C?8$v@@TI~Dz90Gn@SME`1>cPu%%T>6A6 zX>_6wllr(ht8a!W1NrWpfHB+DWuS{C8A`rNqJFMt8zINE@cVg{AYZQ!+=vuvg5l~f zt6aVXzB+nx8Zei@3(iinqEhh>cujNd+fr+d3vVTB$UDwXX~0q`B1SMVHPe0DM71Bt z6OWchg=$Z};N5Z7#%|Oy=4yMVMg8t?XLNyhw zp0shXPv_z;y682%fcCfx6<nd(59_2rT>##s;j{6O^?uz4kMu z)OyFCy5LXV^U{gfTxQcRGr#NN&Jiab`bn?HQDEJ8SAj+D2#FjoCQdqUiK z+eHC&NCuzVDRHIv&f^{Fu>iUt8jti@o+NoN8ga&^`ZW<*6B;_IBbAVo*qqD*5B-*d zH0XN1A3GwV2}9i#xwsON^0R8Y4ow_pF!U~GdToZPE-nitk|h3Pdsa6I;<@+5t2fY+ zwBk@SHFnVyM1l2Y<7<8qd|=OKsYfG zWU`SA&Hw1S{VAE;C+=AkB##np+GGMyE{EU&?`E}BPm7=4=?41qP5v`a*eS0w4cm$TuNTiKb!9Neo2jr zIm+==hye&4`-NtEC#tBkTDQJKjzOk89u2QE?YIrB_A(4WR(OcLMee` zonq59x^=^3pz4BolmcA@qVXLJKnZSgaEn!F_a;;`t=yS3FOXVH!%_;ymXeQkRt4f8 z+uP-;_u1U>>Fd5^Cg)*@fRM5V#7TE23A(4tSLwx*!q29+t9_jKZ+{^eeDdgn7{@4g zgFAeI?qPo&CFoj#!ldE@Yazw%7WP?fXG2{J^|deItmkwT{^BMwp*va}_ahmkz0XwG z7{vX1SSw=ty(Gz#f7X+&-#KqV2+b4tE;LECRFz&oJ-2?=sP3gwX$x?`4R8v?Mfsc| zaijUb{OyMML!`pcqU=M`$LXBtGhZx&W}hony-2EiCd%d=xNKW;99Vizfb(Ay_~Q2<$&cejmbz#1e-ePw zH0T-A<&kQ=yI@3#;OW0*3smJ0oaR4SM_Bkvvo}xmcFFHypQ0a%;6)Vj^70#pEgz%F z_78}EXAkN@ygwm0?}vXGuD|rZ_?nVJqNMV(-?HGpvla7SwR+Z)b&HG_UqVt+j7vpa zRBXupW44@x)^B|r+Va1fGA}~UM)P!8y7jjG{f7T>nHbw}OYZ~ppZTwj1BERhsWYyp zdFFT7Lkv+k%_-xr2HmMkO*QV?EzLDKsKj~y$a<`6CY^81Y@U`6dw)`Wu z#_|N%+oj{#Xh3c(b@ha<e72S-Z%PTX9qRX3-)n87<3$|ydqVoC z&G;lgiYk4iNcaFkD?s`VibttTb#_y1i0OlqBhM9Um88V++50B6$uvGZ!)Jc$-b` zeh;3`MK{)qGj?|Sft;T7dIo1NHv&05VH3ro9Hqf6@Pxzsro~hI81L&;7)&{cFFRuj z8IU1rDoD$$6fA&&q0?|TqAj0%93E{@qu|(bp^ajvr5z>Ve2%xb#HRSvuEI0zT6bx{ z#PBw7Sih7wYK2HE@<}?U5vNKNGrM7un?)VFSV!KO8x@Ca43U5yeG168mch;=I4XsP`o+;tnAEgG(pIiTWMOdrxMd zGmoghdi7#auq!f(5-itBwz85WtzvC^Gqk2~tJkrs&|rb;mKQaw8`p)uMh}Bf!Gw4a z^B@c%ypOsfqM5VD+;w2)V0B&HkHZ!iwG6Ty>#xOuVo|!$CXW?c3 z@5cz^qd>VxkSl#85u{HTOgFjpMTVFu6P-a$cD~ujZ_J5l9+yo>FR*LV6PX_=E5{{4JBpcScot$F=9A zuW`3s9=%F6ejoH*Howez%@g`9#XuZgKr_KDC zV#?-47}IoQzJXx{xkZ@SBEa;kL^)-Zi7IUX~R4bq>R#yH;Vo9Ec7!%-2`kJy@u(~Mf zY)ae5l%tuo<~T;hm5&ykKc<50nPjso7)B>c%+z7qq?=^PPB>D|kJCgu)U-iQUl&rI z_slH)($&Qovlz={mtR|UNsSO3iHDGRY+S9SL{xY zh+p^9gqs6yi23bp;)++)Az;QzRu*Vjx!0Fsv3m`OTq-o(k%gfby-|UpB0qHTvrsJ& zUf~**sZHDW`7`7<f&Zl60O)Rl#v*s?I(jVDM?JvE3bGmWv?{ zQtneQigYz`;!&wOe!T*fQQ?%y-t^+-xOG=a;F}khLnGwp?dj6~il#!Cm*lbz8(ZAs=c{W;*vS2=pW5SjxiB24xE^SK@3~Dh`EsKtbsESX9`TdJQ1}yp$@Mq(qHUv?>G(6Ay_Kz$(doUkqSn{1 z70CS^X%aUiFw^m&qW)LAEr7~~`O#wDHMWOG^Y_W9pfj#ao0_?5t7@TJg$HQ8aScLiW~;~`VGg(}Cwk8Lez<>v-v<=2E4 z6Dnn>oPgl@i03*t!u+R791HCOHIXU8vO$xpCbohowW^MGL~E{SIw#4<*Vl>~4|?!C z%~YbIO_8#Z9@Ib(L-ZR10qk~2UA$nJ*~(Xf;!R}O$-GI9muKb+;$qH=!#C8Xn&EKU zxpkd*Gearekgobpnn7x%@$Jt{rg`=illGhPbH@ZOs$frAl6i(huJv?&1d5&V=V=;% z6koqjS0ODOT;&T#8$MpHhfEqRO&3AP9D8yL-oSYggp*W4sZ-!jLBgB5&7UQpli3iA zlzrzj6YxC^>eOZ8%g-fP6_Of$w)&J!EtZeG?p>vOB`7r?j9gUOCskci?+d?C2qE<K;FBe zUL;rl`B?#k`j-yO#o+?BkIA?fz>Ofu&W3QCb3V4{SQO546C9^4k?3fIU30OJkoSWF zL4#AArw%gBYtp*VSQ_#fv*8k?16$RKjeIhwmvnOy60!mzijA{izW12+=_Cf)yrlO$ z>&ur`x^D(%53gt&orrMf@;|8$F{`$< zD8T|XiY!`d;cyNKSoVun6eAj~fR-XfuNT!VHZZ)I2q};`gup8%K#W_*P8%ULJqQ1X^^n5cddDx<%`|-8j$Jg~C zj21)^VMGZgEKmFJbVvt}0p-%;akrAQ!h5ckSQR$Hy2 zn6q_Er5#(16RzsTFmvddnx@G%NIk|Gb)Bu@^^C01oZU>)2rOb!l~t#Acdo)6WYH5$ z{jloIGAHzi*P8HY@hSaVbYsu6Io%YWfo)w_&{-}%m7PIv*YfGa!|VV&KEz!&?px8$ zIP5seQsbYfz~{nL=Y&GNTc!(Md9Skpr$;wxU9JhJOXY2mdB>;k0pxsfc*3X7_WT#S8SU&WI zw+!N?Qz^l{X#TTT;Ah^n1f}9(**CuKXQt}4YDo)gkncv0(78_=Nk&1B6r)yX+OrUu zP;H8e&D1&NI5U{ zxA#!*TPFPJFK+k=E`W`;VmebOO*;h&6K0xgfvCww$@~D_!FmYE%NtTJRL1b`8m=`( zcw9Z4rRx~~0qhjOHakp-WY)Fu&V%tFe(90H`zsRrDT`gR1oE$ic}`5YPNu&VKU#2s zCA@;2i}xRVC^RqhYuty<9Juwl*g0DOJfvbGHb*jn?AIGM!(YZ@I*eEgQ9WBxCBw#x zGRAmqM}=@1Z@b!+GA0SbzGkP!*wX@lpjy2&6{I#@v8SvY%a7R;9S8{!-@LCE&Couc z?JXsWWw2H*p#S+Az~3_|#gLkYGTg`AB?4WyS0M6`o+nfXInh@S09L7@aBOA8v~T5d zpQs~rU2h%k9M9Y`&jES<;K2sfuKG@%u~ee~CCh`XD`d}5%h65KGkG%KbMUuW>gS^a za~D#-o!}ye&55ME0muFq`6csFhdW5i6|IR`1!M z%+sZ3txxom2_CONXRaz&Ue#!24LP>L%f;qrYj^MJd}QNbodyy&w8AS-oeL!jq@zRz z4kdb5uzdQS9J=+zFi6Ec+dwSy zL77Qp43C0?C${TAlEM0D;{0A7ZI3<)iZwaF9&9GXF3;yL!=))KfKeIEq?<|)nqTj_ z)l%ARSN3WRQ5IsBvN|7%u;uamzO%)8c1Pd(=;7hB?mt25#g}C zrQXwjVp`#v_KbVrPwowRNoiFk%mU|>8}seg4p@a~Q5a0ACy-~Sm?YzbEHz78N|c(j zD>`zhS#G}{o!Zn4@ZZ&iC9m_S1h7GuoD+q~!K`dtBpx~(u_>V&$22jHwY7|hFq+vW zPNH=2(JM-GpTw2%rg|cobwWPm*uyp@do_s#+EaEYhK`A(n#W>+MBtsQ`aMU9s#}}f zM(|AH&%=ZOS=BVU!RY?JfXiaa&QdK-_kB<%v30sL(b8t-rwNzwY&Kj2fGxE?nU4|Q zxneNvuz;7SUtNdNVYxr7U5urUH|vnO+)I(xJ-0kIK8zE%jMlU+a3g$?U;r*MB81bS zi$IY;&83iH5aD}JU4XwC^E~=T+E3UnQaSdH9<% z;IA#2wVvLC!nCDm7QkaF>?XMpWA&myF6%UPMvtl?$OP&vv)>E4D(`Z1Xf|%Xc)-R* z3rs6<_R!>NS`@`C#wXDz4$TzsY*>4;hKP+8ZM!@(eMf0l0O?$r(R6U=QveDzR>)D` zMrET#lH$0mY(A!JunIHB+I5vgRG(49p(ZRYB~+kRrz;L%X1Bjrd%tq&1Q`kq={!RyY z>~7D<_mna~ZbLQ_@bqoTF-u|hrX9zLcN1EHOxKVs7)=;9ES%#uHj1p5LD{eWvE;eZ z(3;vOw(q;=Q=HuJM=NW9I?I^d=})2VsFk}vHIvjRKG%LMGTgoFB zZ)9LZpHgraI;HbX<$(S+)hpQO=}2V_tmfr=P$5w|kDd;bE?k?f_x94Bp@GK;2q~HR zAx{w~p1pWkD-u`B`1!EfFz-@XI53x6d%}7D_83z`z`?H@LHqX+C$hhq`D<<{TD@!5 zhE)l>r}Sb|C-L#^3^Jh}?*K87XRhW%Wr-&BD}Ty2 z=yNNA)amY==R+*D(ljxmp12)U9>#M|@7%xTQI5Yo#rVdL8)0&k4?ztVKsI$<<*GpT zqXiJL0f$7bCPpjh4+^+&f?5G&yk9T9P$70RX^p#eIe8*M?}JI8f8V5u;J9O0dTx8z zPw;FpKgJt~pz8&7t^uWvlX?xs*g^GEB<&{dmhiC1`3Pl}tNhO`ATfifDp z4F}wF`hp1{4Rza^&rX{8NE4cJ2}Gb#SDwwY#H{PI_>PK?+}vl^Kp2SIcr42U)#)b> z<|2!l?#r*#*l$Clf%aB%jmf#EbQ6=&wE2ZLH{;_ZHG2OpFB~t}DF6sPBWZI#@?>T^ z7O^m+ZUB1vU6rdq!esri$!Bxq{lj`M7>7E51Dl0Jxt(iVt=qbMX6JD&9+l)k!h6^5 zKv7_NhF`jN)1G;w{t0F^i4@2s8W?2JSLGxQM7JCFo@Zd<6g)Q^r(D9pay&7r<8`{Z zz$kT(w1iWbU{u96BR;gSHPg+E*gyRqI*Bmqm<2VcHhWpB4JTfunQKq#amFlUdhFjWtfnw3Fm19>$#^$q6F!5(rOgLCh54OJxYQ=QFre0{Pr3EylB2BXEa}=7Dv6(Ml_* zF%V`dZ?KAN(hXhT*B{x#3B)Ex^1$07(mu=C*X3IAM~;!YmVzc?9d*(1dO<h@=V zZ_M9qJ@^ITw*8(?fZrnN^ryO4Z&3s>Km$oT!*F4mxd-LZk*loJ`Zk|HNkqsjj92O6c1B`;22oqV{Lq!RH- zCZ3sYDay=#T=HVp#eg=);w7g__$OdG^Y-(BNigM8y^k#;D~;RI9uHo3zqbutyEB~( zb=(NOwh6RWiFnu*f?#=_0Oi@L70DDsyw55n*c4JG161!)^Rk$Te+5E*j=2+M>f}S= zC6PNbE>y+B+dyP8GHU)MheG{Vmf}xZXDL2qB`(%4*mB&bpch>7vB6AGYAG3Cl)h=2#!ita~S0pa6B&)reqX;#Xuq{Q_7we&txfUi@fp08()=0vgMyr9C19R!%_ZBQx7 zLuWdn>!O%ZeTs_ev`t?=Yb31)U?H%yLqitf(Xe0ksFRzArkzPNZ+}Vy6_GNN*}-5V zF3M_2WPmq$t#`M1n4@HxvutF4z`C;7@6vpR(5vtHi&pb zm{RE@Hfzv^ZCeW_2yLuUAqPEQ)35U05kH*yd%28j6GCB*9(tg32cgjCK=EQQg5Jz6LbA>&2>AwgD$}i>G;=diFH6}4rq<5Oc*rEhq1}Uv$v<% zr-HppyntxM^T=2iR8lp{dLLVi1d=(|01;MwAKAmJayS;< zQS2!09Dwxc@42!(jW-K=`Kcxg-vb}FEAVyff#@19B4j9HxJ09wyNCyw%Og}A8_T*; z-4_ zZ|KCAb5~4wmIL1SW^2eOPC-4XSgJ9y0AM$YfZE>Ncy3GRAr82se0hApF^8Y$+zV@B ze>2{26yu-S)tc5y25St~c7M`p&%}Q|3j5FD^Z!LB_3ttGf9EDQ%>+}Q!kaEBsS6Edx-0I?FzFxTJ^L*r z{eVJ9(}wJ7T+>oZdyf<+R;wAK_ne{Lx#S{6uLdY_Nkf3h5@c0j_E%+rapL{Xui|1C7J<1gY7NwjTqKeA#lIL1@>z2GTe!Q4fH zJH;gbXfuCP&!9%hKOI^AOHa+YK!G1;ddF7vt}!<+P1w<9m~S$7<6`TQ`6^)pedvGKzHRO+3k%Eoih(0DPqmY(yM^Z>>iU$kW|X5 z>+iBU;RX7cEQ0SehJW~pI->%wjynvH`!JGN+#wH69KdX+_BKkLHr$s-NCrv}r4V98 zuHQIn0Bf54+z3yVRZju2c``kHBHn52Hq#OsiAfW2qO(;`HCtbk+MPNmYa`u#;K<~8 z*DX!NniRLxVE4J$;YO$2`sDCZzsEt@+NQ1)qbw>#nP%3!6&-n)hVge07|gP8)n4*g zxhHVF>MqbtL(7pI~xf`ngkjPv3QkyaD zi0?!87?QL#G3Pj+jk5En0z-qxzxeih(VhUqaf)52D~1=cX{uH!rK_Ga?DEI~A8C z#xNWPO^UU8=vlbe%=>kiXLQ*LkMZrlEOX-(fJR1 z7Z0Pa;VGmeB5&_Mm+Fw53$O%QE=J=6OlGa_sV4`pVwB{bsd2`^xJ~tm>0+6E6X@wm zj*hsK=&XTWhO%vK0nZfO^ULj;LwBqrb0!tEfROE*5z{m$R(Q5k+Iq%T>_+NIDS4&x z+tLmrl0+#!KjWRD_!fIy#vR)-^LU>HqK+6kN?)!k*|ytQT!k9`>TFMuSod%vPf@Uy zn_nvkoltH($}8oJkU4W|BvR)BpqQ)m2U@3G%(=5OzxqU(Sie)};+PrhE5`-hAQhDf zVBS1-L~1!v1}ilkeBizDUynS$Sq}&l53R{y{hSc`*DD5p`Ro4#B<4?n?4^o{;fD{G zDuzC`1gQ$_=e9OLBmAFig z_}uw*39{5Qjy<6;SDqE`hvbot!`?S4BnbV&&Mg$8BF_R*k+GoZLh-KPamTVw@Yea= zNQo+5%!U3Rk(TQNV!FTr#$_c_$WUYg6GLk+-*|~meb7umqisQ$n|6j&Ye29W2ZhC* zLw_;TX)s<91xM^66_LVrbLf2bD0cmWk%y-1Y{@rG?J{R6MC9VRapsA5> zGRUj!wbIfZ79&fV@^AW0z9SRCOHzxaedv44FR*f06Zr?73mEb$A>2LX_LScGm~-s& z{iAhe$JJBcDjc%}X4Y4I6)iR5o}I!xDNL7|3Xsv28K1Q*1~DFa#}{Jn+imsP2vd>g z{pZD%0^Yo82p(2nr_R$a7?*%_e-l`;t*q*b@WhPdhi&OlPG@3;EOE9)(wXIz1q7}M%UJ8<~fA;XE}5lLIH*v?s}Z;|<;E{v%*(k1aS?)N(} zR+L`7A;%AYkRYW|AE;a+YaWCJ!<$-^#~IO!Iz$SnHpR_{v5jIhVNU`QYDFCTW54cf zW!gY=M)JRQDkST(RX`?LkypAU=dePu{}d^G*&_Dt1u(X=3=uEJ^O;lyM%GQ@EHW{fHYvQk zZM-xWrgSL{b@&p|UIMQwgC==)b9t^-YRvU@nw#W2eD!Y3+Xvg2`k$7xCQuAgT?=X5C0v(Dz*lOTAPK% zr-y^apA+KVm24R(;`USN*|8J%!wA)H-FEa-6};Vm5BFmX+&g`|-)Pg?zVcl1!m=yk z(z5SlU` ziId_`p#7YApjv<1$pjnf?h)yz$o;AgXbhr%QFyfMCi^z;y?8dHPF%j{^B-Pzkv|8z z*p}S)xuDqS*_8})u8ybxaqbBbT^=!|Nz9q(1Yjb?UFRE{W=?Gs97}(5E8fBXzz7QInTFyPe?!O|PWVQTi!OW0Gw(pb z@!iJf;*kT-?Ni+lFDyuG2j}0eRxvFHPh)8iz!`o>&R?DWpySr!cd*Q|@9jNp>0;=k zzF-7P1vn5LZtuwBMr3us#ZB^#(^)#phe1#8yG-N=A>%h>rw|81-XCs`{+oZ)`? zlJWxnyl$;=jRHI_OpdugnT7dmJxTQl@#tjVS72;aT-B`KtMc<667nBsnKUV+Lh~X! zANg;D(VuA^Q&4>RjUwwW^`TJlD6G^zt7FFE9m6_*^`KUON87X>6{Fzc=B)PE80*hF zv`W5Tt($S#zK#bN#AbP|3)=%ca`1yQ3iLcYU1Wp)$4r%a?-4rnv*4vp{M#3op7?T1 zC>eNNY8wCUP?Gk=fJSIdUJ!Q(`RKDhz9|1H6KZ(*MlF>RTmU((``Eqm!ERk@nn}P5 zU@FDiZv&R6eTo^ZcJn7TkzQQf2)K)aH*0_0&$^d~=1U8V6Ng82^J;pEf`03gV|Ew1 zf24X#FB9rb4urs;R1<}O-bGg?%^AN#;97|0!R&puoarz_I-RT8qjAw5GeXR8U~$y z@X%ETsgC58o<&}UTVi9c?DS!VdtuKI;H(XU_rlI{6W;>9_!K2Q-}zbK-NK!x7~3{9 zQ^oQZELBfE0Rw)GDM1}yuZqnp1twEM8c5eP(WZ(#tx^_RX%CwyP?q8WMqgX|?rymB z%wO)%Tr{nlZ}>S>f80<9!1?*EloU)IXlDOMa25yK};W!jHI>k24${&o`3Szbd zvx`OEKu77CGA nX!O8#z+O$cRXymBo<*($v^sy$OZpa{VT@(Gd(`I@rTFAQ{et{ zum-~QG^uS{89+!1%1s59$cfHtW7dSigK?%uNNGGVw>mzrF{X;Yv%=R6!E&IN?iXl* zSgeIE;N9glhBq0tHC;FnvyT@pf_fK1q*8y!wz_|Z;E~?D$mSgs0Pi6~K`l4^p!H0d zOuVbNBmOfA2d*1>U2NYe+?!g&-owoNfC}w^Nk^fx)pX-9X5ZT|uei778D$*+s60ek zx=&^?r2ZZ0ss?`+JU(XGSJ+mACVw{Kp2X%iDH6QMQ}=^1%=o3B7Y052G-bi(%mG5@ zwbv&y?@g!DYq;<+ibtaB^K6VxP;>@fH}_&&nPeDi!NC1JMOB)<1@-*^akE7CI?55D z56FA7U%&fLAP>qKSe;2{c`np(<;aSO`QCMB!@->9ba!s5F!Obt?!-)KO_Y=>$yR+dM$A5S;}VG?o39A4-3Ww zN9Riq-qMtqBjW@9FLy4{+zs~VGcw>$PF7Ay#(^zAUl7$%RPnP<`jr7;Wu3$$mNKvBaVL#&@`htcqwY;rgy?VdmP!U6 zhAm;+bycq;zHg+b=)QeeIAjg3&ys07AHQOwL)Q{~GVu-OAT@fPEtNZgIKB(JdgV&} z>QrFO@Akx> zuASQYT~)A|Do&BeGEb$=UWU&Ccvr6Me6yiPtU>5BD>=AMEvKm}er;-ZFlkh#n@lcd zHdk7}U%oAatNq9`K`g``zQEMzQX(SE-=gdd=~|+OB<1Kb;i|Nl)xRwZhY(GvCnKk` zaji(bKkp%k(}pK^gZ|Soy2JGpS)fdS{*n82$W^sT_+F^4Z^TV7AWDbh=GK|93&mG8 zi_nuB@$t_y&8KpT1f`NfZOk8zzS013u=bGDnHeVsa}E3KfAiQrJh<<(C}0vzN%R)n zPmIjf&gWMxsbC7Vwn41ZQ)}NL$`kO}6%e6j+MJ`#7X)@#jg%}FC>lleJoug@l@I(o z>#D#1%%-YWd5V@^gYT9O->vvbk;2kR@45c>EM;OD;Vsp!=IR!>vvqkB!9Pn6#0noG z8<$9JHuDgtI=2N^y&ImNp2Tf_wKi`!wM3 zl`HS7ZXuXBTj{S{X*RftCe=b%Xf*jjMjBpgT)LGE?Ct_*d$0c%Lo?35{DF4ezW6!W zsl*!eYodZ1Rwlwrp zr7q-E`>Z=VuK^b)eiCpXx53)pJIb4AVMkpm;7r3Cz_YO1yi$10Z0<(^N^b3k!cFj#1TBg ziC_`b+x9s2#^w$tQq$v02GsDIq4T;X;=5xoQkNQQ)fUQ$FDLmOaQ%~!JO&u2yGmkX z5wmV!ptL<%84+z!xIm!DuU363Iq6oCx2hxG&d8K1CAXCKU#_I;`Y#v^TbN94k%E^D z^Aql-2{wk0lqcKQM11`mJ*TwG<$@w4NoyfHsHb#l0oplIx$cb5c#Yww{?$t=>Vsy~zEWm^>Lg>we7A_*mQu;zso5PyHEl)w=P$V0HD9R7r)D4o|Q6<>u;* ze5fRhq|SGq{)x7!E5-y)cjvd&>`t#;kzTlH~*7h4?o z_}G($nstjbSp!?Ydd>_m;b(V*!&@X`4daVrZ3cSA^nqbcecdj-aMm$X!e%L;U|<^b z{_&JxCPE*D{>q6l;8ZK~VTkwm7{b%NvEqpZGg~X~eT0>7g8RC)?Tc$3OjD>UVaD;u z?GrO|j!jCyb#N@Xte35?@Ah|wJLZ~*$8FMc=9Uoqg@gd--2o1pO ziuIas@ee3{e)Hk1EOfNiQPaLUhL;wY;D+gYTK%npwzY*D|7qC`>x5x2FC#N-tgGz{ z;$7YB<}3$;gTZm(tg}b+bJXx7rVexZH^au^isiEUG^b-?4t2>?4PDs!iQQx*Ft_=%;;T*T^ZRej zJ#u*f@AVm%=wtg`NQD=F|1!tRASYRITpw={ZMzd@o*hn*Dy|Y=MVhu#j&OnoUGLEM zCDtLonx9FYN#f2IHEk`KiH~XbGWTTesL_e=qeCyPGeuI0234c20UmH zQ0lt1;MX0)zHV$h+s5rAfU_jLiW%J#uY|h!P{z6|l%a}Rb-OR#fX{VYMKs=X*hG*s zkPcUjdZr8!dJ837*Pam+Rk9p4-d_<-4-dd3qnQh=Y{PZMihz)Fm`~y2acUR}fnxgi zO{3>719L$}W5xCpMFB8+C@|g@<@Sv%9mzMlAC#wY6klASphUYq$ljk_a4bAV9XE&F z7fTadiaUnl{-2i0hol-aD&2tRfo-^{df0Pg)+?!d&%c3K0p4@&}$ZKgdd^6 zzYIou22Hl&sZ%YneT8+8=kw5B$tI4uS~nWYH}5?S>$tNlBCm`wCD+!3EaGKZZ{XwW z`8}GfnWu-uynYJBKm)ahe~#pxTVDPsKZ12rlziPuu%O^P|K~}|jT5Yq6fbDoID%uF?m>6NkUl3P;cz(xz`a6v%oJnT}Z7t zs`OE5wf&_Capn#g;>)UxmD$SqLg?A8>#Do0>G60oh{}oZscTi>28izRJdpErbs&Rx zwRmt5tmu!TB7zt!6eaXmPHbN#`hgX{`2PDfsuk`~2mEQ`hnbSm+iuG$N=@xmSsE17 z{@LZQ3oE&D_}Kf(Fx3dn|1BQQt~G++MAd?T2o^oRv@}d|LT?8^8HoMBqADrB%9TTZ z7e;!t1TbvOWv5%v_<%q9skz@9_(KTvudM2^i~jzo#=*$_Rz5U8gOR-3{`v>)P9LboD%NiVs@T`oyVP+aDuAojLx0dzF=UW}FJUHZMx-(8<{Re9Hm zU?xPcu347aM>;^-;=3cgEu?}>#ppCZ}pm8%Y;oy6e191r~Z{pGI#QBZx{qrHke zaJ+!BGzcqd$)9I?cpdRX_d3sgppGWIuK-MDD&X}V_ z#@}ox^qb3?XDVd!lL!c>h>$DFtFPbQJ_cb%i^s9U?%qj^CaM{^~^$yApB64+LFEHg> zRUv$?wl<%oCO}HZ+BfLce+2sPJ$)x->^hwTMz!!grpY92YT7vl=ugtjlO5!LY1nhJ z6{$y^RMMiNoW@mYDUaV9-tifUP@xCtACT9S(>OT7m!bg#`UB!1OY5w5Wq;D6vZ^N~ z;nyTNKlmpSOlPA#J?x_!w$_rlPhR(_);sb?ley0DMv95I0Ax;R2^`>O3Xo)}D`p${ zYJWHaX*yT#|KyOZmsGu^`@kIg?%rkO^er%-xh7{U#LD#HY;mPwy&Ziop+YS|Lzh#> zKDO1*I>M>RkzjrHBA%I5yg*T!z9HC)xo5F3DD&9-z5@zivr7nfe~^MUdUb9abX2Xf zfQF5=QL)q?AH~5OZaCXzk4uPz13MT$Ya|IX_oiVZ;rDoS_MH^&Jev}h&gp0gg{Jek zU81zp3#T|YIlu&8?%77iQ(ye&Pu!h>%JGG$RRZcS%LKRISGrn z#ex+*RRIWRNGC=&Q!A0d?A_wJ`T{4zI03F~vkCVv+FLF)S1z64-XM-uM1IEnYQmiQ zr^}lN3%#f(hUH>2;2RBsHY`ec_MdJON2hwXsezuL*&7SPO{5#STae{gGi?ITqTKdNG*AD4xmdZdx zz$b$a0|vBBGM_nqLmhj5$pu{8W=PvILBn3q4}rMuunK#-_LCfV&s`C$2tFqdo#k*e zb8r*k%YF&k{?YO*7MP2W><@o>ilzTdxZdiDt9^SiS!qPvu{iDuE^|x(FSQqtc8Ap6 zR*J334_C-_3tu@(zjF+VV1C)@It(+2DTDEOs85?6kmc^l!dmAKOI*-fgMo0kO}Bqh z5%h+nTkofbR+E7k8#bKj=t6MNUqD(XHfm@&rA52p+dMK+!xPbEV_SUVYY7|fI9E+= z%q9Jed5C!2-PLE>;I22wg0_@OUP<(`+%NR{*>QhpiJpw`_t=?0QU_rb0EQs{Eo%o5 zbiGjyZdGICjySmrcN;r`{lG+s`P}UXxGKCv8sr_nUSjJ*eL@sI){@DZMx-&Gv@YYF=Ak=nb6T{!MtA4)e^n_bPH zuTL19?ETmb<{x7FS6LImXmjR4n)q4~!nG`FY6F;*`=LZG5@mq}0MbI#Ab8iRZ_RsX ze*TNhG*Ik4G?Tu&7vP|0n&+@Elmu3-vNvTjpmXC>qXx5WvgIYLK?>N;4}kv6u?IC- z_UfBv{#0d5@<#=Uq&$RKapPmzc+?^d9Xwl%=BDB1I2r{l=(Drk$kAK_guqISu`qk) z>!;O3-X#}wUukkBOfsP?v~7l;n-oSwGk+3uK~1Y)pAJlnUPpOx<2F#dY|>UPAXr8N z!Nk4<+4(=ARSW|$VC(x5wI{BZsH^0?8#OH=g9%Sv`cJs9#-ef`-B+c{=Pi5N8^SKx zVkla{dPB3=etyGBZvM|ZS}7?NgY|%$Zz|yv7M1YLKul>Y&%N;mFWn8y!FRf`q&I&r z5gpiznVWpynu(mLA9 z64RxYNtA2#K(DTrCEvuzobL*?qkp>Pr5y2lTR$tV++d6{h8};q7B!u%A^N2lGg+ba zbiV6?+QT_nd*9`E(FDcYSn3Y|DVnpMC9a%AjlI6=z`E>yL)M5DV%PkwSmrgkK$TbQ z@NOl#W>D9@M2yJ3;t?oqoRcW!N1R04W(qajTH{AjA~gVww=yj8&gNI(_6A$!!R%5*GzZoC{{i4{)p4aLk-21v*vJzS-p%vtp*vlV+Am7GnYlE zd_x)Da(*SXr|#tK;^HqgQgOK9RfVyPNP!p-d#W z7FF0!<3{Sux32PHF}{1kwfZxz?mSA@bnA$-%_e$yZOC~^@h~zTaVq4c@S+~98HSzN zcXsn!UrJZ{owN3b)OQF7r562A&*V66^R*yMs0j#&2Nui%Gn;o2Pn_VrP3Dez5|1kR z{M`b{Uvn=iQ-d5B$|!xMxE0VD2hgDcsxxlwf`&jCn*biee&$AF{A#-Tbq?Dkd-y&f zmWNS0?1-HBibYs4Yp3j2Y4WGaSmOKC=1;oE72j%Hb6zF-gr{&bT{~KyP?oS(lgjgh zDua5&PKI5V@W=>dgk~16+yuv8MM7Y3G!blTgZ{PYt(WP$4g7&n;tAxP;_!@W@X+O` zj8lbfJ`!%hY}}K{e|q{$|6pN`>t@AC0nip4Y1C$kiyk5F!ANMjMjeB^A<+tSHqrZ7F!EpRREmV@m&YFq_E;dQ8|j1tn{g6l28f5lIIc2IK@tl-b8k8D#-Qm#*{)|zwCp z-@G!zzj|SxLi|!-9<(eg%U14dyQWg;Yy~<{dfczdXc}z9-^f*oD!khz@BVCac^H{I z7@bT1@b8#~B1>7{*o_=%79YC_{9pdgB) zy*6%^RrW$`W)h$vwjqH&B@lSz{2v`BXAPMGQKKNRcu(fI{W2N&&W5r^9->aCpv5ph zHzt7o0ATiYq5?G*!?qlT$C-?^-90_S7}3TiD-PHvAEZSB1}o=l~faaiv?Jl^*-HjPb62 zXKz~R)g|2Gg-3{Fpo~t*hzWd-lt%T?u;y4d2(`Z^MO@h(U56}BQaFHWG9@JTaN^#) z)2O8VVsn^zW|=928a}dMe_K*ngEf=9EaTW63D-**Q3jk&!oE15G$8RIJJ0ULXW2&K zA1-JPD6IrOxt%*hMn+Fjv9-}=dNG=Osz^a15u*0NJV^ko?763)4Jvj_niq=_%NVKPLp3h zK7MuA8+yVt*H?DcMW87NKxg(ZIZ)r{7l)l4h8mwGNB^RE&aGgnMYXb6kC71988`Uu zGImUH|4oOa6eYvz6S`uKa;G1~g`5*7J8=;jEO-i2aX|VZSv_$@!q^%OG(wDhrY0KSP+}+%SO|#8U^^-nTuVy*mPKCrDWaXugSld+Y z)ga^mL5Mh}h+~i`rPTq&F%xq+!r_RZGFi^A@VAxYTu4Bsu^8SkiJlF7=l9qPbYGes^8<}`|@tx#Ru>nzvbx?Tk0YfvX+zzi* zojY;ssG}4v4Nf7^Fw!lo`4y}5hm7PpumSm3qJR??4I zGcF$Q#Q}yaq;izH=<#853D4HQ5Wa2<)CiNp~TbB60rC&i~ z|MZc6NybjLEIJgyE!L;$sGk)NEGcR=^;hdx_M01P!z%kPc{0uNx{2@nE05O&=@}x& z{%u01NpQSkM2Sc%4WO4~DY)owk_osXLFP%Ly+!?qQ{;EY$me~#A?bB5XK6=1=h3$% zh%iJrR8Y5(Qdw&V@Rvs65zVyl1~PL-;tgf_J16GTnOP2sxOfMhJvaIT8_<7b(TFVTncw|D z%&QlxCb)~F2N~;?LSpk}1T_y}9ZEl7V=s+5)$u2X(w7pXiVKP|1ok>jHY7-qW1N|5bvtS8&LpWMpP7$(r&jTJYxQfd9Kwr z6p_@qa-dV6vSd0t6jlN*^Rj9k3qfl>iu>kdjeLIlyYTsAM=8AE+2y`uQr(GC-NzBo zN_Di+joCZ=Qvwb6+nx<%wrbIM8?E8Vyl=ZL3zTsQ{yz;Pe+yo{ocvnL+TP+>!GYbp`*Tk z`hYzD`*;4IGA~=E53BjVp3*uSuNR8~p6MSHnjFgFcKH{{mzCc*1V2IZ?~o|n5_#q# zpq^1$pweJeasQF(!+v39E`b68n4X?>cU0doA)xerQg>Eqf>WsmW&K-vF}Xos(veWL zklo$_oh4q?zXGk55fo0vgNF;AsOv9}C{+41H$yW`u{e!k9YM|{VWZB8zL)cm@YC|> zYU3D1b0QdcH`tBLd_~lpr3HoN__6tm_%q>dqnBIwWDAcMZFfNdP4F2*kj)kpc7^3+ zl{odKutA*;`!ddus0U!nX+E*uCcEW_!ywjq&R1;n05?5F zYB0yn95Ta2$M0&DEn&V+Z$SEi9})QT+|~>I-s--DfU;g_sMp+F8%@_xAezCI*kuV& z5P*W5LYNiXpZNN>(ss+ z;r;!J#;`6wa|fXN$*QD1lxU3UKCcvz1Q(%VcLT9TlTHIAfRqk0;*nCpO|uS0?l^6- z2ghRoCJxe+v_!)0eEOvezNNwLW2WX(120xXtN;ZuG6fpZt?k|E-)EqgBaruvO^}5Q?VqXAmY%Q&37ulO^<5>Q;LSP6ew5iWL6n zF8=x}6(9dujd4r#W8+V^^D-mJ+jVn-YPNw180q4hJCM2=LCRieiUoLy7rHz)-0;b( z*-*h1kOdku5hP>;%H_Nu!{4Q{G#**U+0Ij?oW+uElrI?CziBht^i4VQ4{qb=I)uA# zv(&Q-_gB7LC|qHhr*869dhU9Ppf|s5!-FfObW3C+g;|{hnPj z#V-7c;}QfVk}cvO%k)Cfl`rpk80J@9eugYSbaS^=NxziiX%Q;idtX8l3WHBK3bG4A irzHMRY4B`ocf=mGBKX1U%iv9+^Cs5D73VJh^uGXo8srH8 literal 0 HcmV?d00001 diff --git a/docs/plugins/development.md b/docs/plugins/development.md index 584e00cae..0f82f0dff 100644 --- a/docs/plugins/development.md +++ b/docs/plugins/development.md @@ -194,3 +194,50 @@ urlpatterns = [ ``` This makes our view accessible at the URL `/plugins/animal-sounds/random-sound/`. (Remember, our `AnimalSoundsConfig` class sets our plugin's base URL to `animal-sounds`.) Viewing this URL should show the base NetBox template with our custom content inside it. + +## REST API Endpoints + +Plugins can declare custom endpoints on NetBox's REST API. These behave very similarly to views, except that instead of rendering arbitrary content using a template, data is returned in JSON format using a serializer. NetBox uses the [Django REST Framework](https://www.django-rest-framework.org/), which makes writing API serializers and views very simple. + +First, we'll create a serializer for our `Animal` model, in `api/serializers.py`: + +```python +from rest_framework.serializers import ModelSerializer +from netbox_animal_sounds.models import Animal + +class AnimalSerializer(ModelSerializer): + + class Meta: + model = Animal + fields = ('id', 'name', 'sound') +``` + +Next, we'll create a generic API viewset that allows basic CRUD (create, read, update, and delete) operations for Animal instances. This is defined in `api/views.py`: + +```python +from rest_framework.viewsets import ModelViewSet +from netbox_animal_sounds.models import Animal +from .serializers import AnimalSerializer + +class AnimalViewSet(ModelViewSet): + queryset = Animal.objects.all() + serializer_class = AnimalSerializer +``` + +Finally, we'll register a URL for our endpoint in `api/urls.py`. This file **must** define a variable named `urlpatterns`. + +```python +from rest_framework import routers +from .views import AnimalViewSet + +router = routers.DefaultRouter() +router.register('animals', AnimalViewSet) +urlpatterns = router.urls +``` + +With these three components in place, we can request `/api/plugins/animal-sounds/animals/` to retrieve a list of all Animal objects defined. + +![NetBox REST API plugin endpoint](../media/plugins/plugin_rest_api_endpoint.png) + +!!! note + This example is provided as a minimal reference implementation only. It does not address authentication, performance, or myriad other concerns that plugin authors should have. From ce0b1733fe373b7f4982c33f60bd1021df48defe Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Mon, 23 Mar 2020 14:03:04 -0400 Subject: [PATCH 068/124] Derive API URLs app_name for plugins from url_slug --- netbox/extras/plugins/urls.py | 17 +++++------------ 1 file changed, 5 insertions(+), 12 deletions(-) diff --git a/netbox/extras/plugins/urls.py b/netbox/extras/plugins/urls.py index 1dc36befb..1f27ad6ac 100644 --- a/netbox/extras/plugins/urls.py +++ b/netbox/extras/plugins/urls.py @@ -1,9 +1,6 @@ -import importlib - from django.apps import apps from django.conf import settings from django.conf.urls import include -from django.core.exceptions import ImproperlyConfigured from django.urls import path from django.utils.module_loading import import_string @@ -21,25 +18,21 @@ for plugin in settings.PLUGINS: # Check if the plugin specifies any URLs try: urlpatterns = import_string(f"{plugin}.urls.urlpatterns") - except ImportError: - # No urls defined - urlpatterns = None - if urlpatterns: plugin_patterns.append( path(f"{url_slug}/", include((urlpatterns, app.label))) ) + except ImportError: + pass # Check if the plugin specifies any API URLs try: urlpatterns = import_string(f"{plugin}.api.urls.urlpatterns") - app_name = import_string(f"{plugin}.api.urls.app_name") - except ImportError: - # No urls defined - urlpatterns = None - if urlpatterns: + app_name = f"{url_slug}-api" plugin_api_patterns.append( path(f"{url_slug}/", include((urlpatterns, app_name))) ) + except ImportError: + pass # Plugin list admin view admin_plugin_patterns = [ From 5ec1b31804084f42af921b0f158d5ee400aaa958 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Tue, 24 Mar 2020 09:41:46 -0400 Subject: [PATCH 069/124] Add disclaimer/warning to PLUGINS_ENABLED --- docs/configuration/optional-settings.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/configuration/optional-settings.md b/docs/configuration/optional-settings.md index a678ac26d..e76dae231 100644 --- a/docs/configuration/optional-settings.md +++ b/docs/configuration/optional-settings.md @@ -315,6 +315,9 @@ Default: `False` Enable [NetBox plugins](../../plugins/). +!!! warning + Plugins extend NetBox by allowing external code to run with the same access and privileges as NetBox itself. Only install plugins from trusted sources. The NetBox maintainers make absolutely no guarantees about the integrity or security of your installation with plugins enabled. + --- ## PREFER_IPV4 From eedda6e648c99c7a3d2e5f0ba15fdaddec70a2de Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Tue, 24 Mar 2020 09:42:24 -0400 Subject: [PATCH 070/124] Incorporate John's feedback --- docs/plugins/development.md | 31 ++++++++++++++++++++++++++----- 1 file changed, 26 insertions(+), 5 deletions(-) diff --git a/docs/plugins/development.md b/docs/plugins/development.md index 0f82f0dff..63f1b5de6 100644 --- a/docs/plugins/development.md +++ b/docs/plugins/development.md @@ -2,6 +2,15 @@ This documentation covers the development of custom plugins for NetBox. Plugins are essentially self-contained [Django apps](https://docs.djangoproject.com/en/stable/) which integrate with NetBox to provide custom functionality. Since the development of Django apps is already very well-documented, we'll only be covering the aspects that are specific to NetBox. +Plugins can do a lot, including: + +* Create Django models to store data in the database +* Provide their own "pages" (views) in the web user interface +* Establish their own REST API endpoints +* Add custom request/response middleware + +However, keep in mind that each piece of functionality is entirely optional. For example, if your plugin merely adds a piece of middleware or an API endpoint, there's no need to define a new model. + ## Initial Setup ## Plugin Structure @@ -84,6 +93,7 @@ class AnimalSoundsConfig(PluginConfig): * `name` - Raw plugin name; same as the plugin's source directory * `author_name` - Name of plugin's author +* `author_email` - Author's public email address * `verbose_name` - Human-friendly name * `version` - Plugin version * `description` - Brief description of the plugin's purpose @@ -95,9 +105,17 @@ class AnimalSoundsConfig(PluginConfig): * `middleware`: A list of middleware classes to append after NetBox's build-in middleware. * `caching_config`: Plugin-specific cache configuration +### Install the Plugin for Development + +To ease development, it is recommended to go ahead and install the plugin at this point using setuptools' "develop" mode. This will create symbolic links within your Python environment to the plugin development directory. Call `setup.py` from the plugin's root directory with the `develop` argument (instead of `install`): + +```no-highlight +$ python setup.py develop +``` + ## Database Models -Plugins can define their own Django models to record user data. A model is a Python representation of a database table. Model instances can be created, manipulated, and deleted using the [Django ORM](https://docs.djangoproject.com/en/stable/topics/db/). Models are typically defined within a plugin's `models.py` file, though this is not a strict requirement. +If your plugin introduces a new type of object in NetBox, you'll probably want to create a Django model for it. A model is essentially a Python representation of a database table, with attributes that represent individual columns. Model instances can be created, manipulated, and deleted using the [Django ORM](https://docs.djangoproject.com/en/stable/topics/db/). Models are typically defined within a plugin's `models.py` file, though this is not a strict requirement. Below is a simple example `models.py` file showing a model with two character fields: @@ -112,7 +130,10 @@ class Animal(models.Model): return self.name ``` -Once you have defined the model(s) for your plugin, you'll need to create the necessary database schema migrations as well. This can be done using the Django `makemigrations` management command: +Once you have defined the model(s) for your plugin, you'll need to create the necessary database schema migrations as well. This can be done using the Django `makemigrations` management command. + +!!! note + A plugin must be installed before it can be used with Django management commands. If you skipped this step above, run `python setup.py develop` from the plugin's root directory. ```no-highlight $ ./manage.py makemigrations netbox_animal_sounds @@ -121,7 +142,7 @@ Migrations for 'netbox_animal_sounds': - Create model Animal ``` -Once the migration has been created, we can apply it locally with the `migrate` command: +Once you're satisfied the migration is ready and all model changes have been accounted for, we can apply it locally with the `migrate` command: ```no-highlight $ ./manage.py migrate netbox_animal_sounds @@ -152,7 +173,7 @@ This will display the plugin and its model in the admin UI. Staff users can crea ## Views -A view is a particular page tied to a URL within NetBox. Views are typically defined in `views.py`, and URL patterns in `urls.py`. As an example, let's write a view which displays a random animal and the sound it makes. First, we'll create the view in `views.py`: +If your plugin needs its own page or pages in the NetBox web UI, you'll need to define views. A view is a particular page tied to a URL within NetBox. Views are typically defined in `views.py`, and URL patterns in `urls.py`. As an example, let's write a view which displays a random animal and the sound it makes. First, we'll create the view in `views.py`: ```python from django.shortcuts import render @@ -197,7 +218,7 @@ This makes our view accessible at the URL `/plugins/animal-sounds/random-sound/` ## REST API Endpoints -Plugins can declare custom endpoints on NetBox's REST API. These behave very similarly to views, except that instead of rendering arbitrary content using a template, data is returned in JSON format using a serializer. NetBox uses the [Django REST Framework](https://www.django-rest-framework.org/), which makes writing API serializers and views very simple. +Plugins can declare custom endpoints on NetBox's REST API to retrieve or manipulate models or other data. These behave very similarly to views, except that instead of rendering arbitrary content using a template, data is returned in JSON format using a serializer. NetBox uses the [Django REST Framework](https://www.django-rest-framework.org/), which makes writing API serializers and views very simple. First, we'll create a serializer for our `Animal` model, in `api/serializers.py`: From 745ac294a5fa2dbb0530faec2b1d08817e22290b Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Tue, 24 Mar 2020 14:21:08 -0400 Subject: [PATCH 071/124] Tweak plugin template docs --- docs/plugins/development.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/docs/plugins/development.md b/docs/plugins/development.md index 63f1b5de6..9c30fe0b7 100644 --- a/docs/plugins/development.md +++ b/docs/plugins/development.md @@ -21,7 +21,8 @@ Although the specific structure of a plugin is largely left to the discretion of plugin_name/ - plugin_name/ - templates/ - - *.html + - plugin_name/ + - *.html - __init__.py - middleware.py - navigation.py @@ -185,18 +186,22 @@ class RandomAnimalSoundView(View): def get(self, request): animal = Animal.objects.order_by('?').first() - return render(request, 'animal_sound.html', { + return render(request, 'netbox_animal_sounds/animal_sound.html', { 'animal': animal, }) ``` -This view retrieves a random animal from the database and and passes it as a context variable when rendering ta template named `animal_sound.html`. To create this template, create a `templates/` directory within the plugin source directory and save the following: +This view retrieves a random animal from the database and and passes it as a context variable when rendering a template named `animal_sound.html`. To create this template, first create a directory named `templates/netbox_animal_sounds/` within the plugin root directory. We use the plugin's name as a subdirectory to guard against naming collisions with other plugins. Then, create `animal_sound.html`: ```jinja2 {% extends '_base.html' %} {% block content %} -The {{ animal.name }} says {{ animal.sound }} +{% if animal %} + The {{ animal.name }} says {{ animal.sound }} +{% else %} + No animals have been created yet! +{% endif %} {% endblock %} ``` From 579c365808e27f114910ec50c09a0eb14a2bddf3 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Tue, 24 Mar 2020 15:22:57 -0400 Subject: [PATCH 072/124] Extend plugins docs to include nav menu links --- docs/plugins/development.md | 27 ++++++++++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/docs/plugins/development.md b/docs/plugins/development.md index 9c30fe0b7..52f9e106e 100644 --- a/docs/plugins/development.md +++ b/docs/plugins/development.md @@ -6,6 +6,7 @@ Plugins can do a lot, including: * Create Django models to store data in the database * Provide their own "pages" (views) in the web user interface +* Inject template content and navigation links * Establish their own REST API endpoints * Add custom request/response middleware @@ -215,7 +216,7 @@ from django.urls import path from .views import RandomAnimalSoundView urlpatterns = [ - path('random-sound/', RandomAnimalSoundView.as_view()) + path('random-sound/', RandomAnimalSoundView.as_view(), name='random_sound') ] ``` @@ -267,3 +268,27 @@ With these three components in place, we can request `/api/plugins/animal-sounds !!! note This example is provided as a minimal reference implementation only. It does not address authentication, performance, or myriad other concerns that plugin authors should have. + +## Navigation Menu Items + +To make its views easily accessible to users, a plugin can inject items in NetBox's navigation menu. This is done by instantiating NetBox's `PluginNavMenuLink` class. Each instance of this class appears in the navigation menu under the header for its plugin. We'll create a link in the file `navigation.py`: + +```python +from extras.plugins import PluginNavMenuLink + +class RandomSoundLink(PluginNavMenuLink): + link = 'plugins:netbox_animal_sounds:random_sound' + link_text = 'Random sound' +``` + +Once we have our menu item defined, we need to register it in `signals.py`: + +```python +from django.dispatch import receiver +from extras.plugins.signals import register_nav_menu_link_classes +from .navigation import RandomSoundLink + +@receiver(register_nav_menu_link_classes) +def nav_menu_link_classes(**kwargs): + return [RandomSoundLink] +``` From 16b8a45ed6f62f3101e9610af7648a7440ede93b Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Tue, 24 Mar 2020 15:24:14 -0400 Subject: [PATCH 073/124] Get menu header via apps.get_config --- netbox/extras/plugins/__init__.py | 10 +++------- 1 file changed, 3 insertions(+), 7 deletions(-) diff --git a/netbox/extras/plugins/__init__.py b/netbox/extras/plugins/__init__.py index bab798f2f..752c054d5 100644 --- a/netbox/extras/plugins/__init__.py +++ b/netbox/extras/plugins/__init__.py @@ -1,8 +1,7 @@ import collections -import importlib import inspect -from django.apps import AppConfig +from django.apps import AppConfig, apps from django.template.loader import get_template from extras.registry import registry @@ -178,11 +177,8 @@ def register_nav_menu_links(): responses = register_nav_menu_link_classes.send('registration_event') for receiver, response in responses: - # Import the app config for the plugin to get the name to be used as the nav menu section text - module = importlib.import_module(receiver.__module__.split('.')[0]) - default_app_config = getattr(module, 'default_app_config') - module, app_config = default_app_config.rsplit('.', 1) - app_config = getattr(importlib.import_module(module), app_config) + # Derive menu section header from plugin name + app_config = apps.get_app_config(receiver.__module__.split('.')[0]) section_name = getattr(app_config, 'verbose_name', app_config.name) if not isinstance(response, list): From 2a47bb8b547115bf95c4bab9efcb26f3df672498 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Tue, 24 Mar 2020 16:20:47 -0400 Subject: [PATCH 074/124] Rename url_slug to base_url --- docs/plugins/development.md | 4 ++-- netbox/extras/plugins/__init__.py | 2 +- netbox/extras/plugins/urls.py | 7 +++---- netbox/extras/plugins/views.py | 2 +- 4 files changed, 7 insertions(+), 8 deletions(-) diff --git a/docs/plugins/development.md b/docs/plugins/development.md index 52f9e106e..67abeb8d5 100644 --- a/docs/plugins/development.md +++ b/docs/plugins/development.md @@ -84,7 +84,7 @@ class AnimalSoundsConfig(PluginConfig): version = '0.1' author = 'Author Name' description = 'Show animals and the sounds they make' - url_slug = 'animal-sounds' + base_url = 'animal-sounds' required_settings = [] default_settings = { 'loud': False @@ -99,7 +99,7 @@ class AnimalSoundsConfig(PluginConfig): * `verbose_name` - Human-friendly name * `version` - Plugin version * `description` - Brief description of the plugin's purpose -* `url_slug` - Base path to use for plugin URLs (optional). If not specified, the project's `name` will be used. +* `base_url` - Base path to use for plugin URLs (optional). If not specified, the project's `name` will be used. * `required_settings`: A list of configuration parameters that **must** be defined by the user * `default_settings`: A dictionary of configuration parameter names and their default values * `min_version`: Minimum version of NetBox with which the plugin is compatible diff --git a/netbox/extras/plugins/__init__.py b/netbox/extras/plugins/__init__.py index 752c054d5..b88af8c1c 100644 --- a/netbox/extras/plugins/__init__.py +++ b/netbox/extras/plugins/__init__.py @@ -23,7 +23,7 @@ class PluginConfig(AppConfig): version = '' # Root URL path under /plugins. If not set, the plugin's label will be used. - url_slug = None + base_url = None # Minimum/maximum compatible versions of NetBox min_version = None diff --git a/netbox/extras/plugins/urls.py b/netbox/extras/plugins/urls.py index 1f27ad6ac..064967677 100644 --- a/netbox/extras/plugins/urls.py +++ b/netbox/extras/plugins/urls.py @@ -13,13 +13,13 @@ plugin_api_patterns = [] for plugin in settings.PLUGINS: app = apps.get_app_config(plugin) - url_slug = getattr(app, 'url_slug') or app.label + base_url = getattr(app, 'base_url') or app.label # Check if the plugin specifies any URLs try: urlpatterns = import_string(f"{plugin}.urls.urlpatterns") plugin_patterns.append( - path(f"{url_slug}/", include((urlpatterns, app.label))) + path(f"{base_url}/", include((urlpatterns, app.label))) ) except ImportError: pass @@ -27,9 +27,8 @@ for plugin in settings.PLUGINS: # Check if the plugin specifies any API URLs try: urlpatterns = import_string(f"{plugin}.api.urls.urlpatterns") - app_name = f"{url_slug}-api" plugin_api_patterns.append( - path(f"{url_slug}/", include((urlpatterns, app_name))) + path(f"{base_url}/", include((urlpatterns, f"{app.label}-api"))) ) except ImportError: pass diff --git a/netbox/extras/plugins/views.py b/netbox/extras/plugins/views.py index 690a708b6..67bc72101 100644 --- a/netbox/extras/plugins/views.py +++ b/netbox/extras/plugins/views.py @@ -69,7 +69,7 @@ class PluginsAPIRootView(APIView): return None try: - entry = (getattr(app_config, 'url_slug', app_config.label), reverse( + entry = (getattr(app_config, 'base_url', app_config.label), reverse( f"plugins-api:{api_app_name}:api-root", request=request, format=format From c1f2ad90efa0756a6f871c80fb340a83c3944944 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Wed, 25 Mar 2020 11:32:50 -0400 Subject: [PATCH 075/124] Simplify the mechanism for plugins to register navigation menu items --- netbox/extras/plugins/__init__.py | 86 ++++++++++----------- netbox/extras/plugins/context_processors.py | 6 +- netbox/extras/plugins/signals.py | 8 -- 3 files changed, 45 insertions(+), 55 deletions(-) diff --git a/netbox/extras/plugins/__init__.py b/netbox/extras/plugins/__init__.py index b88af8c1c..d43c0cf5c 100644 --- a/netbox/extras/plugins/__init__.py +++ b/netbox/extras/plugins/__init__.py @@ -1,11 +1,16 @@ import collections import inspect -from django.apps import AppConfig, apps +from django.apps import AppConfig from django.template.loader import get_template +from django.utils.module_loading import import_string from extras.registry import registry -from .signals import register_detail_page_content_classes, register_nav_menu_link_classes +from .signals import register_detail_page_content_classes + + +# Initialize plugin registry stores +registry['plugin_nav_menu_links'] = {} # @@ -41,6 +46,23 @@ class PluginConfig(AppConfig): # Caching configuration caching_config = {} + def ready(self): + + # Register navigation menu items (if defined) + register_menu_items(self.verbose_name, self.get_menu_items()) + + def get_menu_items(self): + """ + Default method to import navigation menu items for a plugin from the default location (menu_items in a + file named navigation.py). This method may be overridden by a plugin author to import menu items from + a different location if needed. + """ + try: + menu_items = import_string(f"{self.__module__}.navigation.menu_items") + return menu_items + except ImportError: + return [] + # # Template content injection @@ -138,7 +160,7 @@ def get_content_classes(model): # -# Nav menu links +# Navigation menu links # class PluginNavMenuLink: @@ -149,10 +171,14 @@ class PluginNavMenuLink: Links are specified as Django reverse URL strings. Buttons are each specified as a list of PluginNavMenuButton instances. """ - link = None - link_text = None - link_permission = None - buttons = [] + def __init__(self, link, link_text, permission=None, buttons=None): + self.link = link + self.link_text = link_text + self.link_permission = permission + if buttons is None: + self.buttons = [] + else: + self.buttons = buttons class PluginNavMenuButton: @@ -168,42 +194,16 @@ class PluginNavMenuButton: self.permission = permission -def register_nav_menu_links(): +def register_menu_items(section_name, class_list): """ - Helper method that populates the registry with all nav menu link classes that have been registered by plugins + Register a list of PluginNavMenuLink instances for a given menu section (e.g. plugin name) """ - registry['plugin_nav_menu_link_classes'] = {} + # Validation + for menu_link in class_list: + if not isinstance(menu_link, PluginNavMenuLink): + raise TypeError(f"{menu_link} must be an instance of extras.plugins.PluginNavMenuLink") + for button in menu_link.buttons: + if not isinstance(button, PluginNavMenuButton): + raise TypeError(f"{button} must be an instance of extras.plugins.PluginNavMenuButton") - responses = register_nav_menu_link_classes.send('registration_event') - for receiver, response in responses: - - # Derive menu section header from plugin name - app_config = apps.get_app_config(receiver.__module__.split('.')[0]) - section_name = getattr(app_config, 'verbose_name', app_config.name) - - if not isinstance(response, list): - response = [response] - for link_class in response: - if not inspect.isclass(link_class): - raise TypeError('Plugin nav menu link class {} was passes as an instance!'.format(link_class)) - if not issubclass(link_class, PluginNavMenuLink): - raise TypeError('{} is not a subclass of extras.plugins.PluginNavMenuLink!'.format(link_class)) - if link_class.link is None or link_class.link_text is None: - raise TypeError('Plugin nav menu link {} must specify at least link and link_text'.format(link_class)) - - for button in link_class.buttons: - if not isinstance(button, PluginNavMenuButton): - raise TypeError('{} must be an instance of PluginNavMenuButton!'.format(button)) - - registry['plugin_nav_menu_link_classes'][section_name] = response - - -def get_nav_menu_link_classes(): - """ - Return the list of all registered nav menu link classes. - Populate the registry if it is empty. - """ - if 'plugin_nav_menu_link_classes' not in registry: - register_nav_menu_links() - - return registry['plugin_nav_menu_link_classes'] + registry['plugin_nav_menu_links'][section_name] = class_list diff --git a/netbox/extras/plugins/context_processors.py b/netbox/extras/plugins/context_processors.py index 14b05b874..fbb4e8c03 100644 --- a/netbox/extras/plugins/context_processors.py +++ b/netbox/extras/plugins/context_processors.py @@ -1,12 +1,10 @@ -from . import get_nav_menu_link_classes +from extras.registry import registry def nav_menu_links(request): """ Retrieve and expose all plugin registered nav links """ - nav_menu_links = get_nav_menu_link_classes() - return { - 'plugin_nav_menu_links': nav_menu_links + 'plugin_nav_menu_links': registry['plugin_nav_menu_links'] } diff --git a/netbox/extras/plugins/signals.py b/netbox/extras/plugins/signals.py index 7ebb549db..fbe30a310 100644 --- a/netbox/extras/plugins/signals.py +++ b/netbox/extras/plugins/signals.py @@ -32,11 +32,3 @@ This signal collects template content classes which render content for object de register_detail_page_content_classes = PluginSignal( providing_args=[] ) - - -""" -This signal collects nav menu link classes -""" -register_nav_menu_link_classes = PluginSignal( - providing_args=[] -) From 9ea30c057fc8488abe200fd1d0a824cf9c173cf6 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Wed, 25 Mar 2020 13:51:37 -0400 Subject: [PATCH 076/124] Replace get_menu_items() with static attribute --- netbox/extras/plugins/__init__.py | 18 +++++++----------- 1 file changed, 7 insertions(+), 11 deletions(-) diff --git a/netbox/extras/plugins/__init__.py b/netbox/extras/plugins/__init__.py index d43c0cf5c..40db432e3 100644 --- a/netbox/extras/plugins/__init__.py +++ b/netbox/extras/plugins/__init__.py @@ -46,22 +46,18 @@ class PluginConfig(AppConfig): # Caching configuration caching_config = {} + # Default integration paths. Plugin authors can override these to customize the paths to + # integrated components. + menu_items = 'navigation.menu_items' + def ready(self): # Register navigation menu items (if defined) - register_menu_items(self.verbose_name, self.get_menu_items()) - - def get_menu_items(self): - """ - Default method to import navigation menu items for a plugin from the default location (menu_items in a - file named navigation.py). This method may be overridden by a plugin author to import menu items from - a different location if needed. - """ try: - menu_items = import_string(f"{self.__module__}.navigation.menu_items") - return menu_items + menu_items = import_string(f"{self.__module__}.{self.menu_items}") + register_menu_items(self.verbose_name, menu_items) except ImportError: - return [] + pass # From d0edd9d5c1f436386daf6bb658f09f7015c3bc1f Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Wed, 25 Mar 2020 14:33:32 -0400 Subject: [PATCH 077/124] Update documentation for #4401 --- docs/plugins/development.md | 41 ++++++++++++------- netbox/extras/plugins/__init__.py | 2 +- .../templates/inc/plugin_nav_menu_items.html | 4 +- 3 files changed, 30 insertions(+), 17 deletions(-) diff --git a/docs/plugins/development.md b/docs/plugins/development.md index 67abeb8d5..71ff255cf 100644 --- a/docs/plugins/development.md +++ b/docs/plugins/development.md @@ -106,6 +106,7 @@ class AnimalSoundsConfig(PluginConfig): * `max_version`: Maximum version of NetBox with which the plugin is compatible * `middleware`: A list of middleware classes to append after NetBox's build-in middleware. * `caching_config`: Plugin-specific cache configuration +* `menu_items`: The dotted path to the list of menu items provided by the plugin (default: `navigation.menu_items`) ### Install the Plugin for Development @@ -271,24 +272,36 @@ With these three components in place, we can request `/api/plugins/animal-sounds ## Navigation Menu Items -To make its views easily accessible to users, a plugin can inject items in NetBox's navigation menu. This is done by instantiating NetBox's `PluginNavMenuLink` class. Each instance of this class appears in the navigation menu under the header for its plugin. We'll create a link in the file `navigation.py`: +To make its views easily accessible to users, a plugin can inject items in NetBox's navigation menu. Menu items are added by defining a list of PluginNavMenuLink instances. By default, this should be a variable named `menu_items` in the file `navigations.py`. An example is shown below. ```python -from extras.plugins import PluginNavMenuLink +from extras.plugins import PluginNavMenuButton, PluginNavMenuLink +from utilities.choices import ButtonColorChoices -class RandomSoundLink(PluginNavMenuLink): - link = 'plugins:netbox_animal_sounds:random_sound' - link_text = 'Random sound' +menu_items = ( + PluginNavMenuLink( + link='plugins:netbox_animal_sounds:random_sound', + link_text='Random sound', + buttons=( + PluginNavMenuButton('home', 'Button A', 'fa-info', ButtonColorChoices.BLUE), + PluginNavMenuButton('home', 'Button B', 'fa-warning', ButtonColorChoices.GREEN), + ) + ), +) ``` -Once we have our menu item defined, we need to register it in `signals.py`: +A `PluginNavMenuLink` has the following attributes: -```python -from django.dispatch import receiver -from extras.plugins.signals import register_nav_menu_link_classes -from .navigation import RandomSoundLink +* `link` - The name of the URL path to which this menu item links +* `link_text` - The text presented to the user +* `permission` - The name of the permission required to display this link (optional) +* `buttons` - An iterable of PluginNavMenuButton instances to display (optional) -@receiver(register_nav_menu_link_classes) -def nav_menu_link_classes(**kwargs): - return [RandomSoundLink] -``` + +A `PluginNavMenuButton` has the following attributes: + +* `link` - The name of the URL path to which this menu item links +* `title` - The tooltip text (displayed when the mouse hovers over the button) +* `color` - Button color (one of the choices provided by `ButtonColorChoices`) +* `icon_class` - Button icon CSS class +* `permission` - The name of the permission required to display this button (optional) diff --git a/netbox/extras/plugins/__init__.py b/netbox/extras/plugins/__init__.py index 40db432e3..a0ebec7e9 100644 --- a/netbox/extras/plugins/__init__.py +++ b/netbox/extras/plugins/__init__.py @@ -170,7 +170,7 @@ class PluginNavMenuLink: def __init__(self, link, link_text, permission=None, buttons=None): self.link = link self.link_text = link_text - self.link_permission = permission + self.permission = permission if buttons is None: self.buttons = [] else: diff --git a/netbox/templates/inc/plugin_nav_menu_items.html b/netbox/templates/inc/plugin_nav_menu_items.html index b79044273..55aab84c1 100644 --- a/netbox/templates/inc/plugin_nav_menu_items.html +++ b/netbox/templates/inc/plugin_nav_menu_items.html @@ -4,8 +4,8 @@ {% for section_name, link_items in plugin_nav_menu_links.items %}
  • {{ section_name }}
    • {% for link_item in link_items %} - {% if link_item.link_permission %} - + {% if link_item.permission %} + {% else %}
  • {% endif %} From 68a0e76ca61d233bd5efc39565c99a7215b04b91 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Wed, 25 Mar 2020 16:06:00 -0400 Subject: [PATCH 078/124] Rework template content registration to work like menu items --- netbox/extras/plugins/__init__.py | 50 +++++++++++---------------- netbox/extras/plugins/signals.py | 12 ++----- netbox/extras/templatetags/plugins.py | 7 ++-- 3 files changed, 27 insertions(+), 42 deletions(-) diff --git a/netbox/extras/plugins/__init__.py b/netbox/extras/plugins/__init__.py index a0ebec7e9..cbe846632 100644 --- a/netbox/extras/plugins/__init__.py +++ b/netbox/extras/plugins/__init__.py @@ -6,10 +6,10 @@ from django.template.loader import get_template from django.utils.module_loading import import_string from extras.registry import registry -from .signals import register_detail_page_content_classes # Initialize plugin registry stores +registry['plugin_template_content_classes'] = collections.defaultdict(list) registry['plugin_nav_menu_links'] = {} @@ -48,10 +48,18 @@ class PluginConfig(AppConfig): # Default integration paths. Plugin authors can override these to customize the paths to # integrated components. + template_content_classes = 'template_content.template_content_classes' menu_items = 'navigation.menu_items' def ready(self): + # Register template content + try: + class_list = import_string(f"{self.__module__}.{self.template_content_classes}") + register_template_content_classes(class_list) + except ImportError: + pass + # Register navigation menu items (if defined) try: menu_items = import_string(f"{self.__module__}.{self.menu_items}") @@ -67,7 +75,7 @@ class PluginConfig(AppConfig): class PluginTemplateContent: """ This class is used to register plugin content to be injected into core NetBox templates. - It contains methods that are overriden by plugin authors to return template content. + It contains methods that are overridden by plugin authors to return template content. The `model` attribute on the class defines the which model detail page this class renders content for. It should be set as a string in the form '.'. @@ -123,36 +131,20 @@ class PluginTemplateContent: raise NotImplementedError -def register_content_classes(): +def register_template_content_classes(class_list): """ - Helper method that populates the registry with all template content classes that have been registered by plugins + Register a list of PluginTemplateContent classes """ - registry['plugin_template_content_classes'] = collections.defaultdict(list) + # Validation + for template_content_class in class_list: + if not inspect.isclass(template_content_class): + raise TypeError('Plugin content class {} was passes as an instance!'.format(template_content_class)) + if not issubclass(template_content_class, PluginTemplateContent): + raise TypeError('{} is not a subclass of extras.plugins.PluginTemplateContent!'.format(template_content_class)) + if template_content_class.model is None: + raise TypeError('Plugin content class {} does not define a valid model!'.format(template_content_class)) - responses = register_detail_page_content_classes.send('registration_event') - for receiver, response in responses: - if not isinstance(response, list): - response = [response] - for template_class in response: - if not inspect.isclass(template_class): - raise TypeError('Plugin content class {} was passes as an instance!'.format(template_class)) - if not issubclass(template_class, PluginTemplateContent): - raise TypeError('{} is not a subclass of extras.plugins.PluginTemplateContent!'.format(template_class)) - if template_class.model is None: - raise TypeError('Plugin content class {} does not define a valid model!'.format(template_class)) - - registry['plugin_template_content_classes'][template_class.model].append(template_class) - - -def get_content_classes(model): - """ - Given a model string, return the list of all registered template content classes. - Populate the registry if it is empty. - """ - if 'plugin_template_content_classes' not in registry: - register_content_classes() - - return registry['plugin_template_content_classes'].get(model, []) + registry['plugin_template_content_classes'][template_content_class.model].append(template_content_class) # diff --git a/netbox/extras/plugins/signals.py b/netbox/extras/plugins/signals.py index fbe30a310..165b5b9cc 100644 --- a/netbox/extras/plugins/signals.py +++ b/netbox/extras/plugins/signals.py @@ -3,7 +3,9 @@ from django.dispatch.dispatcher import NO_RECEIVERS class PluginSignal(django.dispatch.Signal): - + """ + FUTURE USE + """ def _sorted_receivers(self, sender): orig_list = self._live_receivers(sender) sorted_list = sorted( @@ -24,11 +26,3 @@ class PluginSignal(django.dispatch.Signal): response = receiver(signal=self, sender=sender, **kwargs) responses.append((receiver, response)) return responses - - -""" -This signal collects template content classes which render content for object detail pages -""" -register_detail_page_content_classes = PluginSignal( - providing_args=[] -) diff --git a/netbox/extras/templatetags/plugins.py b/netbox/extras/templatetags/plugins.py index 384b08b6a..d2b10669a 100644 --- a/netbox/extras/templatetags/plugins.py +++ b/netbox/extras/templatetags/plugins.py @@ -1,9 +1,7 @@ from django import template as template_ -from django.template.loader import get_template from django.utils.safestring import mark_safe -from extras.plugins import get_content_classes - +from extras.registry import registry register = template_.Library() @@ -15,7 +13,8 @@ def _get_registered_content(obj, method, context): """ html = '' - plugin_template_classes = get_content_classes(obj._meta.label_lower) + model_name = obj._meta.label_lower + plugin_template_classes = registry['plugin_template_content_classes'].get(model_name, []) for plugin_template_class in plugin_template_classes: plugin_template_renderer = plugin_template_class(obj, context) try: From 5540079e81edeeb62dd0dc39e4517d8e733b0996 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Wed, 25 Mar 2020 16:25:44 -0400 Subject: [PATCH 079/124] Add documentation for PluginTemplateContent --- docs/plugins/development.md | 38 +++++++++++++++++++++++++++++++ netbox/extras/plugins/__init__.py | 4 ++-- 2 files changed, 40 insertions(+), 2 deletions(-) diff --git a/docs/plugins/development.md b/docs/plugins/development.md index 71ff255cf..341f53624 100644 --- a/docs/plugins/development.md +++ b/docs/plugins/development.md @@ -106,6 +106,7 @@ class AnimalSoundsConfig(PluginConfig): * `max_version`: Maximum version of NetBox with which the plugin is compatible * `middleware`: A list of middleware classes to append after NetBox's build-in middleware. * `caching_config`: Plugin-specific cache configuration +* `template_content`: The dotted path to the list of template content classes (default: `template_content.template_contnet`) * `menu_items`: The dotted path to the list of menu items provided by the plugin (default: `navigation.menu_items`) ### Install the Plugin for Development @@ -305,3 +306,40 @@ A `PluginNavMenuButton` has the following attributes: * `color` - Button color (one of the choices provided by `ButtonColorChoices`) * `icon_class` - Button icon CSS class * `permission` - The name of the permission required to display this button (optional) + +## Template Content + +Plugins can inject custom content into certain areas of the detail views of applicable models. This is accomplished by subclassing `PluginTemplateContent`, designating a particular NetBox model, and defining the desired methods to render custom content. Four methods are available: + +* `left_page()` - Inject content on the left side of the page +* `right_page()` - Inject content on the right side of the page +* `full_width_page()` - Inject content across the entire bottom of the page +* `buttons()` - Add buttons to the top of the page + +Each of these methods must return HTML content suitable for inclusion in the object template. Two instance attributes are available for context: + +* `self.obj` - The object being viewed +* `self.context` - The current template context + +Additionally, a `render()` method is available for convenience. This method accepts the name of a template to render, and any additional context data. Its use is optional, however. + +Declared subclasses should be gathered into a list or tuple for integration with NetBox. By default, NetBox looks for an iterable named `template_content` within a `template_content.py` file. (This can be overridden by setting `template_content` to a custom value on the plugin's PluginConfig.) An example is below. + +```python +from extras.plugins import PluginTemplateContent + +class AddSiteAnimal(PluginTemplateContent): + model = 'dcim.site' + + def full_width_page(self): + return self.render('netbox_animal_sounds/site.html') + +class AddRackAnimal(PluginTemplateContent): + model = 'dcim.rack' + + def left_page(self): + extra_data = {'foo': 123} + return self.render('netbox_animal_sounds/rack.html', extra_data) + +template_content_classes = [AddSiteAnimal, AddRackAnimal] +``` diff --git a/netbox/extras/plugins/__init__.py b/netbox/extras/plugins/__init__.py index cbe846632..0a5f8de37 100644 --- a/netbox/extras/plugins/__init__.py +++ b/netbox/extras/plugins/__init__.py @@ -88,8 +88,8 @@ class PluginTemplateContent: def render(self, template, extra_context=None): """ - Convenience menthod for rendering the provided template name. The detail page object is automatically - passed into the template context as `obj` and the origional detail page's context is available as + Convenience method for rendering the provided template name. The detail page object is automatically + passed into the template context as `obj` and the original detail page's context is available as `obj_context`. An additional context dictionary may be passed as `extra_context`. """ context = { From 68ef5dd2a4b663294e81326858574a2c2aedc4ba Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Thu, 26 Mar 2020 11:09:20 -0400 Subject: [PATCH 080/124] Revised plugins documentation --- docs/configuration/optional-settings.md | 14 ++++- docs/plugins/development.md | 79 ++++++++++++++++--------- docs/plugins/index.md | 25 +++++--- 3 files changed, 81 insertions(+), 37 deletions(-) diff --git a/docs/configuration/optional-settings.md b/docs/configuration/optional-settings.md index e76dae231..c4d3c0897 100644 --- a/docs/configuration/optional-settings.md +++ b/docs/configuration/optional-settings.md @@ -303,7 +303,19 @@ Determine how many objects to display per page within each list of objects. Default: Empty -This parameter holds configuration settings for individual NetBox plugins. It is defined as a dictionary, with each key using the name of an installed plugin. The specific parameters supported are unique to each plugin: Reference the plugin's documentation to determine the supported parameters. +This parameter holds configuration settings for individual NetBox plugins. It is defined as a dictionary, with each key using the name of an installed plugin. The specific parameters supported are unique to each plugin: Reference the plugin's documentation to determine the supported parameters. An example configuration is shown below: + +```python +PLUGINS_CONFIG = { + 'plugin1': { + 'foo': 123, + 'bar': True + }, + 'plugin2': { + 'foo': 456, + }, +} +``` Note that `PLUGINS_ENABLED` must be set to True for this to take effect. diff --git a/docs/plugins/development.md b/docs/plugins/development.md index 341f53624..4a82a3e8d 100644 --- a/docs/plugins/development.md +++ b/docs/plugins/development.md @@ -10,7 +10,7 @@ Plugins can do a lot, including: * Establish their own REST API endpoints * Add custom request/response middleware -However, keep in mind that each piece of functionality is entirely optional. For example, if your plugin merely adds a piece of middleware or an API endpoint, there's no need to define a new model. +However, keep in mind that each piece of functionality is entirely optional. For example, if your plugin merely adds a piece of middleware or an API endpoint for existing data, there's no need to define any new models. ## Initial Setup @@ -35,9 +35,9 @@ plugin_name/ - setup.py ``` -The top level is the project root, which is typically synonymous with the git repository. Within the root should exist several files: +The top level is the project root. Immediately within the root should exist several items: -* `setup.py` - This is a standard Python installation script used to install the plugin package within the Python environment. +* `setup.py` - This is a standard installation script used to install the plugin package within the Python environment. * `README` - A brief introduction to your plugin, how to install and configure it, where to find help, and any other pertinent information. It is recommended to write README files using a markup language such as Markdown. * The plugin source directory, with the same name as your plugin. @@ -45,7 +45,7 @@ The plugin source directory contains all of the actual Python code and other res ### Create setup.py -`setup.py` is the [setup script](https://docs.python.org/3.6/distutils/setupscript.html) we'll use to install our plugin once it's finished. This script essentially just calls the setuptools library's `setup()` function to create a Python distribution package. We can pass a number of keyword arguments to information the package creation as well as to provide metadata about the plugin. An example `setup.py` is below: +`setup.py` is the [setup script](https://docs.python.org/3.6/distutils/setupscript.html) we'll use to install our plugin once it's finished. The primary function of this script is to call the setuptools library's `setup()` function to create a Python distribution package. We can pass a number of keyword arguments to inform the package creation as well as to provide metadata about the plugin. An example `setup.py` is below: ```python from setuptools import find_packages, setup @@ -67,13 +67,11 @@ setup( ) ``` -Many of these are self-explanatory, but for more information, see the [setuptools documentation](https://setuptools.readthedocs.io/en/latest/setuptools.html). - -The key requirement for a NetBox plugin is the presence of an entry point for `netbox_plugins` pointing to the `PluginConfig` subclass, which we'll define next. +Many of these are self-explanatory, but for more information, see the [setuptools documentation](https://setuptools.readthedocs.io/en/latest/setuptools.html). The key requirement for a NetBox plugin is the presence of an entry point for `netbox_plugins` pointing to the `PluginConfig` subclass, which we'll create next. ### Define a PluginConfig -The `PluginConfig` class is a NetBox-specific wrapper around Django's built-in [`AppConfig`](https://docs.djangoproject.com/en/stable/ref/applications/). It is used to declare NetBox plugin functionality within a Python package. Each plugin should provide its own subclass, defining its name, metadata, and default and required configuration parameters. An example is below: +The `PluginConfig` class is a NetBox-specific wrapper around Django's built-in [`AppConfig`](https://docs.djangoproject.com/en/stable/ref/applications/) class. It is used to declare NetBox plugin functionality within a Python package. Each plugin should provide its own subclass, defining its name, metadata, and default and required configuration parameters. An example is below: ```python from extras.plugins import PluginConfig @@ -94,24 +92,24 @@ class AnimalSoundsConfig(PluginConfig): #### PluginConfig Attributes * `name` - Raw plugin name; same as the plugin's source directory +* `verbose_name` - Human-friendly name for the plugin +* `version` - Current release ([semantic versioning](https://semver.org/) is encouraged) +* `description` - Brief description of the plugin's purpose * `author_name` - Name of plugin's author * `author_email` - Author's public email address -* `verbose_name` - Human-friendly name -* `version` - Plugin version -* `description` - Brief description of the plugin's purpose * `base_url` - Base path to use for plugin URLs (optional). If not specified, the project's `name` will be used. -* `required_settings`: A list of configuration parameters that **must** be defined by the user +* `required_settings`: A list of any configuration parameters that **must** be defined by the user * `default_settings`: A dictionary of configuration parameter names and their default values * `min_version`: Minimum version of NetBox with which the plugin is compatible * `max_version`: Maximum version of NetBox with which the plugin is compatible -* `middleware`: A list of middleware classes to append after NetBox's build-in middleware. +* `middleware`: A list of middleware classes to append after NetBox's build-in middleware * `caching_config`: Plugin-specific cache configuration * `template_content`: The dotted path to the list of template content classes (default: `template_content.template_contnet`) * `menu_items`: The dotted path to the list of menu items provided by the plugin (default: `navigation.menu_items`) ### Install the Plugin for Development -To ease development, it is recommended to go ahead and install the plugin at this point using setuptools' "develop" mode. This will create symbolic links within your Python environment to the plugin development directory. Call `setup.py` from the plugin's root directory with the `develop` argument (instead of `install`): +To ease development, it is recommended to go ahead and install the plugin at this point using setuptools' `develop` mode. This will create symbolic links within your Python environment to the plugin development directory. Call `setup.py` from the plugin's root directory with the `develop` argument (instead of `install`): ```no-highlight $ python setup.py develop @@ -119,9 +117,9 @@ $ python setup.py develop ## Database Models -If your plugin introduces a new type of object in NetBox, you'll probably want to create a Django model for it. A model is essentially a Python representation of a database table, with attributes that represent individual columns. Model instances can be created, manipulated, and deleted using the [Django ORM](https://docs.djangoproject.com/en/stable/topics/db/). Models are typically defined within a plugin's `models.py` file, though this is not a strict requirement. +If your plugin introduces a new type of object in NetBox, you'll probably want to create a [Django model](https://docs.djangoproject.com/en/stable/topics/db/models/) for it. A model is essentially a Python representation of a database table, with attributes that represent individual columns. Model instances can be created, manipulated, and deleted using [queries](https://docs.djangoproject.com/en/stable/topics/db/queries/). Models must be defined within a file named `models.py`. -Below is a simple example `models.py` file showing a model with two character fields: +Below is an example `models.py` file containing a model with two character fields: ```python from django.db import models @@ -134,7 +132,7 @@ class Animal(models.Model): return self.name ``` -Once you have defined the model(s) for your plugin, you'll need to create the necessary database schema migrations as well. This can be done using the Django `makemigrations` management command. +Once you have defined the model(s) for your plugin, you'll need to create the database schema migrations. A migration file is essentially a set of instructions for manipulating the PostgreSQL database to support your new model, or to alter existing models. Creating migrations can usually be done automatically using Django's `makemigrations` management command. !!! note A plugin must be installed before it can be used with Django management commands. If you skipped this step above, run `python setup.py develop` from the plugin's root directory. @@ -146,7 +144,7 @@ Migrations for 'netbox_animal_sounds': - Create model Animal ``` -Once you're satisfied the migration is ready and all model changes have been accounted for, we can apply it locally with the `migrate` command: +Next, we can apply the migration to the database with the `migrate` command: ```no-highlight $ ./manage.py migrate netbox_animal_sounds @@ -156,17 +154,18 @@ Running migrations: Applying netbox_animal_sounds.0001_initial... OK ``` -For more information on database migrations, see the [Django documentation](https://docs.djangoproject.com/en/stable/topics/migrations/). +For more background on schema migrations, see the [Django documentation](https://docs.djangoproject.com/en/stable/topics/migrations/). ### Using the Django Admin Interface -Plugins can optionally expose their models via Django's built-in [administrative interface](https://docs.djangoproject.com/en/stable/ref/contrib/admin/). This can greatly improve troubleshooting ability, particularly during development. An example `admin.py` file for the above model is shown below: +Plugins can optionally expose their models via Django's built-in [administrative interface](https://docs.djangoproject.com/en/stable/ref/contrib/admin/). This can greatly improve troubleshooting ability, particularly during development. To expose a model, simply register it with Netbox's `admin_site` object. An example `admin.py` file for the above model is shown below: ```python from django.contrib import admin +from netbox.admin import admin_site from .models import Animal -@admin.register(Animal) +@admin.register(Animal, site=admin_site) class AnimalAdmin(admin.ModelAdmin): list_display = ('name', 'sound') ``` @@ -177,7 +176,7 @@ This will display the plugin and its model in the admin UI. Staff users can crea ## Views -If your plugin needs its own page or pages in the NetBox web UI, you'll need to define views. A view is a particular page tied to a URL within NetBox. Views are typically defined in `views.py`, and URL patterns in `urls.py`. As an example, let's write a view which displays a random animal and the sound it makes. First, we'll create the view in `views.py`: +If your plugin needs its own page or pages in the NetBox web UI, you'll need to define views. A view is a particular page tied to a URL within NetBox, which renders content using a template. Views are typically defined in `views.py`, and URL patterns in `urls.py`. As an example, let's write a view which displays a random animal and the sound it makes. First, we'll create the view in `views.py`: ```python from django.shortcuts import render @@ -187,6 +186,7 @@ from .models import Animal class RandomAnimalSoundView(View): def get(self, request): + # Retrieve a random animal animal = Animal.objects.order_by('?').first() return render(request, 'netbox_animal_sounds/animal_sound.html', { @@ -194,7 +194,7 @@ class RandomAnimalSoundView(View): }) ``` -This view retrieves a random animal from the database and and passes it as a context variable when rendering a template named `animal_sound.html`. To create this template, first create a directory named `templates/netbox_animal_sounds/` within the plugin root directory. We use the plugin's name as a subdirectory to guard against naming collisions with other plugins. Then, create `animal_sound.html`: +This view retrieves a random animal from the database and and passes it as a context variable when rendering a template named `animal_sound.html`, which doesn't exist yet. To create this template, first create a directory named `templates/netbox_animal_sounds/` within the plugin source directory. (We use the plugin's name as a subdirectory to guard against naming collisions with other plugins.) Then, create `animal_sound.html`: ```jinja2 {% extends '_base.html' %} @@ -208,10 +208,12 @@ This view retrieves a random animal from the database and and passes it as a con {% endblock %} ``` +The first line of the template instructs Django to extend the NetBox base template and inject our custom content within its `content` block. + !!! note Django renders templates with its own custom [template language](https://docs.djangoproject.com/en/stable/topics/templates/#the-django-template-language). This is very similar to Jinja2, however there are some important differences to be aware of. -Finally, to make the view accessible to users, we need to register a URL for it. We do this in `urls.py`: +Finally, to make the view accessible to users, we need to register a URL for it. We do this in `urls.py` by defining a `urlpatterns` variable containing a list of paths. ```python from django.urls import path @@ -222,6 +224,12 @@ urlpatterns = [ ] ``` +A URL pattern has three components: + +* `route` - The unique portion of the URL dedicated to this view +* `view` - The view itself +* `name` - A short name used to identify the URL path internally + This makes our view accessible at the URL `/plugins/animal-sounds/random-sound/`. (Remember, our `AnimalSoundsConfig` class sets our plugin's base URL to `animal-sounds`.) Viewing this URL should show the base NetBox template with our custom content inside it. ## REST API Endpoints @@ -273,7 +281,7 @@ With these three components in place, we can request `/api/plugins/animal-sounds ## Navigation Menu Items -To make its views easily accessible to users, a plugin can inject items in NetBox's navigation menu. Menu items are added by defining a list of PluginNavMenuLink instances. By default, this should be a variable named `menu_items` in the file `navigations.py`. An example is shown below. +To make its views easily accessible to users, a plugin can inject items in NetBox's navigation menu under the "Plugins" header. Menu items are added by defining a list of PluginNavMenuLink instances. By default, this should be a variable named `menu_items` in the file `navigation.py`. An example is shown below. ```python from extras.plugins import PluginNavMenuButton, PluginNavMenuLink @@ -301,7 +309,7 @@ A `PluginNavMenuLink` has the following attributes: A `PluginNavMenuButton` has the following attributes: -* `link` - The name of the URL path to which this menu item links +* `link` - The name of the URL path to which this button links * `title` - The tooltip text (displayed when the mouse hovers over the button) * `color` - Button color (one of the choices provided by `ButtonColorChoices`) * `icon_class` - Button icon CSS class @@ -321,7 +329,7 @@ Each of these methods must return HTML content suitable for inclusion in the obj * `self.obj` - The object being viewed * `self.context` - The current template context -Additionally, a `render()` method is available for convenience. This method accepts the name of a template to render, and any additional context data. Its use is optional, however. +Additionally, a `render()` method is available for convenience. This method accepts the name of a template to render, and any additional context data you want to pass. Its use is optional, however. Declared subclasses should be gathered into a list or tuple for integration with NetBox. By default, NetBox looks for an iterable named `template_content` within a `template_content.py` file. (This can be overridden by setting `template_content` to a custom value on the plugin's PluginConfig.) An example is below. @@ -343,3 +351,20 @@ class AddRackAnimal(PluginTemplateContent): template_content_classes = [AddSiteAnimal, AddRackAnimal] ``` + +## Caching Configuration + +By default, all query operations within a plugin are cached. To change this, define a caching configuration under the PluginConfig class' `caching_config` attribute. An example configuration is below: + +```python +class MyPluginConfig(PluginConfig): + ... + caching_config = { + 'my_plugin.foo': { + 'ops': 'get', + 'timeout': 60 * 15, + }, + } +``` + +See the [django-cacheops](https://github.com/Suor/django-cacheops) documentation for more detail on configuring caching. diff --git a/docs/plugins/index.md b/docs/plugins/index.md index 7e6913329..f2ea69719 100644 --- a/docs/plugins/index.md +++ b/docs/plugins/index.md @@ -8,21 +8,21 @@ Plugins are supported on NetBox v2.8 and later. The NetBox plugin architecture allows for the following: -* **Add new data models.** A plugin can introduce one or more models to hold data. (A model is essentially a SQL table.) -* **Add new URLs and views.** Plugins can register URLS under the `/plugins` root path to provide browsable views for users. +* **Add new data models.** A plugin can introduce one or more models to hold data. (A model is essentially a table in the SQL database.) +* **Add new URLs and views.** Plugins can register URLs under the `/plugins` root path to provide browsable views for users. * **Add content to existing model templates.** A template content class can be used to inject custom HTML content within the view of a core NetBox model. This content can appear in the left side, right side, or bottom of the page. * **Add navigation menu items.** Each plugin can register new links in the navigation menu. Each link may have a set of buttons for specific actions, similar to the built-in navigation items. * **Add custom middleware.** Custom Django middleware can be registered by each plugin. -* **Declare configuration parameters.** Each plugin can define required, optional, and default configuration parameters within its unique namespace. +* **Declare configuration parameters.** Each plugin can define required, optional, and default configuration parameters within its unique namespace. Plug configuration parameter are defined by the user under `PLUGINS_CONFIG` in `configuration.py`. * **Limit installation by NetBox version.** A plugin can specify a minimum and/or maximum NetBox version with which it is compatible. ## Limitations -Either by policy or by technical limitation, the interaction of plugins with NetBox core is restricted in certain ways. These include: +Either by policy or by technical limitation, the interaction of plugins with NetBox core is restricted in certain ways. A plugin may not: * **Modify core models.** Plugins may not alter, remove, or override core NetBox models in any way. This rule is in place to ensure the integrity of the core data model. -* **Register URLs outside the `/plugins` root.`** All plugin URLs are restricted to this path to prevent name/path collisions. -* **Override core templates.** The only avenue available for injecting content into core templates is the provided +* **Register URLs outside the `/plugins` root.** All plugin URLs are restricted to this path to prevent path collisions with core or other plugins. +* **Override core templates.** Plugins can inject additional content where supported, but may not manipulate or remove core content. * **Modify core settings.** A configuration registry is provided for plugins, however they cannot alter or delete the core configuration. * **Disable core components.** Plugins are not permitted to disable or hide core NetBox components. @@ -32,11 +32,18 @@ The instructions below detail the process for installing and enabling a NetBox p ### Install Package -TODO +Download and install the plugin package per its installation instructions. Plugins published via PyPI are typically installed using pip. Be sure to install the plugin within NetBox's virtual environment. + +```no-highlight +$ source /opt/netbox/venv/bin/activate +(venv) $ pip install +``` + +Alternatively, you may wish to install the plugin manually by running `python setup.py install`. If you are developing a plugin and want to install it only temporarily, run `python setup.py develop` instead. ### Enable Plugins -In `configuration.py`, set the `PLUGINS_ENABLED` parameter to True (if not already set): +In `configuration.py`, ensure the `PLUGINS_ENABLED` parameter is set to True: ```python PLUGINS_ENABLED = True @@ -57,7 +64,7 @@ PLUGINS_CONFIG = { ### Restart WSGI Service -Restart the WSGI service to detect the new plugin: +Restart the WSGI service to load the new plugin: ```no-highlight # sudo systemctl restart netbox From 81c9177c097c2d54e434f011b68a075ed583150b Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Thu, 26 Mar 2020 11:26:11 -0400 Subject: [PATCH 081/124] Add a default button color --- docs/plugins/development.md | 2 +- netbox/extras/plugins/__init__.py | 9 +++++++-- netbox/utilities/choices.py | 3 ++- 3 files changed, 10 insertions(+), 4 deletions(-) diff --git a/docs/plugins/development.md b/docs/plugins/development.md index 4a82a3e8d..3b75a8145 100644 --- a/docs/plugins/development.md +++ b/docs/plugins/development.md @@ -311,8 +311,8 @@ A `PluginNavMenuButton` has the following attributes: * `link` - The name of the URL path to which this button links * `title` - The tooltip text (displayed when the mouse hovers over the button) -* `color` - Button color (one of the choices provided by `ButtonColorChoices`) * `icon_class` - Button icon CSS class +* `color` - One of the choices provided by `ButtonColorChoices` (optional) * `permission` - The name of the permission required to display this button (optional) ## Template Content diff --git a/netbox/extras/plugins/__init__.py b/netbox/extras/plugins/__init__.py index 0a5f8de37..c2235c0c6 100644 --- a/netbox/extras/plugins/__init__.py +++ b/netbox/extras/plugins/__init__.py @@ -6,6 +6,7 @@ from django.template.loader import get_template from django.utils.module_loading import import_string from extras.registry import registry +from utilities.choices import ButtonColorChoices # Initialize plugin registry stores @@ -174,13 +175,17 @@ class PluginNavMenuButton: This class represents a button which is a part of the nav menu link item. Note that button colors should come from ButtonColorChoices """ - def __init__(self, link, title, icon_class, color, permission=None): + color = ButtonColorChoices.DEFAULT + + def __init__(self, link, title, icon_class, color=None, permission=None): self.link = link self.title = title self.icon_class = icon_class - self.color = color self.permission = permission + if color is not None: + self.color = color + def register_menu_items(section_name, class_list): """ diff --git a/netbox/utilities/choices.py b/netbox/utilities/choices.py index c38b2d1bf..aba64e63b 100644 --- a/netbox/utilities/choices.py +++ b/netbox/utilities/choices.py @@ -88,7 +88,7 @@ class ButtonColorChoices(ChoiceSet): """ Map standard button color choices to Bootstrap color classes """ - + DEFAULT = 'default' BLUE = 'primary' GREY = 'secondary' GREEN = 'success' @@ -97,6 +97,7 @@ class ButtonColorChoices(ChoiceSet): BLACK = 'dark' CHOICES = ( + (DEFAULT, 'Default'), (BLUE, 'Blue'), (GREY, 'Grey'), (GREEN, 'Green'), From 40574b65afb707da7c7acc4f1db787f456274d77 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Thu, 26 Mar 2020 11:29:05 -0400 Subject: [PATCH 082/124] Rename PluginNavMenuLink to PluginMenuItem --- docs/plugins/development.md | 8 ++++---- netbox/extras/plugins/__init__.py | 8 ++++---- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/plugins/development.md b/docs/plugins/development.md index 3b75a8145..1599a8c53 100644 --- a/docs/plugins/development.md +++ b/docs/plugins/development.md @@ -281,14 +281,14 @@ With these three components in place, we can request `/api/plugins/animal-sounds ## Navigation Menu Items -To make its views easily accessible to users, a plugin can inject items in NetBox's navigation menu under the "Plugins" header. Menu items are added by defining a list of PluginNavMenuLink instances. By default, this should be a variable named `menu_items` in the file `navigation.py`. An example is shown below. +To make its views easily accessible to users, a plugin can inject items in NetBox's navigation menu under the "Plugins" header. Menu items are added by defining a list of PluginMenuItem instances. By default, this should be a variable named `menu_items` in the file `navigation.py`. An example is shown below. ```python -from extras.plugins import PluginNavMenuButton, PluginNavMenuLink +from extras.plugins import PluginNavMenuButton, PluginMenuItem from utilities.choices import ButtonColorChoices menu_items = ( - PluginNavMenuLink( + PluginMenuItem( link='plugins:netbox_animal_sounds:random_sound', link_text='Random sound', buttons=( @@ -299,7 +299,7 @@ menu_items = ( ) ``` -A `PluginNavMenuLink` has the following attributes: +A `PluginMenuItem` has the following attributes: * `link` - The name of the URL path to which this menu item links * `link_text` - The text presented to the user diff --git a/netbox/extras/plugins/__init__.py b/netbox/extras/plugins/__init__.py index c2235c0c6..4891dce4c 100644 --- a/netbox/extras/plugins/__init__.py +++ b/netbox/extras/plugins/__init__.py @@ -152,7 +152,7 @@ def register_template_content_classes(class_list): # Navigation menu links # -class PluginNavMenuLink: +class PluginMenuItem: """ This class represents a nav menu item. This constitutes primary link and its text, but also allows for specifying additional link buttons that appear to the right of the item in the van menu. @@ -189,12 +189,12 @@ class PluginNavMenuButton: def register_menu_items(section_name, class_list): """ - Register a list of PluginNavMenuLink instances for a given menu section (e.g. plugin name) + Register a list of PluginMenuItem instances for a given menu section (e.g. plugin name) """ # Validation for menu_link in class_list: - if not isinstance(menu_link, PluginNavMenuLink): - raise TypeError(f"{menu_link} must be an instance of extras.plugins.PluginNavMenuLink") + if not isinstance(menu_link, PluginMenuItem): + raise TypeError(f"{menu_link} must be an instance of extras.plugins.PluginMenuItem") for button in menu_link.buttons: if not isinstance(button, PluginNavMenuButton): raise TypeError(f"{button} must be an instance of extras.plugins.PluginNavMenuButton") From d316d8ac6180b65535e719ad392551bbbd2fb47c Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Thu, 26 Mar 2020 11:30:42 -0400 Subject: [PATCH 083/124] Rename PluginNavMenuButton to PluginMenuButton --- docs/plugins/development.md | 10 +++++----- netbox/extras/plugins/__init__.py | 8 ++++---- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/plugins/development.md b/docs/plugins/development.md index 1599a8c53..756dd537a 100644 --- a/docs/plugins/development.md +++ b/docs/plugins/development.md @@ -284,7 +284,7 @@ With these three components in place, we can request `/api/plugins/animal-sounds To make its views easily accessible to users, a plugin can inject items in NetBox's navigation menu under the "Plugins" header. Menu items are added by defining a list of PluginMenuItem instances. By default, this should be a variable named `menu_items` in the file `navigation.py`. An example is shown below. ```python -from extras.plugins import PluginNavMenuButton, PluginMenuItem +from extras.plugins import PluginMenuButton, PluginMenuItem from utilities.choices import ButtonColorChoices menu_items = ( @@ -292,8 +292,8 @@ menu_items = ( link='plugins:netbox_animal_sounds:random_sound', link_text='Random sound', buttons=( - PluginNavMenuButton('home', 'Button A', 'fa-info', ButtonColorChoices.BLUE), - PluginNavMenuButton('home', 'Button B', 'fa-warning', ButtonColorChoices.GREEN), + PluginMenuButton('home', 'Button A', 'fa-info', ButtonColorChoices.BLUE), + PluginMenuButton('home', 'Button B', 'fa-warning', ButtonColorChoices.GREEN), ) ), ) @@ -304,10 +304,10 @@ A `PluginMenuItem` has the following attributes: * `link` - The name of the URL path to which this menu item links * `link_text` - The text presented to the user * `permission` - The name of the permission required to display this link (optional) -* `buttons` - An iterable of PluginNavMenuButton instances to display (optional) +* `buttons` - An iterable of PluginMenuButton instances to display (optional) -A `PluginNavMenuButton` has the following attributes: +A `PluginMenuButton` has the following attributes: * `link` - The name of the URL path to which this button links * `title` - The tooltip text (displayed when the mouse hovers over the button) diff --git a/netbox/extras/plugins/__init__.py b/netbox/extras/plugins/__init__.py index 4891dce4c..b133f83a0 100644 --- a/netbox/extras/plugins/__init__.py +++ b/netbox/extras/plugins/__init__.py @@ -158,7 +158,7 @@ class PluginMenuItem: specifying additional link buttons that appear to the right of the item in the van menu. Links are specified as Django reverse URL strings. - Buttons are each specified as a list of PluginNavMenuButton instances. + Buttons are each specified as a list of PluginMenuButton instances. """ def __init__(self, link, link_text, permission=None, buttons=None): self.link = link @@ -170,7 +170,7 @@ class PluginMenuItem: self.buttons = buttons -class PluginNavMenuButton: +class PluginMenuButton: """ This class represents a button which is a part of the nav menu link item. Note that button colors should come from ButtonColorChoices @@ -196,7 +196,7 @@ def register_menu_items(section_name, class_list): if not isinstance(menu_link, PluginMenuItem): raise TypeError(f"{menu_link} must be an instance of extras.plugins.PluginMenuItem") for button in menu_link.buttons: - if not isinstance(button, PluginNavMenuButton): - raise TypeError(f"{button} must be an instance of extras.plugins.PluginNavMenuButton") + if not isinstance(button, PluginMenuButton): + raise TypeError(f"{button} must be an instance of extras.plugins.PluginMenuButton") registry['plugin_nav_menu_links'][section_name] = class_list From 62f14f04736f80378541e68e880d6a7948dbea0e Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Thu, 26 Mar 2020 12:03:10 -0400 Subject: [PATCH 084/124] Convert PluginConfig attrs list to a table --- docs/plugins/development.md | 32 +++++++++++++++++--------------- 1 file changed, 17 insertions(+), 15 deletions(-) diff --git a/docs/plugins/development.md b/docs/plugins/development.md index 756dd537a..f56852cbd 100644 --- a/docs/plugins/development.md +++ b/docs/plugins/development.md @@ -91,21 +91,23 @@ class AnimalSoundsConfig(PluginConfig): #### PluginConfig Attributes -* `name` - Raw plugin name; same as the plugin's source directory -* `verbose_name` - Human-friendly name for the plugin -* `version` - Current release ([semantic versioning](https://semver.org/) is encouraged) -* `description` - Brief description of the plugin's purpose -* `author_name` - Name of plugin's author -* `author_email` - Author's public email address -* `base_url` - Base path to use for plugin URLs (optional). If not specified, the project's `name` will be used. -* `required_settings`: A list of any configuration parameters that **must** be defined by the user -* `default_settings`: A dictionary of configuration parameter names and their default values -* `min_version`: Minimum version of NetBox with which the plugin is compatible -* `max_version`: Maximum version of NetBox with which the plugin is compatible -* `middleware`: A list of middleware classes to append after NetBox's build-in middleware -* `caching_config`: Plugin-specific cache configuration -* `template_content`: The dotted path to the list of template content classes (default: `template_content.template_contnet`) -* `menu_items`: The dotted path to the list of menu items provided by the plugin (default: `navigation.menu_items`) +| Name | Description | +| ---- | ----------- | +| `name` | Raw plugin name; same as the plugin's source directory | +| `verbose_name` | Human-friendly name for the plugin | +| `version` | Current release ([semantic versioning](https://semver.org/) is encouraged) | +| `description` | Brief description of the plugin's purpose | +| `author_name` | Name of plugin's author | +| `author_email` | Author's public email address | +| `base_url` | Base path to use for plugin URLs (optional). If not specified, the project's `name` will be used. | +| `required_settings` | A list of any configuration parameters that **must** be defined by the user | +| `default_settings` | A dictionary of configuration parameters and their default values | +| `min_version` | Minimum version of NetBox with which the plugin is compatible | +| `max_version` | Maximum version of NetBox with which the plugin is compatible | +| `middleware` | A list of middleware classes to append after NetBox's build-in middleware | +| `caching_config` | Plugin-specific cache configuration +| `template_content` | The dotted path to the list of template content classes (default: `template_content.template_contnet`) | +| `menu_items` | The dotted path to the list of menu items provided by the plugin (default: `navigation.menu_items`) | ### Install the Plugin for Development From 877417d68f118dcdc2fc48723325a71870c0b5ee Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Thu, 26 Mar 2020 12:18:58 -0400 Subject: [PATCH 085/124] Rename PluginTemplateContent to PluginTemplateExtension --- docs/plugins/development.md | 16 +++++++------- netbox/extras/plugins/__init__.py | 30 +++++++++++++-------------- netbox/extras/templatetags/plugins.py | 4 ++-- 3 files changed, 25 insertions(+), 25 deletions(-) diff --git a/docs/plugins/development.md b/docs/plugins/development.md index f56852cbd..b48a329fb 100644 --- a/docs/plugins/development.md +++ b/docs/plugins/development.md @@ -106,7 +106,7 @@ class AnimalSoundsConfig(PluginConfig): | `max_version` | Maximum version of NetBox with which the plugin is compatible | | `middleware` | A list of middleware classes to append after NetBox's build-in middleware | | `caching_config` | Plugin-specific cache configuration -| `template_content` | The dotted path to the list of template content classes (default: `template_content.template_contnet`) | +| `template_extensions` | The dotted path to the list of template extension classes (default: `template_content.template_extensions`) | | `menu_items` | The dotted path to the list of menu items provided by the plugin (default: `navigation.menu_items`) | ### Install the Plugin for Development @@ -317,9 +317,9 @@ A `PluginMenuButton` has the following attributes: * `color` - One of the choices provided by `ButtonColorChoices` (optional) * `permission` - The name of the permission required to display this button (optional) -## Template Content +## Extending Core Templates -Plugins can inject custom content into certain areas of the detail views of applicable models. This is accomplished by subclassing `PluginTemplateContent`, designating a particular NetBox model, and defining the desired methods to render custom content. Four methods are available: +Plugins can inject custom content into certain areas of the detail views of applicable models. This is accomplished by subclassing `PluginTemplateExtension`, designating a particular NetBox model, and defining the desired methods to render custom content. Four methods are available: * `left_page()` - Inject content on the left side of the page * `right_page()` - Inject content on the right side of the page @@ -333,25 +333,25 @@ Each of these methods must return HTML content suitable for inclusion in the obj Additionally, a `render()` method is available for convenience. This method accepts the name of a template to render, and any additional context data you want to pass. Its use is optional, however. -Declared subclasses should be gathered into a list or tuple for integration with NetBox. By default, NetBox looks for an iterable named `template_content` within a `template_content.py` file. (This can be overridden by setting `template_content` to a custom value on the plugin's PluginConfig.) An example is below. +Declared subclasses should be gathered into a list or tuple for integration with NetBox. By default, NetBox looks for an iterable named `template_extensions` within a `template_content.py` file. (This can be overridden by setting `template_extensions` to a custom value on the plugin's PluginConfig.) An example is below. ```python -from extras.plugins import PluginTemplateContent +from extras.plugins import PluginTemplateExtension -class AddSiteAnimal(PluginTemplateContent): +class AddSiteAnimal(PluginTemplateExtension): model = 'dcim.site' def full_width_page(self): return self.render('netbox_animal_sounds/site.html') -class AddRackAnimal(PluginTemplateContent): +class AddRackAnimal(PluginTemplateExtension): model = 'dcim.rack' def left_page(self): extra_data = {'foo': 123} return self.render('netbox_animal_sounds/rack.html', extra_data) -template_content_classes = [AddSiteAnimal, AddRackAnimal] +template_extensions = [AddSiteAnimal, AddRackAnimal] ``` ## Caching Configuration diff --git a/netbox/extras/plugins/__init__.py b/netbox/extras/plugins/__init__.py index b133f83a0..b16f70b1a 100644 --- a/netbox/extras/plugins/__init__.py +++ b/netbox/extras/plugins/__init__.py @@ -10,7 +10,7 @@ from utilities.choices import ButtonColorChoices # Initialize plugin registry stores -registry['plugin_template_content_classes'] = collections.defaultdict(list) +registry['plugin_template_extensions'] = collections.defaultdict(list) registry['plugin_nav_menu_links'] = {} @@ -49,15 +49,15 @@ class PluginConfig(AppConfig): # Default integration paths. Plugin authors can override these to customize the paths to # integrated components. - template_content_classes = 'template_content.template_content_classes' + template_extensions = 'template_content.template_extensions' menu_items = 'navigation.menu_items' def ready(self): # Register template content try: - class_list = import_string(f"{self.__module__}.{self.template_content_classes}") - register_template_content_classes(class_list) + template_extensions = import_string(f"{self.__module__}.{self.template_extensions}") + register_template_extensions(template_extensions) except ImportError: pass @@ -73,7 +73,7 @@ class PluginConfig(AppConfig): # Template content injection # -class PluginTemplateContent: +class PluginTemplateExtension: """ This class is used to register plugin content to be injected into core NetBox templates. It contains methods that are overridden by plugin authors to return template content. @@ -132,20 +132,20 @@ class PluginTemplateContent: raise NotImplementedError -def register_template_content_classes(class_list): +def register_template_extensions(class_list): """ - Register a list of PluginTemplateContent classes + Register a list of PluginTemplateExtension classes """ # Validation - for template_content_class in class_list: - if not inspect.isclass(template_content_class): - raise TypeError('Plugin content class {} was passes as an instance!'.format(template_content_class)) - if not issubclass(template_content_class, PluginTemplateContent): - raise TypeError('{} is not a subclass of extras.plugins.PluginTemplateContent!'.format(template_content_class)) - if template_content_class.model is None: - raise TypeError('Plugin content class {} does not define a valid model!'.format(template_content_class)) + for template_extension in class_list: + if not inspect.isclass(template_extension): + raise TypeError(f"PluginTemplateExtension class {template_extension} was passes as an instance!") + if not issubclass(template_extension, PluginTemplateExtension): + raise TypeError(f"{template_extension} is not a subclass of extras.plugins.PluginTemplateExtension!") + if template_extension.model is None: + raise TypeError(f"PluginTemplateExtension class {template_extension} does not define a valid model!") - registry['plugin_template_content_classes'][template_content_class.model].append(template_content_class) + registry['plugin_template_extensions'][template_extension.model].append(template_extension) # diff --git a/netbox/extras/templatetags/plugins.py b/netbox/extras/templatetags/plugins.py index d2b10669a..b867819ba 100644 --- a/netbox/extras/templatetags/plugins.py +++ b/netbox/extras/templatetags/plugins.py @@ -8,13 +8,13 @@ register = template_.Library() def _get_registered_content(obj, method, context): """ - Given an object and a PluginTemplateContent method name and the template context, return all the + Given an object and a PluginTemplateExtension method name and the template context, return all the registered content for the object's model. """ html = '' model_name = obj._meta.label_lower - plugin_template_classes = registry['plugin_template_content_classes'].get(model_name, []) + plugin_template_classes = registry['plugin_template_extensions'].get(model_name, []) for plugin_template_class in plugin_template_classes: plugin_template_renderer = plugin_template_class(obj, context) try: From b94ef39a51abe5fcd9e266cde9211b50b7b8cc2c Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Thu, 26 Mar 2020 12:25:36 -0400 Subject: [PATCH 086/124] Standardize naming of menu items --- netbox/extras/plugins/__init__.py | 10 +++++----- netbox/extras/plugins/context_processors.py | 6 +++--- netbox/netbox/settings.py | 2 +- netbox/templates/inc/nav_menu.html | 4 ++-- ..._nav_menu_items.html => plugin_menu_items.html} | 14 +++++++------- 5 files changed, 18 insertions(+), 18 deletions(-) rename netbox/templates/inc/{plugin_nav_menu_items.html => plugin_menu_items.html} (71%) diff --git a/netbox/extras/plugins/__init__.py b/netbox/extras/plugins/__init__.py index b16f70b1a..dbfee45e4 100644 --- a/netbox/extras/plugins/__init__.py +++ b/netbox/extras/plugins/__init__.py @@ -11,7 +11,7 @@ from utilities.choices import ButtonColorChoices # Initialize plugin registry stores registry['plugin_template_extensions'] = collections.defaultdict(list) -registry['plugin_nav_menu_links'] = {} +registry['plugin_menu_items'] = {} # @@ -154,7 +154,7 @@ def register_template_extensions(class_list): class PluginMenuItem: """ - This class represents a nav menu item. This constitutes primary link and its text, but also allows for + This class represents a navigation menu item. This constitutes primary link and its text, but also allows for specifying additional link buttons that appear to the right of the item in the van menu. Links are specified as Django reverse URL strings. @@ -172,8 +172,8 @@ class PluginMenuItem: class PluginMenuButton: """ - This class represents a button which is a part of the nav menu link item. - Note that button colors should come from ButtonColorChoices + This class represents a button within a PluginMenuItem. Note that button colors should come from + ButtonColorChoices. """ color = ButtonColorChoices.DEFAULT @@ -199,4 +199,4 @@ def register_menu_items(section_name, class_list): if not isinstance(button, PluginMenuButton): raise TypeError(f"{button} must be an instance of extras.plugins.PluginMenuButton") - registry['plugin_nav_menu_links'][section_name] = class_list + registry['plugin_menu_items'][section_name] = class_list diff --git a/netbox/extras/plugins/context_processors.py b/netbox/extras/plugins/context_processors.py index fbb4e8c03..026c724c7 100644 --- a/netbox/extras/plugins/context_processors.py +++ b/netbox/extras/plugins/context_processors.py @@ -1,10 +1,10 @@ from extras.registry import registry -def nav_menu_links(request): +def plugin_menu_items(request): """ - Retrieve and expose all plugin registered nav links + Retrieve and expose all plugin registered navigation menu items. """ return { - 'plugin_nav_menu_links': registry['plugin_nav_menu_links'] + 'plugin_menu_items': registry['plugin_menu_items'] } diff --git a/netbox/netbox/settings.py b/netbox/netbox/settings.py index fb8d760fc..932b22611 100644 --- a/netbox/netbox/settings.py +++ b/netbox/netbox/settings.py @@ -326,7 +326,7 @@ TEMPLATES = [ 'django.contrib.auth.context_processors.auth', 'django.contrib.messages.context_processors.messages', 'utilities.context_processors.settings', - 'extras.plugins.context_processors.nav_menu_links', + 'extras.plugins.context_processors.plugin_menu_items', ], }, }, diff --git a/netbox/templates/inc/nav_menu.html b/netbox/templates/inc/nav_menu.html index d42bb7737..8d06ae19f 100644 --- a/netbox/templates/inc/nav_menu.html +++ b/netbox/templates/inc/nav_menu.html @@ -504,8 +504,8 @@
- {% if plugin_nav_menu_links %} - {% include 'inc/plugin_nav_menu_items.html' %} + {% if plugin_menu_items %} + {% include 'inc/plugin_menu_items.html' %} {% endif %} {% endif %} diff --git a/netbox/templates/inc/plugin_nav_menu_items.html b/netbox/templates/inc/plugin_menu_items.html similarity index 71% rename from netbox/templates/inc/plugin_nav_menu_items.html rename to netbox/templates/inc/plugin_menu_items.html index 55aab84c1..5639d39c7 100644 --- a/netbox/templates/inc/plugin_nav_menu_items.html +++ b/netbox/templates/inc/plugin_menu_items.html @@ -1,24 +1,24 @@
    • - {% for section_name, link_items in plugin_nav_menu_links.items %} + {% for section_name, menu_items in plugin_menu_items.items %}
    • {{ section_name }}
      • - {% for link_item in link_items %} - {% if link_item.permission %} - + {% for menu_item in menu_items %} + {% if menu_item.permission %} + {% else %}
    • {% endif %} - {% if link_item.buttons %} + {% if menu_item.buttons %}
      - {% for button in link_item.buttons %} + {% for button in menu_item.buttons %} {% if not button.permission or button.permission in perms %} {% endif %} {% endfor %}
      {% endif %} - {{ link_item.link_text }} + {{ menu_item.link_text }}
      • {% endfor %} {% if not forloop.last %} From 74e56a890c9cee631463587901a5aeef37ef9966 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Thu, 26 Mar 2020 12:26:58 -0400 Subject: [PATCH 087/124] Remove unused PluginSignal class --- netbox/extras/plugins/signals.py | 28 ---------------------------- 1 file changed, 28 deletions(-) delete mode 100644 netbox/extras/plugins/signals.py diff --git a/netbox/extras/plugins/signals.py b/netbox/extras/plugins/signals.py deleted file mode 100644 index 165b5b9cc..000000000 --- a/netbox/extras/plugins/signals.py +++ /dev/null @@ -1,28 +0,0 @@ -import django.dispatch -from django.dispatch.dispatcher import NO_RECEIVERS - - -class PluginSignal(django.dispatch.Signal): - """ - FUTURE USE - """ - def _sorted_receivers(self, sender): - orig_list = self._live_receivers(sender) - sorted_list = sorted( - orig_list, - key=lambda receiver: ( - receiver.__module__, - receiver.__name__, - ) - ) - return sorted_list - - def send(self, sender, **kwargs): - responses = [] - if not self.receivers or self.sender_receivers_cache.get(sender) is NO_RECEIVERS: - return responses - - for receiver in self._sorted_receivers(sender): - response = receiver(signal=self, sender=sender, **kwargs) - responses.append((receiver, response)) - return responses From 84d2db0d35e0299a90c8ddc099170744b4b7aad7 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Thu, 26 Mar 2020 13:37:52 -0400 Subject: [PATCH 088/124] Tweak variable naming --- netbox/extras/templatetags/plugins.py | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/netbox/extras/templatetags/plugins.py b/netbox/extras/templatetags/plugins.py index b867819ba..5fa3b4ce2 100644 --- a/netbox/extras/templatetags/plugins.py +++ b/netbox/extras/templatetags/plugins.py @@ -14,11 +14,10 @@ def _get_registered_content(obj, method, context): html = '' model_name = obj._meta.label_lower - plugin_template_classes = registry['plugin_template_extensions'].get(model_name, []) - for plugin_template_class in plugin_template_classes: - plugin_template_renderer = plugin_template_class(obj, context) + for template_extension_class in registry['plugin_template_extensions'].get(model_name, []): + template_extension_instance = template_extension_class(obj, context) try: - content = getattr(plugin_template_renderer, method)() + content = getattr(template_extension_instance, method)() except NotImplementedError: # This content renderer class does not define content for this method continue @@ -30,7 +29,7 @@ def _get_registered_content(obj, method, context): @register.simple_tag(takes_context=True) def plugin_buttons(context, obj): """ - Fire signal to collect all buttons registered by plugins + Render all buttons registered by plugins """ return _get_registered_content(obj, 'buttons', context) @@ -38,7 +37,7 @@ def plugin_buttons(context, obj): @register.simple_tag(takes_context=True) def plugin_left_page(context, obj): """ - Fire signal to collect all left page content registered by plugins + Render all left page content registered by plugins """ return _get_registered_content(obj, 'left_page', context) @@ -46,7 +45,7 @@ def plugin_left_page(context, obj): @register.simple_tag(takes_context=True) def plugin_right_page(context, obj): """ - Fire signal to collect all right page content registered by plugins + Render all right page content registered by plugins """ return _get_registered_content(obj, 'right_page', context) @@ -54,6 +53,6 @@ def plugin_right_page(context, obj): @register.simple_tag(takes_context=True) def plugin_full_width_page(context, obj): """ - Fire signal to collect all full width page content registered by plugins + Render all full width page content registered by plugins """ return _get_registered_content(obj, 'full_width_page', context) From e7f7b14214cd531594ca463c29834ddd16d85b7e Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Thu, 26 Mar 2020 16:04:12 -0400 Subject: [PATCH 089/124] Extend menu items and buttons to accept a list of required permissions --- docs/plugins/development.md | 5 ++-- netbox/extras/plugins/__init__.py | 23 ++++++++++------ netbox/templates/inc/plugin_menu_items.html | 29 +++++++++------------ netbox/utilities/templatetags/helpers.py | 8 ++++++ 4 files changed, 38 insertions(+), 27 deletions(-) diff --git a/docs/plugins/development.md b/docs/plugins/development.md index b48a329fb..402c047e6 100644 --- a/docs/plugins/development.md +++ b/docs/plugins/development.md @@ -305,17 +305,16 @@ A `PluginMenuItem` has the following attributes: * `link` - The name of the URL path to which this menu item links * `link_text` - The text presented to the user -* `permission` - The name of the permission required to display this link (optional) +* `permissions` - A list of permissions required to display this link (optional) * `buttons` - An iterable of PluginMenuButton instances to display (optional) - A `PluginMenuButton` has the following attributes: * `link` - The name of the URL path to which this button links * `title` - The tooltip text (displayed when the mouse hovers over the button) * `icon_class` - Button icon CSS class * `color` - One of the choices provided by `ButtonColorChoices` (optional) -* `permission` - The name of the permission required to display this button (optional) +* `permissions` - A list of permissions required to display this button (optional) ## Extending Core Templates diff --git a/netbox/extras/plugins/__init__.py b/netbox/extras/plugins/__init__.py index dbfee45e4..bcd57d767 100644 --- a/netbox/extras/plugins/__init__.py +++ b/netbox/extras/plugins/__init__.py @@ -160,13 +160,17 @@ class PluginMenuItem: Links are specified as Django reverse URL strings. Buttons are each specified as a list of PluginMenuButton instances. """ - def __init__(self, link, link_text, permission=None, buttons=None): + permissions = [] + buttons = [] + + def __init__(self, link, link_text, permissions=None, buttons=None): self.link = link self.link_text = link_text - self.permission = permission - if buttons is None: - self.buttons = [] - else: + if permissions is not None: + if type(permissions) not in (list, tuple): + raise TypeError("Permissions must be passed as a tuple or list.") + self.permissions = permissions + if buttons is not None: self.buttons = buttons @@ -176,13 +180,16 @@ class PluginMenuButton: ButtonColorChoices. """ color = ButtonColorChoices.DEFAULT + permissions = [] - def __init__(self, link, title, icon_class, color=None, permission=None): + def __init__(self, link, title, icon_class, color=None, permissions=None): self.link = link self.title = title self.icon_class = icon_class - self.permission = permission - + if permissions is not None: + if type(permissions) not in (list, tuple): + raise TypeError("Permissions must be passed as a tuple or list.") + self.permissions = permissions if color is not None: self.color = color diff --git a/netbox/templates/inc/plugin_menu_items.html b/netbox/templates/inc/plugin_menu_items.html index 5639d39c7..0ba10bd20 100644 --- a/netbox/templates/inc/plugin_menu_items.html +++ b/netbox/templates/inc/plugin_menu_items.html @@ -1,25 +1,22 @@ +{% load helpers %}
      • {% for section_name, menu_items in plugin_menu_items.items %}
      • {{ section_name }}
        • {% for menu_item in menu_items %} - {% if menu_item.permission %} - - {% else %} -
      • - {% endif %} - {% if menu_item.buttons %} -
        - {% for button in menu_item.buttons %} - {% if not button.permission or button.permission in perms %} - - {% endif %} - {% endfor %} -
        - {% endif %} - {{ menu_item.link_text }} -
        • + + {% if menu_item.buttons %} +
        + {% for button in menu_item.buttons %} + {% if not button.permissions or request.user|has_perms:button.permissions %} + + {% endif %} + {% endfor %} +
        + {% endif %} + {{ menu_item.link_text }} + {% endfor %} {% if not forloop.last %}
      • diff --git a/netbox/utilities/templatetags/helpers.py b/netbox/utilities/templatetags/helpers.py index 7d05ce749..466690a4c 100644 --- a/netbox/utilities/templatetags/helpers.py +++ b/netbox/utilities/templatetags/helpers.py @@ -201,6 +201,14 @@ def get_docs(model): return mark_safe(content) +@register.filter() +def has_perms(user, permissions_list): + """ + Return True if the user has *all* permissions in the list. + """ + return user.has_perms(permissions_list) + + # # Tags # From f03cc96050c55a04c2973db5c016b0d53c4828f6 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Thu, 26 Mar 2020 16:50:55 -0400 Subject: [PATCH 090/124] Restrict context data available to PluginTemplateExtensions --- docs/plugins/development.md | 14 +++++++++----- netbox/extras/plugins/__init__.py | 15 ++++++--------- netbox/extras/templatetags/plugins.py | 21 +++++++++++++++++---- 3 files changed, 32 insertions(+), 18 deletions(-) diff --git a/docs/plugins/development.md b/docs/plugins/development.md index 402c047e6..84d04bc8e 100644 --- a/docs/plugins/development.md +++ b/docs/plugins/development.md @@ -325,13 +325,17 @@ Plugins can inject custom content into certain areas of the detail views of appl * `full_width_page()` - Inject content across the entire bottom of the page * `buttons()` - Add buttons to the top of the page -Each of these methods must return HTML content suitable for inclusion in the object template. Two instance attributes are available for context: - -* `self.obj` - The object being viewed -* `self.context` - The current template context - Additionally, a `render()` method is available for convenience. This method accepts the name of a template to render, and any additional context data you want to pass. Its use is optional, however. +When a PluginTemplateExtension is instantiated, context data is assigned to `self.context`. Available data include: + +* `obj` - The object being viewed +* `request` - The current request +* `settings` - Global NetBox settings +* `config` - Plugin-specific configuration parameters + +For example, accessing `{{ request.user }}` within a template will return the current user. + Declared subclasses should be gathered into a list or tuple for integration with NetBox. By default, NetBox looks for an iterable named `template_extensions` within a `template_content.py` file. (This can be overridden by setting `template_extensions` to a custom value on the plugin's PluginConfig.) An example is below. ```python diff --git a/netbox/extras/plugins/__init__.py b/netbox/extras/plugins/__init__.py index bcd57d767..30a4e0acd 100644 --- a/netbox/extras/plugins/__init__.py +++ b/netbox/extras/plugins/__init__.py @@ -83,8 +83,7 @@ class PluginTemplateExtension: """ model = None - def __init__(self, obj, context): - self.obj = obj + def __init__(self, context): self.context = context def render(self, template, extra_context=None): @@ -93,14 +92,12 @@ class PluginTemplateExtension: passed into the template context as `obj` and the original detail page's context is available as `obj_context`. An additional context dictionary may be passed as `extra_context`. """ - context = { - 'obj': self.obj, - 'obj_context': self.context - } - if isinstance(extra_context, dict): - context.update(extra_context) + if extra_context is None: + extra_context = {} + elif not isinstance(extra_context, dict): + raise TypeError("extra_context must be a dictionary") - return get_template(template).render(context) + return get_template(template).render({**self.context, **extra_context}) def left_page(self): """ diff --git a/netbox/extras/templatetags/plugins.py b/netbox/extras/templatetags/plugins.py index 5fa3b4ce2..63c126fc8 100644 --- a/netbox/extras/templatetags/plugins.py +++ b/netbox/extras/templatetags/plugins.py @@ -1,4 +1,5 @@ from django import template as template_ +from django.conf import settings from django.utils.safestring import mark_safe from extras.registry import registry @@ -6,18 +7,30 @@ from extras.registry import registry register = template_.Library() -def _get_registered_content(obj, method, context): +def _get_registered_content(obj, method, template_context): """ Given an object and a PluginTemplateExtension method name and the template context, return all the registered content for the object's model. """ html = '' + context = { + 'obj': obj, + 'request': template_context['request'], + 'settings': template_context['settings'], + 'config': {}, # Defined per-plugin + } model_name = obj._meta.label_lower - for template_extension_class in registry['plugin_template_extensions'].get(model_name, []): - template_extension_instance = template_extension_class(obj, context) + template_extensions = registry['plugin_template_extensions'].get(model_name, []) + for template_extension in template_extensions: + + # Update context with plugin-specific configuration parameters + plugin_name = template_extension.__module__.split('.')[0] + context['config'] = settings.PLUGINS_CONFIG.get(plugin_name) + + instance = template_extension(context) try: - content = getattr(template_extension_instance, method)() + content = getattr(instance, method)() except NotImplementedError: # This content renderer class does not define content for this method continue From af302d8368ceb31e246ee8a0853972426c89e0a4 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Thu, 26 Mar 2020 21:25:10 -0400 Subject: [PATCH 091/124] Avoid instantiating PluginTemplateExtension subclasses when the specified method has not been defined --- netbox/extras/templatetags/plugins.py | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/netbox/extras/templatetags/plugins.py b/netbox/extras/templatetags/plugins.py index 63c126fc8..e3d1d0e46 100644 --- a/netbox/extras/templatetags/plugins.py +++ b/netbox/extras/templatetags/plugins.py @@ -2,6 +2,7 @@ from django import template as template_ from django.conf import settings from django.utils.safestring import mark_safe +from extras.plugins import PluginTemplateExtension from extras.registry import registry register = template_.Library() @@ -17,23 +18,24 @@ def _get_registered_content(obj, method, template_context): 'obj': obj, 'request': template_context['request'], 'settings': template_context['settings'], - 'config': {}, # Defined per-plugin } model_name = obj._meta.label_lower template_extensions = registry['plugin_template_extensions'].get(model_name, []) for template_extension in template_extensions: + # If the class has not overridden the specified method, we can skip it (because we know it + # will raise NotImplementedError). + if getattr(template_extension, method) == getattr(PluginTemplateExtension, method): + continue + # Update context with plugin-specific configuration parameters plugin_name = template_extension.__module__.split('.')[0] - context['config'] = settings.PLUGINS_CONFIG.get(plugin_name) + context['config'] = settings.PLUGINS_CONFIG.get(plugin_name, {}) + # Call the method to render content instance = template_extension(context) - try: - content = getattr(instance, method)() - except NotImplementedError: - # This content renderer class does not define content for this method - continue + content = getattr(instance, method)() html += content return mark_safe(html) From 8a3ebf64bc17bc2cd6f3ddaf4987de86c7630135 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Thu, 26 Mar 2020 21:46:56 -0400 Subject: [PATCH 092/124] Rename obj to object; clean up docstrings --- docs/plugins/development.md | 2 +- netbox/extras/plugins/__init__.py | 22 +++++++++++++--------- netbox/extras/templatetags/plugins.py | 2 +- 3 files changed, 15 insertions(+), 11 deletions(-) diff --git a/docs/plugins/development.md b/docs/plugins/development.md index 84d04bc8e..b96fbec49 100644 --- a/docs/plugins/development.md +++ b/docs/plugins/development.md @@ -329,7 +329,7 @@ Additionally, a `render()` method is available for convenience. This method acce When a PluginTemplateExtension is instantiated, context data is assigned to `self.context`. Available data include: -* `obj` - The object being viewed +* `object` - The object being viewed * `request` - The current request * `settings` - Global NetBox settings * `config` - Plugin-specific configuration parameters diff --git a/netbox/extras/plugins/__init__.py b/netbox/extras/plugins/__init__.py index 30a4e0acd..93aceab3d 100644 --- a/netbox/extras/plugins/__init__.py +++ b/netbox/extras/plugins/__init__.py @@ -75,29 +75,33 @@ class PluginConfig(AppConfig): class PluginTemplateExtension: """ - This class is used to register plugin content to be injected into core NetBox templates. - It contains methods that are overridden by plugin authors to return template content. + This class is used to register plugin content to be injected into core NetBox templates. It contains methods + that are overridden by plugin authors to return template content. - The `model` attribute on the class defines the which model detail page this class renders - content for. It should be set as a string in the form '.'. + The `model` attribute on the class defines the which model detail page this class renders content for. It + should be set as a string in the form '.'. render() provides the following context data: + + * object - The object being viewed + * request - The current request + * settings - Global NetBox settings + * config - Plugin-specific configuration parameters """ model = None def __init__(self, context): self.context = context - def render(self, template, extra_context=None): + def render(self, template_name, extra_context=None): """ - Convenience method for rendering the provided template name. The detail page object is automatically - passed into the template context as `obj` and the original detail page's context is available as - `obj_context`. An additional context dictionary may be passed as `extra_context`. + Convenience method for rendering the specified Django template using the default context data. An additional + context dictionary may be passed as `extra_context`. """ if extra_context is None: extra_context = {} elif not isinstance(extra_context, dict): raise TypeError("extra_context must be a dictionary") - return get_template(template).render({**self.context, **extra_context}) + return get_template(template_name).render({**self.context, **extra_context}) def left_page(self): """ diff --git a/netbox/extras/templatetags/plugins.py b/netbox/extras/templatetags/plugins.py index e3d1d0e46..b66cce0a6 100644 --- a/netbox/extras/templatetags/plugins.py +++ b/netbox/extras/templatetags/plugins.py @@ -15,7 +15,7 @@ def _get_registered_content(obj, method, template_context): """ html = '' context = { - 'obj': obj, + 'object': obj, 'request': template_context['request'], 'settings': template_context['settings'], } From fd6739f0cc19347165e9145223ca1903510dda6f Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Fri, 27 Mar 2020 13:12:58 -0400 Subject: [PATCH 093/124] Improved menu item/button validation --- netbox/extras/plugins/__init__.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/netbox/extras/plugins/__init__.py b/netbox/extras/plugins/__init__.py index 93aceab3d..644188823 100644 --- a/netbox/extras/plugins/__init__.py +++ b/netbox/extras/plugins/__init__.py @@ -172,6 +172,8 @@ class PluginMenuItem: raise TypeError("Permissions must be passed as a tuple or list.") self.permissions = permissions if buttons is not None: + if type(buttons) not in (list, tuple): + raise TypeError("Buttons must be passed as a tuple or list.") self.buttons = buttons @@ -192,6 +194,8 @@ class PluginMenuButton: raise TypeError("Permissions must be passed as a tuple or list.") self.permissions = permissions if color is not None: + if color not in ButtonColorChoices.values(): + raise ValueError("Button color must be a choice within ButtonColorChoices.") self.color = color From dd9fc4173d40ccdb73133d8e4128ef7dd49f3e1f Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Fri, 27 Mar 2020 13:18:51 -0400 Subject: [PATCH 094/124] Expose regsitry in templates using existing context processor for settings --- netbox/extras/plugins/context_processors.py | 10 ---------- netbox/netbox/settings.py | 3 +-- netbox/templates/inc/nav_menu.html | 2 +- netbox/templates/inc/plugin_menu_items.html | 2 +- netbox/utilities/context_processors.py | 7 +++++-- 5 files changed, 8 insertions(+), 16 deletions(-) delete mode 100644 netbox/extras/plugins/context_processors.py diff --git a/netbox/extras/plugins/context_processors.py b/netbox/extras/plugins/context_processors.py deleted file mode 100644 index 026c724c7..000000000 --- a/netbox/extras/plugins/context_processors.py +++ /dev/null @@ -1,10 +0,0 @@ -from extras.registry import registry - - -def plugin_menu_items(request): - """ - Retrieve and expose all plugin registered navigation menu items. - """ - return { - 'plugin_menu_items': registry['plugin_menu_items'] - } diff --git a/netbox/netbox/settings.py b/netbox/netbox/settings.py index 932b22611..2f65dee30 100644 --- a/netbox/netbox/settings.py +++ b/netbox/netbox/settings.py @@ -325,8 +325,7 @@ TEMPLATES = [ 'django.template.context_processors.media', 'django.contrib.auth.context_processors.auth', 'django.contrib.messages.context_processors.messages', - 'utilities.context_processors.settings', - 'extras.plugins.context_processors.plugin_menu_items', + 'utilities.context_processors.settings_and_registry', ], }, }, diff --git a/netbox/templates/inc/nav_menu.html b/netbox/templates/inc/nav_menu.html index 8d06ae19f..765df31cc 100644 --- a/netbox/templates/inc/nav_menu.html +++ b/netbox/templates/inc/nav_menu.html @@ -504,7 +504,7 @@
      • - {% if plugin_menu_items %} + {% if registry.plugin_menu_items %} {% include 'inc/plugin_menu_items.html' %} {% endif %}
    diff --git a/netbox/templates/inc/plugin_menu_items.html b/netbox/templates/inc/plugin_menu_items.html index 0ba10bd20..16d358eeb 100644 --- a/netbox/templates/inc/plugin_menu_items.html +++ b/netbox/templates/inc/plugin_menu_items.html @@ -2,7 +2,7 @@
    • - {% for section_name, menu_items in plugin_menu_items.items %} + {% for section_name, menu_items in registry.plugin_menu_items.items %}
    • {{ section_name }}
      • {% for menu_item in menu_items %} diff --git a/netbox/utilities/context_processors.py b/netbox/utilities/context_processors.py index 06c5c8784..87a5e39d8 100644 --- a/netbox/utilities/context_processors.py +++ b/netbox/utilities/context_processors.py @@ -1,10 +1,13 @@ from django.conf import settings as django_settings +from extras.registry import registry -def settings(request): + +def settings_and_registry(request): """ - Expose Django settings in the template context. Example: {{ settings.DEBUG }} + Expose Django settings and NetBox registry stores in the template context. Example: {{ settings.DEBUG }} """ return { 'settings': django_settings, + 'registry': registry, } From cb344a3792bbafdc86f38f2d5b4a550143bbff34 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Fri, 27 Mar 2020 13:26:53 -0400 Subject: [PATCH 095/124] Clean up plugin URL registration --- netbox/extras/plugins/urls.py | 25 ++++++++++--------------- netbox/netbox/urls.py | 7 ++----- 2 files changed, 12 insertions(+), 20 deletions(-) diff --git a/netbox/extras/plugins/urls.py b/netbox/extras/plugins/urls.py index 064967677..0e4147ad4 100644 --- a/netbox/extras/plugins/urls.py +++ b/netbox/extras/plugins/urls.py @@ -6,16 +6,22 @@ from django.utils.module_loading import import_string from . import views -# Plugins +# Initialize URL base, API, and admin URL patterns for plugins plugin_patterns = [] -plugin_api_patterns = [] +plugin_api_patterns = [ + path('', views.PluginsAPIRootView.as_view(), name='api-root'), + path('installed-plugins/', views.InstalledPluginsAPIView.as_view(), name='plugins-list') +] +plugin_admin_patterns = [ + path('installed-plugins/', views.installed_plugins_admin_view, name='plugins_list') +] +# Register base/API URL patterns for each plugin for plugin in settings.PLUGINS: app = apps.get_app_config(plugin) - base_url = getattr(app, 'base_url') or app.label - # Check if the plugin specifies any URLs + # Check if the plugin specifies any base URLs try: urlpatterns = import_string(f"{plugin}.urls.urlpatterns") plugin_patterns.append( @@ -32,14 +38,3 @@ for plugin in settings.PLUGINS: ) except ImportError: pass - -# Plugin list admin view -admin_plugin_patterns = [ - path('', views.installed_plugins_admin_view, name='plugins_list') -] - -# Plugin list API view -plugin_api_patterns += [ - path('', views.PluginsAPIRootView.as_view(), name='api-root'), - path('installed-plugins/', views.InstalledPluginsAPIView.as_view(), name='plugins-list') -] diff --git a/netbox/netbox/urls.py b/netbox/netbox/urls.py index 52bc197d4..d8aa2f9d1 100644 --- a/netbox/netbox/urls.py +++ b/netbox/netbox/urls.py @@ -1,6 +1,3 @@ -import importlib - -from django.apps import apps from django.conf import settings from django.conf.urls import include from django.urls import path, re_path, reverse @@ -9,7 +6,7 @@ from django.views.static import serve from drf_yasg import openapi from drf_yasg.views import get_schema_view -from extras.plugins.urls import admin_plugin_patterns, plugin_patterns, plugin_api_patterns +from extras.plugins.urls import plugin_admin_patterns, plugin_patterns, plugin_api_patterns from netbox.views import APIRootView, HomeView, StaticMediaFailureView, SearchView from users.views import LoginView, LogoutView from .admin import admin_site @@ -88,7 +85,7 @@ _patterns = [ # Plugins path('plugins/', include((plugin_patterns, 'plugins'))), path('api/plugins/', include((plugin_api_patterns, 'plugins-api'))), - path('admin/plugins/installed-plugins/', include(admin_plugin_patterns)) + path('admin/plugins/', include(plugin_admin_patterns)) ] From 0d9d0b04463768ad3ffb714dceffe68fa933b014 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Fri, 27 Mar 2020 13:35:25 -0400 Subject: [PATCH 096/124] Convert installed_plugins_admin_view to a class-based view --- netbox/extras/plugins/urls.py | 3 ++- netbox/extras/plugins/views.py | 18 ++++++++---------- 2 files changed, 10 insertions(+), 11 deletions(-) diff --git a/netbox/extras/plugins/urls.py b/netbox/extras/plugins/urls.py index 0e4147ad4..f3f591cb0 100644 --- a/netbox/extras/plugins/urls.py +++ b/netbox/extras/plugins/urls.py @@ -1,6 +1,7 @@ from django.apps import apps from django.conf import settings from django.conf.urls import include +from django.contrib.admin.views.decorators import staff_member_required from django.urls import path from django.utils.module_loading import import_string @@ -13,7 +14,7 @@ plugin_api_patterns = [ path('installed-plugins/', views.InstalledPluginsAPIView.as_view(), name='plugins-list') ] plugin_admin_patterns = [ - path('installed-plugins/', views.installed_plugins_admin_view, name='plugins_list') + path('installed-plugins/', staff_member_required(views.InstalledPluginsAdminView.as_view()), name='plugins_list') ] # Register base/API URL patterns for each plugin diff --git a/netbox/extras/plugins/views.py b/netbox/extras/plugins/views.py index 67bc72101..39aa692d7 100644 --- a/netbox/extras/plugins/views.py +++ b/netbox/extras/plugins/views.py @@ -2,27 +2,25 @@ from collections import OrderedDict from django.apps import apps from django.conf import settings -from django.contrib import admin -from django.contrib.admin.views.decorators import staff_member_required +from django.shortcuts import render from django.urls.exceptions import NoReverseMatch from django.utils.module_loading import import_string -from django.shortcuts import render from django.views.generic import View -from rest_framework import authentication, permissions, routers +from rest_framework import permissions from rest_framework.response import Response from rest_framework.reverse import reverse from rest_framework.views import APIView -@staff_member_required -def installed_plugins_admin_view(request): +class InstalledPluginsAdminView(View): """ Admin view for listing all installed plugins """ - context_data = { - 'plugins': [apps.get_app_config(plugin) for plugin in settings.PLUGINS] - } - return render(request, 'extras/admin/plugins_list.html', context_data) + def get(self, request): + plugins = [apps.get_app_config(plugin) for plugin in settings.PLUGINS] + return render(request, 'extras/admin/plugins_list.html', { + 'plugins': plugins, + }) class InstalledPluginsAPIView(APIView): From 9c16d5a747165cb791c4928c66ad8599bf0bc223 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Fri, 27 Mar 2020 13:57:11 -0400 Subject: [PATCH 097/124] Misc cleanup of PluginConfig processing logic --- netbox/netbox/settings.py | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/netbox/netbox/settings.py b/netbox/netbox/settings.py index 2f65dee30..5e442a17d 100644 --- a/netbox/netbox/settings.py +++ b/netbox/netbox/settings.py @@ -647,7 +647,7 @@ if PLUGINS_ENABLED: # Append plugin to INSTALLED_APPS. Specify the path to the PluginConfig so that we don't # have to define default_app_config. app_config = entry_point.load() - INSTALLED_APPS.append('{}.{}'.format(app_config.__module__, app_config.__name__)) + INSTALLED_APPS.append(f"{app_config.__module__}.{app_config.__name__}") # Check version constraints parsed_min_version = parse_version(app_config.min_version or VERSION) @@ -661,7 +661,7 @@ if PLUGINS_ENABLED: # Add middleware plugin_middleware = app_config.middleware - if plugin_middleware and isinstance(plugin_middleware, list): + if plugin_middleware and type(plugin_middleware) in (list, tuple): MIDDLEWARE.extend(plugin_middleware) # Verify required configuration settings @@ -674,22 +674,21 @@ if PLUGINS_ENABLED: f"configuration.py." ) - # Set defined default setting values + # Apply default configuration values for setting, value in app_config.default_settings.items(): if setting not in PLUGINS_CONFIG[plugin]: PLUGINS_CONFIG[plugin][setting] = value # Apply cacheops config plugin_cacheops = app_config.caching_config - if plugin_cacheops and isinstance(plugin_cacheops, dict): + if plugin_cacheops: + if type(plugin_cacheops) is not dict: + raise ImproperlyConfigured(f"Plugin {plugin} caching_config must be a dictionary.") for key in plugin_cacheops.keys(): # Validate config is only being set for the given plugin - try: - app = key.split('.')[0] - except IndexError: - raise ImproperlyConfigured(f"Plugin {plugin} caching_config is invalid!") + app = key.split('.')[0] if app != plugin: - raise ImproperlyConfigured(f"Plugin {plugin} may not modify caching config for another app!") + raise ImproperlyConfigured(f"Plugin {plugin} may not modify caching config for another app: {app}") else: # Apply the default config like all other core apps plugin_cacheops = {f"{plugin}.*": {'ops': 'all'}} From a914a7c4382349bceca43becc9895c6cccade313 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Mon, 30 Mar 2020 12:39:15 -0400 Subject: [PATCH 098/124] Update serializer context assignment for DRF 3.11 --- netbox/extras/api/customfields.py | 8 ++++---- netbox/secrets/api/serializers.py | 8 -------- 2 files changed, 4 insertions(+), 12 deletions(-) diff --git a/netbox/extras/api/customfields.py b/netbox/extras/api/customfields.py index 5bb1f033d..34e865530 100644 --- a/netbox/extras/api/customfields.py +++ b/netbox/extras/api/customfields.py @@ -20,7 +20,10 @@ class CustomFieldDefaultValues: """ Return a dictionary of all CustomFields assigned to the parent model and their default values. """ - def __call__(self): + requires_context = True + + def __call__(self, serializer_field): + self.model = serializer_field.parent.Meta.model # Retrieve the CustomFields for the parent model content_type = ContentType.objects.get_for_model(self.model) @@ -49,9 +52,6 @@ class CustomFieldDefaultValues: return value - def set_context(self, serializer_field): - self.model = serializer_field.parent.Meta.model - class CustomFieldsSerializer(serializers.BaseSerializer): diff --git a/netbox/secrets/api/serializers.py b/netbox/secrets/api/serializers.py index e278f3c40..0b73f0002 100644 --- a/netbox/secrets/api/serializers.py +++ b/netbox/secrets/api/serializers.py @@ -1,5 +1,4 @@ from rest_framework import serializers -from rest_framework.validators import UniqueTogetherValidator from taggit_serializer.serializers import TaggitSerializer, TagListSerializerField from dcim.api.nested_serializers import NestedDeviceSerializer @@ -43,13 +42,6 @@ class SecretSerializer(TaggitSerializer, CustomFieldModelSerializer): data['ciphertext'] = s.ciphertext data['hash'] = s.hash - # Validate uniqueness of name if one has been provided. - if data.get('name'): - validator = UniqueTogetherValidator(queryset=Secret.objects.all(), fields=('device', 'role', 'name')) - validator.set_context(self) - validator(data) - - # Enforce model validation super().validate(data) return data From 613e37837b303777b864e3e9f9781e62ffa044ca Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Mon, 30 Mar 2020 12:39:45 -0400 Subject: [PATCH 099/124] Update Python dependencies for v2.8 release --- base_requirements.txt | 3 +-- requirements.txt | 18 +++++++++--------- 2 files changed, 10 insertions(+), 11 deletions(-) diff --git a/base_requirements.txt b/base_requirements.txt index e5838ef9b..caf7ba5f3 100644 --- a/base_requirements.txt +++ b/base_requirements.txt @@ -68,8 +68,7 @@ Jinja2 # Simple markup language for rendering HTML # https://github.com/Python-Markdown/markdown -# py-gfm requires Markdown<3.0 -Markdown<3.0 +Markdown # Library for manipulating IP prefixes and addresses # https://github.com/drkjam/netaddr diff --git a/requirements.txt b/requirements.txt index b5318c249..213006da1 100644 --- a/requirements.txt +++ b/requirements.txt @@ -5,21 +5,21 @@ django-debug-toolbar==2.2 django-filter==2.2.0 django-mptt==0.11.0 django-pglocks==1.0.4 -django-prometheus==1.1.0 -django-rq==2.2.0 +django-prometheus==2.0.0 +django-rq==2.3.0 django-tables2==2.2.1 django-taggit==1.2.0 django-taggit-serializer==0.1.7 django-timezone-field==4.0 -djangorestframework==3.10.3 -drf-yasg[validation]==1.17.0 +djangorestframework==3.11.0 +drf-yasg[validation]==1.17.1 gunicorn==20.0.4 -Jinja2==2.10.3 +Jinja2==2.11.1 Markdown==3.2.1 netaddr==0.7.19 Pillow==7.0.0 psycopg2-binary==2.8.4 -pycryptodome==3.9.4 -PyYAML==5.3 -redis==3.3.11 -svgwrite==1.3.1 +pycryptodome==3.9.7 +PyYAML==5.3.1 +redis==3.4.1 +svgwrite==1.4 From 5f1329c71c3cb2cf536bea1547a11d6678b4f34b Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Mon, 30 Mar 2020 13:09:10 -0400 Subject: [PATCH 100/124] Changelog for #3351 --- docs/release-notes/version-2.8.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/release-notes/version-2.8.md b/docs/release-notes/version-2.8.md index f42625ef2..665b2eaf4 100644 --- a/docs/release-notes/version-2.8.md +++ b/docs/release-notes/version-2.8.md @@ -16,6 +16,18 @@ Several new configuration parameters provide support for authenticating an incom If further customization of remote authentication is desired (for instance, if you want to pass group/permission information via HTTP headers as well), NetBox allows you to inject a custom [Django authentication backend](https://docs.djangoproject.com/en/stable/topics/auth/customizing/) to retain full control over the authentication and configuration of remote users. +#### Plugins ([#3351](https://github.com/netbox-community/netbox/issues/3351)) + +This release introduces support for custom plugins, which can be used to extend NetBox's functionality beyond what the core product provides. For example, plugins can be used to: + +* Add new Django models +* Provide new views with custom templates +* Inject custom template into object views +* Introduce new API endpoints +* Add custom request/response middleware + +For NetBox plugins to be recognized, the `PLUGINS_ENABLED` configuration parameter must be set to true. (Plugin support is disabled by default). Plugins can be configured under the `PLUGINS_CONFIG` parameter. More information can be found the in the [plugins documentation](https://netbox.readthedocs.io/en/stable/plugins/). + ### Enhancements * [#1754](https://github.com/netbox-community/netbox/issues/1754) - Added support for nested rack groups From 06116cdde7dc0dc4aabc6802b4e306f2ff27cbe7 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Mon, 30 Mar 2020 15:31:13 -0400 Subject: [PATCH 101/124] Add developer docs for application registry --- docs/development/application-registry.md | 55 ++++++++++++++++++++++++ mkdocs.yml | 1 + 2 files changed, 56 insertions(+) create mode 100644 docs/development/application-registry.md diff --git a/docs/development/application-registry.md b/docs/development/application-registry.md new file mode 100644 index 000000000..67479b6fb --- /dev/null +++ b/docs/development/application-registry.md @@ -0,0 +1,55 @@ +# Application Registry + +The registry is an in-memory data structure which houses various miscellaneous application-wide parameters, such as installed plugins. It is not exposed to the user and is not intended to be modified by any code outside of NetBox core. + +The registry behaves essentially like a Python dictionary, with the notable exception that once a store (key) has been declared, it cannot be deleted or overwritten. The value of a store can, however, me modified; e.g. by appending a value to a list. Store values generally do not change once the application has been initialized. + +## Stores + +### `model_features` + +A dictionary of particular features (e.g. custom fields) mapped to the NetBox models which support them, arranged by app. For example: + +```python +{ + 'custom_fields': { + 'circuits': ['provider', 'circuit'], + 'dcim': ['site', 'rack', 'devicetype', ...], + ... + }, + 'webhooks': { + ... + }, + ... +} +``` + +### `plugin_menu_items` + +Navigation menu items provided by NetBox plugins. Each plugin is registered as a key with the list of menu items it provides. An example: + +```python +{ + 'Plugin A': ( + , , , + ), + 'Plugin B': ( + , , , + ), +} +``` + +### `plugin_template_extensions` + +Plugin content that gets embedded into core NetBox templates. The store comprises NetBox models registered as dictionary keys, each pointing to a list of applicable template extension classes that exist. An example: + +```python +{ + 'dcim.site': [ + , , , + ], + 'dcim.rack': [ + , , + ], +} +``` diff --git a/mkdocs.yml b/mkdocs.yml index 69744ad2f..d1ced6d8c 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -71,6 +71,7 @@ nav: - Style Guide: 'development/style-guide.md' - Utility Views: 'development/utility-views.md' - Extending Models: 'development/extending-models.md' + - Application Registry: 'development/application-registry.md' - Release Checklist: 'development/release-checklist.md' - Squashing Migrations: 'development/squashing-migrations.md' - Release Notes: From f469c794cea0401952944021b6b80cec63e6e560 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Wed, 1 Apr 2020 10:02:18 -0400 Subject: [PATCH 102/124] Change PLUGINS_ENABLED to a list of specific plugins (PLUGINS) --- docs/configuration/optional-settings.md | 24 ++--- docs/plugins/development.md | 9 +- docs/plugins/index.md | 8 +- netbox/netbox/settings.py | 113 +++++++++++++----------- 4 files changed, 83 insertions(+), 71 deletions(-) diff --git a/docs/configuration/optional-settings.md b/docs/configuration/optional-settings.md index c4d3c0897..80715b7ec 100644 --- a/docs/configuration/optional-settings.md +++ b/docs/configuration/optional-settings.md @@ -299,6 +299,17 @@ Determine how many objects to display per page within each list of objects. --- +## PLUGINS + +Default: Empty + +A list of installed [NetBox plugins](../../plugins/) to enable. Plugins will not take effect unless they are listed here. + +!!! warning + Plugins extend NetBox by allowing external code to run with the same access and privileges as NetBox itself. Only install plugins from trusted sources. The NetBox maintainers make absolutely no guarantees about the integrity or security of your installation with plugins enabled. + +--- + ## PLUGINS_CONFIG Default: Empty @@ -317,18 +328,7 @@ PLUGINS_CONFIG = { } ``` -Note that `PLUGINS_ENABLED` must be set to True for this to take effect. - ---- - -## PLUGINS_ENABLED - -Default: `False` - -Enable [NetBox plugins](../../plugins/). - -!!! warning - Plugins extend NetBox by allowing external code to run with the same access and privileges as NetBox itself. Only install plugins from trusted sources. The NetBox maintainers make absolutely no guarantees about the integrity or security of your installation with plugins enabled. +Note that a plugin must be listed in `PLUGINS` for its configuration to take effect. --- diff --git a/docs/plugins/development.md b/docs/plugins/development.md index b96fbec49..8a0619c54 100644 --- a/docs/plugins/development.md +++ b/docs/plugins/development.md @@ -61,13 +61,10 @@ setup( install_requires=[], packages=find_packages(), include_package_data=True, - entry_points={ - 'netbox_plugins': 'netbox_animal_sounds=netbox_animal_sounds:AnimalSoundsConfig' - } ) ``` -Many of these are self-explanatory, but for more information, see the [setuptools documentation](https://setuptools.readthedocs.io/en/latest/setuptools.html). The key requirement for a NetBox plugin is the presence of an entry point for `netbox_plugins` pointing to the `PluginConfig` subclass, which we'll create next. +Many of these are self-explanatory, but for more information, see the [setuptools documentation](https://setuptools.readthedocs.io/en/latest/setuptools.html). ### Define a PluginConfig @@ -87,8 +84,12 @@ class AnimalSoundsConfig(PluginConfig): default_settings = { 'loud': False } + +config = AnimalSoundsConfig ``` +NetBox looks for the `config` variable within a plugin's `__init__.py` to load its configuration. Typically, this will be set to the PluginConfig subclass, but you may wish to dynamically generate a PluginConfig class based on environment variables or other factors. + #### PluginConfig Attributes | Name | Description | diff --git a/docs/plugins/index.md b/docs/plugins/index.md index f2ea69719..05f7cd15b 100644 --- a/docs/plugins/index.md +++ b/docs/plugins/index.md @@ -41,12 +41,14 @@ $ source /opt/netbox/venv/bin/activate Alternatively, you may wish to install the plugin manually by running `python setup.py install`. If you are developing a plugin and want to install it only temporarily, run `python setup.py develop` instead. -### Enable Plugins +### Enable the Plugin -In `configuration.py`, ensure the `PLUGINS_ENABLED` parameter is set to True: +In `configuration.py`, add the plugin's name to the `PLUGINS` list: ```python -PLUGINS_ENABLED = True +PLUGINS = [ + 'plugin_name', +] ``` ### Configure Plugin diff --git a/netbox/netbox/settings.py b/netbox/netbox/settings.py index 5e442a17d..370081155 100644 --- a/netbox/netbox/settings.py +++ b/netbox/netbox/settings.py @@ -10,7 +10,7 @@ from urllib.parse import urlsplit from django.contrib.messages import constants as messages from django.core.exceptions import ImproperlyConfigured, ValidationError from django.core.validators import URLValidator -from pkg_resources import iter_entry_points, parse_version +from pkg_resources import parse_version # @@ -92,8 +92,8 @@ NAPALM_PASSWORD = getattr(configuration, 'NAPALM_PASSWORD', '') NAPALM_TIMEOUT = getattr(configuration, 'NAPALM_TIMEOUT', 30) NAPALM_USERNAME = getattr(configuration, 'NAPALM_USERNAME', '') PAGINATE_COUNT = getattr(configuration, 'PAGINATE_COUNT', 50) +PLUGINS = getattr(configuration, 'PLUGINS', []) PLUGINS_CONFIG = getattr(configuration, 'PLUGINS_CONFIG', {}) -PLUGINS_ENABLED = getattr(configuration, 'PLUGINS_ENABLED', False) PREFER_IPV4 = getattr(configuration, 'PREFER_IPV4', False) REMOTE_AUTH_AUTO_CREATE_USER = getattr(configuration, 'REMOTE_AUTH_AUTO_CREATE_USER', False) REMOTE_AUTH_BACKEND = getattr(configuration, 'REMOTE_AUTH_BACKEND', 'utilities.auth_backends.RemoteUserBackend') @@ -637,59 +637,68 @@ if PAGINATE_COUNT not in PER_PAGE_DEFAULTS: # Plugins # -PLUGINS = set() -if PLUGINS_ENABLED: - for entry_point in iter_entry_points(group='netbox_plugins', name=None): - # Append plugin name to PLUGINS - plugin = entry_point.module_name - PLUGINS.add(plugin) +for plugin_name in PLUGINS: - # Append plugin to INSTALLED_APPS. Specify the path to the PluginConfig so that we don't - # have to define default_app_config. - app_config = entry_point.load() - INSTALLED_APPS.append(f"{app_config.__module__}.{app_config.__name__}") + # Import plugin module + try: + plugin = importlib.import_module(plugin_name) + except ImportError: + raise ImproperlyConfigured( + f"Unable to import plugin {plugin_name}: Module not found. Check that the plugin module has been " + f"installed within the correct Python environment." + ) - # Check version constraints - parsed_min_version = parse_version(app_config.min_version or VERSION) - parsed_max_version = parse_version(app_config.max_version or VERSION) - if app_config.min_version and app_config.max_version and parsed_min_version > parsed_max_version: - raise ImproperlyConfigured(f"Plugin {plugin} specifies invalid version constraints!") - if app_config.min_version and parsed_min_version > parse_version(VERSION): - raise ImproperlyConfigured(f"Plugin {plugin} requires NetBox minimum version {app_config.min_version}!") - if app_config.max_version and parsed_max_version < parse_version(VERSION): - raise ImproperlyConfigured(f"Plugin {plugin} requires NetBox maximum version {app_config.max_version}!") + # Determine plugin config and add to INSTALLED_APPS. + try: + plugin_config = plugin.config + INSTALLED_APPS.append(f"{plugin_config.__module__}.{plugin_config.__name__}") + except AttributeError: + raise ImproperlyConfigured( + f"Plugin {plugin_name} does not provide a 'config' variable. This should be defined in the plugin's " + f"__init__.py file and point to the PluginConfig subclass." + ) - # Add middleware - plugin_middleware = app_config.middleware - if plugin_middleware and type(plugin_middleware) in (list, tuple): - MIDDLEWARE.extend(plugin_middleware) + # Check version constraints + parsed_min_version = parse_version(plugin_config.min_version or VERSION) + parsed_max_version = parse_version(plugin_config.max_version or VERSION) + if plugin_config.min_version and plugin_config.max_version and parsed_min_version > parsed_max_version: + raise ImproperlyConfigured(f"Plugin {plugin_name} specifies invalid version constraints!") + if plugin_config.min_version and parsed_min_version > parse_version(VERSION): + raise ImproperlyConfigured(f"Plugin {plugin_name} requires NetBox minimum version {plugin_config.min_version}!") + if plugin_config.max_version and parsed_max_version < parse_version(VERSION): + raise ImproperlyConfigured(f"Plugin {plugin_name} requires NetBox maximum version {plugin_config.max_version}!") - # Verify required configuration settings - if plugin not in PLUGINS_CONFIG: - PLUGINS_CONFIG[plugin] = {} - for setting in app_config.required_settings: - if setting not in PLUGINS_CONFIG[plugin]: - raise ImproperlyConfigured( - f"Plugin {plugin} requires '{setting}' to be present in the PLUGINS_CONFIG section of " - f"configuration.py." - ) + # Add middleware + plugin_middleware = plugin_config.middleware + if plugin_middleware and type(plugin_middleware) in (list, tuple): + MIDDLEWARE.extend(plugin_middleware) - # Apply default configuration values - for setting, value in app_config.default_settings.items(): - if setting not in PLUGINS_CONFIG[plugin]: - PLUGINS_CONFIG[plugin][setting] = value + # Verify required configuration settings + if plugin_name not in PLUGINS_CONFIG: + PLUGINS_CONFIG[plugin_name] = {} + for setting in plugin_config.required_settings: + if setting not in PLUGINS_CONFIG[plugin_name]: + raise ImproperlyConfigured( + f"Plugin {plugin_name} requires '{setting}' to be present in the PLUGINS_CONFIG section of " + f"configuration.py." + ) - # Apply cacheops config - plugin_cacheops = app_config.caching_config - if plugin_cacheops: - if type(plugin_cacheops) is not dict: - raise ImproperlyConfigured(f"Plugin {plugin} caching_config must be a dictionary.") - for key in plugin_cacheops.keys(): - # Validate config is only being set for the given plugin - app = key.split('.')[0] - if app != plugin: - raise ImproperlyConfigured(f"Plugin {plugin} may not modify caching config for another app: {app}") - else: - # Apply the default config like all other core apps - plugin_cacheops = {f"{plugin}.*": {'ops': 'all'}} - CACHEOPS.update(plugin_cacheops) + # Apply default configuration values + for setting, value in plugin_config.default_settings.items(): + if setting not in PLUGINS_CONFIG[plugin_name]: + PLUGINS_CONFIG[plugin_name][setting] = value + + # Apply cacheops config + plugin_cacheops = plugin_config.caching_config + if plugin_cacheops: + if type(plugin_cacheops) is not dict: + raise ImproperlyConfigured(f"Plugin {plugin_name} caching_config must be a dictionary.") + for key in plugin_cacheops.keys(): + # Validate config is only being set for the given plugin + app = key.split('.')[0] + if app != plugin_name: + raise ImproperlyConfigured(f"Plugin {plugin_name} may not modify caching config for another app: {app}") + else: + # Apply the default config like all other core apps + plugin_cacheops = {f"{plugin_name}.*": {'ops': 'all'}} + CACHEOPS.update(plugin_cacheops) From 0432b1a6f9a27bb9a805c9e98147b7c1aeaa032c Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Wed, 1 Apr 2020 12:10:19 -0400 Subject: [PATCH 103/124] Move default caching_config to PluginConfig class --- docs/plugins/development.md | 15 +++++++++++++-- netbox/extras/plugins/__init__.py | 6 ++++-- netbox/netbox/settings.py | 18 +++++------------- 3 files changed, 22 insertions(+), 17 deletions(-) diff --git a/docs/plugins/development.md b/docs/plugins/development.md index 8a0619c54..9f9be2514 100644 --- a/docs/plugins/development.md +++ b/docs/plugins/development.md @@ -360,17 +360,28 @@ template_extensions = [AddSiteAnimal, AddRackAnimal] ## Caching Configuration -By default, all query operations within a plugin are cached. To change this, define a caching configuration under the PluginConfig class' `caching_config` attribute. An example configuration is below: +By default, all query operations within a plugin are cached. To change this, define a caching configuration under the PluginConfig class' `caching_config` attribute. All configuration keys will be applied within the context of the plugin; there is no need to include the plugin name. An example configuration is below: ```python class MyPluginConfig(PluginConfig): ... caching_config = { - 'my_plugin.foo': { + 'foo': { 'ops': 'get', 'timeout': 60 * 15, }, + '*': { + 'ops': 'all', + } } ``` +To disable caching for your plugin entirely, set: + +```python +caching_config = { + '*': None +} +``` + See the [django-cacheops](https://github.com/Suor/django-cacheops) documentation for more detail on configuring caching. diff --git a/netbox/extras/plugins/__init__.py b/netbox/extras/plugins/__init__.py index 644188823..6e515dd5b 100644 --- a/netbox/extras/plugins/__init__.py +++ b/netbox/extras/plugins/__init__.py @@ -44,8 +44,10 @@ class PluginConfig(AppConfig): # Middleware classes provided by the plugin middleware = [] - # Caching configuration - caching_config = {} + # Cacheops configuration. Cache all operations by default. + caching_config = { + '*': {'ops': 'all'}, + } # Default integration paths. Plugin authors can override these to customize the paths to # integrated components. diff --git a/netbox/netbox/settings.py b/netbox/netbox/settings.py index 370081155..c172aeaa9 100644 --- a/netbox/netbox/settings.py +++ b/netbox/netbox/settings.py @@ -689,16 +689,8 @@ for plugin_name in PLUGINS: PLUGINS_CONFIG[plugin_name][setting] = value # Apply cacheops config - plugin_cacheops = plugin_config.caching_config - if plugin_cacheops: - if type(plugin_cacheops) is not dict: - raise ImproperlyConfigured(f"Plugin {plugin_name} caching_config must be a dictionary.") - for key in plugin_cacheops.keys(): - # Validate config is only being set for the given plugin - app = key.split('.')[0] - if app != plugin_name: - raise ImproperlyConfigured(f"Plugin {plugin_name} may not modify caching config for another app: {app}") - else: - # Apply the default config like all other core apps - plugin_cacheops = {f"{plugin_name}.*": {'ops': 'all'}} - CACHEOPS.update(plugin_cacheops) + if type(plugin_config.caching_config) is not dict: + raise ImproperlyConfigured(f"Plugin {plugin_name} caching_config must be a dictionary.") + CACHEOPS.update({ + f"{plugin_name}.{key}": value for key, value in plugin_config.caching_config.items() + }) From f3169589435e753a00f34473941ac609c0d7ab38 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Wed, 1 Apr 2020 13:23:29 -0400 Subject: [PATCH 104/124] Establish a separate configuration file for testing --- netbox/netbox/configuration.testing.py | 36 ++++++++++++++++++++++++++ scripts/cibuild.sh | 6 ++--- 2 files changed, 38 insertions(+), 4 deletions(-) create mode 100644 netbox/netbox/configuration.testing.py diff --git a/netbox/netbox/configuration.testing.py b/netbox/netbox/configuration.testing.py new file mode 100644 index 000000000..8d66515bb --- /dev/null +++ b/netbox/netbox/configuration.testing.py @@ -0,0 +1,36 @@ +################################################################### +# This file serves as a base configuration for testing purposes # +# only. It is not intended for production use. # +################################################################### + +ALLOWED_HOSTS = ['*'] + +DATABASE = { + 'NAME': 'netbox', + 'USER': '', + 'PASSWORD': '', + 'HOST': 'localhost', + 'PORT': '', + 'CONN_MAX_AGE': 300, +} + +REDIS = { + 'tasks': { + 'HOST': 'localhost', + 'PORT': 6379, + 'PASSWORD': '', + 'DATABASE': 0, + 'DEFAULT_TIMEOUT': 300, + 'SSL': False, + }, + 'caching': { + 'HOST': 'localhost', + 'PORT': 6379, + 'PASSWORD': '', + 'DATABASE': 1, + 'DEFAULT_TIMEOUT': 300, + 'SSL': False, + } +} + +SECRET_KEY = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789' diff --git a/scripts/cibuild.sh b/scripts/cibuild.sh index 282000b0a..21ccfef67 100755 --- a/scripts/cibuild.sh +++ b/scripts/cibuild.sh @@ -34,11 +34,9 @@ if [[ $RC != 0 ]]; then EXIT=$RC fi -# Prepare configuration file for use in CI +# Point to the testing configuration file for use in CI CONFIG="netbox/netbox/configuration.py" -cp netbox/netbox/configuration.example.py $CONFIG -sed -i -e "s/ALLOWED_HOSTS = \[\]/ALLOWED_HOSTS = \['*'\]/g" $CONFIG -sed -i -e "s/SECRET_KEY = ''/SECRET_KEY = 'netboxci'/g" $CONFIG +ln -s netbox/netbox/configuration.testing.py $CONFIG # Run NetBox tests coverage run --source="netbox/" netbox/manage.py test netbox/ From 093181c1867b4266e6dc18a214d0ea2c8fad6e1f Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Wed, 1 Apr 2020 13:29:54 -0400 Subject: [PATCH 105/124] Correct path to test configuration file --- scripts/cibuild.sh | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/scripts/cibuild.sh b/scripts/cibuild.sh index 21ccfef67..6a0422308 100755 --- a/scripts/cibuild.sh +++ b/scripts/cibuild.sh @@ -35,8 +35,7 @@ if [[ $RC != 0 ]]; then fi # Point to the testing configuration file for use in CI -CONFIG="netbox/netbox/configuration.py" -ln -s netbox/netbox/configuration.testing.py $CONFIG +ln -s configuration.testing.py netbox/netbox/configuration.py # Run NetBox tests coverage run --source="netbox/" netbox/manage.py test netbox/ From 30e330c88758581b661b1f75da07f1eb5ca7d057 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Wed, 1 Apr 2020 17:08:47 -0400 Subject: [PATCH 106/124] Initial implementation of tests for plugins framework --- netbox/extras/plugins/urls.py | 3 +- netbox/extras/tests/dummy_plugin/__init__.py | 15 ++++ netbox/extras/tests/dummy_plugin/admin.py | 9 +++ .../tests/dummy_plugin/api/serializers.py | 9 +++ netbox/extras/tests/dummy_plugin/api/urls.py | 6 ++ netbox/extras/tests/dummy_plugin/api/views.py | 8 ++ .../extras/tests/dummy_plugin/middleware.py | 7 ++ .../dummy_plugin/migrations/0001_initial.py | 23 ++++++ .../tests/dummy_plugin/migrations/__init__.py | 0 netbox/extras/tests/dummy_plugin/models.py | 13 ++++ .../extras/tests/dummy_plugin/navigation.py | 28 +++++++ .../tests/dummy_plugin/template_content.py | 20 +++++ netbox/extras/tests/dummy_plugin/urls.py | 8 ++ netbox/extras/tests/dummy_plugin/views.py | 11 +++ netbox/extras/tests/test_plugins.py | 74 +++++++++++++++++++ netbox/netbox/configuration.testing.py | 4 + 16 files changed, 237 insertions(+), 1 deletion(-) create mode 100644 netbox/extras/tests/dummy_plugin/__init__.py create mode 100644 netbox/extras/tests/dummy_plugin/admin.py create mode 100644 netbox/extras/tests/dummy_plugin/api/serializers.py create mode 100644 netbox/extras/tests/dummy_plugin/api/urls.py create mode 100644 netbox/extras/tests/dummy_plugin/api/views.py create mode 100644 netbox/extras/tests/dummy_plugin/middleware.py create mode 100644 netbox/extras/tests/dummy_plugin/migrations/0001_initial.py create mode 100644 netbox/extras/tests/dummy_plugin/migrations/__init__.py create mode 100644 netbox/extras/tests/dummy_plugin/models.py create mode 100644 netbox/extras/tests/dummy_plugin/navigation.py create mode 100644 netbox/extras/tests/dummy_plugin/template_content.py create mode 100644 netbox/extras/tests/dummy_plugin/urls.py create mode 100644 netbox/extras/tests/dummy_plugin/views.py create mode 100644 netbox/extras/tests/test_plugins.py diff --git a/netbox/extras/plugins/urls.py b/netbox/extras/plugins/urls.py index f3f591cb0..1677692cf 100644 --- a/netbox/extras/plugins/urls.py +++ b/netbox/extras/plugins/urls.py @@ -19,7 +19,8 @@ plugin_admin_patterns = [ # Register base/API URL patterns for each plugin for plugin in settings.PLUGINS: - app = apps.get_app_config(plugin) + plugin_name = plugin.split('.')[-1] + app = apps.get_app_config(plugin_name) base_url = getattr(app, 'base_url') or app.label # Check if the plugin specifies any base URLs diff --git a/netbox/extras/tests/dummy_plugin/__init__.py b/netbox/extras/tests/dummy_plugin/__init__.py new file mode 100644 index 000000000..eaaff4f5e --- /dev/null +++ b/netbox/extras/tests/dummy_plugin/__init__.py @@ -0,0 +1,15 @@ +from extras.plugins import PluginConfig + + +class DummyPluginConfig(PluginConfig): + name = 'extras.tests.dummy_plugin' + verbose_name = 'Dummy plugin' + version = '0.0' + description = 'For testing purposes only' + base_url = 'dummy-plugin' + middleware = [ + 'extras.tests.dummy_plugin.middleware.DummyMiddleware' + ] + + +config = DummyPluginConfig diff --git a/netbox/extras/tests/dummy_plugin/admin.py b/netbox/extras/tests/dummy_plugin/admin.py new file mode 100644 index 000000000..d6d2233e5 --- /dev/null +++ b/netbox/extras/tests/dummy_plugin/admin.py @@ -0,0 +1,9 @@ +from django.contrib import admin + +from netbox.admin import admin_site +from .models import DummyModel + + +@admin.register(DummyModel, site=admin_site) +class AnimalAdmin(admin.ModelAdmin): + list_display = ('name', 'number') diff --git a/netbox/extras/tests/dummy_plugin/api/serializers.py b/netbox/extras/tests/dummy_plugin/api/serializers.py new file mode 100644 index 000000000..c0f89fd0f --- /dev/null +++ b/netbox/extras/tests/dummy_plugin/api/serializers.py @@ -0,0 +1,9 @@ +from rest_framework.serializers import ModelSerializer +from extras.tests.dummy_plugin.models import DummyModel + + +class DummySerializer(ModelSerializer): + + class Meta: + model = DummyModel + fields = ('id', 'name', 'sound') diff --git a/netbox/extras/tests/dummy_plugin/api/urls.py b/netbox/extras/tests/dummy_plugin/api/urls.py new file mode 100644 index 000000000..d6c27809b --- /dev/null +++ b/netbox/extras/tests/dummy_plugin/api/urls.py @@ -0,0 +1,6 @@ +from rest_framework import routers +from .views import DummyViewSet + +router = routers.DefaultRouter() +router.register('dummy-models', DummyViewSet) +urlpatterns = router.urls diff --git a/netbox/extras/tests/dummy_plugin/api/views.py b/netbox/extras/tests/dummy_plugin/api/views.py new file mode 100644 index 000000000..1977ec2af --- /dev/null +++ b/netbox/extras/tests/dummy_plugin/api/views.py @@ -0,0 +1,8 @@ +from rest_framework.viewsets import ModelViewSet +from extras.tests.dummy_plugin.models import DummyModel +from .serializers import DummySerializer + + +class DummyViewSet(ModelViewSet): + queryset = DummyModel.objects.all() + serializer_class = DummySerializer diff --git a/netbox/extras/tests/dummy_plugin/middleware.py b/netbox/extras/tests/dummy_plugin/middleware.py new file mode 100644 index 000000000..97592c3b2 --- /dev/null +++ b/netbox/extras/tests/dummy_plugin/middleware.py @@ -0,0 +1,7 @@ +class DummyMiddleware: + + def __init__(self, get_response): + self.get_response = get_response + + def __call__(self, request): + return self.get_response(request) diff --git a/netbox/extras/tests/dummy_plugin/migrations/0001_initial.py b/netbox/extras/tests/dummy_plugin/migrations/0001_initial.py new file mode 100644 index 000000000..4342d9576 --- /dev/null +++ b/netbox/extras/tests/dummy_plugin/migrations/0001_initial.py @@ -0,0 +1,23 @@ +from django.db import migrations, models + + +class Migration(migrations.Migration): + + initial = True + + dependencies = [ + ] + + operations = [ + migrations.CreateModel( + name='DummyModel', + fields=[ + ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False)), + ('name', models.CharField(max_length=20)), + ('number', models.IntegerField(default=100)), + ], + options={ + 'ordering': ['name'], + }, + ), + ] diff --git a/netbox/extras/tests/dummy_plugin/migrations/__init__.py b/netbox/extras/tests/dummy_plugin/migrations/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/netbox/extras/tests/dummy_plugin/models.py b/netbox/extras/tests/dummy_plugin/models.py new file mode 100644 index 000000000..9bd39a46b --- /dev/null +++ b/netbox/extras/tests/dummy_plugin/models.py @@ -0,0 +1,13 @@ +from django.db import models + + +class DummyModel(models.Model): + name = models.CharField( + max_length=20 + ) + number = models.IntegerField( + default=100 + ) + + class Meta: + ordering = ['name'] diff --git a/netbox/extras/tests/dummy_plugin/navigation.py b/netbox/extras/tests/dummy_plugin/navigation.py new file mode 100644 index 000000000..028f0884f --- /dev/null +++ b/netbox/extras/tests/dummy_plugin/navigation.py @@ -0,0 +1,28 @@ +from extras.plugins import PluginMenuButton, PluginMenuItem +from utilities.choices import ButtonColorChoices + + +menu_items = ( + PluginMenuItem( + link='plugins:dummy_plugin:dummy_models', + link_text='Item 1', + buttons=( + PluginMenuButton( + link='plugins:netbox_animal_sounds:random_animal', + title='Random animal', + icon_class='fa-question' + ), + PluginMenuButton( + link='admin:netbox_animal_sounds_animal_add', + title='Add a new animal', + icon_class='fa-plus', + color=ButtonColorChoices.GREEN, + permissions=['netbox_animal_sounds.add_animal'] + ), + ) + ), + PluginMenuItem( + link='plugins:dummy_plugin:dummy_models', + link_text='Item 2', + ), +) diff --git a/netbox/extras/tests/dummy_plugin/template_content.py b/netbox/extras/tests/dummy_plugin/template_content.py new file mode 100644 index 000000000..fed17ca0b --- /dev/null +++ b/netbox/extras/tests/dummy_plugin/template_content.py @@ -0,0 +1,20 @@ +from extras.plugins import PluginTemplateExtension + + +class SiteContent(PluginTemplateExtension): + model = 'dcim.site' + + def left_page(self): + return "SITE CONTENT - LEFT PAGE" + + def right_page(self): + return "SITE CONTENT - RIGHT PAGE" + + def full_width_page(self): + return "SITE CONTENT - FULL WIDTH PAGE" + + def full_buttons(self): + return "SITE CONTENT - BUTTONS" + + +template_extensions = [SiteContent] diff --git a/netbox/extras/tests/dummy_plugin/urls.py b/netbox/extras/tests/dummy_plugin/urls.py new file mode 100644 index 000000000..053a7443e --- /dev/null +++ b/netbox/extras/tests/dummy_plugin/urls.py @@ -0,0 +1,8 @@ +from django.urls import path + +from . import views + + +urlpatterns = ( + path('models/', views.DummyModelsView.as_view(), name='dummy_models'), +) diff --git a/netbox/extras/tests/dummy_plugin/views.py b/netbox/extras/tests/dummy_plugin/views.py new file mode 100644 index 000000000..4512758df --- /dev/null +++ b/netbox/extras/tests/dummy_plugin/views.py @@ -0,0 +1,11 @@ +from django.http import HttpResponse +from django.views.generic import View + +from .models import DummyModel + + +class DummyModelsView(View): + + def get(self, request): + instance_count = DummyModel.objects.count() + return HttpResponse(f"Instances: {instance_count}") diff --git a/netbox/extras/tests/test_plugins.py b/netbox/extras/tests/test_plugins.py new file mode 100644 index 000000000..6134fbd82 --- /dev/null +++ b/netbox/extras/tests/test_plugins.py @@ -0,0 +1,74 @@ +from django.conf import settings +from django.test import Client, TestCase +from django.urls import reverse + +from extras.registry import registry +from extras.tests.dummy_plugin.models import DummyModel +from extras.tests.dummy_plugin.template_content import SiteContent + + +class PluginTest(TestCase): + + def test_config(self): + + self.assertIn('extras.tests.dummy_plugin.DummyPluginConfig', settings.INSTALLED_APPS) + + def test_models(self): + + # Test saving an instance + instance = DummyModel(name='Instance 1', number=100) + instance.save() + self.assertIsNotNone(instance.pk) + + # Test deleting an instance + instance.delete() + self.assertIsNone(instance.pk) + + def test_admin(self): + + # Test admin view URL resolution + url = reverse('admin:dummy_plugin_dummymodel_add') + self.assertEqual(url, '/admin/dummy_plugin/dummymodel/add/') + + def test_views(self): + + # Test URL resolution + url = reverse('plugins:dummy_plugin:dummy_models') + self.assertEqual(url, '/plugins/dummy-plugin/models/') + + # Test GET request + client = Client() + response = client.get(url) + self.assertEqual(response.status_code, 200) + + def test_api_views(self): + + # Test URL resolution + url = reverse('plugins-api:dummy_plugin-api:dummymodel-list') + self.assertEqual(url, '/api/plugins/dummy-plugin/dummy-models/') + + # Test GET request + client = Client() + response = client.get(url) + self.assertEqual(response.status_code, 200) + + def test_menu_items(self): + """ + Check that plugin MenuItems and MenuButtons are registered. + """ + self.assertIn('Dummy plugin', registry['plugin_menu_items']) + menu_items = registry['plugin_menu_items']['Dummy plugin'] + self.assertEqual(len(menu_items), 2) + self.assertEqual(len(menu_items[0].buttons), 2) + + def test_template_extensions(self): + """ + Check that plugin TemplateExtensions are registered. + """ + self.assertIn(SiteContent, registry['plugin_template_extensions']['dcim.site']) + + def test_middleware(self): + """ + Check that plugin middleware is registered. + """ + self.assertIn('extras.tests.dummy_plugin.middleware.DummyMiddleware', settings.MIDDLEWARE) diff --git a/netbox/netbox/configuration.testing.py b/netbox/netbox/configuration.testing.py index 8d66515bb..3cade747f 100644 --- a/netbox/netbox/configuration.testing.py +++ b/netbox/netbox/configuration.testing.py @@ -14,6 +14,10 @@ DATABASE = { 'CONN_MAX_AGE': 300, } +PLUGINS = [ + 'extras.tests.dummy_plugin' +] + REDIS = { 'tasks': { 'HOST': 'localhost', From 92fc28aa09b4030aa8535f4590eb4b635158fbd7 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Wed, 1 Apr 2020 17:18:15 -0400 Subject: [PATCH 107/124] Remove errant references to external plugin --- netbox/extras/tests/dummy_plugin/admin.py | 2 +- netbox/extras/tests/dummy_plugin/navigation.py | 13 +++++-------- 2 files changed, 6 insertions(+), 9 deletions(-) diff --git a/netbox/extras/tests/dummy_plugin/admin.py b/netbox/extras/tests/dummy_plugin/admin.py index d6d2233e5..83bc22ad8 100644 --- a/netbox/extras/tests/dummy_plugin/admin.py +++ b/netbox/extras/tests/dummy_plugin/admin.py @@ -5,5 +5,5 @@ from .models import DummyModel @admin.register(DummyModel, site=admin_site) -class AnimalAdmin(admin.ModelAdmin): +class DummyModelAdmin(admin.ModelAdmin): list_display = ('name', 'number') diff --git a/netbox/extras/tests/dummy_plugin/navigation.py b/netbox/extras/tests/dummy_plugin/navigation.py index 028f0884f..75b500916 100644 --- a/netbox/extras/tests/dummy_plugin/navigation.py +++ b/netbox/extras/tests/dummy_plugin/navigation.py @@ -1,5 +1,4 @@ from extras.plugins import PluginMenuButton, PluginMenuItem -from utilities.choices import ButtonColorChoices menu_items = ( @@ -8,16 +7,14 @@ menu_items = ( link_text='Item 1', buttons=( PluginMenuButton( - link='plugins:netbox_animal_sounds:random_animal', - title='Random animal', - icon_class='fa-question' + link='admin:dummy_plugin_dummymodel_add', + title='Add a new dummy model', + icon_class='fa-plus', ), PluginMenuButton( - link='admin:netbox_animal_sounds_animal_add', - title='Add a new animal', + link='admin:dummy_plugin_dummymodel_add', + title='Add a new dummy model', icon_class='fa-plus', - color=ButtonColorChoices.GREEN, - permissions=['netbox_animal_sounds.add_animal'] ), ) ), From ee4c5ef64a8d84f6d7b5a2ef63674d1364c4ea01 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Thu, 2 Apr 2020 15:11:19 -0400 Subject: [PATCH 108/124] Fix CI tests --- netbox/extras/tests/dummy_plugin/api/serializers.py | 2 +- netbox/extras/tests/test_plugins.py | 3 ++- netbox/netbox/configuration.testing.py | 2 +- 3 files changed, 4 insertions(+), 3 deletions(-) diff --git a/netbox/extras/tests/dummy_plugin/api/serializers.py b/netbox/extras/tests/dummy_plugin/api/serializers.py index c0f89fd0f..101786168 100644 --- a/netbox/extras/tests/dummy_plugin/api/serializers.py +++ b/netbox/extras/tests/dummy_plugin/api/serializers.py @@ -6,4 +6,4 @@ class DummySerializer(ModelSerializer): class Meta: model = DummyModel - fields = ('id', 'name', 'sound') + fields = ('id', 'name', 'number') diff --git a/netbox/extras/tests/test_plugins.py b/netbox/extras/tests/test_plugins.py index 6134fbd82..83a7e33ed 100644 --- a/netbox/extras/tests/test_plugins.py +++ b/netbox/extras/tests/test_plugins.py @@ -1,5 +1,5 @@ from django.conf import settings -from django.test import Client, TestCase +from django.test import Client, TestCase, override_settings from django.urls import reverse from extras.registry import registry @@ -41,6 +41,7 @@ class PluginTest(TestCase): response = client.get(url) self.assertEqual(response.status_code, 200) + @override_settings(EXEMPT_VIEW_PERMISSIONS=['*']) def test_api_views(self): # Test URL resolution diff --git a/netbox/netbox/configuration.testing.py b/netbox/netbox/configuration.testing.py index 3cade747f..09d5362ab 100644 --- a/netbox/netbox/configuration.testing.py +++ b/netbox/netbox/configuration.testing.py @@ -15,7 +15,7 @@ DATABASE = { } PLUGINS = [ - 'extras.tests.dummy_plugin' + 'extras.tests.dummy_plugin', ] REDIS = { From 9e0aa0d11ea16e324b8121051c6a1a42f3aaee85 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Thu, 2 Apr 2020 15:43:23 -0400 Subject: [PATCH 109/124] Naming tweaks --- netbox/extras/plugins/urls.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/netbox/extras/plugins/urls.py b/netbox/extras/plugins/urls.py index 1677692cf..b4360dc9e 100644 --- a/netbox/extras/plugins/urls.py +++ b/netbox/extras/plugins/urls.py @@ -18,14 +18,14 @@ plugin_admin_patterns = [ ] # Register base/API URL patterns for each plugin -for plugin in settings.PLUGINS: - plugin_name = plugin.split('.')[-1] +for plugin_path in settings.PLUGINS: + plugin_name = plugin_path.split('.')[-1] app = apps.get_app_config(plugin_name) base_url = getattr(app, 'base_url') or app.label # Check if the plugin specifies any base URLs try: - urlpatterns = import_string(f"{plugin}.urls.urlpatterns") + urlpatterns = import_string(f"{plugin_path}.urls.urlpatterns") plugin_patterns.append( path(f"{base_url}/", include((urlpatterns, app.label))) ) @@ -34,7 +34,7 @@ for plugin in settings.PLUGINS: # Check if the plugin specifies any API URLs try: - urlpatterns = import_string(f"{plugin}.api.urls.urlpatterns") + urlpatterns = import_string(f"{plugin_path}.api.urls.urlpatterns") plugin_api_patterns.append( path(f"{base_url}/", include((urlpatterns, f"{app.label}-api"))) ) From 6413d47fb2924a404ca9ee0bf95b9f5e2a01173b Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Thu, 2 Apr 2020 16:13:15 -0400 Subject: [PATCH 110/124] Skip PluginTest if dummy_plugin not in PLUGINS list --- netbox/extras/tests/test_plugins.py | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/netbox/extras/tests/test_plugins.py b/netbox/extras/tests/test_plugins.py index 83a7e33ed..dba6308b9 100644 --- a/netbox/extras/tests/test_plugins.py +++ b/netbox/extras/tests/test_plugins.py @@ -1,12 +1,13 @@ +from unittest import skipIf + from django.conf import settings from django.test import Client, TestCase, override_settings from django.urls import reverse from extras.registry import registry -from extras.tests.dummy_plugin.models import DummyModel -from extras.tests.dummy_plugin.template_content import SiteContent +@skipIf('extras.tests.dummy_plugin.DummyPluginConfig' not in settings.PLUGINS, "dummy_plugin not in settings.PLUGINS") class PluginTest(TestCase): def test_config(self): @@ -14,6 +15,7 @@ class PluginTest(TestCase): self.assertIn('extras.tests.dummy_plugin.DummyPluginConfig', settings.INSTALLED_APPS) def test_models(self): + from extras.tests.dummy_plugin.models import DummyModel # Test saving an instance instance = DummyModel(name='Instance 1', number=100) @@ -66,6 +68,8 @@ class PluginTest(TestCase): """ Check that plugin TemplateExtensions are registered. """ + from extras.tests.dummy_plugin.template_content import SiteContent + self.assertIn(SiteContent, registry['plugin_template_extensions']['dcim.site']) def test_middleware(self): From 58442b1af67ad8f0befdf46ee0d80abee24d1213 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Mon, 6 Apr 2020 11:43:52 -0400 Subject: [PATCH 111/124] Correct author name parameter --- docs/plugins/development.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/plugins/development.md b/docs/plugins/development.md index 9f9be2514..232cd18da 100644 --- a/docs/plugins/development.md +++ b/docs/plugins/development.md @@ -98,7 +98,7 @@ NetBox looks for the `config` variable within a plugin's `__init__.py` to load i | `verbose_name` | Human-friendly name for the plugin | | `version` | Current release ([semantic versioning](https://semver.org/) is encouraged) | | `description` | Brief description of the plugin's purpose | -| `author_name` | Name of plugin's author | +| `author` | Name of plugin's author | | `author_email` | Author's public email address | | `base_url` | Base path to use for plugin URLs (optional). If not specified, the project's `name` will be used. | | `required_settings` | A list of any configuration parameters that **must** be defined by the user | From 9ffc40402728f99df3685a64040a4cfe153ab6fd Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Mon, 6 Apr 2020 11:44:38 -0400 Subject: [PATCH 112/124] Add tests for plugin configuration, min/max version --- netbox/extras/plugins/__init__.py | 34 +++++++++++++ netbox/extras/tests/dummy_plugin/__init__.py | 2 + netbox/extras/tests/test_plugins.py | 53 +++++++++++++++++++- netbox/netbox/configuration.testing.py | 4 ++ netbox/netbox/settings.py | 29 ++--------- 5 files changed, 96 insertions(+), 26 deletions(-) diff --git a/netbox/extras/plugins/__init__.py b/netbox/extras/plugins/__init__.py index 6e515dd5b..df98b1a65 100644 --- a/netbox/extras/plugins/__init__.py +++ b/netbox/extras/plugins/__init__.py @@ -1,7 +1,10 @@ import collections import inspect +from pkg_resources import parse_version from django.apps import AppConfig +from django.conf import settings +from django.core.exceptions import ImproperlyConfigured from django.template.loader import get_template from django.utils.module_loading import import_string @@ -70,6 +73,37 @@ class PluginConfig(AppConfig): except ImportError: pass + @classmethod + def validate(cls, user_config): + + # Enforce version constraints + current_version = parse_version(settings.VERSION) + if cls.min_version is not None: + min_version = parse_version(cls.min_version) + if current_version < min_version: + raise ImproperlyConfigured( + f"Plugin {cls.__module__} requires NetBox minimum version {cls.min_version}." + ) + if cls.max_version is not None: + max_version = parse_version(cls.max_version) + if current_version > max_version: + raise ImproperlyConfigured( + f"Plugin {cls.__module__} requires NetBox maximum version {cls.max_version}." + ) + + # Verify required configuration settings + for setting in cls.required_settings: + if setting not in user_config: + raise ImproperlyConfigured( + f"Plugin {cls.__module__} requires '{setting}' to be present in the PLUGINS_CONFIG section of " + f"configuration.py." + ) + + # Apply default configuration values + for setting, value in cls.default_settings.items(): + if setting not in user_config: + user_config[setting] = value + # # Template content injection diff --git a/netbox/extras/tests/dummy_plugin/__init__.py b/netbox/extras/tests/dummy_plugin/__init__.py index eaaff4f5e..63f7d308e 100644 --- a/netbox/extras/tests/dummy_plugin/__init__.py +++ b/netbox/extras/tests/dummy_plugin/__init__.py @@ -7,6 +7,8 @@ class DummyPluginConfig(PluginConfig): version = '0.0' description = 'For testing purposes only' base_url = 'dummy-plugin' + min_version = '1.0' + max_version = '9.0' middleware = [ 'extras.tests.dummy_plugin.middleware.DummyMiddleware' ] diff --git a/netbox/extras/tests/test_plugins.py b/netbox/extras/tests/test_plugins.py index dba6308b9..94c0a85f3 100644 --- a/netbox/extras/tests/test_plugins.py +++ b/netbox/extras/tests/test_plugins.py @@ -1,13 +1,15 @@ from unittest import skipIf from django.conf import settings +from django.core.exceptions import ImproperlyConfigured from django.test import Client, TestCase, override_settings from django.urls import reverse from extras.registry import registry +from extras.tests.dummy_plugin import config as dummy_config -@skipIf('extras.tests.dummy_plugin.DummyPluginConfig' not in settings.PLUGINS, "dummy_plugin not in settings.PLUGINS") +@skipIf('extras.tests.dummy_plugin' not in settings.PLUGINS, "dummy_plugin not in settings.PLUGINS") class PluginTest(TestCase): def test_config(self): @@ -77,3 +79,52 @@ class PluginTest(TestCase): Check that plugin middleware is registered. """ self.assertIn('extras.tests.dummy_plugin.middleware.DummyMiddleware', settings.MIDDLEWARE) + + @override_settings(VERSION='0.9') + def test_min_version(self): + """ + Check enforcement of minimum NetBox version. + """ + with self.assertRaises(ImproperlyConfigured): + dummy_config.validate({}) + + @override_settings(VERSION='10.0') + def test_max_version(self): + """ + Check enforcement of maximum NetBox version. + """ + with self.assertRaises(ImproperlyConfigured): + dummy_config.validate({}) + + def test_required_settings(self): + """ + Validate enforcement of required settings. + """ + class DummyConfigWithRequiredSettings(dummy_config): + required_settings = ['foo'] + + # Validation should pass when all required settings are present + DummyConfigWithRequiredSettings.validate({'foo': True}) + + # Validation should fail when a required setting is missing + with self.assertRaises(ImproperlyConfigured): + DummyConfigWithRequiredSettings.validate({}) + + def test_default_settings(self): + """ + Validate population of default config settings. + """ + class DummyConfigWithDefaultSettings(dummy_config): + default_settings = { + 'bar': 123, + } + + # Populate the default value if setting has not been specified + user_config = {} + DummyConfigWithDefaultSettings.validate(user_config) + self.assertEqual(user_config['bar'], 123) + + # Don't overwrite specified values + user_config = {'bar': 456} + DummyConfigWithDefaultSettings.validate(user_config) + self.assertEqual(user_config['bar'], 456) diff --git a/netbox/netbox/configuration.testing.py b/netbox/netbox/configuration.testing.py index 09d5362ab..c0cd6b3ea 100644 --- a/netbox/netbox/configuration.testing.py +++ b/netbox/netbox/configuration.testing.py @@ -18,6 +18,10 @@ PLUGINS = [ 'extras.tests.dummy_plugin', ] +PLUGINS_CONFIG = { + 'foo': True, +} + REDIS = { 'tasks': { 'HOST': 'localhost', diff --git a/netbox/netbox/settings.py b/netbox/netbox/settings.py index c172aeaa9..a6a55cf4b 100644 --- a/netbox/netbox/settings.py +++ b/netbox/netbox/settings.py @@ -10,7 +10,6 @@ from urllib.parse import urlsplit from django.contrib.messages import constants as messages from django.core.exceptions import ImproperlyConfigured, ValidationError from django.core.validators import URLValidator -from pkg_resources import parse_version # @@ -658,36 +657,16 @@ for plugin_name in PLUGINS: f"__init__.py file and point to the PluginConfig subclass." ) - # Check version constraints - parsed_min_version = parse_version(plugin_config.min_version or VERSION) - parsed_max_version = parse_version(plugin_config.max_version or VERSION) - if plugin_config.min_version and plugin_config.max_version and parsed_min_version > parsed_max_version: - raise ImproperlyConfigured(f"Plugin {plugin_name} specifies invalid version constraints!") - if plugin_config.min_version and parsed_min_version > parse_version(VERSION): - raise ImproperlyConfigured(f"Plugin {plugin_name} requires NetBox minimum version {plugin_config.min_version}!") - if plugin_config.max_version and parsed_max_version < parse_version(VERSION): - raise ImproperlyConfigured(f"Plugin {plugin_name} requires NetBox maximum version {plugin_config.max_version}!") + # Validate user-provided configuration settings and assign defaults + if plugin_name not in PLUGINS_CONFIG: + PLUGINS_CONFIG[plugin_name] = {} + plugin_config.validate(PLUGINS_CONFIG[plugin_name]) # Add middleware plugin_middleware = plugin_config.middleware if plugin_middleware and type(plugin_middleware) in (list, tuple): MIDDLEWARE.extend(plugin_middleware) - # Verify required configuration settings - if plugin_name not in PLUGINS_CONFIG: - PLUGINS_CONFIG[plugin_name] = {} - for setting in plugin_config.required_settings: - if setting not in PLUGINS_CONFIG[plugin_name]: - raise ImproperlyConfigured( - f"Plugin {plugin_name} requires '{setting}' to be present in the PLUGINS_CONFIG section of " - f"configuration.py." - ) - - # Apply default configuration values - for setting, value in plugin_config.default_settings.items(): - if setting not in PLUGINS_CONFIG[plugin_name]: - PLUGINS_CONFIG[plugin_name][setting] = value - # Apply cacheops config if type(plugin_config.caching_config) is not dict: raise ImproperlyConfigured(f"Plugin {plugin_name} caching_config must be a dictionary.") From 76230cad53f0180fc4a425d91e432dfa1adca905 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Mon, 6 Apr 2020 11:51:03 -0400 Subject: [PATCH 113/124] Remove extraneous plugin config --- netbox/netbox/configuration.testing.py | 4 ---- 1 file changed, 4 deletions(-) diff --git a/netbox/netbox/configuration.testing.py b/netbox/netbox/configuration.testing.py index c0cd6b3ea..09d5362ab 100644 --- a/netbox/netbox/configuration.testing.py +++ b/netbox/netbox/configuration.testing.py @@ -18,10 +18,6 @@ PLUGINS = [ 'extras.tests.dummy_plugin', ] -PLUGINS_CONFIG = { - 'foo': True, -} - REDIS = { 'tasks': { 'HOST': 'localhost', From 34c33549b896e07831cc834b9ec16967a71594f2 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Mon, 6 Apr 2020 12:00:28 -0400 Subject: [PATCH 114/124] Add tests for plugins caching config --- netbox/extras/tests/test_plugins.py | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/netbox/extras/tests/test_plugins.py b/netbox/extras/tests/test_plugins.py index 94c0a85f3..7cbe792d3 100644 --- a/netbox/extras/tests/test_plugins.py +++ b/netbox/extras/tests/test_plugins.py @@ -80,6 +80,12 @@ class PluginTest(TestCase): """ self.assertIn('extras.tests.dummy_plugin.middleware.DummyMiddleware', settings.MIDDLEWARE) + def test_caching_config(self): + """ + Check that plugin caching configuration is registered. + """ + self.assertIn('extras.tests.dummy_plugin.*', settings.CACHEOPS) + @override_settings(VERSION='0.9') def test_min_version(self): """ From 52ef488208fb69c570832d129eec87acbaff2b4b Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Mon, 6 Apr 2020 13:27:41 -0400 Subject: [PATCH 115/124] Fix nav menu w/plugins enabled --- netbox/project-static/css/base.css | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/netbox/project-static/css/base.css b/netbox/project-static/css/base.css index 6bff895c8..1bba7cd67 100644 --- a/netbox/project-static/css/base.css +++ b/netbox/project-static/css/base.css @@ -34,6 +34,9 @@ body { footer p { margin: 20px 0; } +#navbar_search { + padding: 0 8px; +} /* Hide the username in the navigation menu on displays less than 1400px wide */ @media (max-width: 1399px) { @@ -64,7 +67,7 @@ footer p { /* Scroll the drop-down menus at or above 768px wide to match bootstrap's behavior for hiding dropdown menus */ @media (min-width: 768px) { - .navbar-nav>li>ul { + .navbar-nav > li > ul { max-height: calc(80vh - 50px); overflow-y: auto; } @@ -133,6 +136,9 @@ ul.dropdown-menu div.buttons a { ul.dropdown-menu > li > a { clear: left; } +.nav > li > a.dropdown-toggle { + padding: 15px 12px; +} /* Forms */ label { From ed05198c45f3a99c5f8b54c5030d606ccd42547e Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Thu, 9 Apr 2020 14:52:18 -0400 Subject: [PATCH 116/124] Add static file collection to plugins installation doc --- docs/plugins/index.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/plugins/index.md b/docs/plugins/index.md index 05f7cd15b..1f5587539 100644 --- a/docs/plugins/index.md +++ b/docs/plugins/index.md @@ -64,6 +64,15 @@ PLUGINS_CONFIG = { } ``` +### Collect Static Files + +Plugins may package static files to be served directly by the HTTP front end. Ensure that these are copied to the static root directory with the `collectstatic` management command: + +```no-highlight +(venv) $ cd /opt/netbox/netbox/ +(venv) $ python3 manage.py collectstatic +``` + ### Restart WSGI Service Restart the WSGI service to load the new plugin: From 884d648cc2d1e6c0e4fecb771427a6524f96ce1d Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Thu, 9 Apr 2020 15:31:18 -0400 Subject: [PATCH 117/124] Set X_FRAME_OPTIONS to SAMEORIGIN (changed in Django 3.0) --- netbox/netbox/settings.py | 1 + 1 file changed, 1 insertion(+) diff --git a/netbox/netbox/settings.py b/netbox/netbox/settings.py index a6a55cf4b..87e584b69 100644 --- a/netbox/netbox/settings.py +++ b/netbox/netbox/settings.py @@ -345,6 +345,7 @@ USE_TZ = True WSGI_APPLICATION = 'netbox.wsgi.application' SECURE_PROXY_SSL_HEADER = ('HTTP_X_FORWARDED_PROTO', 'https') USE_X_FORWARDED_HOST = True +X_FRAME_OPTIONS = 'SAMEORIGIN' # Static files (CSS, JavaScript, Images) STATIC_ROOT = BASE_DIR + '/static' From b5aff1575d858637c872cde1466a11990a6caa4f Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Thu, 9 Apr 2020 15:45:38 -0400 Subject: [PATCH 118/124] Add plugins settings to example config --- netbox/netbox/configuration.example.py | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/netbox/netbox/configuration.example.py b/netbox/netbox/configuration.example.py index 6e67d228f..0c9182ab1 100644 --- a/netbox/netbox/configuration.example.py +++ b/netbox/netbox/configuration.example.py @@ -175,6 +175,12 @@ NAPALM_ARGS = {} # Determine how many objects to display per page within a list. (Default: 50) PAGINATE_COUNT = 50 +# Enable installed plugins. Add the name of each plugin to the list. +PLUGINS = [] + +# Configure enabled plugins. This should be a dictionary of dictionaries, mapping each plugin by name to its configuration parameters. +PLUGINS_CONFIG = {} + # When determining the primary IP address for a device, IPv6 is preferred over IPv4 by default. Set this to True to # prefer IPv4 instead. PREFER_IPV4 = False From d5dbd5ccf13905521fddf6c6072843031b3b687c Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Thu, 9 Apr 2020 15:55:17 -0400 Subject: [PATCH 119/124] Update bug report template to denote disabling plugins --- .github/ISSUE_TEMPLATE/bug_report.md | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 38a6fd550..e1012212d 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -15,22 +15,23 @@ about: Report a reproducible bug in the current release of NetBox Please describe the environment in which you are running NetBox. Be sure that you are running an unmodified instance of the latest stable release - before submitting a bug report. + before submitting a bug report, and that any plugins have been disabled. --> ### Environment -* Python version: -* NetBox version: +* Python version: +* NetBox version: ### Steps to Reproduce -1. +1. Disable any installed plugins by commenting out the `PLUGINS` setting in + `configuration.py`. 2. 3. From db70f04447890a3b221848a8eebe07ee01b42e5e Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Fri, 10 Apr 2020 10:10:27 -0400 Subject: [PATCH 120/124] Minor tweaks to plugins development doc --- docs/plugins/development.md | 83 ++++++++++++---------- netbox/templates/{_base.html => base.html} | 0 2 files changed, 44 insertions(+), 39 deletions(-) rename netbox/templates/{_base.html => base.html} (100%) diff --git a/docs/plugins/development.md b/docs/plugins/development.md index 232cd18da..7fd8badf3 100644 --- a/docs/plugins/development.md +++ b/docs/plugins/development.md @@ -53,10 +53,9 @@ from setuptools import find_packages, setup setup( name='netbox-animal-sounds', version='0.1', - description='Show animals and the sounds they make', - url='https://github.com/example-org/animal-sounds', - author='Author Name', - author_email='author@example.com', + description='An example NetBox plugin', + url='https://github.com/netbox-community/netbox-animal-sounds', + author='Jeremy Stretch', license='Apache 2.0', install_requires=[], packages=find_packages(), @@ -75,10 +74,11 @@ from extras.plugins import PluginConfig class AnimalSoundsConfig(PluginConfig): name = 'netbox_animal_sounds' - verbose_name = 'Animal Sounds Plugin' + verbose_name = 'Animal Sounds' + description = 'An example plugin for development purposes' version = '0.1' - author = 'Author Name' - description = 'Show animals and the sounds they make' + author = 'Jeremy Stretch' + author_email = 'author@example.com' base_url = 'animal-sounds' required_settings = [] default_settings = { @@ -161,14 +161,13 @@ For more background on schema migrations, see the [Django documentation](https:/ ### Using the Django Admin Interface -Plugins can optionally expose their models via Django's built-in [administrative interface](https://docs.djangoproject.com/en/stable/ref/contrib/admin/). This can greatly improve troubleshooting ability, particularly during development. To expose a model, simply register it with Netbox's `admin_site` object. An example `admin.py` file for the above model is shown below: +Plugins can optionally expose their models via Django's built-in [administrative interface](https://docs.djangoproject.com/en/stable/ref/contrib/admin/). This can greatly improve troubleshooting ability, particularly during development. To expose a model, simply register it using Django's `admin.register()` function. An example `admin.py` file for the above model is shown below: ```python from django.contrib import admin -from netbox.admin import admin_site from .models import Animal -@admin.register(Animal, site=admin_site) +@admin.register(Animal) class AnimalAdmin(admin.ModelAdmin): list_display = ('name', 'sound') ``` @@ -186,29 +185,39 @@ from django.shortcuts import render from django.views.generic import View from .models import Animal -class RandomAnimalSoundView(View): - +class RandomAnimalView(View): + """ + Display a randomly-selected animal. + """ def get(self, request): - # Retrieve a random animal animal = Animal.objects.order_by('?').first() - - return render(request, 'netbox_animal_sounds/animal_sound.html', { + return render(request, 'netbox_animal_sounds/animal.html', { 'animal': animal, }) ``` -This view retrieves a random animal from the database and and passes it as a context variable when rendering a template named `animal_sound.html`, which doesn't exist yet. To create this template, first create a directory named `templates/netbox_animal_sounds/` within the plugin source directory. (We use the plugin's name as a subdirectory to guard against naming collisions with other plugins.) Then, create `animal_sound.html`: +This view retrieves a random animal from the database and and passes it as a context variable when rendering a template named `animal.html`, which doesn't exist yet. To create this template, first create a directory named `templates/netbox_animal_sounds/` within the plugin source directory. (We use the plugin's name as a subdirectory to guard against naming collisions with other plugins.) Then, create `animal.html`: ```jinja2 -{% extends '_base.html' %} +{% extends 'base.html' %} {% block content %} -{% if animal %} - The {{ animal.name }} says {{ animal.sound }} -{% else %} - No animals have been created yet! -{% endif %} +{% with config=settings.PLUGINS_CONFIG.netbox_animal_sounds %} +

      + {% if animal %} + The {{ animal.name|lower }} says + {% if config.loud %} + {{ animal.sound|upper }}! + {% else %} + {{ animal.sound }} + {% endif %} + {% else %} + No animals have been created yet! + {% endif %} +

      +{% endwith %} {% endblock %} + ``` The first line of the template instructs Django to extend the NetBox base template and inject our custom content within its `content` block. @@ -220,10 +229,10 @@ Finally, to make the view accessible to users, we need to register a URL for it. ```python from django.urls import path -from .views import RandomAnimalSoundView +from . import views urlpatterns = [ - path('random-sound/', RandomAnimalSoundView.as_view(), name='random_sound') + path('random/', views.RandomAnimalView.as_view(), name='random_animal'), ] ``` @@ -233,7 +242,7 @@ A URL pattern has three components: * `view` - The view itself * `name` - A short name used to identify the URL path internally -This makes our view accessible at the URL `/plugins/animal-sounds/random-sound/`. (Remember, our `AnimalSoundsConfig` class sets our plugin's base URL to `animal-sounds`.) Viewing this URL should show the base NetBox template with our custom content inside it. +This makes our view accessible at the URL `/plugins/animal-sounds/random/`. (Remember, our `AnimalSoundsConfig` class sets our plugin's base URL to `animal-sounds`.) Viewing this URL should show the base NetBox template with our custom content inside it. ## REST API Endpoints @@ -252,7 +261,7 @@ class AnimalSerializer(ModelSerializer): fields = ('id', 'name', 'sound') ``` -Next, we'll create a generic API viewset that allows basic CRUD (create, read, update, and delete) operations for Animal instances. This is defined in `api/views.py`: +Next, we'll create a generic API view set that allows basic CRUD (create, read, update, and delete) operations for Animal instances. This is defined in `api/views.py`: ```python from rest_framework.viewsets import ModelViewSet @@ -279,7 +288,7 @@ With these three components in place, we can request `/api/plugins/animal-sounds ![NetBox REST API plugin endpoint](../media/plugins/plugin_rest_api_endpoint.png) -!!! note +!!! warning This example is provided as a minimal reference implementation only. It does not address authentication, performance, or myriad other concerns that plugin authors should have. ## Navigation Menu Items @@ -292,7 +301,7 @@ from utilities.choices import ButtonColorChoices menu_items = ( PluginMenuItem( - link='plugins:netbox_animal_sounds:random_sound', + link='plugins:netbox_animal_sounds:random_animal', link_text='Random sound', buttons=( PluginMenuButton('home', 'Button A', 'fa-info', ButtonColorChoices.BLUE), @@ -341,21 +350,17 @@ Declared subclasses should be gathered into a list or tuple for integration with ```python from extras.plugins import PluginTemplateExtension +from .models import Animal -class AddSiteAnimal(PluginTemplateExtension): +class SiteAnimalCount(PluginTemplateExtension): model = 'dcim.site' - def full_width_page(self): - return self.render('netbox_animal_sounds/site.html') + def right_page(self): + return self.render('netbox_animal_sounds/inc/animal_count.html', extra_context={ + 'animal_count': Animal.objects.count(), + }) -class AddRackAnimal(PluginTemplateExtension): - model = 'dcim.rack' - - def left_page(self): - extra_data = {'foo': 123} - return self.render('netbox_animal_sounds/rack.html', extra_data) - -template_extensions = [AddSiteAnimal, AddRackAnimal] +template_extensions = [SiteAnimalCount] ``` ## Caching Configuration diff --git a/netbox/templates/_base.html b/netbox/templates/base.html similarity index 100% rename from netbox/templates/_base.html rename to netbox/templates/base.html From 19a10cee82b6ef2416a086cde9aef3bf6f238903 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Fri, 10 Apr 2020 10:21:02 -0400 Subject: [PATCH 121/124] Rename base template --- netbox/extras/views.py | 2 +- netbox/templates/404.html | 2 +- netbox/templates/circuits/circuit.html | 2 +- netbox/templates/circuits/circuittermination_edit.html | 2 +- netbox/templates/circuits/provider.html | 2 +- netbox/templates/dcim/bulk_rename.html | 2 +- netbox/templates/dcim/cable.html | 2 +- netbox/templates/dcim/cable_connect.html | 2 +- netbox/templates/dcim/cable_trace.html | 2 +- netbox/templates/dcim/console_connections_list.html | 2 +- netbox/templates/dcim/device.html | 2 +- netbox/templates/dcim/device_component_add.html | 2 +- netbox/templates/dcim/devicebay_populate.html | 2 +- netbox/templates/dcim/devicetype.html | 2 +- netbox/templates/dcim/devicetype_component_add.html | 2 +- netbox/templates/dcim/interface.html | 2 +- netbox/templates/dcim/interface_connections_list.html | 2 +- netbox/templates/dcim/power_connections_list.html | 2 +- netbox/templates/dcim/powerfeed.html | 2 +- netbox/templates/dcim/powerpanel.html | 2 +- netbox/templates/dcim/rack.html | 2 +- netbox/templates/dcim/rack_elevation_list.html | 2 +- netbox/templates/dcim/rackreservation.html | 2 +- netbox/templates/dcim/site.html | 2 +- netbox/templates/dcim/virtualchassis_add_member.html | 2 +- netbox/templates/dcim/virtualchassis_edit.html | 2 +- netbox/templates/extras/configcontext.html | 2 +- netbox/templates/extras/objectchange.html | 2 +- netbox/templates/extras/report.html | 2 +- netbox/templates/extras/report_list.html | 2 +- netbox/templates/extras/script.html | 2 +- netbox/templates/extras/script_list.html | 2 +- netbox/templates/extras/tag.html | 2 +- netbox/templates/home.html | 2 +- netbox/templates/import_success.html | 2 +- netbox/templates/ipam/aggregate.html | 2 +- netbox/templates/ipam/ipaddress.html | 2 +- netbox/templates/ipam/prefix.html | 2 +- netbox/templates/ipam/service.html | 2 +- netbox/templates/ipam/vlan.html | 2 +- netbox/templates/ipam/vlangroup_vlans.html | 2 +- netbox/templates/ipam/vrf.html | 2 +- netbox/templates/login.html | 2 +- netbox/templates/search.html | 2 +- netbox/templates/secrets/secret.html | 2 +- netbox/templates/secrets/secret_edit.html | 2 +- netbox/templates/tenancy/tenant.html | 2 +- netbox/templates/users/_user.html | 2 +- netbox/templates/utilities/confirmation_form.html | 2 +- netbox/templates/utilities/obj_bulk_add_component.html | 2 +- netbox/templates/utilities/obj_bulk_delete.html | 2 +- netbox/templates/utilities/obj_bulk_edit.html | 2 +- netbox/templates/utilities/obj_bulk_import.html | 2 +- netbox/templates/utilities/obj_bulk_remove.html | 2 +- netbox/templates/utilities/obj_edit.html | 2 +- netbox/templates/utilities/obj_import.html | 2 +- netbox/templates/utilities/obj_list.html | 2 +- netbox/templates/virtualization/cluster.html | 2 +- netbox/templates/virtualization/cluster_add_devices.html | 2 +- netbox/templates/virtualization/virtualmachine.html | 2 +- .../templates/virtualization/virtualmachine_component_add.html | 2 +- 61 files changed, 61 insertions(+), 61 deletions(-) diff --git a/netbox/extras/views.py b/netbox/extras/views.py index b625cf7b1..bb7d76dd0 100644 --- a/netbox/extras/views.py +++ b/netbox/extras/views.py @@ -274,7 +274,7 @@ class ObjectChangeLogView(View): template.loader.get_template(base_template) object_var = model._meta.model_name except template.TemplateDoesNotExist: - base_template = '_base.html' + base_template = 'base.html' object_var = 'obj' return render(request, 'extras/object_changelog.html', { diff --git a/netbox/templates/404.html b/netbox/templates/404.html index 92d1f3589..f2fe6b430 100644 --- a/netbox/templates/404.html +++ b/netbox/templates/404.html @@ -1,4 +1,4 @@ -{% extends '_base.html' %} +{% extends 'base.html' %} {% block content %}
      diff --git a/netbox/templates/circuits/circuit.html b/netbox/templates/circuits/circuit.html index 6b380dc38..a12b9c3f1 100644 --- a/netbox/templates/circuits/circuit.html +++ b/netbox/templates/circuits/circuit.html @@ -1,4 +1,4 @@ -{% extends '_base.html' %} +{% extends 'base.html' %} {% load buttons %} {% load custom_links %} {% load helpers %} diff --git a/netbox/templates/circuits/circuittermination_edit.html b/netbox/templates/circuits/circuittermination_edit.html index 6b702c1dc..ce8af5a23 100644 --- a/netbox/templates/circuits/circuittermination_edit.html +++ b/netbox/templates/circuits/circuittermination_edit.html @@ -1,4 +1,4 @@ -{% extends '_base.html' %} +{% extends 'base.html' %} {% load static %} {% load form_helpers %} diff --git a/netbox/templates/circuits/provider.html b/netbox/templates/circuits/provider.html index c8b6cd66f..c02637e8e 100644 --- a/netbox/templates/circuits/provider.html +++ b/netbox/templates/circuits/provider.html @@ -1,4 +1,4 @@ -{% extends '_base.html' %} +{% extends 'base.html' %} {% load buttons %} {% load static %} {% load custom_links %} diff --git a/netbox/templates/dcim/bulk_rename.html b/netbox/templates/dcim/bulk_rename.html index 6abcaf305..90456ed97 100644 --- a/netbox/templates/dcim/bulk_rename.html +++ b/netbox/templates/dcim/bulk_rename.html @@ -1,4 +1,4 @@ -{% extends '_base.html' %} +{% extends 'base.html' %} {% load helpers %} {% load form_helpers %} diff --git a/netbox/templates/dcim/cable.html b/netbox/templates/dcim/cable.html index a74debfe9..e6a2fa008 100644 --- a/netbox/templates/dcim/cable.html +++ b/netbox/templates/dcim/cable.html @@ -1,4 +1,4 @@ -{% extends '_base.html' %} +{% extends 'base.html' %} {% load buttons %} {% load custom_links %} {% load helpers %} diff --git a/netbox/templates/dcim/cable_connect.html b/netbox/templates/dcim/cable_connect.html index 3d9d06a1f..1a7c9411e 100644 --- a/netbox/templates/dcim/cable_connect.html +++ b/netbox/templates/dcim/cable_connect.html @@ -1,4 +1,4 @@ -{% extends '_base.html' %} +{% extends 'base.html' %} {% load static %} {% load helpers %} {% load form_helpers %} diff --git a/netbox/templates/dcim/cable_trace.html b/netbox/templates/dcim/cable_trace.html index 8c7b69f26..87f286b1f 100644 --- a/netbox/templates/dcim/cable_trace.html +++ b/netbox/templates/dcim/cable_trace.html @@ -1,4 +1,4 @@ -{% extends '_base.html' %} +{% extends 'base.html' %} {% load helpers %} {% block header %} diff --git a/netbox/templates/dcim/console_connections_list.html b/netbox/templates/dcim/console_connections_list.html index b49190cda..15f7a36bb 100644 --- a/netbox/templates/dcim/console_connections_list.html +++ b/netbox/templates/dcim/console_connections_list.html @@ -1,4 +1,4 @@ -{% extends '_base.html' %} +{% extends 'base.html' %} {% load buttons %} {% block content %} diff --git a/netbox/templates/dcim/device.html b/netbox/templates/dcim/device.html index 34eee3f55..250774022 100644 --- a/netbox/templates/dcim/device.html +++ b/netbox/templates/dcim/device.html @@ -1,4 +1,4 @@ -{% extends '_base.html' %} +{% extends 'base.html' %} {% load buttons %} {% load static %} {% load helpers %} diff --git a/netbox/templates/dcim/device_component_add.html b/netbox/templates/dcim/device_component_add.html index f14d9c9c8..0b7200c1f 100644 --- a/netbox/templates/dcim/device_component_add.html +++ b/netbox/templates/dcim/device_component_add.html @@ -1,4 +1,4 @@ -{% extends '_base.html' %} +{% extends 'base.html' %} {% load form_helpers %} {% block title %}Create {{ component_type }}{% endblock %} diff --git a/netbox/templates/dcim/devicebay_populate.html b/netbox/templates/dcim/devicebay_populate.html index 38a8d57da..d3024c10b 100644 --- a/netbox/templates/dcim/devicebay_populate.html +++ b/netbox/templates/dcim/devicebay_populate.html @@ -1,4 +1,4 @@ -{% extends '_base.html' %} +{% extends 'base.html' %} {% load form_helpers %} {% block content %} diff --git a/netbox/templates/dcim/devicetype.html b/netbox/templates/dcim/devicetype.html index 4d401da88..568f0433c 100644 --- a/netbox/templates/dcim/devicetype.html +++ b/netbox/templates/dcim/devicetype.html @@ -1,4 +1,4 @@ -{% extends '_base.html' %} +{% extends 'base.html' %} {% load buttons %} {% load custom_links %} {% load helpers %} diff --git a/netbox/templates/dcim/devicetype_component_add.html b/netbox/templates/dcim/devicetype_component_add.html index 9645b7813..7d2cc9f92 100644 --- a/netbox/templates/dcim/devicetype_component_add.html +++ b/netbox/templates/dcim/devicetype_component_add.html @@ -1,4 +1,4 @@ -{% extends '_base.html' %} +{% extends 'base.html' %} {% load form_helpers %} {% block title %}Add {{ component_type }} to {{ parent }}{% endblock %} diff --git a/netbox/templates/dcim/interface.html b/netbox/templates/dcim/interface.html index 4fc7d21ac..9d94e0639 100644 --- a/netbox/templates/dcim/interface.html +++ b/netbox/templates/dcim/interface.html @@ -1,4 +1,4 @@ -{% extends '_base.html' %} +{% extends 'base.html' %} {% load helpers %} {% block header %} diff --git a/netbox/templates/dcim/interface_connections_list.html b/netbox/templates/dcim/interface_connections_list.html index 273fb4f47..606505e9e 100644 --- a/netbox/templates/dcim/interface_connections_list.html +++ b/netbox/templates/dcim/interface_connections_list.html @@ -1,4 +1,4 @@ -{% extends '_base.html' %} +{% extends 'base.html' %} {% load buttons %} {% block content %} diff --git a/netbox/templates/dcim/power_connections_list.html b/netbox/templates/dcim/power_connections_list.html index fb3f8160b..7e791d6fe 100644 --- a/netbox/templates/dcim/power_connections_list.html +++ b/netbox/templates/dcim/power_connections_list.html @@ -1,4 +1,4 @@ -{% extends '_base.html' %} +{% extends 'base.html' %} {% load buttons %} {% block content %} diff --git a/netbox/templates/dcim/powerfeed.html b/netbox/templates/dcim/powerfeed.html index 026d97313..017a430ee 100644 --- a/netbox/templates/dcim/powerfeed.html +++ b/netbox/templates/dcim/powerfeed.html @@ -1,4 +1,4 @@ -{% extends '_base.html' %} +{% extends 'base.html' %} {% load buttons %} {% load static %} {% load custom_links %} diff --git a/netbox/templates/dcim/powerpanel.html b/netbox/templates/dcim/powerpanel.html index a2d3376d7..3ee8d80e0 100644 --- a/netbox/templates/dcim/powerpanel.html +++ b/netbox/templates/dcim/powerpanel.html @@ -1,4 +1,4 @@ -{% extends '_base.html' %} +{% extends 'base.html' %} {% load buttons %} {% load custom_links %} {% load helpers %} diff --git a/netbox/templates/dcim/rack.html b/netbox/templates/dcim/rack.html index 02c6d57b2..2c7452ba2 100644 --- a/netbox/templates/dcim/rack.html +++ b/netbox/templates/dcim/rack.html @@ -1,4 +1,4 @@ -{% extends '_base.html' %} +{% extends 'base.html' %} {% load buttons %} {% load custom_links %} {% load helpers %} diff --git a/netbox/templates/dcim/rack_elevation_list.html b/netbox/templates/dcim/rack_elevation_list.html index f48b81e06..e4949eb17 100644 --- a/netbox/templates/dcim/rack_elevation_list.html +++ b/netbox/templates/dcim/rack_elevation_list.html @@ -1,4 +1,4 @@ -{% extends '_base.html' %} +{% extends 'base.html' %} {% load helpers %} {% load static %} diff --git a/netbox/templates/dcim/rackreservation.html b/netbox/templates/dcim/rackreservation.html index 911fb0d5c..d4bbbc97d 100644 --- a/netbox/templates/dcim/rackreservation.html +++ b/netbox/templates/dcim/rackreservation.html @@ -1,4 +1,4 @@ -{% extends '_base.html' %} +{% extends 'base.html' %} {% load buttons %} {% load custom_links %} {% load helpers %} diff --git a/netbox/templates/dcim/site.html b/netbox/templates/dcim/site.html index 915588e4d..f5823f721 100644 --- a/netbox/templates/dcim/site.html +++ b/netbox/templates/dcim/site.html @@ -1,4 +1,4 @@ -{% extends '_base.html' %} +{% extends 'base.html' %} {% load buttons %} {% load custom_links %} {% load helpers %} diff --git a/netbox/templates/dcim/virtualchassis_add_member.html b/netbox/templates/dcim/virtualchassis_add_member.html index cef1a2a2e..5b3a92208 100644 --- a/netbox/templates/dcim/virtualchassis_add_member.html +++ b/netbox/templates/dcim/virtualchassis_add_member.html @@ -1,4 +1,4 @@ -{% extends '_base.html' %} +{% extends 'base.html' %} {% load form_helpers %} {% block content %} diff --git a/netbox/templates/dcim/virtualchassis_edit.html b/netbox/templates/dcim/virtualchassis_edit.html index 2665473fc..54bdc9fe8 100644 --- a/netbox/templates/dcim/virtualchassis_edit.html +++ b/netbox/templates/dcim/virtualchassis_edit.html @@ -1,4 +1,4 @@ -{% extends '_base.html' %} +{% extends 'base.html' %} {% load helpers %} {% load form_helpers %} diff --git a/netbox/templates/extras/configcontext.html b/netbox/templates/extras/configcontext.html index 7731acae5..998ab7681 100644 --- a/netbox/templates/extras/configcontext.html +++ b/netbox/templates/extras/configcontext.html @@ -1,4 +1,4 @@ -{% extends '_base.html' %} +{% extends 'base.html' %} {% load helpers %} {% load static %} diff --git a/netbox/templates/extras/objectchange.html b/netbox/templates/extras/objectchange.html index 16efa6421..dcaaafdca 100644 --- a/netbox/templates/extras/objectchange.html +++ b/netbox/templates/extras/objectchange.html @@ -1,4 +1,4 @@ -{% extends '_base.html' %} +{% extends 'base.html' %} {% load helpers %} {% block title %}{{ objectchange }}{% endblock %} diff --git a/netbox/templates/extras/report.html b/netbox/templates/extras/report.html index addb5fbda..8ddf74eca 100644 --- a/netbox/templates/extras/report.html +++ b/netbox/templates/extras/report.html @@ -1,4 +1,4 @@ -{% extends '_base.html' %} +{% extends 'base.html' %} {% load helpers %} {% block title %}{{ report.name }}{% endblock %} diff --git a/netbox/templates/extras/report_list.html b/netbox/templates/extras/report_list.html index 609e8acc9..7de085974 100644 --- a/netbox/templates/extras/report_list.html +++ b/netbox/templates/extras/report_list.html @@ -1,4 +1,4 @@ -{% extends '_base.html' %} +{% extends 'base.html' %} {% load helpers %} {% block content %} diff --git a/netbox/templates/extras/script.html b/netbox/templates/extras/script.html index 6d7aca126..01dc4bfa5 100644 --- a/netbox/templates/extras/script.html +++ b/netbox/templates/extras/script.html @@ -1,4 +1,4 @@ -{% extends '_base.html' %} +{% extends 'base.html' %} {% load helpers %} {% load form_helpers %} {% load log_levels %} diff --git a/netbox/templates/extras/script_list.html b/netbox/templates/extras/script_list.html index a13298b2c..a1b97cfc2 100644 --- a/netbox/templates/extras/script_list.html +++ b/netbox/templates/extras/script_list.html @@ -1,4 +1,4 @@ -{% extends '_base.html' %} +{% extends 'base.html' %} {% load helpers %} {% block content %} diff --git a/netbox/templates/extras/tag.html b/netbox/templates/extras/tag.html index d87aec3f7..0c20bcbdc 100644 --- a/netbox/templates/extras/tag.html +++ b/netbox/templates/extras/tag.html @@ -1,4 +1,4 @@ -{% extends '_base.html' %} +{% extends 'base.html' %} {% load helpers %} {% block header %} diff --git a/netbox/templates/home.html b/netbox/templates/home.html index d3885b88f..50a411048 100644 --- a/netbox/templates/home.html +++ b/netbox/templates/home.html @@ -1,4 +1,4 @@ -{% extends '_base.html' %} +{% extends 'base.html' %} {% load helpers %} {% block header %} diff --git a/netbox/templates/import_success.html b/netbox/templates/import_success.html index dba525af5..da9958bdb 100644 --- a/netbox/templates/import_success.html +++ b/netbox/templates/import_success.html @@ -1,4 +1,4 @@ -{% extends '_base.html' %} +{% extends 'base.html' %} {% block content %}

      {% block title %}Import Completed{% endblock %}

      diff --git a/netbox/templates/ipam/aggregate.html b/netbox/templates/ipam/aggregate.html index 9810e3689..998eb2066 100644 --- a/netbox/templates/ipam/aggregate.html +++ b/netbox/templates/ipam/aggregate.html @@ -1,4 +1,4 @@ -{% extends '_base.html' %} +{% extends 'base.html' %} {% load buttons %} {% load custom_links %} {% load helpers %} diff --git a/netbox/templates/ipam/ipaddress.html b/netbox/templates/ipam/ipaddress.html index a627b8d69..6eba1a5e6 100644 --- a/netbox/templates/ipam/ipaddress.html +++ b/netbox/templates/ipam/ipaddress.html @@ -1,4 +1,4 @@ -{% extends '_base.html' %} +{% extends 'base.html' %} {% load buttons %} {% load custom_links %} {% load helpers %} diff --git a/netbox/templates/ipam/prefix.html b/netbox/templates/ipam/prefix.html index d6d7ef4d8..4620f6bf4 100644 --- a/netbox/templates/ipam/prefix.html +++ b/netbox/templates/ipam/prefix.html @@ -1,4 +1,4 @@ -{% extends '_base.html' %} +{% extends 'base.html' %} {% load buttons %} {% load custom_links %} {% load helpers %} diff --git a/netbox/templates/ipam/service.html b/netbox/templates/ipam/service.html index 2d4e69fa5..b16e99aa3 100644 --- a/netbox/templates/ipam/service.html +++ b/netbox/templates/ipam/service.html @@ -1,4 +1,4 @@ -{% extends '_base.html' %} +{% extends 'base.html' %} {% load buttons %} {% load custom_links %} {% load helpers %} diff --git a/netbox/templates/ipam/vlan.html b/netbox/templates/ipam/vlan.html index 6b867762b..ec1f94b51 100644 --- a/netbox/templates/ipam/vlan.html +++ b/netbox/templates/ipam/vlan.html @@ -1,4 +1,4 @@ -{% extends '_base.html' %} +{% extends 'base.html' %} {% load buttons %} {% load custom_links %} {% load helpers %} diff --git a/netbox/templates/ipam/vlangroup_vlans.html b/netbox/templates/ipam/vlangroup_vlans.html index 34810b1d2..7f8ac2044 100644 --- a/netbox/templates/ipam/vlangroup_vlans.html +++ b/netbox/templates/ipam/vlangroup_vlans.html @@ -1,4 +1,4 @@ -{% extends '_base.html' %} +{% extends 'base.html' %} {% block title %}{{ vlan_group }} - VLANs{% endblock %} diff --git a/netbox/templates/ipam/vrf.html b/netbox/templates/ipam/vrf.html index e448743f1..6fb6d725f 100644 --- a/netbox/templates/ipam/vrf.html +++ b/netbox/templates/ipam/vrf.html @@ -1,4 +1,4 @@ -{% extends '_base.html' %} +{% extends 'base.html' %} {% load buttons %} {% load custom_links %} {% load helpers %} diff --git a/netbox/templates/login.html b/netbox/templates/login.html index e3d22399e..96b94adee 100644 --- a/netbox/templates/login.html +++ b/netbox/templates/login.html @@ -1,4 +1,4 @@ -{% extends '_base.html' %} +{% extends 'base.html' %} {% load form_helpers %} {% block content %} diff --git a/netbox/templates/search.html b/netbox/templates/search.html index 6388cc022..68b69cf94 100644 --- a/netbox/templates/search.html +++ b/netbox/templates/search.html @@ -1,4 +1,4 @@ -{% extends '_base.html' %} +{% extends 'base.html' %} {% load helpers %} {% load form_helpers %} diff --git a/netbox/templates/secrets/secret.html b/netbox/templates/secrets/secret.html index 6de32b72c..3ddb2fe98 100644 --- a/netbox/templates/secrets/secret.html +++ b/netbox/templates/secrets/secret.html @@ -1,4 +1,4 @@ -{% extends '_base.html' %} +{% extends 'base.html' %} {% load buttons %} {% load custom_links %} {% load helpers %} diff --git a/netbox/templates/secrets/secret_edit.html b/netbox/templates/secrets/secret_edit.html index 699999a9d..cb3935521 100644 --- a/netbox/templates/secrets/secret_edit.html +++ b/netbox/templates/secrets/secret_edit.html @@ -1,4 +1,4 @@ -{% extends '_base.html' %} +{% extends 'base.html' %} {% load static %} {% load form_helpers %} {% load secret_helpers %} diff --git a/netbox/templates/tenancy/tenant.html b/netbox/templates/tenancy/tenant.html index 5232d1a86..a9cf67398 100644 --- a/netbox/templates/tenancy/tenant.html +++ b/netbox/templates/tenancy/tenant.html @@ -1,4 +1,4 @@ -{% extends '_base.html' %} +{% extends 'base.html' %} {% load buttons %} {% load custom_links %} {% load helpers %} diff --git a/netbox/templates/users/_user.html b/netbox/templates/users/_user.html index b8cc0471f..441caf289 100644 --- a/netbox/templates/users/_user.html +++ b/netbox/templates/users/_user.html @@ -1,4 +1,4 @@ -{% extends '_base.html' %} +{% extends 'base.html' %} {% block content %}
      diff --git a/netbox/templates/utilities/confirmation_form.html b/netbox/templates/utilities/confirmation_form.html index af15f7ab9..3a495f26f 100644 --- a/netbox/templates/utilities/confirmation_form.html +++ b/netbox/templates/utilities/confirmation_form.html @@ -1,4 +1,4 @@ -{% extends '_base.html' %} +{% extends 'base.html' %} {% load form_helpers %} {% block content %} diff --git a/netbox/templates/utilities/obj_bulk_add_component.html b/netbox/templates/utilities/obj_bulk_add_component.html index fb9fb0418..c0d1a6335 100644 --- a/netbox/templates/utilities/obj_bulk_add_component.html +++ b/netbox/templates/utilities/obj_bulk_add_component.html @@ -1,4 +1,4 @@ -{% extends '_base.html' %} +{% extends 'base.html' %} {% load form_helpers %} {% block content %} diff --git a/netbox/templates/utilities/obj_bulk_delete.html b/netbox/templates/utilities/obj_bulk_delete.html index eec5a3b42..d622a5ab0 100644 --- a/netbox/templates/utilities/obj_bulk_delete.html +++ b/netbox/templates/utilities/obj_bulk_delete.html @@ -1,4 +1,4 @@ -{% extends '_base.html' %} +{% extends 'base.html' %} {% load helpers %} {% block title %}Delete {{ table.rows|length }} {{ obj_type_plural|bettertitle }}?{% endblock %} diff --git a/netbox/templates/utilities/obj_bulk_edit.html b/netbox/templates/utilities/obj_bulk_edit.html index 2b12f2a07..b679f94c1 100644 --- a/netbox/templates/utilities/obj_bulk_edit.html +++ b/netbox/templates/utilities/obj_bulk_edit.html @@ -1,4 +1,4 @@ -{% extends '_base.html' %} +{% extends 'base.html' %} {% load helpers %} {% load form_helpers %} diff --git a/netbox/templates/utilities/obj_bulk_import.html b/netbox/templates/utilities/obj_bulk_import.html index 97b093a02..a476cbd15 100644 --- a/netbox/templates/utilities/obj_bulk_import.html +++ b/netbox/templates/utilities/obj_bulk_import.html @@ -1,4 +1,4 @@ -{% extends '_base.html' %} +{% extends 'base.html' %} {% load helpers %} {% load form_helpers %} diff --git a/netbox/templates/utilities/obj_bulk_remove.html b/netbox/templates/utilities/obj_bulk_remove.html index a850cf914..57af19e3d 100644 --- a/netbox/templates/utilities/obj_bulk_remove.html +++ b/netbox/templates/utilities/obj_bulk_remove.html @@ -1,4 +1,4 @@ -{% extends '_base.html' %} +{% extends 'base.html' %} {% load helpers %} {% block title %}Remove {{ table.rows|length }} {{ obj_type_plural|bettertitle }}?{% endblock %} diff --git a/netbox/templates/utilities/obj_edit.html b/netbox/templates/utilities/obj_edit.html index bbe162def..5230b2594 100644 --- a/netbox/templates/utilities/obj_edit.html +++ b/netbox/templates/utilities/obj_edit.html @@ -1,4 +1,4 @@ -{% extends '_base.html' %} +{% extends 'base.html' %} {% load form_helpers %} {% load helpers %} diff --git a/netbox/templates/utilities/obj_import.html b/netbox/templates/utilities/obj_import.html index d0ba99295..5b79a5ced 100644 --- a/netbox/templates/utilities/obj_import.html +++ b/netbox/templates/utilities/obj_import.html @@ -1,4 +1,4 @@ -{% extends '_base.html' %} +{% extends 'base.html' %} {% load helpers %} {% load form_helpers %} diff --git a/netbox/templates/utilities/obj_list.html b/netbox/templates/utilities/obj_list.html index 8f9a0563c..f5482baf0 100644 --- a/netbox/templates/utilities/obj_list.html +++ b/netbox/templates/utilities/obj_list.html @@ -1,4 +1,4 @@ -{% extends '_base.html' %} +{% extends 'base.html' %} {% load buttons %} {% load helpers %} diff --git a/netbox/templates/virtualization/cluster.html b/netbox/templates/virtualization/cluster.html index 5a9d26837..7b250e5b1 100644 --- a/netbox/templates/virtualization/cluster.html +++ b/netbox/templates/virtualization/cluster.html @@ -1,4 +1,4 @@ -{% extends '_base.html' %} +{% extends 'base.html' %} {% load buttons %} {% load custom_links %} {% load helpers %} diff --git a/netbox/templates/virtualization/cluster_add_devices.html b/netbox/templates/virtualization/cluster_add_devices.html index ca37d0df1..16ea7e03f 100644 --- a/netbox/templates/virtualization/cluster_add_devices.html +++ b/netbox/templates/virtualization/cluster_add_devices.html @@ -1,4 +1,4 @@ -{% extends '_base.html' %} +{% extends 'base.html' %} {% load static %} {% load form_helpers %} diff --git a/netbox/templates/virtualization/virtualmachine.html b/netbox/templates/virtualization/virtualmachine.html index ba6a4d33e..ea8f4fedb 100644 --- a/netbox/templates/virtualization/virtualmachine.html +++ b/netbox/templates/virtualization/virtualmachine.html @@ -1,4 +1,4 @@ -{% extends '_base.html' %} +{% extends 'base.html' %} {% load buttons %} {% load custom_links %} {% load static %} diff --git a/netbox/templates/virtualization/virtualmachine_component_add.html b/netbox/templates/virtualization/virtualmachine_component_add.html index 90754519b..34a8f3c3d 100644 --- a/netbox/templates/virtualization/virtualmachine_component_add.html +++ b/netbox/templates/virtualization/virtualmachine_component_add.html @@ -1,4 +1,4 @@ -{% extends '_base.html' %} +{% extends 'base.html' %} {% load helpers %} {% load form_helpers %} From 5de085d83df70a7e38160939c36e80f8fe834921 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Fri, 10 Apr 2020 10:36:03 -0400 Subject: [PATCH 122/124] Tweak PluginMenuButton icon_class to require additional "fa" class --- docs/plugins/development.md | 6 +++--- netbox/extras/tests/dummy_plugin/navigation.py | 4 ++-- netbox/templates/inc/plugin_menu_items.html | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/plugins/development.md b/docs/plugins/development.md index 7fd8badf3..ad7eef310 100644 --- a/docs/plugins/development.md +++ b/docs/plugins/development.md @@ -304,8 +304,8 @@ menu_items = ( link='plugins:netbox_animal_sounds:random_animal', link_text='Random sound', buttons=( - PluginMenuButton('home', 'Button A', 'fa-info', ButtonColorChoices.BLUE), - PluginMenuButton('home', 'Button B', 'fa-warning', ButtonColorChoices.GREEN), + PluginMenuButton('home', 'Button A', 'fa fa-info', ButtonColorChoices.BLUE), + PluginMenuButton('home', 'Button B', 'fa fa-warning', ButtonColorChoices.GREEN), ) ), ) @@ -322,7 +322,7 @@ A `PluginMenuButton` has the following attributes: * `link` - The name of the URL path to which this button links * `title` - The tooltip text (displayed when the mouse hovers over the button) -* `icon_class` - Button icon CSS class +* `icon_class` - Button icon CSS class (NetBox currently supports [Font Awesome 4.7](https://fontawesome.com/v4.7.0/icons/)) * `color` - One of the choices provided by `ButtonColorChoices` (optional) * `permissions` - A list of permissions required to display this button (optional) diff --git a/netbox/extras/tests/dummy_plugin/navigation.py b/netbox/extras/tests/dummy_plugin/navigation.py index 75b500916..feeb38b69 100644 --- a/netbox/extras/tests/dummy_plugin/navigation.py +++ b/netbox/extras/tests/dummy_plugin/navigation.py @@ -9,12 +9,12 @@ menu_items = ( PluginMenuButton( link='admin:dummy_plugin_dummymodel_add', title='Add a new dummy model', - icon_class='fa-plus', + icon_class='fa fa-plus', ), PluginMenuButton( link='admin:dummy_plugin_dummymodel_add', title='Add a new dummy model', - icon_class='fa-plus', + icon_class='fa fa-plus', ), ) ), diff --git a/netbox/templates/inc/plugin_menu_items.html b/netbox/templates/inc/plugin_menu_items.html index 16d358eeb..0df4a5e8a 100644 --- a/netbox/templates/inc/plugin_menu_items.html +++ b/netbox/templates/inc/plugin_menu_items.html @@ -10,7 +10,7 @@
      {% for button in menu_item.buttons %} {% if not button.permissions or request.user|has_perms:button.permissions %} - + {% endif %} {% endfor %}
      From 8939d4de921f2b27d817646ce4087508ca8143d1 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Fri, 10 Apr 2020 11:18:01 -0400 Subject: [PATCH 123/124] Use packaging.version.parse directly --- netbox/extras/plugins/__init__.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/netbox/extras/plugins/__init__.py b/netbox/extras/plugins/__init__.py index df98b1a65..ee7f59196 100644 --- a/netbox/extras/plugins/__init__.py +++ b/netbox/extras/plugins/__init__.py @@ -1,6 +1,6 @@ import collections import inspect -from pkg_resources import parse_version +from packaging import version from django.apps import AppConfig from django.conf import settings @@ -77,15 +77,15 @@ class PluginConfig(AppConfig): def validate(cls, user_config): # Enforce version constraints - current_version = parse_version(settings.VERSION) + current_version = version.parse(settings.VERSION) if cls.min_version is not None: - min_version = parse_version(cls.min_version) + min_version = version.parse(cls.min_version) if current_version < min_version: raise ImproperlyConfigured( f"Plugin {cls.__module__} requires NetBox minimum version {cls.min_version}." ) if cls.max_version is not None: - max_version = parse_version(cls.max_version) + max_version = version.parse(cls.max_version) if current_version > max_version: raise ImproperlyConfigured( f"Plugin {cls.__module__} requires NetBox maximum version {cls.max_version}." From 0316063ba93a2948823f85b9432fa5b9e2fd2007 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Fri, 10 Apr 2020 11:56:52 -0400 Subject: [PATCH 124/124] Update v2.8 release notes --- docs/release-notes/version-2.8.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/release-notes/version-2.8.md b/docs/release-notes/version-2.8.md index 665b2eaf4..48625d8d9 100644 --- a/docs/release-notes/version-2.8.md +++ b/docs/release-notes/version-2.8.md @@ -2,7 +2,9 @@ ## v2.8.0 (FUTURE) -### New Features +### New Features (Beta) + +This releases introduces two new features in beta status. While they are expected to be functional, their precise implementation is subject to change during the v2.8 release cycle. It is recommended to wait until NetBox v2.9 to deploy them in production. #### Remote Authentication Support ([#2328](https://github.com/netbox-community/netbox/issues/2328)) @@ -26,7 +28,7 @@ This release introduces support for custom plugins, which can be used to extend * Introduce new API endpoints * Add custom request/response middleware -For NetBox plugins to be recognized, the `PLUGINS_ENABLED` configuration parameter must be set to true. (Plugin support is disabled by default). Plugins can be configured under the `PLUGINS_CONFIG` parameter. More information can be found the in the [plugins documentation](https://netbox.readthedocs.io/en/stable/plugins/). +For NetBox plugins to be recognized, they must be installed and added by name to the `PLUGINS` configuration parameter. (Plugin support is disabled by default.) Plugins can be configured under the `PLUGINS_CONFIG` parameter. More information can be found the in the [plugins documentation](https://netbox.readthedocs.io/en/stable/plugins/). ### Enhancements