From d7f594f7fbade51b18ec6557b95573221c3511a5 Mon Sep 17 00:00:00 2001 From: bellwood Date: Thu, 13 Apr 2017 17:03:58 -0400 Subject: [PATCH 01/36] Enhance LDAP documentation Incorporating @marvnrawley's enhancements from #518 --- docs/installation/ldap.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/docs/installation/ldap.md b/docs/installation/ldap.md index 6a4994a5c..9231e422f 100644 --- a/docs/installation/ldap.md +++ b/docs/installation/ldap.md @@ -49,6 +49,8 @@ AUTH_LDAP_BIND_PASSWORD = "demo" # ldap.set_option(ldap.OPT_X_TLS_REQUIRE_CERT, ldap.OPT_X_TLS_NEVER) LDAP_IGNORE_CERT_ERRORS = True ``` +!!! info + When using Windows Server 2012 you may need to specify a port on AUTH_LDAP_SERVER_URI - 3269 for secure, 3268 for non-secure. ## User Authentication @@ -70,6 +72,8 @@ AUTH_LDAP_USER_ATTR_MAP = { "last_name": "sn" } ``` +!!! info + When using Windows Server 2012 AUTH_LDAP_USER_DN_TEMPLATE should be set to None. # User Groups for Permissions @@ -99,3 +103,17 @@ AUTH_LDAP_FIND_GROUP_PERMS = True AUTH_LDAP_CACHE_GROUPS = True AUTH_LDAP_GROUP_CACHE_TIMEOUT = 3600 ``` + +!!! info + "is_active" - you must map all users to at least this group if you want their account to be treated as enabled. Without this, your users cannot log in. + +"is_staff" - users mapped to this group are enabled for access to the Administration tools; this is the equivalent of checking the "Staff status" box on a manually created user. This doesn't necessarily imply additional privileges, which still needed to be assigned via a group, or on a per-user basis. + +"is_superuser" - users mapped to this group in addition to the "is_staff" group will be assumed to have full permissions to all modules. Without also being mapped to "is_staff", this group observably has no impact to your effective permissions. + +!!! info + It is also possible map user attributes to Django attributes: +AUTH_LDAP_USER_ATTR_MAP = { +"first_name": "givenName", +"last_name": "sn" +} From ecab1ef2e9e0044113439f112edc16ef48731899 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Thu, 25 May 2017 14:46:34 -0400 Subject: [PATCH 02/36] Post-release version bump --- 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 c6d48454a..7eec50475 100644 --- a/netbox/netbox/settings.py +++ b/netbox/netbox/settings.py @@ -13,7 +13,7 @@ except ImportError: ) -VERSION = '2.0.4' +VERSION = '2.0.5-dev' # Import local configuration ALLOWED_HOSTS = DATABASE = SECRET_KEY = None From ff964882b4898e0cab908988b86e3b8ff413022a Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Fri, 26 May 2017 09:55:22 -0400 Subject: [PATCH 03/36] Tweaked upgrade script to prefer pip3/python3 if present --- upgrade.sh | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/upgrade.sh b/upgrade.sh index 53e0c1db6..f8ce22a6f 100755 --- a/upgrade.sh +++ b/upgrade.sh @@ -20,9 +20,11 @@ COMMAND="${PREFIX}find . -name \"*.pyc\" -delete" echo "Cleaning up stale Python bytecode ($COMMAND)..." eval $COMMAND -# Fall back to pip3 if pip is missing -PIP="pip" -type $PIP >/dev/null 2>&1 || PIP="pip3" +# Prefer python3/pip3 +PYTHON="python3" +type $PYTHON >/dev/null 2>&1 || PYTHON="python" +PIP="pip3" +type $PIP >/dev/null 2>&1 || PIP="pip" # Install any new Python packages COMMAND="${PREFIX}${PIP} install -r requirements.txt --upgrade" @@ -30,11 +32,11 @@ echo "Updating required Python packages ($COMMAND)..." eval $COMMAND # Apply any database migrations -COMMAND="./netbox/manage.py migrate" +COMMAND="${PYTHON} netbox/manage.py migrate" echo "Applying database migrations ($COMMAND)..." eval $COMMAND # Collect static files -COMMAND="./netbox/manage.py collectstatic --no-input" +COMMAND="${PYTHON} netbox/manage.py collectstatic --no-input" echo "Collecting static files ($COMMAND)..." eval $COMMAND From f28f462277f47e3679788f15a4501e24bc73d8fe Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Fri, 26 May 2017 10:08:03 -0400 Subject: [PATCH 04/36] Fixes #1225: Fixed border on empty circuits table on provider view --- netbox/templates/circuits/provider.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/netbox/templates/circuits/provider.html b/netbox/templates/circuits/provider.html index 3cdeea36f..35562a7a3 100644 --- a/netbox/templates/circuits/provider.html +++ b/netbox/templates/circuits/provider.html @@ -181,7 +181,7 @@ {% empty %} - None + None {% endfor %} From e2d5f934b247bdbdd0c30ea12371001105970afd Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Tue, 30 May 2017 13:03:25 -0400 Subject: [PATCH 05/36] Fixes #1235: Fix permission name for adding/editing inventory items --- netbox/templates/dcim/inc/inventoryitem.html | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/netbox/templates/dcim/inc/inventoryitem.html b/netbox/templates/dcim/inc/inventoryitem.html index 01281c317..6aa77d1c2 100644 --- a/netbox/templates/dcim/inc/inventoryitem.html +++ b/netbox/templates/dcim/inc/inventoryitem.html @@ -5,10 +5,10 @@ {{ item.part_id }} {{ item.serial }} - {% if perms.dcim.change_inventory_item %} + {% if perms.dcim.change_inventoryitem %} {% endif %} - {% if perms.dcim.delete_inventory_item %} + {% if perms.dcim.delete_inventoryitem %} {% endif %} From fc0ae93f9d6a2f1a1804aa47db790201313a1d09 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Tue, 30 May 2017 13:13:01 -0400 Subject: [PATCH 06/36] Fixes #1236: Truncate rack names in elevations list; add facility ID --- netbox/templates/dcim/rack_elevation_list.html | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/netbox/templates/dcim/rack_elevation_list.html b/netbox/templates/dcim/rack_elevation_list.html index c5c060940..9f6c4df83 100644 --- a/netbox/templates/dcim/rack_elevation_list.html +++ b/netbox/templates/dcim/rack_elevation_list.html @@ -14,7 +14,8 @@ {% for rack in page %}
-

{{ rack.name }}

+ {{ rack.name|truncatechars:"25" }} +

{{ rack.facility_id|truncatechars:"30" }}

{% if face_id %} {% include 'dcim/inc/rack_elevation.html' with primary_face=rack.get_rear_elevation secondary_face=rack.get_front_elevation face_id=1 %} @@ -23,7 +24,8 @@ {% endif %}
-

{{ rack.name }}

+ {{ rack.name|truncatechars:"25" }} +

{{ rack.facility_id|truncatechars:"30" }}

{% endfor %} From 6a4e7695a61797b4b181702c4243e594138d6258 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Tue, 30 May 2017 23:24:21 -0400 Subject: [PATCH 07/36] Closes #1237: Enabled setting limit=0 to disable pagination in API requests; added MAX_PAGE_SIZE configuration setting --- docs/api/overview.md | 5 +++ docs/configuration/optional-settings.md | 8 ++++ netbox/netbox/configuration.example.py | 5 +++ netbox/netbox/settings.py | 3 +- netbox/utilities/api.py | 49 +++++++++++++++++++++++++ 5 files changed, 69 insertions(+), 1 deletion(-) diff --git a/docs/api/overview.md b/docs/api/overview.md index 5f8e43973..a9ad115f8 100644 --- a/docs/api/overview.md +++ b/docs/api/overview.md @@ -136,3 +136,8 @@ The response will return devices 1 through 100. The URL provided in the `next` a "results": [...] } ``` + +The maximum number of objects that can be returned is limited by the [`MAX_PAGE_SIZE`](../configuration/optional-settings/#max_page_size) setting, which is 1000 by default. Setting this to `0` or `None` will remove the maximum limit. An API consumer can then pass `?limit=0` to retrieve _all_ matching objects with a single request. + +!!! warning + Disabling the page size limit introduces a potential for very resource-intensive requests, since one API request can effectively retrieve an entire table from the database. diff --git a/docs/configuration/optional-settings.md b/docs/configuration/optional-settings.md index ed5d2c03c..6c68ca386 100644 --- a/docs/configuration/optional-settings.md +++ b/docs/configuration/optional-settings.md @@ -99,6 +99,14 @@ Setting this to True will display a "maintenance mode" banner at the top of ever --- +## MAX_PAGE_SIZE + +Default: 1000 + +An API consumer can request an arbitrary number of objects by appending the "limit" parameter to the URL (e.g. `?limit=1000`). This setting defines the maximum limit. Setting it to `0` or `None` will allow an API consumer to request all objects by specifying `?limit=0`. + +--- + ## NETBOX_USERNAME ## NETBOX_PASSWORD diff --git a/netbox/netbox/configuration.example.py b/netbox/netbox/configuration.example.py index f185a68c7..bc255bac3 100644 --- a/netbox/netbox/configuration.example.py +++ b/netbox/netbox/configuration.example.py @@ -79,6 +79,11 @@ LOGIN_REQUIRED = False # Setting this to True will display a "maintenance mode" banner at the top of every page. MAINTENANCE_MODE = False +# An API consumer can request an arbitrary number of objects =by appending the "limit" parameter to the URL (e.g. +# "?limit=1000"). This setting defines the maximum limit. Setting it to 0 or None will allow an API consumer to request +# all objects by specifying "?limit=0". +MAX_PAGE_SIZE = 1000 + # Credentials that NetBox will use to access live devices (future use). NETBOX_USERNAME = '' NETBOX_PASSWORD = '' diff --git a/netbox/netbox/settings.py b/netbox/netbox/settings.py index 7eec50475..acdf8e38b 100644 --- a/netbox/netbox/settings.py +++ b/netbox/netbox/settings.py @@ -48,6 +48,7 @@ BANNER_TOP = getattr(configuration, 'BANNER_TOP', False) BANNER_BOTTOM = getattr(configuration, 'BANNER_BOTTOM', False) PREFER_IPV4 = getattr(configuration, 'PREFER_IPV4', False) ENFORCE_GLOBAL_UNIQUE = getattr(configuration, 'ENFORCE_GLOBAL_UNIQUE', False) +MAX_PAGE_SIZE = getattr(configuration, 'MAX_PAGE_SIZE', 1000) CORS_ORIGIN_ALLOW_ALL = getattr(configuration, 'CORS_ORIGIN_ALLOW_ALL', False) CORS_ORIGIN_WHITELIST = getattr(configuration, 'CORS_ORIGIN_WHITELIST', []) CORS_ORIGIN_REGEX_WHITELIST = getattr(configuration, 'CORS_ORIGIN_REGEX_WHITELIST', []) @@ -208,7 +209,7 @@ REST_FRAMEWORK = { 'DEFAULT_FILTER_BACKENDS': ( 'rest_framework.filters.DjangoFilterBackend', ), - 'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.LimitOffsetPagination', + 'DEFAULT_PAGINATION_CLASS': 'utilities.api.OptionalLimitOffsetPagination', 'DEFAULT_PERMISSION_CLASSES': ( 'utilities.api.TokenPermissions', ), diff --git a/netbox/utilities/api.py b/netbox/utilities/api.py index a587c67d1..6fcfc6949 100644 --- a/netbox/utilities/api.py +++ b/netbox/utilities/api.py @@ -5,6 +5,7 @@ from django.contrib.contenttypes.models import ContentType from rest_framework import authentication, exceptions from rest_framework.exceptions import APIException +from rest_framework.pagination import LimitOffsetPagination from rest_framework.permissions import DjangoModelPermissions, SAFE_METHODS from rest_framework.serializers import Field, ValidationError @@ -105,3 +106,51 @@ class WritableSerializerMixin(object): if self.action in WRITE_OPERATIONS and hasattr(self, 'write_serializer_class'): return self.write_serializer_class return self.serializer_class + + +class OptionalLimitOffsetPagination(LimitOffsetPagination): + """ + Override the stock paginator to allow setting limit=0 to disable pagination for a request. This returns all objects + matching a query, but retains the same format as a paginated request. The limit can only be disabled if + MAX_PAGE_SIZE has been set to 0 or None. + """ + + def paginate_queryset(self, queryset, request, view=None): + + try: + self.count = queryset.count() + except (AttributeError, TypeError): + self.count = len(queryset) + self.limit = self.get_limit(request) + self.offset = self.get_offset(request) + self.request = request + + if self.limit and self.count > self.limit and self.template is not None: + self.display_page_controls = True + + if self.count == 0 or self.offset > self.count: + return list() + + if self.limit: + return list(queryset[self.offset:self.offset + self.limit]) + else: + return list(queryset[self.offset:]) + + def get_limit(self, request): + + if self.limit_query_param: + try: + limit = int(request.query_params[self.limit_query_param]) + if limit < 0: + raise ValueError() + # Enforce maximum page size, if defined + if settings.MAX_PAGE_SIZE: + if limit == 0: + return settings.MAX_PAGE_SIZE + else: + return min(limit, settings.MAX_PAGE_SIZE) + return limit + except (KeyError, ValueError): + pass + + return self.default_limit From 64424a497db7813ade86e23cc529770592d08a53 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Wed, 31 May 2017 11:50:03 -0400 Subject: [PATCH 08/36] Fixes #1239: Fix server error when creating VLANGroup via API --- netbox/ipam/api/serializers.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/netbox/ipam/api/serializers.py b/netbox/ipam/api/serializers.py index 096f1d232..f4493719f 100644 --- a/netbox/ipam/api/serializers.py +++ b/netbox/ipam/api/serializers.py @@ -137,7 +137,7 @@ class WritableVLANGroupSerializer(serializers.ModelSerializer): # Validate uniqueness of name and slug if a site has been assigned. if data.get('site', None): for field in ['name', 'slug']: - validator = UniqueTogetherValidator(queryset=VLAN.objects.all(), fields=('site', field)) + validator = UniqueTogetherValidator(queryset=VLANGroup.objects.all(), fields=('site', field)) validator.set_context(self) validator(data) From 4686b266a672c2f908f9dccae38ae13174ccc049 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Wed, 31 May 2017 14:09:57 -0400 Subject: [PATCH 09/36] Fixes #1226: Improve validation for custom field values submitted via the API --- netbox/extras/api/customfields.py | 25 +++++++++++++++++++++---- netbox/extras/models.py | 6 +++++- 2 files changed, 26 insertions(+), 5 deletions(-) diff --git a/netbox/extras/api/customfields.py b/netbox/extras/api/customfields.py index 5bd221893..da15ce1aa 100644 --- a/netbox/extras/api/customfields.py +++ b/netbox/extras/api/customfields.py @@ -1,4 +1,5 @@ from __future__ import unicode_literals +from datetime import datetime from rest_framework import serializers from rest_framework.exceptions import ValidationError @@ -6,7 +7,9 @@ from rest_framework.exceptions import ValidationError from django.contrib.contenttypes.models import ContentType from django.db import transaction -from extras.models import CF_TYPE_SELECT, CustomField, CustomFieldChoice, CustomFieldValue +from extras.models import ( + CF_TYPE_BOOLEAN, CF_TYPE_DATE, CF_TYPE_SELECT, CustomField, CustomFieldChoice, CustomFieldValue, +) # @@ -25,16 +28,30 @@ class CustomFieldsSerializer(serializers.BaseSerializer): for field_name, value in data.items(): + cf = custom_fields[field_name] + # Validate custom field name if field_name not in custom_fields: raise ValidationError("Invalid custom field for {} objects: {}".format(content_type, field_name)) + # Validate boolean + if cf.type == CF_TYPE_BOOLEAN and value not in [True, False, 1, 0]: + raise ValidationError("Invalid value for boolean field {}: {}".format(field_name, value)) + + # Validate date + if cf.type == CF_TYPE_DATE: + try: + datetime.strptime(value, '%Y-%m-%d') + except ValueError: + raise ValidationError("Invalid date for field {}: {}. (Required format is YYYY-MM-DD.)".format( + field_name, value + )) + # Validate selected choice - cf = custom_fields[field_name] if cf.type == CF_TYPE_SELECT: valid_choices = [c.pk for c in cf.choices.all()] if value not in valid_choices: - raise ValidationError("Invalid choice ({}) for field {}".format(value, field_name)) + raise ValidationError("Invalid choice for field {}: {}".format(field_name, value)) # Check for missing required fields missing_fields = [] @@ -87,7 +104,7 @@ class CustomFieldModelSerializer(serializers.ModelSerializer): field=custom_field, obj_type=content_type, obj_id=instance.pk, - defaults={'serialized_value': value}, + defaults={'serialized_value': custom_field.serialize_value(value)}, ) def create(self, validated_data): diff --git a/netbox/extras/models.py b/netbox/extras/models.py index ea92fae0c..bea8a664b 100644 --- a/netbox/extras/models.py +++ b/netbox/extras/models.py @@ -139,7 +139,11 @@ class CustomField(models.Model): if self.type == CF_TYPE_BOOLEAN: return str(int(bool(value))) if self.type == CF_TYPE_DATE: - return value.strftime('%Y-%m-%d') + # Could be date/datetime object or string + try: + return value.strftime('%Y-%m-%d') + except AttributeError: + return value if self.type == CF_TYPE_SELECT: # Could be ModelChoiceField or TypedChoiceField return str(value.id) if hasattr(value, 'id') else str(value) From cac3d5a6e645af3491852625bd922ed8593c51ba Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Wed, 31 May 2017 17:40:11 -0400 Subject: [PATCH 10/36] Initial work on #655: CSV import headers --- netbox/templates/tenancy/tenant_import.html | 37 --------- netbox/templates/utilities/obj_import.html | 17 +++++ netbox/tenancy/forms.py | 21 +++--- netbox/tenancy/views.py | 6 +- netbox/utilities/forms.py | 56 +++++++++++++- netbox/utilities/views.py | 83 ++++++++++++++++++++- 6 files changed, 168 insertions(+), 52 deletions(-) diff --git a/netbox/templates/tenancy/tenant_import.html b/netbox/templates/tenancy/tenant_import.html index 2e5196a88..4d0e97f48 100644 --- a/netbox/templates/tenancy/tenant_import.html +++ b/netbox/templates/tenancy/tenant_import.html @@ -1,40 +1,3 @@ {% extends 'utilities/obj_import.html' %} {% block title %}Tenant Import{% endblock %} - -{% block instructions %} -

CSV Format

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescriptionExample
NameTenant nameWIDG01
SlugURL-friendly namewidg01
GroupTenant group (optional)Customers
DescriptionLong-form name or other text (optional)Widgets Inc.
-

Example

- 
WIDG01,widg01,Customers,Widgets Inc.
-{% endblock %} diff --git a/netbox/templates/utilities/obj_import.html b/netbox/templates/utilities/obj_import.html index 2d69be048..325cfa304 100644 --- a/netbox/templates/utilities/obj_import.html +++ b/netbox/templates/utilities/obj_import.html @@ -28,6 +28,23 @@
{% block instructions %}{% endblock %} + {% if fields %} +

CSV Format

+ + + + + + + {% for name, field in fields.items %} + + + + + + {% endfor %} +
FieldRequiredDescription
{{ name }}{% if field.required %}{% endif %}{{ field.help_text }}
+ {% endif %}
{% endblock %} diff --git a/netbox/tenancy/forms.py b/netbox/tenancy/forms.py index df4f05b95..32e8263c2 100644 --- a/netbox/tenancy/forms.py +++ b/netbox/tenancy/forms.py @@ -5,8 +5,7 @@ from django.db.models import Count from extras.forms import CustomFieldForm, CustomFieldBulkEditForm, CustomFieldFilterForm from utilities.forms import ( - APISelect, BootstrapMixin, BulkImportForm, ChainedFieldsMixin, ChainedModelChoiceField, CommentField, CSVDataField, - FilterChoiceField, SlugField, + APISelect, BootstrapMixin, ChainedFieldsMixin, ChainedModelChoiceField, CommentField, FilterChoiceField, SlugField, ) from .models import Tenant, TenantGroup @@ -36,17 +35,19 @@ class TenantForm(BootstrapMixin, CustomFieldForm): fields = ['name', 'slug', 'group', 'description', 'comments'] -class TenantFromCSVForm(forms.ModelForm): - group = forms.ModelChoiceField(TenantGroup.objects.all(), required=False, to_field_name='name', - error_messages={'invalid_choice': 'Group not found.'}) +class TenantCSVForm(forms.ModelForm): + group = forms.ModelChoiceField( + queryset=TenantGroup.objects.all(), + required=False, + to_field_name='name', + error_messages={ + 'invalid_choice': 'Group not found.' + } + ) class Meta: model = Tenant - fields = ['name', 'slug', 'group', 'description'] - - -class TenantImportForm(BootstrapMixin, BulkImportForm): - csv = CSVDataField(csv_form=TenantFromCSVForm) + fields = ['name', 'slug', 'group', 'description', 'comments'] class TenantBulkEditForm(BootstrapMixin, CustomFieldBulkEditForm): diff --git a/netbox/tenancy/views.py b/netbox/tenancy/views.py index 3b5ad9b37..27afed269 100644 --- a/netbox/tenancy/views.py +++ b/netbox/tenancy/views.py @@ -10,7 +10,7 @@ from circuits.models import Circuit from dcim.models import Site, Rack, Device from ipam.models import IPAddress, Prefix, VLAN, VRF from utilities.views import ( - BulkDeleteView, BulkEditView, BulkImportView, ObjectDeleteView, ObjectEditView, ObjectListView, + BulkDeleteView, BulkEditView, BulkImportView, BulkImportView2, ObjectDeleteView, ObjectEditView, ObjectListView, ) from .models import Tenant, TenantGroup from . import filters, forms, tables @@ -95,9 +95,9 @@ class TenantDeleteView(PermissionRequiredMixin, ObjectDeleteView): default_return_url = 'tenancy:tenant_list' -class TenantBulkImportView(PermissionRequiredMixin, BulkImportView): +class TenantBulkImportView(PermissionRequiredMixin, BulkImportView2): permission_required = 'tenancy.add_tenant' - form = forms.TenantImportForm + model_form = forms.TenantCSVForm table = tables.TenantTable template_name = 'tenancy/tenant_import.html' default_return_url = 'tenancy:tenant_list' diff --git a/netbox/utilities/forms.py b/netbox/utilities/forms.py index 37101a56e..fcdaf2c53 100644 --- a/netbox/utilities/forms.py +++ b/netbox/utilities/forms.py @@ -256,6 +256,60 @@ class CSVDataField(forms.CharField): return records +class CSVDataField2(forms.CharField): + """ + A CharField (rendered as a Textarea) which accepts CSV-formatted data. It returns a list of dictionaries mapping + column headers to values. Each dictionary represents an individual record. + """ + widget = forms.Textarea + + def __init__(self, fields, required_fields=[], *args, **kwargs): + + self.fields = fields + self.required_fields = required_fields + + super(CSVDataField2, self).__init__(*args, **kwargs) + + self.strip = False + if not self.label: + self.label = 'CSV Data' + if not self.initial: + self.initial = ','.join(required_fields) + '\n' + if not self.help_text: + self.help_text = 'Enter one line per record. Use commas to separate values.' + + def to_python(self, value): + + # Python 2's csv module has problems with Unicode + if not isinstance(value, str): + value = value.encode('utf-8') + + records = [] + reader = csv.reader(value.splitlines()) + + # Consume and valdiate the first line of CSV data as column headers + headers = reader.next() + for f in self.required_fields: + if f not in headers: + raise forms.ValidationError('Required column header "{}" not found.'.format(f)) + for f in headers: + if f not in self.fields: + raise forms.ValidationError('Unexpected column header "{}" found.'.format(f)) + + # Parse CSV data + for i, row in enumerate(reader, start=1): + if row: + if len(row) != len(headers): + raise forms.ValidationError( + "Row {}: Expected {} columns but found {}".format(i, len(headers), len(row)) + ) + row = [col.strip() for col in row] + record = dict(zip(headers, row)) + records.append(record) + + return records + + class ExpandableNameField(forms.CharField): """ A field which allows for numeric range expansion @@ -488,7 +542,7 @@ class BulkEditForm(forms.Form): class BulkImportForm(forms.Form): def clean(self): - records = self.cleaned_data.get('csv') + fields, records = self.cleaned_data.get('csv').split('\n', 1) if not records: return diff --git a/netbox/utilities/views.py b/netbox/utilities/views.py index 9c7a4b55e..7791e69b7 100644 --- a/netbox/utilities/views.py +++ b/netbox/utilities/views.py @@ -6,9 +6,10 @@ from django_tables2 import RequestConfig from django.conf import settings from django.contrib import messages from django.contrib.contenttypes.models import ContentType +from django.core.exceptions import ValidationError from django.db import transaction, IntegrityError from django.db.models import ProtectedError -from django.forms import CharField, ModelMultipleChoiceField, MultipleHiddenInput, TypedChoiceField +from django.forms import CharField, Form, ModelMultipleChoiceField, MultipleHiddenInput, TypedChoiceField from django.http import HttpResponse from django.shortcuts import get_object_or_404, redirect, render from django.template import TemplateSyntaxError @@ -19,6 +20,7 @@ from django.utils.safestring import mark_safe from django.views.generic import View from extras.models import CustomField, CustomFieldValue, ExportTemplate, UserAction +from utilities.forms import BootstrapMixin, CSVDataField2 from .error_handlers import handle_protectederror from .forms import ConfirmationForm from .paginator import EnhancedPaginator @@ -422,6 +424,85 @@ class BulkImportView(View): obj.save() +class BulkImportView2(View): + """ + Import objects in bulk (CSV format). + + model_form: The form used to create each imported object + table: The django-tables2 Table used to render the list of imported objects + template_name: The name of the template + default_return_url: The name of the URL to use for the cancel button + """ + model_form = None + table = None + template_name = None + default_return_url = None + + def _import_form(self, *args, **kwargs): + + fields = self.model_form().fields.keys() + required_fields = [name for name, field in self.model_form().fields.items() if field.required] + + class ImportForm(BootstrapMixin, Form): + csv = CSVDataField2(fields=fields, required_fields=required_fields) + + return ImportForm(*args, **kwargs) + + def get(self, request): + + return render(request, self.template_name, { + 'form': self._import_form(), + 'fields': self.model_form().fields, + 'return_url': self.default_return_url, + }) + + def post(self, request): + + new_objs = [] + form = self._import_form(request.POST) + + if form.is_valid(): + + try: + + # Iterate through CSV data and bind each row to a new model form instance. + with transaction.atomic(): + for row, data in enumerate(form.cleaned_data['csv'], start=1): + obj_form = self.model_form(data) + if obj_form.is_valid(): + obj = obj_form.save() + new_objs.append(obj) + else: + for field, err in obj_form.errors.items(): + form.add_error('csv', "Row {} {}: {}".format(row, field, err[0])) + raise ValidationError("") + + # Compile a table containing the imported objects + obj_table = self.table(new_objs) + + if new_objs: + msg = 'Imported {} {}'.format(len(new_objs), new_objs[0]._meta.verbose_name_plural) + messages.success(request, msg) + UserAction.objects.log_import(request.user, ContentType.objects.get_for_model(new_objs[0]), msg) + + return render(request, "import_success.html", { + 'table': obj_table, + 'return_url': self.default_return_url, + }) + + except ValidationError: + pass + + return render(request, self.template_name, { + 'form': form, + 'fields': self.model_form().fields, + 'return_url': self.default_return_url, + }) + + def save_obj(self, obj): + obj.save() + + class BulkEditView(View): """ Edit objects in bulk. From 0ceb667aedb6d5080abb8222e6f040f2a0db334a Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Thu, 1 Jun 2017 16:13:07 -0400 Subject: [PATCH 11/36] Fixes #1243: Catch ValueError in IP-based object filters --- netbox/ipam/filters.py | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/netbox/ipam/filters.py b/netbox/ipam/filters.py index 54146e91a..11c19b7ee 100644 --- a/netbox/ipam/filters.py +++ b/netbox/ipam/filters.py @@ -85,7 +85,7 @@ class AggregateFilter(CustomFieldFilterSet, django_filters.FilterSet): try: prefix = str(IPNetwork(value.strip()).cidr) qs_filter |= Q(prefix__net_contains_or_equals=prefix) - except AddrFormatError: + except (AddrFormatError, ValueError): pass return queryset.filter(qs_filter) @@ -172,7 +172,7 @@ class PrefixFilter(CustomFieldFilterSet, django_filters.FilterSet): try: prefix = str(IPNetwork(value.strip()).cidr) qs_filter |= Q(prefix__net_contains_or_equals=prefix) - except AddrFormatError: + except (AddrFormatError, ValueError): pass return queryset.filter(qs_filter) @@ -183,7 +183,7 @@ class PrefixFilter(CustomFieldFilterSet, django_filters.FilterSet): try: query = str(IPNetwork(value).cidr) return queryset.filter(prefix__net_contained_or_equal=query) - except AddrFormatError: + except (AddrFormatError, ValueError): return queryset.none() def filter_mask_length(self, queryset, name, value): @@ -259,7 +259,7 @@ class IPAddressFilter(CustomFieldFilterSet, django_filters.FilterSet): try: ipaddress = str(IPNetwork(value.strip())) qs_filter |= Q(address__net_host=ipaddress) - except AddrFormatError: + except (AddrFormatError, ValueError): pass return queryset.filter(qs_filter) @@ -270,7 +270,7 @@ class IPAddressFilter(CustomFieldFilterSet, django_filters.FilterSet): try: query = str(IPNetwork(value.strip()).cidr) return queryset.filter(address__net_host_contained=query) - except AddrFormatError: + except (AddrFormatError, ValueError): return queryset.none() def filter_mask_length(self, queryset, name, value): From 87880907d1ec68027f7079109de27d561f192954 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Thu, 1 Jun 2017 16:57:32 -0400 Subject: [PATCH 12/36] #1190: Allow partial string matching when searching on custom fields --- netbox/extras/filters.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/netbox/extras/filters.py b/netbox/extras/filters.py index e44fb86e9..6bd5f3737 100644 --- a/netbox/extras/filters.py +++ b/netbox/extras/filters.py @@ -32,7 +32,7 @@ class CustomFieldFilter(django_filters.Filter): pass return queryset.filter( custom_field_values__field__name=self.name, - custom_field_values__serialized_value=value, + custom_field_values__serialized_value__icontains=value, ) From 83a50f45b547ff982513f9100162868590e83ce7 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Fri, 2 Jun 2017 13:40:52 -0400 Subject: [PATCH 13/36] Converted circuits import views to new scheme --- netbox/circuits/forms.py | 57 ++++++++++++------- netbox/circuits/views.py | 12 ++-- netbox/templates/circuits/circuit_import.html | 55 ------------------ .../templates/circuits/provider_import.html | 45 --------------- netbox/templates/tenancy/tenant_import.html | 3 - netbox/templates/utilities/obj_import.html | 5 +- netbox/tenancy/forms.py | 6 ++ netbox/tenancy/views.py | 1 - netbox/utilities/forms.py | 4 +- netbox/utilities/views.py | 4 +- 10 files changed, 57 insertions(+), 135 deletions(-) delete mode 100644 netbox/templates/circuits/circuit_import.html delete mode 100644 netbox/templates/circuits/provider_import.html delete mode 100644 netbox/templates/tenancy/tenant_import.html diff --git a/netbox/circuits/forms.py b/netbox/circuits/forms.py index 79cad0a6b..444974240 100644 --- a/netbox/circuits/forms.py +++ b/netbox/circuits/forms.py @@ -8,8 +8,8 @@ from extras.forms import CustomFieldForm, CustomFieldBulkEditForm, CustomFieldFi from tenancy.forms import TenancyForm from tenancy.models import Tenant from utilities.forms import ( - APISelect, BootstrapMixin, BulkImportForm, ChainedFieldsMixin, ChainedModelChoiceField, CommentField, CSVDataField, - FilterChoiceField, Livesearch, SmallTextarea, SlugField, + APISelect, BootstrapMixin, ChainedFieldsMixin, ChainedModelChoiceField, CommentField, FilterChoiceField, + SmallTextarea, SlugField, ) from .models import Circuit, CircuitTermination, CircuitType, Provider @@ -39,15 +39,17 @@ class ProviderForm(BootstrapMixin, CustomFieldForm): } -class ProviderFromCSVForm(forms.ModelForm): +class ProviderCSVForm(forms.ModelForm): + slug = SlugField() class Meta: model = Provider - fields = ['name', 'slug', 'asn', 'account', 'portal_url'] - - -class ProviderImportForm(BootstrapMixin, BulkImportForm): - csv = CSVDataField(csv_form=ProviderFromCSVForm) + fields = ['name', 'slug', 'asn', 'account', 'portal_url', 'comments'] + help_texts = { + 'name': 'Provider name', + 'asn': 'Autonomous system number', + 'comments': 'Free-form comments' + } class ProviderBulkEditForm(BootstrapMixin, CustomFieldBulkEditForm): @@ -102,21 +104,36 @@ class CircuitForm(BootstrapMixin, TenancyForm, CustomFieldForm): } -class CircuitFromCSVForm(forms.ModelForm): - provider = forms.ModelChoiceField(Provider.objects.all(), to_field_name='name', - error_messages={'invalid_choice': 'Provider not found.'}) - type = forms.ModelChoiceField(CircuitType.objects.all(), to_field_name='name', - error_messages={'invalid_choice': 'Invalid circuit type.'}) - tenant = forms.ModelChoiceField(Tenant.objects.all(), to_field_name='name', required=False, - error_messages={'invalid_choice': 'Tenant not found.'}) +class CircuitCSVForm(forms.ModelForm): + provider = forms.ModelChoiceField( + queryset=Provider.objects.all(), + to_field_name='name', + help_text='Name of parent provider', + error_messages={ + 'invalid_choice': 'Provider not found.' + } + ) + type = forms.ModelChoiceField( + queryset=CircuitType.objects.all(), + to_field_name='name', + help_text='Name of assigned tenant', + error_messages={ + 'invalid_choice': 'Invalid circuit type.' + } + ) + tenant = forms.ModelChoiceField( + queryset=Tenant.objects.all(), + required=False, + to_field_name='name', + help_text='Name of circuit type', + error_messages={ + 'invalid_choice': 'Tenant not found.' + } + ) class Meta: model = Circuit - fields = ['cid', 'provider', 'type', 'tenant', 'install_date', 'commit_rate', 'description'] - - -class CircuitImportForm(BootstrapMixin, BulkImportForm): - csv = CSVDataField(csv_form=CircuitFromCSVForm) + fields = ['cid', 'provider', 'type', 'tenant', 'install_date', 'commit_rate', 'description', 'comments'] class CircuitBulkEditForm(BootstrapMixin, CustomFieldBulkEditForm): diff --git a/netbox/circuits/views.py b/netbox/circuits/views.py index eed612a33..144007211 100644 --- a/netbox/circuits/views.py +++ b/netbox/circuits/views.py @@ -12,7 +12,7 @@ from django.views.generic import View from extras.models import Graph, GRAPH_TYPE_PROVIDER from utilities.forms import ConfirmationForm from utilities.views import ( - BulkDeleteView, BulkEditView, BulkImportView, ObjectDeleteView, ObjectEditView, ObjectListView, + BulkDeleteView, BulkEditView, BulkImportView2, ObjectDeleteView, ObjectEditView, ObjectListView, ) from . import filters, forms, tables from .models import Circuit, CircuitTermination, CircuitType, Provider, TERM_SIDE_A, TERM_SIDE_Z @@ -63,11 +63,10 @@ class ProviderDeleteView(PermissionRequiredMixin, ObjectDeleteView): default_return_url = 'circuits:provider_list' -class ProviderBulkImportView(PermissionRequiredMixin, BulkImportView): +class ProviderBulkImportView(PermissionRequiredMixin, BulkImportView2): permission_required = 'circuits.add_provider' - form = forms.ProviderImportForm + model_form = forms.ProviderCSVForm table = tables.ProviderTable - template_name = 'circuits/provider_import.html' default_return_url = 'circuits:provider_list' @@ -161,11 +160,10 @@ class CircuitDeleteView(PermissionRequiredMixin, ObjectDeleteView): default_return_url = 'circuits:circuit_list' -class CircuitBulkImportView(PermissionRequiredMixin, BulkImportView): +class CircuitBulkImportView(PermissionRequiredMixin, BulkImportView2): permission_required = 'circuits.add_circuit' - form = forms.CircuitImportForm + model_form = forms.CircuitCSVForm table = tables.CircuitTable - template_name = 'circuits/circuit_import.html' default_return_url = 'circuits:circuit_list' diff --git a/netbox/templates/circuits/circuit_import.html b/netbox/templates/circuits/circuit_import.html deleted file mode 100644 index 4b0c40b09..000000000 --- a/netbox/templates/circuits/circuit_import.html +++ /dev/null @@ -1,55 +0,0 @@ -{% extends 'utilities/obj_import.html' %} - -{% block title %}Circuit Import{% endblock %} - -{% block instructions %} -

CSV Format

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescriptionExample
Circuit IDAlphanumeric circuit identifierIC-603122
ProviderName of circuit providerTeliaSonera
TypeCircuit typeTransit
TenantName of tenant (optional)Strickland Propane
Install DateDate in YYYY-MM-DD format (optional)2016-02-23
Commit rateCommited rate in Kbps (optional)2000
DescriptionShort description (optional)Primary for voice
-

Example

- 
IC-603122,TeliaSonera,Transit,Strickland Propane,2016-02-23,2000,Primary for voice
-{% endblock %} diff --git a/netbox/templates/circuits/provider_import.html b/netbox/templates/circuits/provider_import.html deleted file mode 100644 index 2ab2e5efb..000000000 --- a/netbox/templates/circuits/provider_import.html +++ /dev/null @@ -1,45 +0,0 @@ -{% extends 'utilities/obj_import.html' %} - -{% block title %}Provider Import{% endblock %} - -{% block instructions %} -

CSV Format

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescriptionExample
NameProvider's proper nameLevel 3
SlugURL-friendly namelevel3
ASNAutonomous system number (optional)3356
AccountAccount number (optional)08931544
Portal URLCustomer service portal URL (optional)https://mylevel3.net
-

Example

- 
Level 3,level3,3356,08931544,https://mylevel3.net
-{% endblock %} diff --git a/netbox/templates/tenancy/tenant_import.html b/netbox/templates/tenancy/tenant_import.html deleted file mode 100644 index 4d0e97f48..000000000 --- a/netbox/templates/tenancy/tenant_import.html +++ /dev/null @@ -1,3 +0,0 @@ -{% extends 'utilities/obj_import.html' %} - -{% block title %}Tenant Import{% endblock %} diff --git a/netbox/templates/utilities/obj_import.html b/netbox/templates/utilities/obj_import.html index 325cfa304..25b737175 100644 --- a/netbox/templates/utilities/obj_import.html +++ b/netbox/templates/utilities/obj_import.html @@ -1,8 +1,9 @@ {% extends '_base.html' %} +{% load helpers %} {% load form_helpers %} {% block content %} -

{% block title %}{% endblock %}

+

{% block title %}{{ obj_type|bettertitle }} Import{% endblock %}

{% if form.non_field_errors %} @@ -40,7 +41,7 @@ {{ name }} {% if field.required %}{% endif %} - {{ field.help_text }} + {{ field.help_text|default:field.label }} {% endfor %} diff --git a/netbox/tenancy/forms.py b/netbox/tenancy/forms.py index 32e8263c2..9950abfc2 100644 --- a/netbox/tenancy/forms.py +++ b/netbox/tenancy/forms.py @@ -36,10 +36,12 @@ class TenantForm(BootstrapMixin, CustomFieldForm): class TenantCSVForm(forms.ModelForm): + slug = SlugField() group = forms.ModelChoiceField( queryset=TenantGroup.objects.all(), required=False, to_field_name='name', + help_text='Name of parent group', error_messages={ 'invalid_choice': 'Group not found.' } @@ -48,6 +50,10 @@ class TenantCSVForm(forms.ModelForm): class Meta: model = Tenant fields = ['name', 'slug', 'group', 'description', 'comments'] + help_texts = { + 'name': 'Tenant name', + 'comments': 'Free-form comments' + } class TenantBulkEditForm(BootstrapMixin, CustomFieldBulkEditForm): diff --git a/netbox/tenancy/views.py b/netbox/tenancy/views.py index 27afed269..feaec38be 100644 --- a/netbox/tenancy/views.py +++ b/netbox/tenancy/views.py @@ -99,7 +99,6 @@ class TenantBulkImportView(PermissionRequiredMixin, BulkImportView2): permission_required = 'tenancy.add_tenant' model_form = forms.TenantCSVForm table = tables.TenantTable - template_name = 'tenancy/tenant_import.html' default_return_url = 'tenancy:tenant_list' diff --git a/netbox/utilities/forms.py b/netbox/utilities/forms.py index fcdaf2c53..6c07aad7f 100644 --- a/netbox/utilities/forms.py +++ b/netbox/utilities/forms.py @@ -276,7 +276,9 @@ class CSVDataField2(forms.CharField): if not self.initial: self.initial = ','.join(required_fields) + '\n' if not self.help_text: - self.help_text = 'Enter one line per record. Use commas to separate values.' + self.help_text = 'Enter the list of column headers followed by one line per record to be imported. Use ' \ + 'commas to separate values. Multi-line data and values containing commas may be wrapped ' \ + 'in double quotes.' def to_python(self, value): diff --git a/netbox/utilities/views.py b/netbox/utilities/views.py index 7791e69b7..e06b900c0 100644 --- a/netbox/utilities/views.py +++ b/netbox/utilities/views.py @@ -435,8 +435,8 @@ class BulkImportView2(View): """ model_form = None table = None - template_name = None default_return_url = None + template_name = 'utilities/obj_import.html' def _import_form(self, *args, **kwargs): @@ -453,6 +453,7 @@ class BulkImportView2(View): return render(request, self.template_name, { 'form': self._import_form(), 'fields': self.model_form().fields, + 'obj_type': self.model_form._meta.model._meta.verbose_name, 'return_url': self.default_return_url, }) @@ -496,6 +497,7 @@ class BulkImportView2(View): return render(request, self.template_name, { 'form': form, 'fields': self.model_form().fields, + 'obj_type': self.model_form._meta.model._meta.verbose_name, 'return_url': self.default_return_url, }) From 95377c42c3015bf6012643402c44da07227ca2e7 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Fri, 2 Jun 2017 14:49:25 -0400 Subject: [PATCH 14/36] Converted site/rack/device import views to new scheme --- netbox/dcim/forms.py | 188 ++++++++++++------ netbox/dcim/views.py | 24 +-- netbox/templates/dcim/device_import.html | 104 +--------- .../templates/dcim/device_import_child.html | 94 +-------- .../dcim/inc/device_import_header.html | 1 - netbox/templates/dcim/rack_import.html | 70 ------- netbox/templates/dcim/site_import.html | 81 -------- netbox/templates/utilities/obj_import.html | 1 + 8 files changed, 140 insertions(+), 423 deletions(-) delete mode 100644 netbox/templates/dcim/rack_import.html delete mode 100644 netbox/templates/dcim/site_import.html diff --git a/netbox/dcim/forms.py b/netbox/dcim/forms.py index 9e1cc657d..f1737b366 100644 --- a/netbox/dcim/forms.py +++ b/netbox/dcim/forms.py @@ -107,29 +107,34 @@ class SiteForm(BootstrapMixin, TenancyForm, CustomFieldForm): } -class SiteFromCSVForm(forms.ModelForm): +class SiteCSVForm(forms.ModelForm): region = forms.ModelChoiceField( - Region.objects.all(), to_field_name='name', required=False, error_messages={ - 'invalid_choice': 'Tenant not found.' + queryset=Region.objects.all(), + required=False, + to_field_name='name', + help_text='Name of assigned region', + error_messages={ + 'invalid_choice': 'Region not found.', } ) tenant = forms.ModelChoiceField( - Tenant.objects.all(), to_field_name='name', required=False, error_messages={ - 'invalid_choice': 'Tenant not found.' + queryset=Tenant.objects.all(), + required=False, + to_field_name='name', + help_text='Name of assigned tenant', + error_messages={ + 'invalid_choice': 'Tenant not found.', } ) class Meta: model = Site fields = [ - 'name', 'slug', 'region', 'tenant', 'facility', 'asn', 'contact_name', 'contact_phone', 'contact_email', + 'name', 'slug', 'region', 'tenant', 'facility', 'asn', 'physical_address', 'shipping_address', + 'contact_name', 'contact_phone', 'contact_email', 'comments', ] -class SiteImportForm(BootstrapMixin, BulkImportForm): - csv = CSVDataField(csv_form=SiteFromCSVForm) - - class SiteBulkEditForm(BootstrapMixin, CustomFieldBulkEditForm): pk = forms.ModelMultipleChoiceField(queryset=Site.objects.all(), widget=forms.MultipleHiddenInput) region = TreeNodeChoiceField(queryset=Region.objects.all(), required=False) @@ -217,35 +222,62 @@ class RackForm(BootstrapMixin, TenancyForm, CustomFieldForm): } -class RackFromCSVForm(forms.ModelForm): - site = forms.ModelChoiceField(queryset=Site.objects.all(), to_field_name='name', - error_messages={'invalid_choice': 'Site not found.'}) - group_name = forms.CharField(required=False) - tenant = forms.ModelChoiceField(Tenant.objects.all(), to_field_name='name', required=False, - error_messages={'invalid_choice': 'Tenant not found.'}) - role = forms.ModelChoiceField(RackRole.objects.all(), to_field_name='name', required=False, - error_messages={'invalid_choice': 'Role not found.'}) +class RackCSVForm(forms.ModelForm): + site = forms.ModelChoiceField( + queryset=Site.objects.all(), + to_field_name='name', + help_text='Name of parent site', + error_messages={ + 'invalid_choice': 'Site not found.', + } + ) + group = forms.ModelChoiceField( + queryset=RackGroup.objects.all(), + to_field_name='name', + required=False, + help_text='Name of parent group', + error_messages={ + 'invalid_choice': 'Rack group not found.', + } + ) + tenant = forms.ModelChoiceField( + queryset=Tenant.objects.all(), + required=False, + to_field_name='name', + help_text='Name of assigned tenant', + error_messages={ + 'invalid_choice': 'Tenant not found.', + } + ) + role = forms.ModelChoiceField( + queryset=RackRole.objects.all(), + required=False, + to_field_name='name', + help_text='Name of assigned role', + error_messages={ + 'invalid_choice': 'Role not found.', + } + ) type = forms.CharField(required=False) class Meta: model = Rack - fields = ['site', 'group_name', 'name', 'facility_id', 'tenant', 'role', 'type', 'width', 'u_height', - 'desc_units'] + fields = [ + 'site', 'group', 'name', 'facility_id', 'tenant', 'role', 'type', 'width', 'u_height', 'desc_units', + ] - def clean(self): + def clean_group(self): site = self.cleaned_data.get('site') - group = self.cleaned_data.get('group_name') + group = self.cleaned_data.get('group') - # Validate rack group - if site and group: - try: - self.instance.group = RackGroup.objects.get(site=site, name=group) - except RackGroup.DoesNotExist: - self.add_error('group_name', "Invalid rack group ({})".format(group)) + if group and group.site != site: + raise ValidationError("Invalid group for site {}: {}".format(site, group)) def clean_type(self): + rack_type = self.cleaned_data['type'] + if not rack_type: return None try: @@ -258,10 +290,6 @@ class RackFromCSVForm(forms.ModelForm): )) -class RackImportForm(BootstrapMixin, BulkImportForm): - csv = CSVDataField(csv_form=RackFromCSVForm) - - class RackBulkEditForm(BootstrapMixin, CustomFieldBulkEditForm): pk = forms.ModelMultipleChoiceField(queryset=Rack.objects.all(), widget=forms.MultipleHiddenInput) site = forms.ModelChoiceField(queryset=Site.objects.all(), required=False, label='Site') @@ -663,25 +691,47 @@ class DeviceForm(BootstrapMixin, TenancyForm, CustomFieldForm): self.initial['rack'] = self.instance.parent_bay.device.rack_id -class BaseDeviceFromCSVForm(forms.ModelForm): +class BaseDeviceCSVForm(forms.ModelForm): device_role = forms.ModelChoiceField( - queryset=DeviceRole.objects.all(), to_field_name='name', - error_messages={'invalid_choice': 'Invalid device role.'} + queryset=DeviceRole.objects.all(), + to_field_name='name', + help_text='Name of assigned role', + error_messages={ + 'invalid_choice': 'Invalid device role.', + } ) tenant = forms.ModelChoiceField( - Tenant.objects.all(), to_field_name='name', required=False, - error_messages={'invalid_choice': 'Tenant not found.'} + queryset=Tenant.objects.all(), + required=False, + to_field_name='name', + help_text='Name of assigned tenant', + error_messages={ + 'invalid_choice': 'Tenant not found.', + } ) manufacturer = forms.ModelChoiceField( - queryset=Manufacturer.objects.all(), to_field_name='name', - error_messages={'invalid_choice': 'Invalid manufacturer.'} + queryset=Manufacturer.objects.all(), + to_field_name='name', + help_text='Manufacturer name', + error_messages={ + 'invalid_choice': 'Invalid manufacturer.', + } + ) + model_name = forms.CharField( + help_text='Model name' ) - model_name = forms.CharField() platform = forms.ModelChoiceField( - queryset=Platform.objects.all(), required=False, to_field_name='name', - error_messages={'invalid_choice': 'Invalid platform.'} + queryset=Platform.objects.all(), + required=False, + to_field_name='name', + help_text='Name of assigned platform', + error_messages={ + 'invalid_choice': 'Invalid platform.', + } + ) + status = forms.CharField( + help_text='Status name' ) - status = forms.CharField() class Meta: fields = [] @@ -707,16 +757,25 @@ class BaseDeviceFromCSVForm(forms.ModelForm): raise ValidationError("Invalid status: {}".format(self.cleaned_data['status'])) -class DeviceFromCSVForm(BaseDeviceFromCSVForm): +class DeviceCSVForm(BaseDeviceCSVForm): site = forms.ModelChoiceField( - queryset=Site.objects.all(), to_field_name='name', error_messages={ + queryset=Site.objects.all(), + to_field_name='name', + help_text='Name of parent site', + error_messages={ 'invalid_choice': 'Invalid site name.', } ) - rack_name = forms.CharField(required=False) - face = forms.CharField(required=False) + rack_name = forms.CharField( + required=False, + help_text='Name of parent rack' + ) + face = forms.CharField( + required=False, + help_text='Mounted rack face (front or rear)' + ) - class Meta(BaseDeviceFromCSVForm.Meta): + class Meta(BaseDeviceCSVForm.Meta): fields = [ 'name', 'device_role', 'tenant', 'manufacturer', 'model_name', 'platform', 'serial', 'asset_tag', 'status', 'site', 'rack_name', 'position', 'face', @@ -724,7 +783,7 @@ class DeviceFromCSVForm(BaseDeviceFromCSVForm): def clean(self): - super(DeviceFromCSVForm, self).clean() + super(DeviceCSVForm, self).clean() site = self.cleaned_data.get('site') rack_name = self.cleaned_data.get('rack_name') @@ -749,18 +808,20 @@ class DeviceFromCSVForm(BaseDeviceFromCSVForm): raise forms.ValidationError('Invalid rack face ({}); must be "front" or "rear".'.format(face)) -class ChildDeviceFromCSVForm(BaseDeviceFromCSVForm): +class ChildDeviceCSVForm(BaseDeviceCSVForm): parent = FlexibleModelChoiceField( queryset=Device.objects.all(), to_field_name='name', - required=False, + help_text='Name of parent device', error_messages={ - 'invalid_choice': 'Parent device not found.' + 'invalid_choice': 'Parent device not found.', } ) - device_bay_name = forms.CharField(required=False) + device_bay_name = forms.CharField( + help_text='Name of device bay', + ) - class Meta(BaseDeviceFromCSVForm.Meta): + class Meta(BaseDeviceCSVForm.Meta): fields = [ 'name', 'device_role', 'tenant', 'manufacturer', 'model_name', 'platform', 'serial', 'asset_tag', 'status', 'parent', 'device_bay_name', @@ -768,7 +829,7 @@ class ChildDeviceFromCSVForm(BaseDeviceFromCSVForm): def clean(self): - super(ChildDeviceFromCSVForm, self).clean() + super(ChildDeviceCSVForm, self).clean() parent = self.cleaned_data.get('parent') device_bay_name = self.cleaned_data.get('device_bay_name') @@ -778,20 +839,15 @@ class ChildDeviceFromCSVForm(BaseDeviceFromCSVForm): try: device_bay = DeviceBay.objects.get(device=parent, name=device_bay_name) if device_bay.installed_device: - self.add_error('device_bay_name', - "Device bay ({} {}) is already occupied".format(parent, device_bay_name)) + self.add_error( + 'device_bay_name', "Device bay ({} {}) is already occupied".format(parent, device_bay_name) + ) else: self.instance.parent_bay = device_bay except DeviceBay.DoesNotExist: - self.add_error('device_bay_name', "Parent device/bay ({} {}) not found".format(parent, device_bay_name)) - - -class DeviceImportForm(BootstrapMixin, BulkImportForm): - csv = CSVDataField(csv_form=DeviceFromCSVForm) - - -class ChildDeviceImportForm(BootstrapMixin, BulkImportForm): - csv = CSVDataField(csv_form=ChildDeviceFromCSVForm) + self.add_error( + 'device_bay_name', "Parent device/bay ({} {}) not found".format(parent, device_bay_name) + ) class DeviceBulkEditForm(BootstrapMixin, CustomFieldBulkEditForm): diff --git a/netbox/dcim/views.py b/netbox/dcim/views.py index f6e00be04..888a54aaf 100644 --- a/netbox/dcim/views.py +++ b/netbox/dcim/views.py @@ -23,14 +23,14 @@ from extras.models import Graph, TopologyMap, GRAPH_TYPE_INTERFACE, GRAPH_TYPE_S from utilities.forms import ConfirmationForm from utilities.paginator import EnhancedPaginator from utilities.views import ( - BulkDeleteView, BulkEditView, BulkImportView, ObjectDeleteView, ObjectEditView, ObjectListView, + BulkDeleteView, BulkEditView, BulkImportView, BulkImportView2, ObjectDeleteView, ObjectEditView, ObjectListView, ) from . import filters, forms, tables from .models import ( CONNECTION_STATUS_CONNECTED, ConsolePort, ConsolePortTemplate, ConsoleServerPort, ConsoleServerPortTemplate, Device, DeviceBay, DeviceBayTemplate, DeviceRole, DeviceType, Interface, InterfaceConnection, InterfaceTemplate, - Manufacturer, InventoryItem, Platform, PowerOutlet, PowerOutletTemplate, PowerPort, PowerPortTemplate, Rack, RackGroup, - RackReservation, RackRole, Region, Site, + Manufacturer, InventoryItem, Platform, PowerOutlet, PowerOutletTemplate, PowerPort, PowerPortTemplate, Rack, + RackGroup, RackReservation, RackRole, Region, Site, ) @@ -217,11 +217,10 @@ class SiteDeleteView(PermissionRequiredMixin, ObjectDeleteView): default_return_url = 'dcim:site_list' -class SiteBulkImportView(PermissionRequiredMixin, BulkImportView): +class SiteBulkImportView(PermissionRequiredMixin, BulkImportView2): permission_required = 'dcim.add_site' - form = forms.SiteImportForm + model_form = forms.SiteCSVForm table = tables.SiteTable - template_name = 'dcim/site_import.html' default_return_url = 'dcim:site_list' @@ -388,11 +387,10 @@ class RackDeleteView(PermissionRequiredMixin, ObjectDeleteView): default_return_url = 'dcim:rack_list' -class RackBulkImportView(PermissionRequiredMixin, BulkImportView): +class RackBulkImportView(PermissionRequiredMixin, BulkImportView2): permission_required = 'dcim.add_rack' - form = forms.RackImportForm + model_form = forms.RackCSVForm table = tables.RackImportTable - template_name = 'dcim/rack_import.html' default_return_url = 'dcim:rack_list' @@ -864,17 +862,17 @@ class DeviceDeleteView(PermissionRequiredMixin, ObjectDeleteView): default_return_url = 'dcim:device_list' -class DeviceBulkImportView(PermissionRequiredMixin, BulkImportView): +class DeviceBulkImportView(PermissionRequiredMixin, BulkImportView2): permission_required = 'dcim.add_device' - form = forms.DeviceImportForm + model_form = forms.DeviceCSVForm table = tables.DeviceImportTable template_name = 'dcim/device_import.html' default_return_url = 'dcim:device_list' -class ChildDeviceBulkImportView(PermissionRequiredMixin, BulkImportView): +class ChildDeviceBulkImportView(PermissionRequiredMixin, BulkImportView2): permission_required = 'dcim.add_device' - form = forms.ChildDeviceImportForm + model_form = forms.ChildDeviceCSVForm table = tables.DeviceImportTable template_name = 'dcim/device_import_child.html' default_return_url = 'dcim:device_list' diff --git a/netbox/templates/dcim/device_import.html b/netbox/templates/dcim/device_import.html index 8a1cfa1a5..85ebfbbc6 100644 --- a/netbox/templates/dcim/device_import.html +++ b/netbox/templates/dcim/device_import.html @@ -1,103 +1,5 @@ -{% extends '_base.html' %} -{% load form_helpers %} +{% extends 'utilities/obj_import.html' %} -{% block title %}Device Import{% endblock %} - -{% block content %} -{% include 'dcim/inc/device_import_header.html' %} -
-
-
- {% csrf_token %} - {% render_form form %} -
-
- - {% if return_url %} - Cancel - {% endif %} -
-
-
-

CSV Format

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescriptionExample
NameDevice name (optional)rack101_sw1
Device roleFunctional role of deviceToR Switch
TenantName of tenant (optional)Pied Piper
Device manufacturerHardware manufacturerJuniper
Device modelHardware modelEX4300-48T
PlatformSoftware running on device (optional)Juniper Junos
Serial numberPhysical serial number (optional)CAB00577291
Asset tagUnique alphanumeric tag (optional)ABC123456
StatusCurrent statusActive
SiteSite nameAshburn-VA
RackRack name (optional)R101
Position (U)Lowest-numbered rack unit occupied by the device (optional)21
FaceRack face; front or rear (required if position is set)Rear
-

Example

- 
rack101_sw1,ToR Switch,Pied Piper,Juniper,EX4300-48T,Juniper Junos,CAB00577291,ABC123456,Active,Ashburn-VA,R101,21,Rear
-
-
+{% block tabs %} + {% include 'dcim/inc/device_import_header.html' %} {% endblock %} diff --git a/netbox/templates/dcim/device_import_child.html b/netbox/templates/dcim/device_import_child.html index 668a9c810..406d239d7 100644 --- a/netbox/templates/dcim/device_import_child.html +++ b/netbox/templates/dcim/device_import_child.html @@ -1,93 +1,5 @@ -{% extends '_base.html' %} -{% load form_helpers %} +{% extends 'utilities/obj_import.html' %} -{% block title %}Device Import{% endblock %} - -{% block content %} -{% include 'dcim/inc/device_import_header.html' with active_tab='child_import' %} -
-
-
- {% csrf_token %} - {% render_form form %} -
-
- - {% if return_url %} - Cancel - {% endif %} -
-
-
-

CSV Format

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescriptionExample
NameDevice name (optional)Blade12
Device roleFunctional role of deviceBlade Server
TenantName of tenant (optional)Pied Piper
Device manufacturerHardware manufacturerDell
Device modelHardware modelBS2000T
PlatformSoftware running on device (optional)Linux
Serial numberPhysical serial number (optional)CAB00577291
Asset tagUnique alphanumeric tag (optional)ABC123456
StatusCurrent statusActive
Parent deviceParent deviceServer101
Device bayDevice bay nameSlot 4
-

Example

- 
Blade12,Blade Server,Pied Piper,Dell,BS2000T,Linux,CAB00577291,ABC123456,Active,Server101,Slot4
-
-
+{% block tabs %} + {% include 'dcim/inc/device_import_header.html' with active_tab='child_import' %} {% endblock %} diff --git a/netbox/templates/dcim/inc/device_import_header.html b/netbox/templates/dcim/inc/device_import_header.html index 57dd1b46e..2adc867b1 100644 --- a/netbox/templates/dcim/inc/device_import_header.html +++ b/netbox/templates/dcim/inc/device_import_header.html @@ -1,4 +1,3 @@ -

Device Import

    diff --git a/netbox/templates/dcim/rack_import.html b/netbox/templates/dcim/rack_import.html deleted file mode 100644 index e3e40c5cd..000000000 --- a/netbox/templates/dcim/rack_import.html +++ /dev/null @@ -1,70 +0,0 @@ -{% extends 'utilities/obj_import.html' %} - -{% block title %}Rack Import{% endblock %} - -{% block instructions %} -

    CSV Format

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldDescriptionExample
    SiteName of the assigned siteDC-4
    GroupRack group name (optional)Cage 1400
    NameInternal rack nameR101
    Facility IDRack ID assigned by the facility (optional)J12.100
    TenantName of tenant (optional)Pied Piper
    RoleFunctional role (optional)Compute
    TypeRack type (optional)4-post cabinet
    WidthRail-to-rail width (19 or 23 inches)19
    HeightHeight in rack units42
    Descending unitsUnits are numbered top-to-bottomFalse
    -

    Example

    - 
    DC-4,Cage 1400,R101,J12.100,Pied Piper,Compute,4-post cabinet,19,42,False
    -{% endblock %} diff --git a/netbox/templates/dcim/site_import.html b/netbox/templates/dcim/site_import.html deleted file mode 100644 index 3a4e6277a..000000000 --- a/netbox/templates/dcim/site_import.html +++ /dev/null @@ -1,81 +0,0 @@ -{% extends '_base.html' %} -{% load form_helpers %} - -{% block title %}Site Import{% endblock %} - -{% block content %} -

    Site Import

    -
    -
    -
    - {% csrf_token %} - {% render_form form %} -
    - - Cancel -
    -
    -
    -
    -

    CSV Format

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldDescriptionExample
    NameSite's proper nameASH-4 South
    SlugURL-friendly nameash4-south
    RegionName of region (optional)North America
    TenantName of tenant (optional)Pied Piper
    FacilityName of the hosting facility (optional)Equinix DC6
    ASNAutonomous system number (optional)65000
    Contact NameName of administrative contact (optional)Hank Hill
    Contact PhonePhone number (optional)+1-214-555-1234
    Contact E-mailE-mail address (optional)hhill@example.com
    -

    Example

    - 
    ASH-4 South,ash4-south,North America,Pied Piper,Equinix DC6,65000,Hank Hill,+1-214-555-1234,hhill@example.com
    -
    -
    -{% endblock %} diff --git a/netbox/templates/utilities/obj_import.html b/netbox/templates/utilities/obj_import.html index 25b737175..7aa7d3b0f 100644 --- a/netbox/templates/utilities/obj_import.html +++ b/netbox/templates/utilities/obj_import.html @@ -4,6 +4,7 @@ {% block content %}

    {% block title %}{{ obj_type|bettertitle }} Import{% endblock %}

    +{% block tabs %}{% endblock %}
    {% if form.non_field_errors %} From a2174e7e9892aa5ee54e8123bed6e2ce5058b279 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Fri, 2 Jun 2017 16:07:11 -0400 Subject: [PATCH 15/36] Converted IPAM import views to new scheme --- netbox/ipam/forms.py | 204 +++++++++++++------- netbox/ipam/views.py | 28 ++- netbox/templates/ipam/aggregate_import.html | 40 ---- netbox/templates/ipam/ipaddress_import.html | 60 ------ netbox/templates/ipam/prefix_import.html | 70 ------- netbox/templates/ipam/vlan_import.html | 60 ------ netbox/templates/ipam/vrf_import.html | 45 ----- 7 files changed, 151 insertions(+), 356 deletions(-) delete mode 100644 netbox/templates/ipam/aggregate_import.html delete mode 100644 netbox/templates/ipam/ipaddress_import.html delete mode 100644 netbox/templates/ipam/prefix_import.html delete mode 100644 netbox/templates/ipam/vlan_import.html delete mode 100644 netbox/templates/ipam/vrf_import.html diff --git a/netbox/ipam/forms.py b/netbox/ipam/forms.py index 3bc8124ea..896ca1d87 100644 --- a/netbox/ipam/forms.py +++ b/netbox/ipam/forms.py @@ -9,8 +9,8 @@ from extras.forms import CustomFieldForm, CustomFieldBulkEditForm, CustomFieldFi from tenancy.forms import TenancyForm from tenancy.models import Tenant from utilities.forms import ( - APISelect, BootstrapMixin, BulkEditNullBooleanSelect, BulkImportForm, ChainedModelChoiceField, CSVDataField, - ExpandableIPAddressField, FilterChoiceField, Livesearch, ReturnURLForm, SlugField, add_blank_choice, + APISelect, BootstrapMixin, BulkEditNullBooleanSelect, ChainedModelChoiceField, ExpandableIPAddressField, + FilterChoiceField, Livesearch, ReturnURLForm, SlugField, add_blank_choice, ) from .models import ( Aggregate, IPAddress, IPADDRESS_STATUS_CHOICES, Prefix, PREFIX_STATUS_CHOICES, RIR, Role, Service, VLAN, @@ -48,19 +48,22 @@ class VRFForm(BootstrapMixin, TenancyForm, CustomFieldForm): } -class VRFFromCSVForm(forms.ModelForm): - tenant = forms.ModelChoiceField(Tenant.objects.all(), to_field_name='name', required=False, - error_messages={'invalid_choice': 'Tenant not found.'}) +class VRFCSVForm(forms.ModelForm): + tenant = forms.ModelChoiceField( + queryset=Tenant.objects.all(), + required=False, + to_field_name='name', + help_text='Name of assigned tenant', + error_messages={ + 'invalid_choice': 'Tenant not found.', + } + ) class Meta: model = VRF fields = ['name', 'rd', 'tenant', 'enforce_unique', 'description'] -class VRFImportForm(BootstrapMixin, BulkImportForm): - csv = CSVDataField(csv_form=VRFFromCSVForm) - - class VRFBulkEditForm(BootstrapMixin, CustomFieldBulkEditForm): pk = forms.ModelMultipleChoiceField(queryset=VRF.objects.all(), widget=forms.MultipleHiddenInput) tenant = forms.ModelChoiceField(queryset=Tenant.objects.all(), required=False) @@ -116,19 +119,21 @@ class AggregateForm(BootstrapMixin, CustomFieldForm): } -class AggregateFromCSVForm(forms.ModelForm): - rir = forms.ModelChoiceField(queryset=RIR.objects.all(), to_field_name='name', - error_messages={'invalid_choice': 'RIR not found.'}) +class AggregateCSVForm(forms.ModelForm): + rir = forms.ModelChoiceField( + queryset=RIR.objects.all(), + to_field_name='name', + help_text='Name of parent RIR', + error_messages={ + 'invalid_choice': 'RIR not found.', + } + ) class Meta: model = Aggregate fields = ['prefix', 'rir', 'date_added', 'description'] -class AggregateImportForm(BootstrapMixin, BulkImportForm): - csv = CSVDataField(csv_form=AggregateFromCSVForm) - - class AggregateBulkEditForm(BootstrapMixin, CustomFieldBulkEditForm): pk = forms.ModelMultipleChoiceField(queryset=Aggregate.objects.all(), widget=forms.MultipleHiddenInput) rir = forms.ModelChoiceField(queryset=RIR.objects.all(), required=False, label='RIR') @@ -197,18 +202,54 @@ class PrefixForm(BootstrapMixin, TenancyForm, CustomFieldForm): self.fields['vrf'].empty_label = 'Global' -class PrefixFromCSVForm(forms.ModelForm): - vrf = forms.ModelChoiceField(queryset=VRF.objects.all(), required=False, to_field_name='rd', - error_messages={'invalid_choice': 'VRF not found.'}) - tenant = forms.ModelChoiceField(Tenant.objects.all(), to_field_name='name', required=False, - error_messages={'invalid_choice': 'Tenant not found.'}) - site = forms.ModelChoiceField(queryset=Site.objects.all(), required=False, to_field_name='name', - error_messages={'invalid_choice': 'Site not found.'}) - vlan_group_name = forms.CharField(required=False) - vlan_vid = forms.IntegerField(required=False) - status = forms.CharField() - role = forms.ModelChoiceField(queryset=Role.objects.all(), required=False, to_field_name='name', - error_messages={'invalid_choice': 'Invalid role.'}) +class PrefixCSVForm(forms.ModelForm): + vrf = forms.ModelChoiceField( + queryset=VRF.objects.all(), + required=False, + to_field_name='rd', + help_text='Route distinguisher of parent VRF', + error_messages={ + 'invalid_choice': 'VRF not found.', + } + ) + tenant = forms.ModelChoiceField( + queryset=Tenant.objects.all(), + required=False, + to_field_name='name', + help_text='Name of assigned tenant', + error_messages={ + 'invalid_choice': 'Tenant not found.', + } + ) + site = forms.ModelChoiceField( + queryset=Site.objects.all(), + required=False, + to_field_name='name', + help_text='Name of parent site', + error_messages={ + 'invalid_choice': 'Site not found.', + } + ) + vlan_group_name = forms.CharField( + help_text='Group name of assigned VLAN', + required=False + ) + vlan_vid = forms.IntegerField( + help_text='Numeric ID of assigned VLAN', + required=False + ) + status = forms.CharField( + help_text='Status name' + ) + role = forms.ModelChoiceField( + queryset=Role.objects.all(), + required=False, + to_field_name='name', + help_text='Role name', + error_messages={ + 'invalid_choice': 'Invalid role.', + } + ) class Meta: model = Prefix @@ -219,8 +260,6 @@ class PrefixFromCSVForm(forms.ModelForm): def clean(self): - super(PrefixFromCSVForm, self).clean() - site = self.cleaned_data.get('site') vlan_group_name = self.cleaned_data.get('vlan_group_name') vlan_vid = self.cleaned_data.get('vlan_vid') @@ -258,10 +297,6 @@ class PrefixFromCSVForm(forms.ModelForm): raise ValidationError("Invalid status: {}".format(self.cleaned_data['status'])) -class PrefixImportForm(BootstrapMixin, BulkImportForm): - csv = CSVDataField(csv_form=PrefixFromCSVForm) - - class PrefixBulkEditForm(BootstrapMixin, CustomFieldBulkEditForm): pk = forms.ModelMultipleChoiceField(queryset=Prefix.objects.all(), widget=forms.MultipleHiddenInput) site = forms.ModelChoiceField(queryset=Site.objects.all(), required=False) @@ -513,16 +548,45 @@ class IPAddressBulkAddForm(BootstrapMixin, TenancyForm, CustomFieldForm): self.fields['vrf'].empty_label = 'Global' -class IPAddressFromCSVForm(forms.ModelForm): - vrf = forms.ModelChoiceField(queryset=VRF.objects.all(), required=False, to_field_name='rd', - error_messages={'invalid_choice': 'VRF not found.'}) - tenant = forms.ModelChoiceField(Tenant.objects.all(), to_field_name='name', required=False, - error_messages={'invalid_choice': 'Tenant not found.'}) - status = forms.CharField() - device = forms.ModelChoiceField(queryset=Device.objects.all(), required=False, to_field_name='name', - error_messages={'invalid_choice': 'Device not found.'}) - interface_name = forms.CharField(required=False) - is_primary = forms.BooleanField(required=False) +class IPAddressCSVForm(forms.ModelForm): + vrf = forms.ModelChoiceField( + queryset=VRF.objects.all(), + required=False, + to_field_name='rd', + help_text='Route distinguisher of the assigned VRF', + error_messages={ + 'invalid_choice': 'VRF not found.', + } + ) + tenant = forms.ModelChoiceField( + queryset=Tenant.objects.all(), + to_field_name='name', + required=False, + help_text='Name of the assigned tenant', + error_messages={ + 'invalid_choice': 'Tenant not found.', + } + ) + status = forms.CharField( + help_text='Status name' + ) + device = forms.ModelChoiceField( + queryset=Device.objects.all(), + required=False, + to_field_name='name', + help_text='Name of assigned Device', + error_messages={ + 'invalid_choice': 'Device not found.', + } + ) + interface_name = forms.CharField( + help_text='Name of assigned interface', + required=False + ) + is_primary = forms.BooleanField( + help_text='This is the primary IP for the assigned device', + required=False + ) class Meta: model = IPAddress @@ -569,11 +633,7 @@ class IPAddressFromCSVForm(forms.ModelForm): elif self.instance.address.version == 6: self.instance.primary_ip6_for = self.cleaned_data['device'] - return super(IPAddressFromCSVForm, self).save(*args, **kwargs) - - -class IPAddressImportForm(BootstrapMixin, BulkImportForm): - csv = CSVDataField(csv_form=IPAddressFromCSVForm) + return super(IPAddressCSVForm, self).save(*args, **kwargs) class IPAddressBulkEditForm(BootstrapMixin, CustomFieldBulkEditForm): @@ -673,20 +733,40 @@ class VLANForm(BootstrapMixin, TenancyForm, CustomFieldForm): } -class VLANFromCSVForm(forms.ModelForm): +class VLANCSVForm(forms.ModelForm): site = forms.ModelChoiceField( - queryset=Site.objects.all(), required=False, to_field_name='name', - error_messages={'invalid_choice': 'Site not found.'} + queryset=Site.objects.all(), + required=False, + to_field_name='name', + help_text='Name of parent site', + error_messages={ + 'invalid_choice': 'Site not found.', + } + ) + group_name = forms.CharField( + help_text='Name of parent VLAN group', + required=False ) - group_name = forms.CharField(required=False) tenant = forms.ModelChoiceField( - Tenant.objects.all(), to_field_name='name', required=False, - error_messages={'invalid_choice': 'Tenant not found.'} + queryset=Tenant.objects.all(), + to_field_name='name', + required=False, + help_text='Name of assigned tenant', + error_messages={ + 'invalid_choice': 'Tenant not found.', + } + ) + status = forms.CharField( + help_text='Status name' ) - status = forms.CharField() role = forms.ModelChoiceField( - queryset=Role.objects.all(), required=False, to_field_name='name', - error_messages={'invalid_choice': 'Invalid role.'} + queryset=Role.objects.all(), + required=False, + to_field_name='name', + help_text='Name of assigned role', + error_messages={ + 'invalid_choice': 'Invalid role.', + } ) class Meta: @@ -695,8 +775,6 @@ class VLANFromCSVForm(forms.ModelForm): def clean(self): - super(VLANFromCSVForm, self).clean() - # Validate VLANGroup group_name = self.cleaned_data.get('group_name') if group_name: @@ -714,7 +792,7 @@ class VLANFromCSVForm(forms.ModelForm): def save(self, *args, **kwargs): - vlan = super(VLANFromCSVForm, self).save(commit=False) + vlan = super(VLANCSVForm, self).save(commit=False) # Assign VLANGroup by site and name if self.cleaned_data['group_name']: @@ -725,10 +803,6 @@ class VLANFromCSVForm(forms.ModelForm): return vlan -class VLANImportForm(BootstrapMixin, BulkImportForm): - csv = CSVDataField(csv_form=VLANFromCSVForm) - - class VLANBulkEditForm(BootstrapMixin, CustomFieldBulkEditForm): pk = forms.ModelMultipleChoiceField(queryset=VLAN.objects.all(), widget=forms.MultipleHiddenInput) site = forms.ModelChoiceField(queryset=Site.objects.all(), required=False) diff --git a/netbox/ipam/views.py b/netbox/ipam/views.py index a51f47b6e..871bae6e1 100644 --- a/netbox/ipam/views.py +++ b/netbox/ipam/views.py @@ -13,7 +13,8 @@ from django.views.generic import View from dcim.models import Device from utilities.paginator import EnhancedPaginator from utilities.views import ( - BulkAddView, BulkDeleteView, BulkEditView, BulkImportView, ObjectDeleteView, ObjectEditView, ObjectListView, + BulkAddView, BulkDeleteView, BulkEditView, BulkImportView, BulkImportView2, ObjectDeleteView, ObjectEditView, + ObjectListView, ) from . import filters, forms, tables from .models import ( @@ -128,11 +129,10 @@ class VRFDeleteView(PermissionRequiredMixin, ObjectDeleteView): default_return_url = 'ipam:vrf_list' -class VRFBulkImportView(PermissionRequiredMixin, BulkImportView): +class VRFBulkImportView(PermissionRequiredMixin, BulkImportView2): permission_required = 'ipam.add_vrf' - form = forms.VRFImportForm + model_form = forms.VRFCSVForm table = tables.VRFTable - template_name = 'ipam/vrf_import.html' default_return_url = 'ipam:vrf_list' @@ -339,11 +339,10 @@ class AggregateDeleteView(PermissionRequiredMixin, ObjectDeleteView): default_return_url = 'ipam:aggregate_list' -class AggregateBulkImportView(PermissionRequiredMixin, BulkImportView): +class AggregateBulkImportView(PermissionRequiredMixin, BulkImportView2): permission_required = 'ipam.add_aggregate' - form = forms.AggregateImportForm + model_form = forms.AggregateCSVForm table = tables.AggregateTable - template_name = 'ipam/aggregate_import.html' default_return_url = 'ipam:aggregate_list' @@ -536,11 +535,10 @@ class PrefixDeleteView(PermissionRequiredMixin, ObjectDeleteView): default_return_url = 'ipam:prefix_list' -class PrefixBulkImportView(PermissionRequiredMixin, BulkImportView): +class PrefixBulkImportView(PermissionRequiredMixin, BulkImportView2): permission_required = 'ipam.add_prefix' - form = forms.PrefixImportForm + model_form = forms.PrefixCSVForm table = tables.PrefixTable - template_name = 'ipam/prefix_import.html' default_return_url = 'ipam:prefix_list' @@ -638,11 +636,10 @@ class IPAddressBulkAddView(PermissionRequiredMixin, BulkAddView): default_return_url = 'ipam:ipaddress_list' -class IPAddressBulkImportView(PermissionRequiredMixin, BulkImportView): +class IPAddressBulkImportView(PermissionRequiredMixin, BulkImportView2): permission_required = 'ipam.add_ipaddress' - form = forms.IPAddressImportForm + model_form = forms.IPAddressCSVForm table = tables.IPAddressTable - template_name = 'ipam/ipaddress_import.html' default_return_url = 'ipam:ipaddress_list' def save_obj(self, obj): @@ -746,11 +743,10 @@ class VLANDeleteView(PermissionRequiredMixin, ObjectDeleteView): default_return_url = 'ipam:vlan_list' -class VLANBulkImportView(PermissionRequiredMixin, BulkImportView): +class VLANBulkImportView(PermissionRequiredMixin, BulkImportView2): permission_required = 'ipam.add_vlan' - form = forms.VLANImportForm + model_form = forms.VLANCSVForm table = tables.VLANTable - template_name = 'ipam/vlan_import.html' default_return_url = 'ipam:vlan_list' diff --git a/netbox/templates/ipam/aggregate_import.html b/netbox/templates/ipam/aggregate_import.html deleted file mode 100644 index 1a270e450..000000000 --- a/netbox/templates/ipam/aggregate_import.html +++ /dev/null @@ -1,40 +0,0 @@ -{% extends 'utilities/obj_import.html' %} - -{% block title %}Aggregate Import{% endblock %} - -{% block instructions %} -

    CSV Format

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldDescriptionExample
    PrefixIPv4 or IPv6 network172.16.0.0/12
    RIRName of RIRRFC 1918
    Date AddedDate in YYYY-MM-DD format (optional)2016-02-23
    DescriptionShort description (optional)Private IPv4 space
    -

    Example

    - 
    172.16.0.0/12,RFC 1918,2016-02-23,Private IPv4 space
    -{% endblock %} diff --git a/netbox/templates/ipam/ipaddress_import.html b/netbox/templates/ipam/ipaddress_import.html deleted file mode 100644 index 9193a207d..000000000 --- a/netbox/templates/ipam/ipaddress_import.html +++ /dev/null @@ -1,60 +0,0 @@ -{% extends 'utilities/obj_import.html' %} - -{% block title %}IP Address Import{% endblock %} - -{% block instructions %} -

    CSV Format

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldDescriptionExample
    AddressIPv4 or IPv6 address192.0.2.42/24
    VRFVRF route distinguisher (optional)65000:123
    TenantName of tenant (optional)ABC01
    StatusCurrent statusActive
    DeviceDevice name (optional)switch12
    InterfaceInterface name (optional)ge-0/0/31
    Is PrimaryIf "true", IP will be primary for device (optional)True
    DescriptionShort description (optional)Management IP
    -

    Example

    - 
    192.0.2.42/24,65000:123,ABC01,Active,switch12,ge-0/0/31,True,Management IP
    -{% endblock %} diff --git a/netbox/templates/ipam/prefix_import.html b/netbox/templates/ipam/prefix_import.html deleted file mode 100644 index a135fcb31..000000000 --- a/netbox/templates/ipam/prefix_import.html +++ /dev/null @@ -1,70 +0,0 @@ -{% extends 'utilities/obj_import.html' %} - -{% block title %}Prefix Import{% endblock %} - -{% block instructions %} -

    CSV Format

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldDescriptionExample
    PrefixIPv4 or IPv6 network192.168.42.0/24
    VRFVRF route distinguisher (optional)65000:123
    TenantName of tenant (optional)ABC01
    SiteName of assigned site (optional)HQ
    VLAN GroupName of group for VLAN selection (optional)Customers
    VLAN IDNumeric VLAN ID (optional)801
    StatusCurrent statusActive
    RoleFunctional role (optional)Customer
    Is a poolTrue if all IPs are considered usableFalse
    DescriptionShort description (optional)7th floor WiFi
    -

    Example

    - 
    192.168.42.0/24,65000:123,ABC01,HQ,Customers,801,Active,Customer,False,7th floor WiFi
    -{% endblock %} diff --git a/netbox/templates/ipam/vlan_import.html b/netbox/templates/ipam/vlan_import.html deleted file mode 100644 index 7c9081c24..000000000 --- a/netbox/templates/ipam/vlan_import.html +++ /dev/null @@ -1,60 +0,0 @@ -{% extends 'utilities/obj_import.html' %} - -{% block title %}VLAN Import{% endblock %} - -{% block instructions %} -

    CSV Format

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldDescriptionExample
    SiteName of assigned site (optional)LAS2
    GroupName of VLAN group (optional)Backend Network
    IDConfigured VLAN ID1400
    NameConfigured VLAN nameCameras
    TenantName of tenant (optional)Internal
    StatusCurrent statusActive
    RoleFunctional role (optional)Security
    DescriptionShort description (optional)Security team only
    -

    Example

    - 
    LAS2,Backend Network,1400,Cameras,Internal,Active,Security,Security team only
    -{% endblock %} diff --git a/netbox/templates/ipam/vrf_import.html b/netbox/templates/ipam/vrf_import.html deleted file mode 100644 index 5c7821e53..000000000 --- a/netbox/templates/ipam/vrf_import.html +++ /dev/null @@ -1,45 +0,0 @@ -{% extends 'utilities/obj_import.html' %} - -{% block title %}VRF Import{% endblock %} - -{% block instructions %} -

    CSV Format

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldDescriptionExample
    NameName of VRFCustomer_ABC
    RDRoute distinguisher65000:123456
    TenantName of tenant (optional)ABC01
    Enforce uniquenessPrevent duplicate prefixes/IP addressesTrue
    DescriptionShort description (optional)Native VRF for customer ABC
    -

    Example

    - 
    Customer_ABC,65000:123456,ABC01,True,Native VRF for customer ABC
    -{% endblock %} From 8cdfac5056b7f919a6b51389d4fa2247f98a211a Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Fri, 2 Jun 2017 17:23:41 -0400 Subject: [PATCH 16/36] Converted secrets import view to new scheme --- netbox/ipam/views.py | 3 +- netbox/secrets/forms.py | 34 +++++++++++------- netbox/secrets/urls.py | 2 +- netbox/secrets/views.py | 76 ++++++++++++++++++--------------------- netbox/tenancy/views.py | 2 +- netbox/utilities/views.py | 11 +++--- 6 files changed, 67 insertions(+), 61 deletions(-) diff --git a/netbox/ipam/views.py b/netbox/ipam/views.py index 871bae6e1..56a135d3f 100644 --- a/netbox/ipam/views.py +++ b/netbox/ipam/views.py @@ -13,8 +13,7 @@ from django.views.generic import View from dcim.models import Device from utilities.paginator import EnhancedPaginator from utilities.views import ( - BulkAddView, BulkDeleteView, BulkEditView, BulkImportView, BulkImportView2, ObjectDeleteView, ObjectEditView, - ObjectListView, + BulkAddView, BulkDeleteView, BulkEditView, BulkImportView2, ObjectDeleteView, ObjectEditView, ObjectListView, ) from . import filters, forms, tables from .models import ( diff --git a/netbox/secrets/forms.py b/netbox/secrets/forms.py index b8e165804..806c9d50c 100644 --- a/netbox/secrets/forms.py +++ b/netbox/secrets/forms.py @@ -7,7 +7,7 @@ from django import forms from django.db.models import Count from dcim.models import Device -from utilities.forms import BootstrapMixin, BulkEditForm, BulkImportForm, CSVDataField, FilterChoiceField, SlugField +from utilities.forms import BootstrapMixin, BulkEditForm, CSVDataField2, FilterChoiceField, SlugField from .models import Secret, SecretRole, UserKey @@ -65,27 +65,37 @@ class SecretForm(BootstrapMixin, forms.ModelForm): }) -class SecretFromCSVForm(forms.ModelForm): - device = forms.ModelChoiceField(queryset=Device.objects.all(), required=False, to_field_name='name', - error_messages={'invalid_choice': 'Device not found.'}) - role = forms.ModelChoiceField(queryset=SecretRole.objects.all(), to_field_name='name', - error_messages={'invalid_choice': 'Invalid secret role.'}) - plaintext = forms.CharField() +class SecretCSVForm(forms.ModelForm): + device = forms.ModelChoiceField( + queryset=Device.objects.all(), + to_field_name='name', + help_text='Device name', + error_messages={ + 'invalid_choice': 'Device not found.', + } + ) + role = forms.ModelChoiceField( + queryset=SecretRole.objects.all(), + to_field_name='name', + help_text='Name of assigned role', + error_messages={ + 'invalid_choice': 'Invalid secret role.', + } + ) + plaintext = forms.CharField( + help_text='Plaintext secret data' + ) class Meta: model = Secret fields = ['device', 'role', 'name', 'plaintext'] def save(self, *args, **kwargs): - s = super(SecretFromCSVForm, self).save(*args, **kwargs) + s = super(SecretCSVForm, self).save(*args, **kwargs) s.plaintext = str(self.cleaned_data['plaintext']) return s -class SecretImportForm(BootstrapMixin, BulkImportForm): - csv = CSVDataField(csv_form=SecretFromCSVForm, widget=forms.Textarea(attrs={'class': 'requires-session-key'})) - - class SecretBulkEditForm(BootstrapMixin, BulkEditForm): pk = forms.ModelMultipleChoiceField(queryset=Secret.objects.all(), widget=forms.MultipleHiddenInput) role = forms.ModelChoiceField(queryset=SecretRole.objects.all(), required=False) diff --git a/netbox/secrets/urls.py b/netbox/secrets/urls.py index 4961b2c82..b28198a2f 100644 --- a/netbox/secrets/urls.py +++ b/netbox/secrets/urls.py @@ -16,7 +16,7 @@ urlpatterns = [ # Secrets url(r'^secrets/$', views.SecretListView.as_view(), name='secret_list'), - url(r'^secrets/import/$', views.secret_import, name='secret_import'), + url(r'^secrets/import/$', views.SecretBulkImportView.as_view(), name='secret_import'), url(r'^secrets/edit/$', views.SecretBulkEditView.as_view(), name='secret_bulk_edit'), url(r'^secrets/delete/$', views.SecretBulkDeleteView.as_view(), name='secret_bulk_delete'), url(r'^secrets/(?P\d+)/$', views.SecretView.as_view(), name='secret'), diff --git a/netbox/secrets/views.py b/netbox/secrets/views.py index d2427dd73..c6fe939aa 100644 --- a/netbox/secrets/views.py +++ b/netbox/secrets/views.py @@ -12,7 +12,9 @@ from django.utils.decorators import method_decorator from django.views.generic import View from dcim.models import Device -from utilities.views import BulkDeleteView, BulkEditView, ObjectDeleteView, ObjectEditView, ObjectListView +from utilities.views import ( + BulkDeleteView, BulkEditView, BulkImportView2, ObjectDeleteView, ObjectEditView, ObjectListView, +) from . import filters, forms, tables from .decorators import userkey_required from .models import SecretRole, Secret, SessionKey @@ -185,58 +187,50 @@ class SecretDeleteView(PermissionRequiredMixin, ObjectDeleteView): default_return_url = 'secrets:secret_list' -@permission_required('secrets.add_secret') -@userkey_required() -def secret_import(request): +class SecretBulkImportView(BulkImportView2): + permission_required = 'ipam.add_vlan' + model_form = forms.SecretCSVForm + table = tables.SecretTable + default_return_url = 'secrets:secret_list' - session_key = request.COOKIES.get('session_key', None) + master_key = None - if request.method == 'POST': - form = forms.SecretImportForm(request.POST) + def _save_obj(self, obj_form): + """ + Encrypt each object before saving it to the database. + """ + obj = obj_form.save(commit=False) + obj.encrypt(self.master_key) + obj.save() + return obj - if session_key is None: - form.add_error(None, "No session key was provided with the request. Unable to encrypt secret data.") + def post(self, request): - if form.is_valid(): + # Grab the session key from cookies. + session_key = request.COOKIES.get('session_key') + if session_key: - new_secrets = [] - - session_key = base64.b64decode(session_key) - master_key = None + # Attempt to derive the master key using the provided session key. try: sk = SessionKey.objects.get(userkey__user=request.user) - master_key = sk.get_master_key(session_key) + self.master_key = sk.get_master_key(base64.b64decode(session_key)) except SessionKey.DoesNotExist: - form.add_error(None, "No session key found for this user.") + messages.error(request, "No session key found for this user.") - if master_key is None: - form.add_error(None, "Invalid private key! Unable to encrypt secret data.") + if self.master_key is not None: + return super(SecretBulkImportView, self).post(request) else: - try: - with transaction.atomic(): - for secret in form.cleaned_data['csv']: - secret.encrypt(master_key) - secret.save() - new_secrets.append(secret) + messages.error(request, "Invalid private key! Unable to encrypt secret data.") - table = tables.SecretTable(new_secrets) - messages.success(request, "Imported {} new secrets.".format(len(new_secrets))) + else: + messages.error(request, "No session key was provided with the request. Unable to encrypt secret data.") - return render(request, 'import_success.html', { - 'table': table, - 'return_url': 'secrets:secret_list', - }) - - except IntegrityError as e: - form.add_error('csv', "Record {}: {}".format(len(new_secrets) + 1, e.__cause__)) - - else: - form = forms.SecretImportForm() - - return render(request, 'secrets/secret_import.html', { - 'form': form, - 'return_url': 'secrets:secret_list', - }) + return render(request, self.template_name, { + 'form': self._import_form(request.POST), + 'fields': self.model_form().fields, + 'obj_type': self.model_form._meta.model._meta.verbose_name, + 'return_url': self.default_return_url, + }) class SecretBulkEditView(PermissionRequiredMixin, BulkEditView): diff --git a/netbox/tenancy/views.py b/netbox/tenancy/views.py index feaec38be..a292f68cd 100644 --- a/netbox/tenancy/views.py +++ b/netbox/tenancy/views.py @@ -10,7 +10,7 @@ from circuits.models import Circuit from dcim.models import Site, Rack, Device from ipam.models import IPAddress, Prefix, VLAN, VRF from utilities.views import ( - BulkDeleteView, BulkEditView, BulkImportView, BulkImportView2, ObjectDeleteView, ObjectEditView, ObjectListView, + BulkDeleteView, BulkEditView, BulkImportView2, ObjectDeleteView, ObjectEditView, ObjectListView, ) from .models import Tenant, TenantGroup from . import filters, forms, tables diff --git a/netbox/utilities/views.py b/netbox/utilities/views.py index e06b900c0..766b0676d 100644 --- a/netbox/utilities/views.py +++ b/netbox/utilities/views.py @@ -448,6 +448,12 @@ class BulkImportView2(View): return ImportForm(*args, **kwargs) + def _save_obj(self, obj_form): + """ + Provide a hook to modify the object immediately before saving it (e.g. to encrypt secret data). + """ + return obj_form.save() + def get(self, request): return render(request, self.template_name, { @@ -471,7 +477,7 @@ class BulkImportView2(View): for row, data in enumerate(form.cleaned_data['csv'], start=1): obj_form = self.model_form(data) if obj_form.is_valid(): - obj = obj_form.save() + obj = self._save_obj(obj_form) new_objs.append(obj) else: for field, err in obj_form.errors.items(): @@ -501,9 +507,6 @@ class BulkImportView2(View): 'return_url': self.default_return_url, }) - def save_obj(self, obj): - obj.save() - class BulkEditView(View): """ From c234a9e3cb057baf2b0b0a1db300b4fc660f7118 Mon Sep 17 00:00:00 2001 From: Zach Moody Date: Fri, 2 Jun 2017 16:33:49 -0500 Subject: [PATCH 17/36] Fixes #1244 --- netbox/secrets/filters.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/netbox/secrets/filters.py b/netbox/secrets/filters.py index 4bc7b56cd..49cc03c17 100644 --- a/netbox/secrets/filters.py +++ b/netbox/secrets/filters.py @@ -32,7 +32,7 @@ class SecretFilter(django_filters.FilterSet): label='Device (ID)', ) device = django_filters.ModelMultipleChoiceFilter( - name='device', + name='device__name', queryset=Device.objects.all(), to_field_name='name', label='Device (name)', From b4af0739a7ab1cde0174c3e767facb1151406e4e Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Mon, 5 Jun 2017 15:04:23 -0400 Subject: [PATCH 18/36] Converted interface connections import view to new scheme --- netbox/dcim/forms.py | 123 +++++++++++++++++++----------------------- netbox/dcim/models.py | 11 ++-- netbox/dcim/views.py | 5 +- 3 files changed, 65 insertions(+), 74 deletions(-) diff --git a/netbox/dcim/forms.py b/netbox/dcim/forms.py index f1737b366..ce6fed468 100644 --- a/netbox/dcim/forms.py +++ b/netbox/dcim/forms.py @@ -1592,94 +1592,83 @@ class InterfaceConnectionForm(BootstrapMixin, ChainedFieldsMixin, forms.ModelFor ] -class InterfaceConnectionCSVForm(forms.Form): +class InterfaceConnectionCSVForm(forms.ModelForm): device_a = FlexibleModelChoiceField( queryset=Device.objects.all(), to_field_name='name', + help_text='Device name or PK', error_messages={'invalid_choice': 'Device A not found.'} ) - interface_a = forms.CharField() + interface_a = forms.CharField( + help_text='Interface name' + ) device_b = FlexibleModelChoiceField( queryset=Device.objects.all(), to_field_name='name', + help_text='Device name or PK', error_messages={'invalid_choice': 'Device B not found.'} ) - interface_b = forms.CharField() - status = forms.CharField( + interface_b = forms.CharField( + help_text='Interface name' + ) + connection_status = forms.CharField( + help_text='Connection status', validators=[validate_connection_status] ) - def clean(self): + class Meta: + model = InterfaceConnection + fields = ['device_a', 'interface_a', 'device_b', 'interface_b', 'connection_status'] - # Validate interface A - if self.cleaned_data.get('device_a'): - try: - interface_a = Interface.objects.get(device=self.cleaned_data['device_a'], - name=self.cleaned_data['interface_a']) - except Interface.DoesNotExist: - raise forms.ValidationError("Invalid interface ({} {})" - .format(self.cleaned_data['device_a'], self.cleaned_data['interface_a'])) - try: - InterfaceConnection.objects.get(Q(interface_a=interface_a) | Q(interface_b=interface_a)) - raise forms.ValidationError("{} {} is already connected" - .format(self.cleaned_data['device_a'], self.cleaned_data['interface_a'])) - except InterfaceConnection.DoesNotExist: - pass + def clean_interface_a(self): - # Validate interface B - if self.cleaned_data.get('device_b'): - try: - interface_b = Interface.objects.get(device=self.cleaned_data['device_b'], - name=self.cleaned_data['interface_b']) - except Interface.DoesNotExist: - raise forms.ValidationError("Invalid interface ({} {})" - .format(self.cleaned_data['device_b'], self.cleaned_data['interface_b'])) - try: - InterfaceConnection.objects.get(Q(interface_a=interface_b) | Q(interface_b=interface_b)) - raise forms.ValidationError("{} {} is already connected" - .format(self.cleaned_data['device_b'], self.cleaned_data['interface_b'])) - except InterfaceConnection.DoesNotExist: - pass + interface_name = self.cleaned_data.get('interface_a') + if not interface_name: + return None + try: + # Retrieve interface by name + interface = Interface.objects.get( + device=self.cleaned_data['device_a'], name=self.cleaned_data['interface_a'] + ) + # Check for an existing connection to this interface + if InterfaceConnection.objects.filter(Q(interface_a=interface) | Q(interface_b=interface)).count(): + raise forms.ValidationError("{} {} is already connected".format( + self.cleaned_data['device_a'], interface_name + )) + except Interface.DoesNotExist: + raise forms.ValidationError("Invalid interface ({} {})".format( + self.cleaned_data['device_a'], interface_name + )) -class InterfaceConnectionImportForm(BootstrapMixin, BulkImportForm): - csv = CSVDataField(csv_form=InterfaceConnectionCSVForm) + return interface - def clean(self): - records = self.cleaned_data.get('csv') - if not records: - return + def clean_interface_b(self): - connection_list = [] - occupied_interfaces = [] + interface_name = self.cleaned_data.get('interface_b') + if not interface_name: + return None - for i, record in enumerate(records, start=1): - form = self.fields['csv'].csv_form(data=record) - if form.is_valid(): - interface_a = Interface.objects.get(device=form.cleaned_data['device_a'], - name=form.cleaned_data['interface_a']) - if interface_a in occupied_interfaces: - raise forms.ValidationError("{} {} found in multiple connections" - .format(interface_a.device.name, interface_a.name)) - interface_b = Interface.objects.get(device=form.cleaned_data['device_b'], - name=form.cleaned_data['interface_b']) - if interface_b in occupied_interfaces: - raise forms.ValidationError("{} {} found in multiple connections" - .format(interface_b.device.name, interface_b.name)) - connection = InterfaceConnection(interface_a=interface_a, interface_b=interface_b) - if form.cleaned_data['status'] == 'planned': - connection.connection_status = CONNECTION_STATUS_PLANNED - else: - connection.connection_status = CONNECTION_STATUS_CONNECTED - connection_list.append(connection) - occupied_interfaces.append(interface_a) - occupied_interfaces.append(interface_b) - else: - for field, errors in form.errors.items(): - for e in errors: - self.add_error('csv', "Record {} {}: {}".format(i, field, e)) + try: + # Retrieve interface by name + interface = Interface.objects.get( + device=self.cleaned_data['device_b'], name=self.cleaned_data['interface_b'] + ) + # Check for an existing connection to this interface + if InterfaceConnection.objects.filter(Q(interface_a=interface) | Q(interface_b=interface)).count(): + raise forms.ValidationError("{} {} is already connected".format( + self.cleaned_data['device_b'], interface_name + )) + except Interface.DoesNotExist: + raise forms.ValidationError("Invalid interface ({} {})".format( + self.cleaned_data['device_b'], interface_name + )) - self.cleaned_data['csv'] = connection_list + return interface + + def clean_connection_status(self): + + return True if self.cleaned_data['connection_status'] == 'connected' else False class InterfaceConnectionDeletionForm(BootstrapMixin, forms.Form): diff --git a/netbox/dcim/models.py b/netbox/dcim/models.py index 043df10dc..0c3b9cc52 100644 --- a/netbox/dcim/models.py +++ b/netbox/dcim/models.py @@ -1393,10 +1393,13 @@ class InterfaceConnection(models.Model): verbose_name='Status') def clean(self): - if self.interface_a == self.interface_b: - raise ValidationError({ - 'interface_b': "Cannot connect an interface to itself." - }) + try: + if self.interface_a == self.interface_b: + raise ValidationError({ + 'interface_b': "Cannot connect an interface to itself." + }) + except ObjectDoesNotExist: + pass # Used for connections export def to_csv(self): diff --git a/netbox/dcim/views.py b/netbox/dcim/views.py index 888a54aaf..58ea57580 100644 --- a/netbox/dcim/views.py +++ b/netbox/dcim/views.py @@ -1672,11 +1672,10 @@ def interfaceconnection_delete(request, pk): }) -class InterfaceConnectionsBulkImportView(PermissionRequiredMixin, BulkImportView): +class InterfaceConnectionsBulkImportView(PermissionRequiredMixin, BulkImportView2): permission_required = 'dcim.change_interface' - form = forms.InterfaceConnectionImportForm + model_form = forms.InterfaceConnectionCSVForm table = tables.InterfaceConnectionTable - template_name = 'dcim/interface_connections_import.html' default_return_url = 'dcim:interface_connections_list' From 9f06783fc97350c89d87c96ce02596d43d1bf371 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Mon, 5 Jun 2017 15:53:03 -0400 Subject: [PATCH 19/36] Converted console/power import views to new scheme --- netbox/dcim/forms.py | 229 +++++++++--------- netbox/dcim/views.py | 12 +- .../dcim/console_connections_import.html | 45 ---- .../dcim/interface_connections_import.html | 45 ---- .../dcim/power_connections_import.html | 45 ---- netbox/utilities/forms.py | 25 -- netbox/utilities/views.py | 55 ----- 7 files changed, 125 insertions(+), 331 deletions(-) delete mode 100644 netbox/templates/dcim/console_connections_import.html delete mode 100644 netbox/templates/dcim/interface_connections_import.html delete mode 100644 netbox/templates/dcim/power_connections_import.html diff --git a/netbox/dcim/forms.py b/netbox/dcim/forms.py index ce6fed468..bff89a3b5 100644 --- a/netbox/dcim/forms.py +++ b/netbox/dcim/forms.py @@ -14,8 +14,8 @@ from tenancy.forms import TenancyForm from tenancy.models import Tenant from utilities.forms import ( APISelect, add_blank_choice, ArrayFieldSelectMultiple, BootstrapMixin, BulkEditForm, BulkEditNullBooleanSelect, - BulkImportForm, ChainedFieldsMixin, ChainedModelChoiceField, CommentField, CSVDataField, ExpandableNameField, - FilterChoiceField, FlexibleModelChoiceField, Livesearch, SelectWithDisabled, SmallTextarea, SlugField, + ChainedFieldsMixin, ChainedModelChoiceField, CommentField, ExpandableNameField, FilterChoiceField, + FlexibleModelChoiceField, Livesearch, SelectWithDisabled, SmallTextarea, SlugField, FilterTreeNodeMultipleChoiceField, ) from .formfields import MACAddressFormField @@ -945,75 +945,81 @@ class ConsolePortCreateForm(DeviceComponentForm): name_pattern = ExpandableNameField(label='Name') -class ConsoleConnectionCSVForm(forms.Form): +class ConsoleConnectionCSVForm(forms.ModelForm): console_server = FlexibleModelChoiceField( queryset=Device.objects.filter(device_type__is_console_server=True), to_field_name='name', + help_text='Console server name or PK', error_messages={ 'invalid_choice': 'Console server not found', } ) - cs_port = forms.CharField() - device = FlexibleModelChoiceField(queryset=Device.objects.all(), to_field_name='name', - error_messages={'invalid_choice': 'Device not found'}) - console_port = forms.CharField() + cs_port = forms.CharField( + help_text='Console server port name' + ) + device = FlexibleModelChoiceField( + queryset=Device.objects.all(), + to_field_name='name', + help_text='Device name or PK', + error_messages={ + 'invalid_choice': 'Device not found', + } + ) + console_port = forms.CharField( + help_text='Console port name' + ) status = forms.CharField(validators=[validate_connection_status]) - def clean(self): + class Meta: + model = ConsolePort + fields = ['console_server', 'cs_port', 'device', 'console_port'] - # Validate console server port - if self.cleaned_data.get('console_server'): - try: - cs_port = ConsoleServerPort.objects.get(device=self.cleaned_data['console_server'], - name=self.cleaned_data['cs_port']) - if ConsolePort.objects.filter(cs_port=cs_port): - raise forms.ValidationError("Console server port is already occupied (by {} {})" - .format(cs_port.connected_console.device, cs_port.connected_console)) - except ConsoleServerPort.DoesNotExist: - raise forms.ValidationError("Invalid console server port ({} {})" - .format(self.cleaned_data['console_server'], self.cleaned_data['cs_port'])) + def clean_console_port(self): - # Validate console port - if self.cleaned_data.get('device'): - try: - console_port = ConsolePort.objects.get(device=self.cleaned_data['device'], - name=self.cleaned_data['console_port']) - if console_port.cs_port: - raise forms.ValidationError("Console port is already connected (to {} {})" - .format(console_port.cs_port.device, console_port.cs_port)) - except ConsolePort.DoesNotExist: - raise forms.ValidationError("Invalid console port ({} {})" - .format(self.cleaned_data['device'], self.cleaned_data['console_port'])) + console_port_name = self.cleaned_data.get('console_port') + if not self.cleaned_data.get('device') or not console_port_name: + return None + try: + # Retrieve console port by name + consoleport = ConsolePort.objects.get( + device=self.cleaned_data['device'], name=console_port_name + ) + # Check if the console port is already connected + if consoleport.cs_port is not None: + raise forms.ValidationError("{} {} is already connected".format( + self.cleaned_data['device'], console_port_name + )) + except ConsolePort.DoesNotExist: + raise forms.ValidationError("Invalid console port ({} {})".format( + self.cleaned_data['device'], console_port_name + )) -class ConsoleConnectionImportForm(BootstrapMixin, BulkImportForm): - csv = CSVDataField(csv_form=ConsoleConnectionCSVForm) + self.instance = consoleport + return consoleport - def clean(self): - records = self.cleaned_data.get('csv') - if not records: - return + def clean_cs_port(self): - connection_list = [] + cs_port_name = self.cleaned_data.get('cs_port') + if not self.cleaned_data.get('console_server') or not cs_port_name: + return None - for i, record in enumerate(records, start=1): - form = self.fields['csv'].csv_form(data=record) - if form.is_valid(): - console_port = ConsolePort.objects.get(device=form.cleaned_data['device'], - name=form.cleaned_data['console_port']) - console_port.cs_port = ConsoleServerPort.objects.get(device=form.cleaned_data['console_server'], - name=form.cleaned_data['cs_port']) - if form.cleaned_data['status'] == 'planned': - console_port.connection_status = CONNECTION_STATUS_PLANNED - else: - console_port.connection_status = CONNECTION_STATUS_CONNECTED - connection_list.append(console_port) - else: - for field, errors in form.errors.items(): - for e in errors: - self.add_error('csv', "Record {} {}: {}".format(i, field, e)) + try: + # Retrieve console server port by name + cs_port = ConsoleServerPort.objects.get( + device=self.cleaned_data['console_server'], name=cs_port_name + ) + # Check if the console server port is already connected + if ConsolePort.objects.filter(cs_port=cs_port).count(): + raise forms.ValidationError("{} {} is already connected".format( + self.cleaned_data['console_server'], cs_port_name + )) + except ConsoleServerPort.DoesNotExist: + raise forms.ValidationError("Invalid console server port ({} {})".format( + self.cleaned_data['console_server'], cs_port_name + )) - self.cleaned_data['csv'] = connection_list + return cs_port class ConsolePortConnectionForm(BootstrapMixin, ChainedFieldsMixin, forms.ModelForm): @@ -1193,76 +1199,81 @@ class PowerPortCreateForm(DeviceComponentForm): name_pattern = ExpandableNameField(label='Name') -class PowerConnectionCSVForm(forms.Form): +class PowerConnectionCSVForm(forms.ModelForm): pdu = FlexibleModelChoiceField( queryset=Device.objects.filter(device_type__is_pdu=True), to_field_name='name', + help_text='PDU name or PK', error_messages={ 'invalid_choice': 'PDU not found.', } ) - power_outlet = forms.CharField() - device = FlexibleModelChoiceField(queryset=Device.objects.all(), to_field_name='name', - error_messages={'invalid_choice': 'Device not found'}) - power_port = forms.CharField() + power_outlet = forms.CharField( + help_text='Power outlet name' + ) + device = FlexibleModelChoiceField( + queryset=Device.objects.all(), + to_field_name='name', + help_text='Device name or PK', + error_messages={ + 'invalid_choice': 'Device not found', + } + ) + power_port = forms.CharField( + help_text='Power port name' + ) status = forms.CharField(validators=[validate_connection_status]) - def clean(self): + class Meta: + model = PowerPort + fields = ['pdu', 'power_outlet', 'device', 'power_port'] - # Validate power outlet - if self.cleaned_data.get('pdu'): - try: - power_outlet = PowerOutlet.objects.get(device=self.cleaned_data['pdu'], - name=self.cleaned_data['power_outlet']) - if PowerPort.objects.filter(power_outlet=power_outlet): - raise forms.ValidationError("Power outlet is already occupied (by {} {})" - .format(power_outlet.connected_port.device, - power_outlet.connected_port)) - except PowerOutlet.DoesNotExist: - raise forms.ValidationError("Invalid PDU port ({} {})" - .format(self.cleaned_data['pdu'], self.cleaned_data['power_outlet'])) + def clean_power_port(self): - # Validate power port - if self.cleaned_data.get('device'): - try: - power_port = PowerPort.objects.get(device=self.cleaned_data['device'], - name=self.cleaned_data['power_port']) - if power_port.power_outlet: - raise forms.ValidationError("Power port is already connected (to {} {})" - .format(power_port.power_outlet.device, power_port.power_outlet)) - except PowerPort.DoesNotExist: - raise forms.ValidationError("Invalid power port ({} {})" - .format(self.cleaned_data['device'], self.cleaned_data['power_port'])) + power_port_name = self.cleaned_data.get('power_port') + if not self.cleaned_data.get('device') or not power_port_name: + return None + try: + # Retrieve power port by name + powerport = PowerPort.objects.get( + device=self.cleaned_data['device'], name=power_port_name + ) + # Check if the power port is already connected + if powerport.power_outlet is not None: + raise forms.ValidationError("{} {} is already connected".format( + self.cleaned_data['device'], power_port_name + )) + except PowerPort.DoesNotExist: + raise forms.ValidationError("Invalid power port ({} {})".format( + self.cleaned_data['device'], power_port_name + )) -class PowerConnectionImportForm(BootstrapMixin, BulkImportForm): - csv = CSVDataField(csv_form=PowerConnectionCSVForm) + self.instance = powerport + return powerport - def clean(self): - records = self.cleaned_data.get('csv') - if not records: - return + def clean_power_outlet(self): - connection_list = [] + power_outlet_name = self.cleaned_data.get('power_outlet') + if not self.cleaned_data.get('pdu') or not power_outlet_name: + return None - for i, record in enumerate(records, start=1): - form = self.fields['csv'].csv_form(data=record) - if form.is_valid(): - power_port = PowerPort.objects.get(device=form.cleaned_data['device'], - name=form.cleaned_data['power_port']) - power_port.power_outlet = PowerOutlet.objects.get(device=form.cleaned_data['pdu'], - name=form.cleaned_data['power_outlet']) - if form.cleaned_data['status'] == 'planned': - power_port.connection_status = CONNECTION_STATUS_PLANNED - else: - power_port.connection_status = CONNECTION_STATUS_CONNECTED - connection_list.append(power_port) - else: - for field, errors in form.errors.items(): - for e in errors: - self.add_error('csv', "Record {} {}: {}".format(i, field, e)) + try: + # Retrieve power outlet by name + power_outlet = PowerOutlet.objects.get( + device=self.cleaned_data['pdu'], name=power_outlet_name + ) + # Check if the power outlet is already connected + if PowerPort.objects.filter(power_outlet=power_outlet).count(): + raise forms.ValidationError("{} {} is already connected".format( + self.cleaned_data['pdu'], power_outlet_name + )) + except PowerOutlet.DoesNotExist: + raise forms.ValidationError("Invalid power outlet ({} {})".format( + self.cleaned_data['pdu'], power_outlet_name + )) - self.cleaned_data['csv'] = connection_list + return power_outlet class PowerPortConnectionForm(BootstrapMixin, ChainedFieldsMixin, forms.ModelForm): @@ -1629,7 +1640,7 @@ class InterfaceConnectionCSVForm(forms.ModelForm): try: # Retrieve interface by name interface = Interface.objects.get( - device=self.cleaned_data['device_a'], name=self.cleaned_data['interface_a'] + device=self.cleaned_data['device_a'], name=interface_name ) # Check for an existing connection to this interface if InterfaceConnection.objects.filter(Q(interface_a=interface) | Q(interface_b=interface)).count(): @@ -1652,7 +1663,7 @@ class InterfaceConnectionCSVForm(forms.ModelForm): try: # Retrieve interface by name interface = Interface.objects.get( - device=self.cleaned_data['device_b'], name=self.cleaned_data['interface_b'] + device=self.cleaned_data['device_b'], name=interface_name ) # Check for an existing connection to this interface if InterfaceConnection.objects.filter(Q(interface_a=interface) | Q(interface_b=interface)).count(): diff --git a/netbox/dcim/views.py b/netbox/dcim/views.py index 58ea57580..0aade9cb3 100644 --- a/netbox/dcim/views.py +++ b/netbox/dcim/views.py @@ -23,7 +23,7 @@ from extras.models import Graph, TopologyMap, GRAPH_TYPE_INTERFACE, GRAPH_TYPE_S from utilities.forms import ConfirmationForm from utilities.paginator import EnhancedPaginator from utilities.views import ( - BulkDeleteView, BulkEditView, BulkImportView, BulkImportView2, ObjectDeleteView, ObjectEditView, ObjectListView, + BulkDeleteView, BulkEditView, BulkImportView2, ObjectDeleteView, ObjectEditView, ObjectListView, ) from . import filters, forms, tables from .models import ( @@ -1012,11 +1012,10 @@ class ConsolePortBulkDeleteView(PermissionRequiredMixin, BulkDeleteView): parent_cls = Device -class ConsoleConnectionsBulkImportView(PermissionRequiredMixin, BulkImportView): +class ConsoleConnectionsBulkImportView(PermissionRequiredMixin, BulkImportView2): permission_required = 'dcim.change_consoleport' - form = forms.ConsoleConnectionImportForm + model_form = forms.ConsoleConnectionCSVForm table = tables.ConsoleConnectionTable - template_name = 'dcim/console_connections_import.html' default_return_url = 'dcim:console_connections_list' @@ -1235,11 +1234,10 @@ class PowerPortBulkDeleteView(PermissionRequiredMixin, BulkDeleteView): parent_cls = Device -class PowerConnectionsBulkImportView(PermissionRequiredMixin, BulkImportView): +class PowerConnectionsBulkImportView(PermissionRequiredMixin, BulkImportView2): permission_required = 'dcim.change_powerport' - form = forms.PowerConnectionImportForm + model_form = forms.PowerConnectionCSVForm table = tables.PowerConnectionTable - template_name = 'dcim/power_connections_import.html' default_return_url = 'dcim:power_connections_list' diff --git a/netbox/templates/dcim/console_connections_import.html b/netbox/templates/dcim/console_connections_import.html deleted file mode 100644 index 3dc0f96a4..000000000 --- a/netbox/templates/dcim/console_connections_import.html +++ /dev/null @@ -1,45 +0,0 @@ -{% extends 'utilities/obj_import.html' %} - -{% block title %}Console Connections Import{% endblock %} - -{% block instructions %} -

    CSV Format

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldDescriptionExample
    Console serverDevice name or {ID}abc1-cs3
    Console server portFull CS port namePort 35
    DeviceDevice name or {ID}abc1-switch7
    Console PortConsole port nameConsole
    Connection Status"planned" or "connected"planned
    -

    Example

    - 
    abc1-cs3,Port 35,abc1-switch7,Console,planned
    -{% endblock %} diff --git a/netbox/templates/dcim/interface_connections_import.html b/netbox/templates/dcim/interface_connections_import.html deleted file mode 100644 index 4cfd82e58..000000000 --- a/netbox/templates/dcim/interface_connections_import.html +++ /dev/null @@ -1,45 +0,0 @@ -{% extends 'utilities/obj_import.html' %} - -{% block title %}Interface Connections Import{% endblock %} - -{% block instructions %} -

    CSV Format

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldDescriptionExample
    Device ADevice name or {ID}abc1-core1
    Interface AInterface namexe-0/0/6
    Device BDevice name or {ID}abc1-switch7
    Interface BInterface namexe-0/0/0
    Connection Status"planned" or "connected"planned
    -

    Example

    - 
    abc1-core1,xe-0/0/6,abc1-switch7,xe-0/0/0,planned
    -{% endblock %} diff --git a/netbox/templates/dcim/power_connections_import.html b/netbox/templates/dcim/power_connections_import.html deleted file mode 100644 index bd60834da..000000000 --- a/netbox/templates/dcim/power_connections_import.html +++ /dev/null @@ -1,45 +0,0 @@ -{% extends 'utilities/obj_import.html' %} - -{% block title %}Power Connections Import{% endblock %} - -{% block instructions %} -

    CSV Format

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldDescriptionExample
    PDUDevice name or {ID}abc1-pdu1
    Power OutletPower outlet nameAC4
    DeviceDevice name or {ID}abc1-switch7
    Power PortPower port namePSU0
    Connection Status"planned" or "connected"connected
    -

    Example

    - 
    abc1-pdu1,AC4,abc1-switch7,PSU0,connected
    -{% endblock %} diff --git a/netbox/utilities/forms.py b/netbox/utilities/forms.py index 6c07aad7f..56b7c24b7 100644 --- a/netbox/utilities/forms.py +++ b/netbox/utilities/forms.py @@ -539,28 +539,3 @@ class BulkEditForm(forms.Form): self.nullable_fields = [field for field in self.Meta.nullable_fields] else: self.nullable_fields = [] - - -class BulkImportForm(forms.Form): - - def clean(self): - fields, records = self.cleaned_data.get('csv').split('\n', 1) - if not records: - return - - obj_list = [] - - for i, record in enumerate(records, start=1): - obj_form = self.fields['csv'].csv_form(data=record) - if obj_form.is_valid(): - obj = obj_form.save(commit=False) - obj_list.append(obj) - else: - for field, errors in obj_form.errors.items(): - for e in errors: - if field == '__all__': - self.add_error('csv', "Record {}: {}".format(i, e)) - else: - self.add_error('csv', "Record {} ({}): {}".format(i, field, e)) - - self.cleaned_data['csv'] = obj_list diff --git a/netbox/utilities/views.py b/netbox/utilities/views.py index 766b0676d..529244c48 100644 --- a/netbox/utilities/views.py +++ b/netbox/utilities/views.py @@ -369,61 +369,6 @@ class BulkAddView(View): }) -class BulkImportView(View): - """ - Import objects in bulk (CSV format). - - form: Form class - table: The django-tables2 Table used to render the list of imported objects - template_name: The name of the template - default_return_url: The name of the URL to use for the cancel button - """ - form = None - table = None - template_name = None - default_return_url = None - - def get(self, request): - - return render(request, self.template_name, { - 'form': self.form(), - 'return_url': self.default_return_url, - }) - - def post(self, request): - - form = self.form(request.POST) - if form.is_valid(): - new_objs = [] - try: - with transaction.atomic(): - for obj in form.cleaned_data['csv']: - self.save_obj(obj) - new_objs.append(obj) - - obj_table = self.table(new_objs) - if new_objs: - msg = 'Imported {} {}'.format(len(new_objs), new_objs[0]._meta.verbose_name_plural) - messages.success(request, msg) - UserAction.objects.log_import(request.user, ContentType.objects.get_for_model(new_objs[0]), msg) - - return render(request, "import_success.html", { - 'table': obj_table, - 'return_url': self.default_return_url, - }) - - except IntegrityError as e: - form.add_error('csv', "Record {}: {}".format(len(new_objs) + 1, e.__cause__)) - - return render(request, self.template_name, { - 'form': form, - 'return_url': self.default_return_url, - }) - - def save_obj(self, obj): - obj.save() - - class BulkImportView2(View): """ Import objects in bulk (CSV format). From 43445096cc7c741d2c3cfa99c8eec179ecc382c7 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Mon, 5 Jun 2017 15:53:41 -0400 Subject: [PATCH 20/36] Renamed new import view to BulkImportView --- netbox/circuits/views.py | 6 +++--- netbox/dcim/views.py | 16 ++++++++-------- netbox/ipam/views.py | 12 ++++++------ netbox/secrets/views.py | 4 ++-- netbox/tenancy/views.py | 4 ++-- netbox/utilities/views.py | 2 +- 6 files changed, 22 insertions(+), 22 deletions(-) diff --git a/netbox/circuits/views.py b/netbox/circuits/views.py index 144007211..35e37f4c5 100644 --- a/netbox/circuits/views.py +++ b/netbox/circuits/views.py @@ -12,7 +12,7 @@ from django.views.generic import View from extras.models import Graph, GRAPH_TYPE_PROVIDER from utilities.forms import ConfirmationForm from utilities.views import ( - BulkDeleteView, BulkEditView, BulkImportView2, ObjectDeleteView, ObjectEditView, ObjectListView, + BulkDeleteView, BulkEditView, BulkImportView, ObjectDeleteView, ObjectEditView, ObjectListView, ) from . import filters, forms, tables from .models import Circuit, CircuitTermination, CircuitType, Provider, TERM_SIDE_A, TERM_SIDE_Z @@ -63,7 +63,7 @@ class ProviderDeleteView(PermissionRequiredMixin, ObjectDeleteView): default_return_url = 'circuits:provider_list' -class ProviderBulkImportView(PermissionRequiredMixin, BulkImportView2): +class ProviderBulkImportView(PermissionRequiredMixin, BulkImportView): permission_required = 'circuits.add_provider' model_form = forms.ProviderCSVForm table = tables.ProviderTable @@ -160,7 +160,7 @@ class CircuitDeleteView(PermissionRequiredMixin, ObjectDeleteView): default_return_url = 'circuits:circuit_list' -class CircuitBulkImportView(PermissionRequiredMixin, BulkImportView2): +class CircuitBulkImportView(PermissionRequiredMixin, BulkImportView): permission_required = 'circuits.add_circuit' model_form = forms.CircuitCSVForm table = tables.CircuitTable diff --git a/netbox/dcim/views.py b/netbox/dcim/views.py index 0aade9cb3..9a7654808 100644 --- a/netbox/dcim/views.py +++ b/netbox/dcim/views.py @@ -23,7 +23,7 @@ from extras.models import Graph, TopologyMap, GRAPH_TYPE_INTERFACE, GRAPH_TYPE_S from utilities.forms import ConfirmationForm from utilities.paginator import EnhancedPaginator from utilities.views import ( - BulkDeleteView, BulkEditView, BulkImportView2, ObjectDeleteView, ObjectEditView, ObjectListView, + BulkDeleteView, BulkEditView, BulkImportView, ObjectDeleteView, ObjectEditView, ObjectListView, ) from . import filters, forms, tables from .models import ( @@ -217,7 +217,7 @@ class SiteDeleteView(PermissionRequiredMixin, ObjectDeleteView): default_return_url = 'dcim:site_list' -class SiteBulkImportView(PermissionRequiredMixin, BulkImportView2): +class SiteBulkImportView(PermissionRequiredMixin, BulkImportView): permission_required = 'dcim.add_site' model_form = forms.SiteCSVForm table = tables.SiteTable @@ -387,7 +387,7 @@ class RackDeleteView(PermissionRequiredMixin, ObjectDeleteView): default_return_url = 'dcim:rack_list' -class RackBulkImportView(PermissionRequiredMixin, BulkImportView2): +class RackBulkImportView(PermissionRequiredMixin, BulkImportView): permission_required = 'dcim.add_rack' model_form = forms.RackCSVForm table = tables.RackImportTable @@ -862,7 +862,7 @@ class DeviceDeleteView(PermissionRequiredMixin, ObjectDeleteView): default_return_url = 'dcim:device_list' -class DeviceBulkImportView(PermissionRequiredMixin, BulkImportView2): +class DeviceBulkImportView(PermissionRequiredMixin, BulkImportView): permission_required = 'dcim.add_device' model_form = forms.DeviceCSVForm table = tables.DeviceImportTable @@ -870,7 +870,7 @@ class DeviceBulkImportView(PermissionRequiredMixin, BulkImportView2): default_return_url = 'dcim:device_list' -class ChildDeviceBulkImportView(PermissionRequiredMixin, BulkImportView2): +class ChildDeviceBulkImportView(PermissionRequiredMixin, BulkImportView): permission_required = 'dcim.add_device' model_form = forms.ChildDeviceCSVForm table = tables.DeviceImportTable @@ -1012,7 +1012,7 @@ class ConsolePortBulkDeleteView(PermissionRequiredMixin, BulkDeleteView): parent_cls = Device -class ConsoleConnectionsBulkImportView(PermissionRequiredMixin, BulkImportView2): +class ConsoleConnectionsBulkImportView(PermissionRequiredMixin, BulkImportView): permission_required = 'dcim.change_consoleport' model_form = forms.ConsoleConnectionCSVForm table = tables.ConsoleConnectionTable @@ -1234,7 +1234,7 @@ class PowerPortBulkDeleteView(PermissionRequiredMixin, BulkDeleteView): parent_cls = Device -class PowerConnectionsBulkImportView(PermissionRequiredMixin, BulkImportView2): +class PowerConnectionsBulkImportView(PermissionRequiredMixin, BulkImportView): permission_required = 'dcim.change_powerport' model_form = forms.PowerConnectionCSVForm table = tables.PowerConnectionTable @@ -1670,7 +1670,7 @@ def interfaceconnection_delete(request, pk): }) -class InterfaceConnectionsBulkImportView(PermissionRequiredMixin, BulkImportView2): +class InterfaceConnectionsBulkImportView(PermissionRequiredMixin, BulkImportView): permission_required = 'dcim.change_interface' model_form = forms.InterfaceConnectionCSVForm table = tables.InterfaceConnectionTable diff --git a/netbox/ipam/views.py b/netbox/ipam/views.py index 56a135d3f..f8fe0535a 100644 --- a/netbox/ipam/views.py +++ b/netbox/ipam/views.py @@ -13,7 +13,7 @@ from django.views.generic import View from dcim.models import Device from utilities.paginator import EnhancedPaginator from utilities.views import ( - BulkAddView, BulkDeleteView, BulkEditView, BulkImportView2, ObjectDeleteView, ObjectEditView, ObjectListView, + BulkAddView, BulkDeleteView, BulkEditView, BulkImportView, ObjectDeleteView, ObjectEditView, ObjectListView, ) from . import filters, forms, tables from .models import ( @@ -128,7 +128,7 @@ class VRFDeleteView(PermissionRequiredMixin, ObjectDeleteView): default_return_url = 'ipam:vrf_list' -class VRFBulkImportView(PermissionRequiredMixin, BulkImportView2): +class VRFBulkImportView(PermissionRequiredMixin, BulkImportView): permission_required = 'ipam.add_vrf' model_form = forms.VRFCSVForm table = tables.VRFTable @@ -338,7 +338,7 @@ class AggregateDeleteView(PermissionRequiredMixin, ObjectDeleteView): default_return_url = 'ipam:aggregate_list' -class AggregateBulkImportView(PermissionRequiredMixin, BulkImportView2): +class AggregateBulkImportView(PermissionRequiredMixin, BulkImportView): permission_required = 'ipam.add_aggregate' model_form = forms.AggregateCSVForm table = tables.AggregateTable @@ -534,7 +534,7 @@ class PrefixDeleteView(PermissionRequiredMixin, ObjectDeleteView): default_return_url = 'ipam:prefix_list' -class PrefixBulkImportView(PermissionRequiredMixin, BulkImportView2): +class PrefixBulkImportView(PermissionRequiredMixin, BulkImportView): permission_required = 'ipam.add_prefix' model_form = forms.PrefixCSVForm table = tables.PrefixTable @@ -635,7 +635,7 @@ class IPAddressBulkAddView(PermissionRequiredMixin, BulkAddView): default_return_url = 'ipam:ipaddress_list' -class IPAddressBulkImportView(PermissionRequiredMixin, BulkImportView2): +class IPAddressBulkImportView(PermissionRequiredMixin, BulkImportView): permission_required = 'ipam.add_ipaddress' model_form = forms.IPAddressCSVForm table = tables.IPAddressTable @@ -742,7 +742,7 @@ class VLANDeleteView(PermissionRequiredMixin, ObjectDeleteView): default_return_url = 'ipam:vlan_list' -class VLANBulkImportView(PermissionRequiredMixin, BulkImportView2): +class VLANBulkImportView(PermissionRequiredMixin, BulkImportView): permission_required = 'ipam.add_vlan' model_form = forms.VLANCSVForm table = tables.VLANTable diff --git a/netbox/secrets/views.py b/netbox/secrets/views.py index c6fe939aa..e046f1dbc 100644 --- a/netbox/secrets/views.py +++ b/netbox/secrets/views.py @@ -13,7 +13,7 @@ from django.views.generic import View from dcim.models import Device from utilities.views import ( - BulkDeleteView, BulkEditView, BulkImportView2, ObjectDeleteView, ObjectEditView, ObjectListView, + BulkDeleteView, BulkEditView, BulkImportView, ObjectDeleteView, ObjectEditView, ObjectListView, ) from . import filters, forms, tables from .decorators import userkey_required @@ -187,7 +187,7 @@ class SecretDeleteView(PermissionRequiredMixin, ObjectDeleteView): default_return_url = 'secrets:secret_list' -class SecretBulkImportView(BulkImportView2): +class SecretBulkImportView(BulkImportView): permission_required = 'ipam.add_vlan' model_form = forms.SecretCSVForm table = tables.SecretTable diff --git a/netbox/tenancy/views.py b/netbox/tenancy/views.py index a292f68cd..5a820b8f6 100644 --- a/netbox/tenancy/views.py +++ b/netbox/tenancy/views.py @@ -10,7 +10,7 @@ from circuits.models import Circuit from dcim.models import Site, Rack, Device from ipam.models import IPAddress, Prefix, VLAN, VRF from utilities.views import ( - BulkDeleteView, BulkEditView, BulkImportView2, ObjectDeleteView, ObjectEditView, ObjectListView, + BulkDeleteView, BulkEditView, BulkImportView, ObjectDeleteView, ObjectEditView, ObjectListView, ) from .models import Tenant, TenantGroup from . import filters, forms, tables @@ -95,7 +95,7 @@ class TenantDeleteView(PermissionRequiredMixin, ObjectDeleteView): default_return_url = 'tenancy:tenant_list' -class TenantBulkImportView(PermissionRequiredMixin, BulkImportView2): +class TenantBulkImportView(PermissionRequiredMixin, BulkImportView): permission_required = 'tenancy.add_tenant' model_form = forms.TenantCSVForm table = tables.TenantTable diff --git a/netbox/utilities/views.py b/netbox/utilities/views.py index 529244c48..8220b3fb3 100644 --- a/netbox/utilities/views.py +++ b/netbox/utilities/views.py @@ -369,7 +369,7 @@ class BulkAddView(View): }) -class BulkImportView2(View): +class BulkImportView(View): """ Import objects in bulk (CSV format). From e3e29fcdca4fd4521279d977df74dcf8cf1cd772 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Mon, 5 Jun 2017 16:12:51 -0400 Subject: [PATCH 21/36] Implemented ConnectionStatusCSVField --- netbox/dcim/forms.py | 34 ++++++++++++++++++++++------------ 1 file changed, 22 insertions(+), 12 deletions(-) diff --git a/netbox/dcim/forms.py b/netbox/dcim/forms.py index bff89a3b5..541ffbfa3 100644 --- a/netbox/dcim/forms.py +++ b/netbox/dcim/forms.py @@ -50,12 +50,25 @@ def get_device_by_name_or_pk(name): return device -def validate_connection_status(value): +class ConnectionStatusCSVField(forms.CharField): """ - Custom validator for connection statuses. value must be either "planned" or "connected" (case-insensitive). + This field accepts either "planned" or "connected" as a connection status for CSV imports. """ - if value.lower() not in ['planned', 'connected']: - raise ValidationError('Invalid connection status ({}); must be either "planned" or "connected".'.format(value)) + def __init__(self, *args, **kwargs): + super(ConnectionStatusCSVField, self).__init__(*args, **kwargs) + if not self.help_text: + self.help_text = 'Connection status ("planned" or "connected")' + + def clean(self, value): + value = super(ConnectionStatusCSVField, self).clean(value) + try: + return { + 'planned': CONNECTION_STATUS_PLANNED, + 'connected': CONNECTION_STATUS_CONNECTED, + }[value.lower()] + except KeyError: + raise ValidationError( + 'Invalid connection status ({}); must be either "planned" or "connected".'.format(value)) class DeviceComponentForm(BootstrapMixin, forms.Form): @@ -968,11 +981,11 @@ class ConsoleConnectionCSVForm(forms.ModelForm): console_port = forms.CharField( help_text='Console port name' ) - status = forms.CharField(validators=[validate_connection_status]) + connection_status = ConnectionStatusCSVField() class Meta: model = ConsolePort - fields = ['console_server', 'cs_port', 'device', 'console_port'] + fields = ['console_server', 'cs_port', 'device', 'console_port', 'connection_status'] def clean_console_port(self): @@ -1222,11 +1235,11 @@ class PowerConnectionCSVForm(forms.ModelForm): power_port = forms.CharField( help_text='Power port name' ) - status = forms.CharField(validators=[validate_connection_status]) + connection_status = ConnectionStatusCSVField() class Meta: model = PowerPort - fields = ['pdu', 'power_outlet', 'device', 'power_port'] + fields = ['pdu', 'power_outlet', 'device', 'power_port', 'connection_status'] def clean_power_port(self): @@ -1622,10 +1635,7 @@ class InterfaceConnectionCSVForm(forms.ModelForm): interface_b = forms.CharField( help_text='Interface name' ) - connection_status = forms.CharField( - help_text='Connection status', - validators=[validate_connection_status] - ) + connection_status = ConnectionStatusCSVField() class Meta: model = InterfaceConnection From 54aed8789c758d6c24d8e7f239bebf25eb79054c Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Mon, 5 Jun 2017 16:16:23 -0400 Subject: [PATCH 22/36] Replaced old CSVDataField --- netbox/secrets/forms.py | 2 +- netbox/utilities/forms.py | 43 +-------------------------------------- netbox/utilities/views.py | 4 ++-- 3 files changed, 4 insertions(+), 45 deletions(-) diff --git a/netbox/secrets/forms.py b/netbox/secrets/forms.py index 806c9d50c..4a2a75abf 100644 --- a/netbox/secrets/forms.py +++ b/netbox/secrets/forms.py @@ -7,7 +7,7 @@ from django import forms from django.db.models import Count from dcim.models import Device -from utilities.forms import BootstrapMixin, BulkEditForm, CSVDataField2, FilterChoiceField, SlugField +from utilities.forms import BootstrapMixin, BulkEditForm, CSVDataField, FilterChoiceField, SlugField from .models import Secret, SecretRole, UserKey diff --git a/netbox/utilities/forms.py b/netbox/utilities/forms.py index 56b7c24b7..25a2d92df 100644 --- a/netbox/utilities/forms.py +++ b/netbox/utilities/forms.py @@ -216,47 +216,6 @@ class Livesearch(forms.TextInput): # class CSVDataField(forms.CharField): - """ - A field for comma-separated values (CSV). Values containing commas should be encased within double quotes. Example: - '"New York, NY",new-york-ny,Other stuff' => ['New York, NY', 'new-york-ny', 'Other stuff'] - """ - csv_form = None - widget = forms.Textarea - - def __init__(self, csv_form, *args, **kwargs): - self.csv_form = csv_form - self.columns = self.csv_form().fields.keys() - super(CSVDataField, self).__init__(*args, **kwargs) - self.strip = False - if not self.label: - self.label = 'CSV Data' - if not self.help_text: - self.help_text = 'Enter one line per record in CSV format.' - - def to_python(self, value): - """ - Return a list of dictionaries, each representing an individual record - """ - # Python 2's csv module has problems with Unicode - if not isinstance(value, str): - value = value.encode('utf-8') - records = [] - reader = csv.reader(value.splitlines()) - for i, row in enumerate(reader, start=1): - if row: - if len(row) < len(self.columns): - raise forms.ValidationError("Line {}: Field(s) missing (found {}; expected {})" - .format(i, len(row), len(self.columns))) - elif len(row) > len(self.columns): - raise forms.ValidationError("Line {}: Too many fields (found {}; expected {})" - .format(i, len(row), len(self.columns))) - row = [col.strip() for col in row] - record = dict(zip(self.columns, row)) - records.append(record) - return records - - -class CSVDataField2(forms.CharField): """ A CharField (rendered as a Textarea) which accepts CSV-formatted data. It returns a list of dictionaries mapping column headers to values. Each dictionary represents an individual record. @@ -268,7 +227,7 @@ class CSVDataField2(forms.CharField): self.fields = fields self.required_fields = required_fields - super(CSVDataField2, self).__init__(*args, **kwargs) + super(CSVDataField, self).__init__(*args, **kwargs) self.strip = False if not self.label: diff --git a/netbox/utilities/views.py b/netbox/utilities/views.py index 8220b3fb3..7e95469f1 100644 --- a/netbox/utilities/views.py +++ b/netbox/utilities/views.py @@ -20,7 +20,7 @@ from django.utils.safestring import mark_safe from django.views.generic import View from extras.models import CustomField, CustomFieldValue, ExportTemplate, UserAction -from utilities.forms import BootstrapMixin, CSVDataField2 +from utilities.forms import BootstrapMixin, CSVDataField from .error_handlers import handle_protectederror from .forms import ConfirmationForm from .paginator import EnhancedPaginator @@ -389,7 +389,7 @@ class BulkImportView(View): required_fields = [name for name, field in self.model_form().fields.items() if field.required] class ImportForm(BootstrapMixin, Form): - csv = CSVDataField2(fields=fields, required_fields=required_fields) + csv = CSVDataField(fields=fields, required_fields=required_fields) return ImportForm(*args, **kwargs) From 3f3fae6f9f9c582a3bcf920d9f15a33753f5564a Mon Sep 17 00:00:00 2001 From: Brian Ellwood Date: Mon, 5 Jun 2017 20:35:05 -0400 Subject: [PATCH 23/36] Update ldap.md Capitalization --- docs/installation/ldap.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/installation/ldap.md b/docs/installation/ldap.md index 9231e422f..56c82d1e4 100644 --- a/docs/installation/ldap.md +++ b/docs/installation/ldap.md @@ -105,14 +105,14 @@ AUTH_LDAP_GROUP_CACHE_TIMEOUT = 3600 ``` !!! info - "is_active" - you must map all users to at least this group if you want their account to be treated as enabled. Without this, your users cannot log in. +"is_active" - You must map all users to at least this group if you want their account to be treated as enabled. Without this, your users cannot log in. -"is_staff" - users mapped to this group are enabled for access to the Administration tools; this is the equivalent of checking the "Staff status" box on a manually created user. This doesn't necessarily imply additional privileges, which still needed to be assigned via a group, or on a per-user basis. +"is_staff" - Users mapped to this group are enabled for access to the Administration tools; this is the equivalent of checking the "Staff status" box on a manually created user. This doesn't necessarily imply additional privileges, which still needed to be assigned via a group, or on a per-user basis. -"is_superuser" - users mapped to this group in addition to the "is_staff" group will be assumed to have full permissions to all modules. Without also being mapped to "is_staff", this group observably has no impact to your effective permissions. +"is_superuser" - Users mapped to this group in addition to the "is_staff" group will be assumed to have full permissions to all modules. Without also being mapped to "is_staff", this group observably has no impact to your effective permissions. !!! info - It is also possible map user attributes to Django attributes: +It is also possible map user attributes to Django attributes: AUTH_LDAP_USER_ATTR_MAP = { "first_name": "givenName", "last_name": "sn" From 2d6ef60290efcc2bb17e4ded47fc666a9a859123 Mon Sep 17 00:00:00 2001 From: Brian Ellwood Date: Mon, 5 Jun 2017 20:37:09 -0400 Subject: [PATCH 24/36] Update ldap.md Wrap code in code block --- docs/installation/ldap.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/installation/ldap.md b/docs/installation/ldap.md index 56c82d1e4..729e02ff4 100644 --- a/docs/installation/ldap.md +++ b/docs/installation/ldap.md @@ -113,7 +113,10 @@ AUTH_LDAP_GROUP_CACHE_TIMEOUT = 3600 !!! info It is also possible map user attributes to Django attributes: + +```no-highlight AUTH_LDAP_USER_ATTR_MAP = { "first_name": "givenName", "last_name": "sn" } +``` From e879dec1a239187e66ebae7d2d8341bf3f18a2b8 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Tue, 6 Jun 2017 17:27:26 -0400 Subject: [PATCH 25/36] Added dynamic examples for CSV form fields --- netbox/circuits/forms.py | 9 +++++---- netbox/dcim/forms.py | 8 +++++++- netbox/templates/utilities/obj_import.html | 11 ++++++++++- netbox/utilities/forms.py | 2 +- netbox/utilities/templatetags/form_helpers.py | 6 ++++-- netbox/utilities/templatetags/helpers.py | 18 ++++++++++++++++++ 6 files changed, 45 insertions(+), 9 deletions(-) diff --git a/netbox/circuits/forms.py b/netbox/circuits/forms.py index 444974240..b5dc31e73 100644 --- a/netbox/circuits/forms.py +++ b/netbox/circuits/forms.py @@ -47,8 +47,9 @@ class ProviderCSVForm(forms.ModelForm): fields = ['name', 'slug', 'asn', 'account', 'portal_url', 'comments'] help_texts = { 'name': 'Provider name', - 'asn': 'Autonomous system number', - 'comments': 'Free-form comments' + 'asn': '32-bit autonomous system number', + 'portal_url': 'Portal URL', + 'comments': 'Free-form comments', } @@ -116,7 +117,7 @@ class CircuitCSVForm(forms.ModelForm): type = forms.ModelChoiceField( queryset=CircuitType.objects.all(), to_field_name='name', - help_text='Name of assigned tenant', + help_text='Name of circuit type', error_messages={ 'invalid_choice': 'Invalid circuit type.' } @@ -125,7 +126,7 @@ class CircuitCSVForm(forms.ModelForm): queryset=Tenant.objects.all(), required=False, to_field_name='name', - help_text='Name of circuit type', + help_text='Name of assigned tenant', error_messages={ 'invalid_choice': 'Tenant not found.' } diff --git a/netbox/dcim/forms.py b/netbox/dcim/forms.py index 541ffbfa3..a017a41bc 100644 --- a/netbox/dcim/forms.py +++ b/netbox/dcim/forms.py @@ -146,6 +146,10 @@ class SiteCSVForm(forms.ModelForm): 'name', 'slug', 'region', 'tenant', 'facility', 'asn', 'physical_address', 'shipping_address', 'contact_name', 'contact_phone', 'contact_email', 'comments', ] + help_texts = { + 'slug': 'URL-friendly slug', + 'asn': '32-bit autonomous system number', + } class SiteBulkEditForm(BootstrapMixin, CustomFieldBulkEditForm): @@ -271,13 +275,15 @@ class RackCSVForm(forms.ModelForm): 'invalid_choice': 'Role not found.', } ) - type = forms.CharField(required=False) class Meta: model = Rack fields = [ 'site', 'group', 'name', 'facility_id', 'tenant', 'role', 'type', 'width', 'u_height', 'desc_units', ] + help_texts = { + 'type': 'Rack type', + } def clean_group(self): diff --git a/netbox/templates/utilities/obj_import.html b/netbox/templates/utilities/obj_import.html index 7aa7d3b0f..95dc996f1 100644 --- a/netbox/templates/utilities/obj_import.html +++ b/netbox/templates/utilities/obj_import.html @@ -42,7 +42,16 @@ {{ name }} {% if field.required %}{% endif %} - {{ field.help_text|default:field.label }} + + {{ field.help_text|default:field.label }} + {% if field.choices %} +
    Examples: {{ field.choices|example_choices }} + {% elif field|widget_type == 'dateinput' %} +
    Format: YYYY-MM-DD + {% elif field|widget_type == 'checkboxinput' %} +
    Specify "true" or "false" + {% endif %} + {% endfor %} diff --git a/netbox/utilities/forms.py b/netbox/utilities/forms.py index 25a2d92df..628bb9d2a 100644 --- a/netbox/utilities/forms.py +++ b/netbox/utilities/forms.py @@ -235,7 +235,7 @@ class CSVDataField(forms.CharField): if not self.initial: self.initial = ','.join(required_fields) + '\n' if not self.help_text: - self.help_text = 'Enter the list of column headers followed by one line per record to be imported. Use ' \ + self.help_text = 'Enter the list of column headers followed by one line per record to be imported, using ' \ 'commas to separate values. Multi-line data and values containing commas may be wrapped ' \ 'in double quotes.' diff --git a/netbox/utilities/templatetags/form_helpers.py b/netbox/utilities/templatetags/form_helpers.py index 572be15fe..d3451ce86 100644 --- a/netbox/utilities/templatetags/form_helpers.py +++ b/netbox/utilities/templatetags/form_helpers.py @@ -40,7 +40,9 @@ def widget_type(field): """ Return the widget type """ - try: + if hasattr(field, 'widget'): + return field.widget.__class__.__name__.lower() + elif hasattr(field, 'field'): return field.field.widget.__class__.__name__.lower() - except AttributeError: + else: return None diff --git a/netbox/utilities/templatetags/helpers.py b/netbox/utilities/templatetags/helpers.py index 2dc0b429a..257f061ab 100644 --- a/netbox/utilities/templatetags/helpers.py +++ b/netbox/utilities/templatetags/helpers.py @@ -1,3 +1,5 @@ +from __future__ import unicode_literals + from markdown import markdown from django import template @@ -60,6 +62,22 @@ def bettertitle(value): return ' '.join([w[0].upper() + w[1:] for w in value.split()]) +@register.filter() +def example_choices(value, arg=3): + """ + Returns a number (default: 3) of example choices for a ChoiceFiled (useful for CSV import forms). + """ + choices = [] + for id, label in value: + if len(choices) == arg: + choices.append('etc.') + break + if not id: + continue + choices.append(label) + return ', '.join(choices) or 'None found' + + # # Tags # From defa3d2f85672eb03e18e2178253c21e10423ef9 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Tue, 6 Jun 2017 22:35:41 -0400 Subject: [PATCH 26/36] Converted ConnectionStatusCSVField to a ChoiceField --- netbox/dcim/forms.py | 24 ++++++++++++++---------- 1 file changed, 14 insertions(+), 10 deletions(-) diff --git a/netbox/dcim/forms.py b/netbox/dcim/forms.py index a017a41bc..bd81f9303 100644 --- a/netbox/dcim/forms.py +++ b/netbox/dcim/forms.py @@ -50,25 +50,29 @@ def get_device_by_name_or_pk(name): return device -class ConnectionStatusCSVField(forms.CharField): +class ConnectionStatusCSVField(forms.ChoiceField): """ This field accepts either "planned" or "connected" as a connection status for CSV imports. """ + default_error_messages = { + 'invalid_choice': '%(value)s is not a valid connection status. It must be either "planned" or "connected."', + } + def __init__(self, *args, **kwargs): + kwargs['choices'] = ( + ('planned', 'planned'), + ('connected', 'connected'), + ) super(ConnectionStatusCSVField, self).__init__(*args, **kwargs) if not self.help_text: - self.help_text = 'Connection status ("planned" or "connected")' + self.help_text = 'Connection status' def clean(self, value): value = super(ConnectionStatusCSVField, self).clean(value) - try: - return { - 'planned': CONNECTION_STATUS_PLANNED, - 'connected': CONNECTION_STATUS_CONNECTED, - }[value.lower()] - except KeyError: - raise ValidationError( - 'Invalid connection status ({}); must be either "planned" or "connected".'.format(value)) + return { + 'planned': CONNECTION_STATUS_PLANNED, + 'connected': CONNECTION_STATUS_CONNECTED, + }[value.lower()] class DeviceComponentForm(BootstrapMixin, forms.Form): From 4a6b79646ad7d3415432c41202e43d88f681a488 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Wed, 7 Jun 2017 13:22:06 -0400 Subject: [PATCH 27/36] Replaced all CSVForm ChoiceFields with CSVChoiceField --- netbox/dcim/forms.py | 96 ++++++++-------------- netbox/dcim/models.py | 2 +- netbox/dcim/tables.py | 2 +- netbox/ipam/forms.py | 34 ++------ netbox/templates/utilities/obj_import.html | 2 +- netbox/utilities/forms.py | 19 +++++ netbox/utilities/templatetags/helpers.py | 2 +- 7 files changed, 66 insertions(+), 91 deletions(-) diff --git a/netbox/dcim/forms.py b/netbox/dcim/forms.py index bd81f9303..1fdd304f5 100644 --- a/netbox/dcim/forms.py +++ b/netbox/dcim/forms.py @@ -14,7 +14,7 @@ from tenancy.forms import TenancyForm from tenancy.models import Tenant from utilities.forms import ( APISelect, add_blank_choice, ArrayFieldSelectMultiple, BootstrapMixin, BulkEditForm, BulkEditNullBooleanSelect, - ChainedFieldsMixin, ChainedModelChoiceField, CommentField, ExpandableNameField, FilterChoiceField, + ChainedFieldsMixin, ChainedModelChoiceField, CommentField, CSVChoiceField, ExpandableNameField, FilterChoiceField, FlexibleModelChoiceField, Livesearch, SelectWithDisabled, SmallTextarea, SlugField, FilterTreeNodeMultipleChoiceField, ) @@ -24,8 +24,9 @@ from .models import ( ConsolePort, ConsolePortTemplate, ConsoleServerPort, ConsoleServerPortTemplate, Device, DeviceRole, DeviceType, Interface, IFACE_FF_CHOICES, IFACE_FF_LAG, IFACE_ORDERING_CHOICES, InterfaceConnection, InterfaceTemplate, Manufacturer, InventoryItem, Platform, PowerOutlet, PowerOutletTemplate, PowerPort, PowerPortTemplate, - RACK_TYPE_CHOICES, RACK_WIDTH_CHOICES, Rack, RackGroup, RackReservation, RackRole, Region, Site, STATUS_CHOICES, - SUBDEVICE_ROLE_CHILD, SUBDEVICE_ROLE_PARENT, VIRTUAL_IFACE_TYPES, + RACK_FACE_CHOICES, RACK_TYPE_CHOICES, RACK_WIDTH_CHOICES, Rack, RackGroup, RackReservation, RackRole, + RACK_WIDTH_19IN, RACK_WIDTH_23IN, Region, Site, STATUS_CHOICES, SUBDEVICE_ROLE_CHILD, SUBDEVICE_ROLE_PARENT, + VIRTUAL_IFACE_TYPES, ) @@ -50,31 +51,6 @@ def get_device_by_name_or_pk(name): return device -class ConnectionStatusCSVField(forms.ChoiceField): - """ - This field accepts either "planned" or "connected" as a connection status for CSV imports. - """ - default_error_messages = { - 'invalid_choice': '%(value)s is not a valid connection status. It must be either "planned" or "connected."', - } - - def __init__(self, *args, **kwargs): - kwargs['choices'] = ( - ('planned', 'planned'), - ('connected', 'connected'), - ) - super(ConnectionStatusCSVField, self).__init__(*args, **kwargs) - if not self.help_text: - self.help_text = 'Connection status' - - def clean(self, value): - value = super(ConnectionStatusCSVField, self).clean(value) - return { - 'planned': CONNECTION_STATUS_PLANNED, - 'connected': CONNECTION_STATUS_CONNECTED, - }[value.lower()] - - class DeviceComponentForm(BootstrapMixin, forms.Form): """ Allow inclusion of the parent device as context for limiting field choices. @@ -256,7 +232,7 @@ class RackCSVForm(forms.ModelForm): queryset=RackGroup.objects.all(), to_field_name='name', required=False, - help_text='Name of parent group', + help_text='Name of parent rack group', error_messages={ 'invalid_choice': 'Rack group not found.', } @@ -279,15 +255,24 @@ class RackCSVForm(forms.ModelForm): 'invalid_choice': 'Role not found.', } ) + type = CSVChoiceField( + choices=RACK_TYPE_CHOICES, + required=False, + help_text='Rack type' + ) + width = forms.ChoiceField( + choices = ( + (RACK_WIDTH_19IN, '19'), + (RACK_WIDTH_23IN, '23'), + ), + help_text='Rail-to-rail width (in inches)' + ) class Meta: model = Rack fields = [ 'site', 'group', 'name', 'facility_id', 'tenant', 'role', 'type', 'width', 'u_height', 'desc_units', ] - help_texts = { - 'type': 'Rack type', - } def clean_group(self): @@ -297,21 +282,6 @@ class RackCSVForm(forms.ModelForm): if group and group.site != site: raise ValidationError("Invalid group for site {}: {}".format(site, group)) - def clean_type(self): - - rack_type = self.cleaned_data['type'] - - if not rack_type: - return None - try: - choices = {v.lower(): k for k, v in RACK_TYPE_CHOICES} - return choices[rack_type.lower()] - except KeyError: - raise forms.ValidationError('Invalid rack type ({}). Valid choices are: {}.'.format( - rack_type, - ', '.join({v: k for k, v in RACK_TYPE_CHOICES}), - )) - class RackBulkEditForm(BootstrapMixin, CustomFieldBulkEditForm): pk = forms.ModelMultipleChoiceField(queryset=Rack.objects.all(), widget=forms.MultipleHiddenInput) @@ -752,8 +722,9 @@ class BaseDeviceCSVForm(forms.ModelForm): 'invalid_choice': 'Invalid platform.', } ) - status = forms.CharField( - help_text='Status name' + status = CSVChoiceField( + choices=STATUS_CHOICES, + help_text='Operational status of device' ) class Meta: @@ -772,13 +743,6 @@ class BaseDeviceCSVForm(forms.ModelForm): except DeviceType.DoesNotExist: self.add_error('model_name', "Invalid device type ({} {})".format(manufacturer, model_name)) - def clean_status(self): - status_choices = {s[1].lower(): s[0] for s in STATUS_CHOICES} - try: - return status_choices[self.cleaned_data['status'].lower()] - except KeyError: - raise ValidationError("Invalid status: {}".format(self.cleaned_data['status'])) - class DeviceCSVForm(BaseDeviceCSVForm): site = forms.ModelChoiceField( @@ -793,9 +757,10 @@ class DeviceCSVForm(BaseDeviceCSVForm): required=False, help_text='Name of parent rack' ) - face = forms.CharField( + face = CSVChoiceField( + choices=RACK_FACE_CHOICES, required=False, - help_text='Mounted rack face (front or rear)' + help_text='Mounted rack face' ) class Meta(BaseDeviceCSVForm.Meta): @@ -991,7 +956,10 @@ class ConsoleConnectionCSVForm(forms.ModelForm): console_port = forms.CharField( help_text='Console port name' ) - connection_status = ConnectionStatusCSVField() + connection_status = CSVChoiceField( + choices=CONNECTION_STATUS_CHOICES, + help_text='Connection status' + ) class Meta: model = ConsolePort @@ -1245,7 +1213,10 @@ class PowerConnectionCSVForm(forms.ModelForm): power_port = forms.CharField( help_text='Power port name' ) - connection_status = ConnectionStatusCSVField() + connection_status = CSVChoiceField( + choices=CONNECTION_STATUS_CHOICES, + help_text='Connection status' + ) class Meta: model = PowerPort @@ -1645,7 +1616,10 @@ class InterfaceConnectionCSVForm(forms.ModelForm): interface_b = forms.CharField( help_text='Interface name' ) - connection_status = ConnectionStatusCSVField() + connection_status = CSVChoiceField( + choices=CONNECTION_STATUS_CHOICES, + help_text='Connection status' + ) class Meta: model = InterfaceConnection diff --git a/netbox/dcim/models.py b/netbox/dcim/models.py index 0c3b9cc52..bbc27b8d9 100644 --- a/netbox/dcim/models.py +++ b/netbox/dcim/models.py @@ -346,7 +346,7 @@ class RackGroup(models.Model): ] def __str__(self): - return '{} - {}'.format(self.site.name, self.name) + return self.name def get_absolute_url(self): return "{}?group_id={}".format(reverse('dcim:rack_list'), self.pk) diff --git a/netbox/dcim/tables.py b/netbox/dcim/tables.py index be80233e0..c9a5ecdc9 100644 --- a/netbox/dcim/tables.py +++ b/netbox/dcim/tables.py @@ -247,7 +247,7 @@ class RackImportTable(BaseTable): class Meta(BaseTable.Meta): model = Rack - fields = ('site', 'group', 'name', 'facility_id', 'tenant', 'u_height') + fields = ('name', 'site', 'group', 'facility_id', 'tenant', 'u_height') # diff --git a/netbox/ipam/forms.py b/netbox/ipam/forms.py index 896ca1d87..d2c45e405 100644 --- a/netbox/ipam/forms.py +++ b/netbox/ipam/forms.py @@ -9,8 +9,8 @@ from extras.forms import CustomFieldForm, CustomFieldBulkEditForm, CustomFieldFi from tenancy.forms import TenancyForm from tenancy.models import Tenant from utilities.forms import ( - APISelect, BootstrapMixin, BulkEditNullBooleanSelect, ChainedModelChoiceField, ExpandableIPAddressField, - FilterChoiceField, Livesearch, ReturnURLForm, SlugField, add_blank_choice, + APISelect, BootstrapMixin, BulkEditNullBooleanSelect, ChainedModelChoiceField, CSVChoiceField, + ExpandableIPAddressField, FilterChoiceField, Livesearch, ReturnURLForm, SlugField, add_blank_choice, ) from .models import ( Aggregate, IPAddress, IPADDRESS_STATUS_CHOICES, Prefix, PREFIX_STATUS_CHOICES, RIR, Role, Service, VLAN, @@ -238,7 +238,8 @@ class PrefixCSVForm(forms.ModelForm): help_text='Numeric ID of assigned VLAN', required=False ) - status = forms.CharField( + status = CSVChoiceField( + choices=IPADDRESS_STATUS_CHOICES, help_text='Status name' ) role = forms.ModelChoiceField( @@ -289,13 +290,6 @@ class PrefixCSVForm(forms.ModelForm): except VLAN.MultipleObjectsReturned: self.add_error('vlan_vid', "Multiple VLANs found ({} - VID {})".format(site, vlan_vid)) - def clean_status(self): - status_choices = {s[1].lower(): s[0] for s in PREFIX_STATUS_CHOICES} - try: - return status_choices[self.cleaned_data['status'].lower()] - except KeyError: - raise ValidationError("Invalid status: {}".format(self.cleaned_data['status'])) - class PrefixBulkEditForm(BootstrapMixin, CustomFieldBulkEditForm): pk = forms.ModelMultipleChoiceField(queryset=Prefix.objects.all(), widget=forms.MultipleHiddenInput) @@ -567,7 +561,8 @@ class IPAddressCSVForm(forms.ModelForm): 'invalid_choice': 'Tenant not found.', } ) - status = forms.CharField( + status = CSVChoiceField( + choices=PREFIX_STATUS_CHOICES, help_text='Status name' ) device = forms.ModelChoiceField( @@ -613,13 +608,6 @@ class IPAddressCSVForm(forms.ModelForm): if is_primary and not device: self.add_error('is_primary', "No device specified; cannot set as primary IP") - def clean_status(self): - status_choices = {s[1].lower(): s[0] for s in IPADDRESS_STATUS_CHOICES} - try: - return status_choices[self.cleaned_data['status'].lower()] - except KeyError: - raise ValidationError("Invalid status: {}".format(self.cleaned_data['status'])) - def save(self, *args, **kwargs): # Set interface @@ -756,7 +744,8 @@ class VLANCSVForm(forms.ModelForm): 'invalid_choice': 'Tenant not found.', } ) - status = forms.CharField( + status = CSVChoiceField( + choices=VLAN_STATUS_CHOICES, help_text='Status name' ) role = forms.ModelChoiceField( @@ -783,13 +772,6 @@ class VLANCSVForm(forms.ModelForm): except VLANGroup.DoesNotExist: self.add_error('group_name', "Invalid VLAN group {}.".format(group_name)) - def clean_status(self): - status_choices = {s[1].lower(): s[0] for s in VLAN_STATUS_CHOICES} - try: - return status_choices[self.cleaned_data['status'].lower()] - except KeyError: - raise ValidationError("Invalid status: {}".format(self.cleaned_data['status'])) - def save(self, *args, **kwargs): vlan = super(VLANCSVForm, self).save(commit=False) diff --git a/netbox/templates/utilities/obj_import.html b/netbox/templates/utilities/obj_import.html index 95dc996f1..5ff55b399 100644 --- a/netbox/templates/utilities/obj_import.html +++ b/netbox/templates/utilities/obj_import.html @@ -45,7 +45,7 @@ {{ field.help_text|default:field.label }} {% if field.choices %} -
    Examples: {{ field.choices|example_choices }} +
    Choices: {{ field.choices|example_choices }} {% elif field|widget_type == 'dateinput' %}
    Format: YYYY-MM-DD {% elif field|widget_type == 'checkboxinput' %} diff --git a/netbox/utilities/forms.py b/netbox/utilities/forms.py index 628bb9d2a..231de52e5 100644 --- a/netbox/utilities/forms.py +++ b/netbox/utilities/forms.py @@ -271,6 +271,25 @@ class CSVDataField(forms.CharField): return records +class CSVChoiceField(forms.ChoiceField): + """ + Invert the provided set of choices to take the human-friendly label as input, and return the database value. + """ + + def __init__(self, choices, *args, **kwargs): + super(CSVChoiceField, self).__init__(choices, *args, **kwargs) + self.choices = [(label, label) for value, label in choices] + self.choice_values = {label: value for value, label in choices} + + def clean(self, value): + value = super(CSVChoiceField, self).clean(value) + if not value: + return None + if value not in self.choice_values: + raise forms.ValidationError("Invalid choice: {}".format(value)) + return self.choice_values[value] + + class ExpandableNameField(forms.CharField): """ A field which allows for numeric range expansion diff --git a/netbox/utilities/templatetags/helpers.py b/netbox/utilities/templatetags/helpers.py index 257f061ab..42e8a277f 100644 --- a/netbox/utilities/templatetags/helpers.py +++ b/netbox/utilities/templatetags/helpers.py @@ -75,7 +75,7 @@ def example_choices(value, arg=3): if not id: continue choices.append(label) - return ', '.join(choices) or 'None found' + return ', '.join(choices) or 'None' # From eca56a188fa335ff422aa3c8c696e88708d83ff4 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Wed, 7 Jun 2017 14:19:08 -0400 Subject: [PATCH 28/36] Updated CSVForm validation --- netbox/dcim/forms.py | 68 ++++++++--------- netbox/ipam/forms.py | 86 ++++++++++------------ netbox/ipam/models.py | 4 +- netbox/templates/utilities/obj_import.html | 1 - 4 files changed, 71 insertions(+), 88 deletions(-) diff --git a/netbox/dcim/forms.py b/netbox/dcim/forms.py index 1fdd304f5..c847f1e41 100644 --- a/netbox/dcim/forms.py +++ b/netbox/dcim/forms.py @@ -5,7 +5,6 @@ import re from django import forms from django.contrib.postgres.forms.array import SimpleArrayField -from django.core.exceptions import ValidationError from django.db.models import Count, Q from extras.forms import CustomFieldForm, CustomFieldBulkEditForm, CustomFieldFilterForm @@ -228,14 +227,9 @@ class RackCSVForm(forms.ModelForm): 'invalid_choice': 'Site not found.', } ) - group = forms.ModelChoiceField( - queryset=RackGroup.objects.all(), - to_field_name='name', - required=False, - help_text='Name of parent rack group', - error_messages={ - 'invalid_choice': 'Rack group not found.', - } + group_name = forms.CharField( + help_text='Name of rack group', + required=False ) tenant = forms.ModelChoiceField( queryset=Tenant.objects.all(), @@ -274,13 +268,19 @@ class RackCSVForm(forms.ModelForm): 'site', 'group', 'name', 'facility_id', 'tenant', 'role', 'type', 'width', 'u_height', 'desc_units', ] - def clean_group(self): + def clean(self): + + super(RackCSVForm, self).clean() site = self.cleaned_data.get('site') - group = self.cleaned_data.get('group') + group_name = self.cleaned_data.get('group_name') - if group and group.site != site: - raise ValidationError("Invalid group for site {}: {}".format(site, group)) + # Validate rack group + if group_name: + try: + self.instance.group = RackGroup.objects.get(site=site, name=group_name) + except RackGroup.DoesNotExist: + raise forms.ValidationError("Rack group {} not found for site {}".format(group_name, site)) class RackBulkEditForm(BootstrapMixin, CustomFieldBulkEditForm): @@ -733,6 +733,8 @@ class BaseDeviceCSVForm(forms.ModelForm): def clean(self): + super(BaseDeviceCSVForm, self).clean() + manufacturer = self.cleaned_data.get('manufacturer') model_name = self.cleaned_data.get('model_name') @@ -741,7 +743,7 @@ class BaseDeviceCSVForm(forms.ModelForm): try: self.instance.device_type = DeviceType.objects.get(manufacturer=manufacturer, model=model_name) except DeviceType.DoesNotExist: - self.add_error('model_name', "Invalid device type ({} {})".format(manufacturer, model_name)) + raise forms.ValidationError("Device type {} {} not found".format(manufacturer, model_name)) class DeviceCSVForm(BaseDeviceCSVForm): @@ -753,6 +755,10 @@ class DeviceCSVForm(BaseDeviceCSVForm): 'invalid_choice': 'Invalid site name.', } ) + rack_group = forms.CharField( + required=False, + help_text='Name of parent rack\'s group' + ) rack_name = forms.CharField( required=False, help_text='Name of parent rack' @@ -766,7 +772,7 @@ class DeviceCSVForm(BaseDeviceCSVForm): class Meta(BaseDeviceCSVForm.Meta): fields = [ 'name', 'device_role', 'tenant', 'manufacturer', 'model_name', 'platform', 'serial', 'asset_tag', 'status', - 'site', 'rack_name', 'position', 'face', + 'site', 'rack_group', 'rack_name', 'position', 'face', ] def clean(self): @@ -774,26 +780,20 @@ class DeviceCSVForm(BaseDeviceCSVForm): super(DeviceCSVForm, self).clean() site = self.cleaned_data.get('site') + rack_group = self.cleaned_data.get('rack_group') rack_name = self.cleaned_data.get('rack_name') # Validate rack - if site and rack_name: + if site and rack_group and rack_name: try: - self.instance.rack = Rack.objects.get(site=site, name=rack_name) + self.instance.rack = Rack.objects.get(site=site, group__name=rack_group, name=rack_name) except Rack.DoesNotExist: - self.add_error('rack_name', "Invalid rack ({})".format(rack_name)) - - def clean_face(self): - face = self.cleaned_data['face'] - if not face: - return None - try: - return { - 'front': 0, - 'rear': 1, - }[face.lower()] - except KeyError: - raise forms.ValidationError('Invalid rack face ({}); must be "front" or "rear".'.format(face)) + raise forms.ValidationError("Rack {} not found in site {} group {}".format(rack_name, site, rack_group)) + elif site and rack_name: + try: + self.instance.rack = Rack.objects.get(site=site, group__isnull=True, name=rack_name) + except Rack.DoesNotExist: + raise forms.ValidationError("Rack {} not found in site {} (no group)".format(rack_name, site)) class ChildDeviceCSVForm(BaseDeviceCSVForm): @@ -825,13 +825,7 @@ class ChildDeviceCSVForm(BaseDeviceCSVForm): # Validate device bay if parent and device_bay_name: try: - device_bay = DeviceBay.objects.get(device=parent, name=device_bay_name) - if device_bay.installed_device: - self.add_error( - 'device_bay_name', "Device bay ({} {}) is already occupied".format(parent, device_bay_name) - ) - else: - self.instance.parent_bay = device_bay + self.instance.parent_bay = DeviceBay.objects.get(device=parent, name=device_bay_name) except DeviceBay.DoesNotExist: self.add_error( 'device_bay_name', "Parent device/bay ({} {}) not found".format(parent, device_bay_name) diff --git a/netbox/ipam/forms.py b/netbox/ipam/forms.py index d2c45e405..0ea10c838 100644 --- a/netbox/ipam/forms.py +++ b/netbox/ipam/forms.py @@ -1,7 +1,6 @@ from __future__ import unicode_literals from django import forms -from django.core.exceptions import ValidationError from django.db.models import Count from dcim.models import Site, Rack, Device, Interface @@ -230,7 +229,7 @@ class PrefixCSVForm(forms.ModelForm): 'invalid_choice': 'Site not found.', } ) - vlan_group_name = forms.CharField( + vlan_group = forms.CharField( help_text='Group name of assigned VLAN', required=False ) @@ -255,40 +254,36 @@ class PrefixCSVForm(forms.ModelForm): class Meta: model = Prefix fields = [ - 'prefix', 'vrf', 'tenant', 'site', 'vlan_group_name', 'vlan_vid', 'status', 'role', 'is_pool', - 'description', + 'prefix', 'vrf', 'tenant', 'site', 'vlan_group', 'vlan_vid', 'status', 'role', 'is_pool', 'description', ] def clean(self): - site = self.cleaned_data.get('site') - vlan_group_name = self.cleaned_data.get('vlan_group_name') - vlan_vid = self.cleaned_data.get('vlan_vid') - vlan_group = None + super(PrefixCSVForm, self).clean() - # Validate VLAN group - if vlan_group_name: - try: - vlan_group = VLANGroup.objects.get(site=site, name=vlan_group_name) - except VLANGroup.DoesNotExist: - if site: - self.add_error('vlan_group_name', "Invalid VLAN group ({} - {}).".format(site, vlan_group_name)) - else: - self.add_error('vlan_group_name', "Invalid global VLAN group ({}).".format(vlan_group_name)) + site = self.cleaned_data.get('site') + vlan_group = self.cleaned_data.get('vlan_group') + vlan_vid = self.cleaned_data.get('vlan_vid') # Validate VLAN - if vlan_vid: + if vlan_group and vlan_vid: try: - self.instance.vlan = VLAN.objects.get(site=site, group=vlan_group, vid=vlan_vid) + self.instance.vlan = VLAN.objects.get(site=site, group__name=vlan_group, vid=vlan_vid) except VLAN.DoesNotExist: if site: - self.add_error('vlan_vid', "Invalid VLAN ID ({}) for site {}.".format(vlan_vid, site)) - elif vlan_group: - self.add_error('vlan_vid', "Invalid VLAN ID ({}) for group {}.".format(vlan_vid, vlan_group_name)) - elif not vlan_group_name: - self.add_error('vlan_vid', "Invalid global VLAN ID ({}).".format(vlan_vid)) - except VLAN.MultipleObjectsReturned: - self.add_error('vlan_vid', "Multiple VLANs found ({} - VID {})".format(site, vlan_vid)) + raise forms.ValidationError("VLAN {} not found in site {} group {}".format( + vlan_vid, site, vlan_group + )) + else: + raise forms.ValidationError("Global VLAN {} not found in group {}".format(vlan_vid, vlan_group)) + elif vlan_vid: + try: + self.instance.vlan = VLAN.objects.get(site=site, group__isnull=True, vid=vlan_vid) + except VLAN.DoesNotExist: + if site: + raise forms.ValidationError("VLAN {} not found in site {}".format(vlan_vid, site)) + else: + raise forms.ValidationError("Global VLAN {} not found".format(vlan_vid)) class PrefixBulkEditForm(BootstrapMixin, CustomFieldBulkEditForm): @@ -589,6 +584,8 @@ class IPAddressCSVForm(forms.ModelForm): def clean(self): + super(IPAddressCSVForm, self).clean() + device = self.cleaned_data.get('device') interface_name = self.cleaned_data.get('interface_name') is_primary = self.cleaned_data.get('is_primary') @@ -596,17 +593,17 @@ class IPAddressCSVForm(forms.ModelForm): # Validate interface if device and interface_name: try: - Interface.objects.get(device=device, name=interface_name) + self.instance.interface = Interface.objects.get(device=device, name=interface_name) except Interface.DoesNotExist: - self.add_error('interface_name', "Invalid interface ({}) for {}".format(interface_name, device)) + raise forms.ValidationError("Invalid interface {} for device {}".format(interface_name, device)) elif device and not interface_name: - self.add_error('interface_name', "Device set ({}) but interface missing".format(device)) + raise forms.ValidationError("Device set ({}) but interface missing".format(device)) elif interface_name and not device: - self.add_error('device', "Interface set ({}) but device missing or invalid".format(interface_name)) + raise forms.ValidationError("Interface set ({}) but device missing or invalid".format(interface_name)) # Validate is_primary if is_primary and not device: - self.add_error('is_primary', "No device specified; cannot set as primary IP") + raise forms.ValidationError("No device specified; cannot set as primary IP") def save(self, *args, **kwargs): @@ -732,7 +729,7 @@ class VLANCSVForm(forms.ModelForm): } ) group_name = forms.CharField( - help_text='Name of parent VLAN group', + help_text='Name of VLAN group', required=False ) tenant = forms.ModelChoiceField( @@ -764,25 +761,20 @@ class VLANCSVForm(forms.ModelForm): def clean(self): - # Validate VLANGroup + super(VLANCSVForm, self).clean() + + site = self.cleaned_data.get('site') group_name = self.cleaned_data.get('group_name') + + # Validate VLAN group if group_name: try: - VLANGroup.objects.get(site=self.cleaned_data.get('site'), name=group_name) + self.instance.group = VLANGroup.objects.get(site=site, name=group_name) except VLANGroup.DoesNotExist: - self.add_error('group_name', "Invalid VLAN group {}.".format(group_name)) - - def save(self, *args, **kwargs): - - vlan = super(VLANCSVForm, self).save(commit=False) - - # Assign VLANGroup by site and name - if self.cleaned_data['group_name']: - vlan.group = VLANGroup.objects.get(site=self.cleaned_data['site'], name=self.cleaned_data['group_name']) - - if kwargs.get('commit'): - vlan.save() - return vlan + if site: + raise forms.ValidationError("VLAN group {} not found for site {}".format(group_name, site)) + else: + raise forms.ValidationError("Global VLAN group {} not found".format(group_name)) class VLANBulkEditForm(BootstrapMixin, CustomFieldBulkEditForm): diff --git a/netbox/ipam/models.py b/netbox/ipam/models.py index 01cdd406d..04f193dd4 100644 --- a/netbox/ipam/models.py +++ b/netbox/ipam/models.py @@ -498,9 +498,7 @@ class VLANGroup(models.Model): verbose_name_plural = 'VLAN groups' def __str__(self): - if self.site is None: - return self.name - return '{} - {}'.format(self.site.name, self.name) + return self.name def get_absolute_url(self): return "{}?group_id={}".format(reverse('ipam:vlan_list'), self.pk) diff --git a/netbox/templates/utilities/obj_import.html b/netbox/templates/utilities/obj_import.html index 5ff55b399..22e06f6ef 100644 --- a/netbox/templates/utilities/obj_import.html +++ b/netbox/templates/utilities/obj_import.html @@ -29,7 +29,6 @@
    - {% block instructions %}{% endblock %} {% if fields %}

    CSV Format

    From bd9fab09d1f9ae746421f52f60dff4da33ff6328 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Wed, 7 Jun 2017 15:30:28 -0400 Subject: [PATCH 29/36] Form cleanup and fixed child device import --- netbox/circuits/forms.py | 2 +- netbox/dcim/forms.py | 35 +++++++++++++++++++++-------------- netbox/dcim/views.py | 11 +++++------ 3 files changed, 27 insertions(+), 21 deletions(-) diff --git a/netbox/circuits/forms.py b/netbox/circuits/forms.py index b5dc31e73..46472b228 100644 --- a/netbox/circuits/forms.py +++ b/netbox/circuits/forms.py @@ -117,7 +117,7 @@ class CircuitCSVForm(forms.ModelForm): type = forms.ModelChoiceField( queryset=CircuitType.objects.all(), to_field_name='name', - help_text='Name of circuit type', + help_text='Type of circuit', error_messages={ 'invalid_choice': 'Invalid circuit type.' } diff --git a/netbox/dcim/forms.py b/netbox/dcim/forms.py index c847f1e41..20dd6a9a1 100644 --- a/netbox/dcim/forms.py +++ b/netbox/dcim/forms.py @@ -19,13 +19,12 @@ from utilities.forms import ( ) from .formfields import MACAddressFormField from .models import ( - DeviceBay, DeviceBayTemplate, CONNECTION_STATUS_CHOICES, CONNECTION_STATUS_PLANNED, CONNECTION_STATUS_CONNECTED, - ConsolePort, ConsolePortTemplate, ConsoleServerPort, ConsoleServerPortTemplate, Device, DeviceRole, DeviceType, - Interface, IFACE_FF_CHOICES, IFACE_FF_LAG, IFACE_ORDERING_CHOICES, InterfaceConnection, InterfaceTemplate, - Manufacturer, InventoryItem, Platform, PowerOutlet, PowerOutletTemplate, PowerPort, PowerPortTemplate, - RACK_FACE_CHOICES, RACK_TYPE_CHOICES, RACK_WIDTH_CHOICES, Rack, RackGroup, RackReservation, RackRole, - RACK_WIDTH_19IN, RACK_WIDTH_23IN, Region, Site, STATUS_CHOICES, SUBDEVICE_ROLE_CHILD, SUBDEVICE_ROLE_PARENT, - VIRTUAL_IFACE_TYPES, + DeviceBay, DeviceBayTemplate, CONNECTION_STATUS_CHOICES, CONNECTION_STATUS_CONNECTED, ConsolePort, + ConsolePortTemplate, ConsoleServerPort, ConsoleServerPortTemplate, Device, DeviceRole, DeviceType, Interface, + IFACE_FF_CHOICES, IFACE_FF_LAG, IFACE_ORDERING_CHOICES, InterfaceConnection, InterfaceTemplate, Manufacturer, + InventoryItem, Platform, PowerOutlet, PowerOutletTemplate, PowerPort, PowerPortTemplate, RACK_FACE_CHOICES, + RACK_TYPE_CHOICES, RACK_WIDTH_CHOICES, Rack, RackGroup, RackReservation, RackRole, RACK_WIDTH_19IN, RACK_WIDTH_23IN, + Region, Site, STATUS_CHOICES, SUBDEVICE_ROLE_CHILD, SUBDEVICE_ROLE_PARENT, VIRTUAL_IFACE_TYPES, ) @@ -265,8 +264,12 @@ class RackCSVForm(forms.ModelForm): class Meta: model = Rack fields = [ - 'site', 'group', 'name', 'facility_id', 'tenant', 'role', 'type', 'width', 'u_height', 'desc_units', + 'site', 'group_name', 'name', 'facility_id', 'tenant', 'role', 'type', 'width', 'u_height', 'desc_units', ] + help_texts = { + 'name': 'Rack name', + 'u_height': 'Height in rack units', + } def clean(self): @@ -705,13 +708,13 @@ class BaseDeviceCSVForm(forms.ModelForm): manufacturer = forms.ModelChoiceField( queryset=Manufacturer.objects.all(), to_field_name='name', - help_text='Manufacturer name', + help_text='Device type manufacturer', error_messages={ 'invalid_choice': 'Invalid manufacturer.', } ) model_name = forms.CharField( - help_text='Model name' + help_text='Device type model name' ) platform = forms.ModelChoiceField( queryset=Platform.objects.all(), @@ -757,7 +760,7 @@ class DeviceCSVForm(BaseDeviceCSVForm): ) rack_group = forms.CharField( required=False, - help_text='Name of parent rack\'s group' + help_text='Parent rack\'s group (if any)' ) rack_name = forms.CharField( required=False, @@ -774,6 +777,9 @@ class DeviceCSVForm(BaseDeviceCSVForm): 'name', 'device_role', 'tenant', 'manufacturer', 'model_name', 'platform', 'serial', 'asset_tag', 'status', 'site', 'rack_group', 'rack_name', 'position', 'face', ] + help_texts = { + 'name': 'Device name', + } def clean(self): @@ -826,10 +832,11 @@ class ChildDeviceCSVForm(BaseDeviceCSVForm): if parent and device_bay_name: try: self.instance.parent_bay = DeviceBay.objects.get(device=parent, name=device_bay_name) + # Inherit site and rack from parent device + self.instance.site = parent.site + self.instance.rack = parent.rack except DeviceBay.DoesNotExist: - self.add_error( - 'device_bay_name', "Parent device/bay ({} {}) not found".format(parent, device_bay_name) - ) + raise forms.ValidationError("Parent device/bay ({} {}) not found".format(parent, device_bay_name)) class DeviceBulkEditForm(BootstrapMixin, CustomFieldBulkEditForm): diff --git a/netbox/dcim/views.py b/netbox/dcim/views.py index 9a7654808..01957ccbb 100644 --- a/netbox/dcim/views.py +++ b/netbox/dcim/views.py @@ -877,18 +877,17 @@ class ChildDeviceBulkImportView(PermissionRequiredMixin, BulkImportView): template_name = 'dcim/device_import_child.html' default_return_url = 'dcim:device_list' - def save_obj(self, obj): + def _save_obj(self, obj_form): - # Inherit site and rack from parent device - obj.site = obj.parent_bay.device.site - obj.rack = obj.parent_bay.device.rack - obj.save() + obj = obj_form.save() - # Save the reverse relation + # Save the reverse relation to the parent device bay device_bay = obj.parent_bay device_bay.installed_device = obj device_bay.save() + return obj + class DeviceBulkEditView(PermissionRequiredMixin, BulkEditView): permission_required = 'dcim.change_device' From 08315fdab06fa3d668652924a6eeb6cb62e4c4b5 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Wed, 7 Jun 2017 15:33:10 -0400 Subject: [PATCH 30/36] Removed obsolete validation from InterfaceConnectionCSVForm --- netbox/dcim/forms.py | 4 ---- 1 file changed, 4 deletions(-) diff --git a/netbox/dcim/forms.py b/netbox/dcim/forms.py index 20dd6a9a1..40452172b 100644 --- a/netbox/dcim/forms.py +++ b/netbox/dcim/forms.py @@ -1672,10 +1672,6 @@ class InterfaceConnectionCSVForm(forms.ModelForm): return interface - def clean_connection_status(self): - - return True if self.cleaned_data['connection_status'] == 'connected' else False - class InterfaceConnectionDeletionForm(BootstrapMixin, forms.Form): confirm = forms.BooleanField(required=True) From 2512e01df49606155caa86ca4ea5cc94834b76ee Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Wed, 7 Jun 2017 15:51:11 -0400 Subject: [PATCH 31/36] Converted device fields to use FlexibleModelChoiceField; misc cleanup --- netbox/dcim/forms.py | 25 +++++++++++++------------ netbox/ipam/forms.py | 26 +++++++++++++++++--------- netbox/secrets/forms.py | 9 ++++++--- 3 files changed, 36 insertions(+), 24 deletions(-) diff --git a/netbox/dcim/forms.py b/netbox/dcim/forms.py index 40452172b..996c231c8 100644 --- a/netbox/dcim/forms.py +++ b/netbox/dcim/forms.py @@ -125,6 +125,7 @@ class SiteCSVForm(forms.ModelForm): 'contact_name', 'contact_phone', 'contact_email', 'comments', ] help_texts = { + 'name': 'Site name', 'slug': 'URL-friendly slug', 'asn': '32-bit autonomous system number', } @@ -733,6 +734,9 @@ class BaseDeviceCSVForm(forms.ModelForm): class Meta: fields = [] model = Device + help_texts = { + 'name': 'Device name', + } def clean(self): @@ -777,9 +781,6 @@ class DeviceCSVForm(BaseDeviceCSVForm): 'name', 'device_role', 'tenant', 'manufacturer', 'model_name', 'platform', 'serial', 'asset_tag', 'status', 'site', 'rack_group', 'rack_name', 'position', 'face', ] - help_texts = { - 'name': 'Device name', - } def clean(self): @@ -806,7 +807,7 @@ class ChildDeviceCSVForm(BaseDeviceCSVForm): parent = FlexibleModelChoiceField( queryset=Device.objects.all(), to_field_name='name', - help_text='Name of parent device', + help_text='Name or ID of parent device', error_messages={ 'invalid_choice': 'Parent device not found.', } @@ -938,7 +939,7 @@ class ConsoleConnectionCSVForm(forms.ModelForm): console_server = FlexibleModelChoiceField( queryset=Device.objects.filter(device_type__is_console_server=True), to_field_name='name', - help_text='Console server name or PK', + help_text='Console server name or ID', error_messages={ 'invalid_choice': 'Console server not found', } @@ -949,7 +950,7 @@ class ConsoleConnectionCSVForm(forms.ModelForm): device = FlexibleModelChoiceField( queryset=Device.objects.all(), to_field_name='name', - help_text='Device name or PK', + help_text='Device name or ID', error_messages={ 'invalid_choice': 'Device not found', } @@ -1195,7 +1196,7 @@ class PowerConnectionCSVForm(forms.ModelForm): pdu = FlexibleModelChoiceField( queryset=Device.objects.filter(device_type__is_pdu=True), to_field_name='name', - help_text='PDU name or PK', + help_text='PDU name or ID', error_messages={ 'invalid_choice': 'PDU not found.', } @@ -1206,7 +1207,7 @@ class PowerConnectionCSVForm(forms.ModelForm): device = FlexibleModelChoiceField( queryset=Device.objects.all(), to_field_name='name', - help_text='Device name or PK', + help_text='Device name or ID', error_messages={ 'invalid_choice': 'Device not found', } @@ -1602,20 +1603,20 @@ class InterfaceConnectionCSVForm(forms.ModelForm): device_a = FlexibleModelChoiceField( queryset=Device.objects.all(), to_field_name='name', - help_text='Device name or PK', + help_text='Name or ID of device A', error_messages={'invalid_choice': 'Device A not found.'} ) interface_a = forms.CharField( - help_text='Interface name' + help_text='Name of interface A' ) device_b = FlexibleModelChoiceField( queryset=Device.objects.all(), to_field_name='name', - help_text='Device name or PK', + help_text='Name or ID of device B', error_messages={'invalid_choice': 'Device B not found.'} ) interface_b = forms.CharField( - help_text='Interface name' + help_text='Name of interface B' ) connection_status = CSVChoiceField( choices=CONNECTION_STATUS_CHOICES, diff --git a/netbox/ipam/forms.py b/netbox/ipam/forms.py index 0ea10c838..82e489fa8 100644 --- a/netbox/ipam/forms.py +++ b/netbox/ipam/forms.py @@ -9,7 +9,8 @@ from tenancy.forms import TenancyForm from tenancy.models import Tenant from utilities.forms import ( APISelect, BootstrapMixin, BulkEditNullBooleanSelect, ChainedModelChoiceField, CSVChoiceField, - ExpandableIPAddressField, FilterChoiceField, Livesearch, ReturnURLForm, SlugField, add_blank_choice, + ExpandableIPAddressField, FilterChoiceField, FlexibleModelChoiceField, Livesearch, ReturnURLForm, SlugField, + add_blank_choice, ) from .models import ( Aggregate, IPAddress, IPADDRESS_STATUS_CHOICES, Prefix, PREFIX_STATUS_CHOICES, RIR, Role, Service, VLAN, @@ -61,6 +62,9 @@ class VRFCSVForm(forms.ModelForm): class Meta: model = VRF fields = ['name', 'rd', 'tenant', 'enforce_unique', 'description'] + help_texts = { + 'name': 'VRF name', + } class VRFBulkEditForm(BootstrapMixin, CustomFieldBulkEditForm): @@ -239,13 +243,13 @@ class PrefixCSVForm(forms.ModelForm): ) status = CSVChoiceField( choices=IPADDRESS_STATUS_CHOICES, - help_text='Status name' + help_text='Operational status' ) role = forms.ModelChoiceField( queryset=Role.objects.all(), required=False, to_field_name='name', - help_text='Role name', + help_text='Functional role', error_messages={ 'invalid_choice': 'Invalid role.', } @@ -558,13 +562,13 @@ class IPAddressCSVForm(forms.ModelForm): ) status = CSVChoiceField( choices=PREFIX_STATUS_CHOICES, - help_text='Status name' + help_text='Operational status' ) - device = forms.ModelChoiceField( + device = FlexibleModelChoiceField( queryset=Device.objects.all(), required=False, to_field_name='name', - help_text='Name of assigned Device', + help_text='Name or ID of assigned device', error_messages={ 'invalid_choice': 'Device not found.', } @@ -574,7 +578,7 @@ class IPAddressCSVForm(forms.ModelForm): required=False ) is_primary = forms.BooleanField( - help_text='This is the primary IP for the assigned device', + help_text='Make this the primary IP for the assigned device', required=False ) @@ -743,13 +747,13 @@ class VLANCSVForm(forms.ModelForm): ) status = CSVChoiceField( choices=VLAN_STATUS_CHOICES, - help_text='Status name' + help_text='Operational status' ) role = forms.ModelChoiceField( queryset=Role.objects.all(), required=False, to_field_name='name', - help_text='Name of assigned role', + help_text='Functional role', error_messages={ 'invalid_choice': 'Invalid role.', } @@ -758,6 +762,10 @@ class VLANCSVForm(forms.ModelForm): class Meta: model = VLAN fields = ['site', 'group_name', 'vid', 'name', 'tenant', 'status', 'role', 'description'] + help_texts = { + 'vid': 'Numeric VLAN ID (1-4095)', + 'name': 'VLAN name', + } def clean(self): diff --git a/netbox/secrets/forms.py b/netbox/secrets/forms.py index 4a2a75abf..aafa9c4b1 100644 --- a/netbox/secrets/forms.py +++ b/netbox/secrets/forms.py @@ -7,7 +7,7 @@ from django import forms from django.db.models import Count from dcim.models import Device -from utilities.forms import BootstrapMixin, BulkEditForm, CSVDataField, FilterChoiceField, SlugField +from utilities.forms import BootstrapMixin, BulkEditForm, FilterChoiceField, FlexibleModelChoiceField, SlugField from .models import Secret, SecretRole, UserKey @@ -66,10 +66,10 @@ class SecretForm(BootstrapMixin, forms.ModelForm): class SecretCSVForm(forms.ModelForm): - device = forms.ModelChoiceField( + device = FlexibleModelChoiceField( queryset=Device.objects.all(), to_field_name='name', - help_text='Device name', + help_text='Device name or ID', error_messages={ 'invalid_choice': 'Device not found.', } @@ -89,6 +89,9 @@ class SecretCSVForm(forms.ModelForm): class Meta: model = Secret fields = ['device', 'role', 'name', 'plaintext'] + help_texts = { + 'name': 'Name or username', + } def save(self, *args, **kwargs): s = super(SecretCSVForm, self).save(*args, **kwargs) From a578d4d3c0e8869820dc21491edce9c5e18b6fe1 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Wed, 7 Jun 2017 15:54:48 -0400 Subject: [PATCH 32/36] Layout tweaks --- netbox/templates/utilities/obj_import.html | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/netbox/templates/utilities/obj_import.html b/netbox/templates/utilities/obj_import.html index 22e06f6ef..7c331a2ef 100644 --- a/netbox/templates/utilities/obj_import.html +++ b/netbox/templates/utilities/obj_import.html @@ -6,7 +6,7 @@

    {% block title %}{{ obj_type|bettertitle }} Import{% endblock %}

    {% block tabs %}{% endblock %}
    -
    +
    {% if form.non_field_errors %}
    Errors
    @@ -28,9 +28,9 @@
    -
    +
    {% if fields %} -

    CSV Format

    +

    CSV Format

    From 12d13c67deb6cb2a9d211248696c162ba98069e8 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Wed, 7 Jun 2017 15:56:59 -0400 Subject: [PATCH 33/36] PEP8 fix --- netbox/dcim/forms.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/netbox/dcim/forms.py b/netbox/dcim/forms.py index 996c231c8..6aef5808c 100644 --- a/netbox/dcim/forms.py +++ b/netbox/dcim/forms.py @@ -255,7 +255,7 @@ class RackCSVForm(forms.ModelForm): help_text='Rack type' ) width = forms.ChoiceField( - choices = ( + choices=( (RACK_WIDTH_19IN, '19'), (RACK_WIDTH_23IN, '23'), ), From 8b0ace8618837f3cb0a269ac1b9df402ce5bc4d9 Mon Sep 17 00:00:00 2001 From: Markus Witt Date: Thu, 8 Jun 2017 10:58:30 +0200 Subject: [PATCH 34/36] upgrading.md: fix typo --- docs/installation/upgrading.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/installation/upgrading.md b/docs/installation/upgrading.md index 46b2252f7..6d0db728d 100644 --- a/docs/installation/upgrading.md +++ b/docs/installation/upgrading.md @@ -64,7 +64,7 @@ This script: Your models have changes that are not yet reflected in a migration, and so won't be applied. Run 'manage.py makemigrations' to make new migrations, and then re-run 'manage.py migrate' to apply them. - This may occur due to semantic differences in environment, and can be safely ignored. Never attempt to create new migrations unless you are inentionally modifying the database schema. + This may occur due to semantic differences in environment, and can be safely ignored. Never attempt to create new migrations unless you are intentionally modifying the database schema. # Restart the WSGI Service From 1bf319fae20024684548238f08c87e2803cc10c0 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Thu, 8 Jun 2017 10:02:16 -0400 Subject: [PATCH 35/36] Fixed formatting and typos --- docs/installation/ldap.md | 28 +++++++++++++--------------- 1 file changed, 13 insertions(+), 15 deletions(-) diff --git a/docs/installation/ldap.md b/docs/installation/ldap.md index 729e02ff4..2555ccb12 100644 --- a/docs/installation/ldap.md +++ b/docs/installation/ldap.md @@ -1,5 +1,4 @@ -This guide explains how to implement LDAP authentication using an external server. User authentication will fall back to -built-in Django users in the event of a failure. +This guide explains how to implement LDAP authentication using an external server. User authentication will fall back to built-in Django users in the event of a failure. # Requirements @@ -49,6 +48,7 @@ AUTH_LDAP_BIND_PASSWORD = "demo" # ldap.set_option(ldap.OPT_X_TLS_REQUIRE_CERT, ldap.OPT_X_TLS_NEVER) LDAP_IGNORE_CERT_ERRORS = True ``` + !!! info When using Windows Server 2012 you may need to specify a port on AUTH_LDAP_SERVER_URI - 3269 for secure, 3268 for non-secure. @@ -72,6 +72,7 @@ AUTH_LDAP_USER_ATTR_MAP = { "last_name": "sn" } ``` + !!! info When using Windows Server 2012 AUTH_LDAP_USER_DN_TEMPLATE should be set to None. @@ -104,19 +105,16 @@ AUTH_LDAP_CACHE_GROUPS = True AUTH_LDAP_GROUP_CACHE_TIMEOUT = 3600 ``` -!!! info -"is_active" - You must map all users to at least this group if you want their account to be treated as enabled. Without this, your users cannot log in. - -"is_staff" - Users mapped to this group are enabled for access to the Administration tools; this is the equivalent of checking the "Staff status" box on a manually created user. This doesn't necessarily imply additional privileges, which still needed to be assigned via a group, or on a per-user basis. - -"is_superuser" - Users mapped to this group in addition to the "is_staff" group will be assumed to have full permissions to all modules. Without also being mapped to "is_staff", this group observably has no impact to your effective permissions. +* `is_active` - All users must be mapped to at least this group to enable authentication. Without this, users cannot log in. +* `is_staff` - Users mapped to this group are enabled for access to the administration tools; this is the equivalent of checking the "staff status" box on a manually created user. This doesn't grant any specific permissions. +* `is_superuser` - Users mapped to this group will be granted superuser status. Superusers are implicitly granted all permissions. !!! info -It is also possible map user attributes to Django attributes: + It is also possible map user attributes to Django attributes: -```no-highlight -AUTH_LDAP_USER_ATTR_MAP = { -"first_name": "givenName", -"last_name": "sn" -} -``` + ```no-highlight + AUTH_LDAP_USER_ATTR_MAP = { + "first_name": "givenName", + "last_name": "sn" + } + ``` From 481b52545e971abe240a7fd86da4906f51cf5305 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Thu, 8 Jun 2017 10:05:26 -0400 Subject: [PATCH 36/36] Release v2.0.5 --- 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 acdf8e38b..4228f1b27 100644 --- a/netbox/netbox/settings.py +++ b/netbox/netbox/settings.py @@ -13,7 +13,7 @@ except ImportError: ) -VERSION = '2.0.5-dev' +VERSION = '2.0.5' # Import local configuration ALLOWED_HOSTS = DATABASE = SECRET_KEY = None
    Field