Npl 379 import (#160)

Author: arthanson

netbox_custom_objects/field_types.py

@@ -14,7 +14,8 @@
 from django.utils.translation import gettext_lazy as _
 from extras.choices import CustomFieldTypeChoices, CustomFieldUIEditableChoices
 from utilities.api import get_serializer_for_model
-from utilities.forms.fields import (CSVChoiceField, CSVMultipleChoiceField,
+from utilities.forms.fields import (CSVChoiceField, CSVModelChoiceField,
+                                    CSVModelMultipleChoiceField, CSVMultipleChoiceField,
                                     DynamicChoiceField,
                                     DynamicMultipleChoiceField, JSONField,
                                     LaxURLField)
@@ -357,7 +358,6 @@ def get_form_field(self, field, for_csv_import=False, **kwargs):
         """
         content_type = ContentType.objects.get(pk=field.related_object_type_id)
 
-        from utilities.forms.fields import DynamicModelChoiceField
         if content_type.app_label == APP_LABEL:
             # This is a custom object type
             from netbox_custom_objects.models import CustomObjectType
@@ -367,24 +367,34 @@ def get_form_field(self, field, for_csv_import=False, **kwargs):
             )
             custom_object_type = CustomObjectType.objects.get(pk=custom_object_type_id)
             model = custom_object_type.get_model()
-            field_class = DynamicModelChoiceField
         else:
             # This is a regular NetBox model
             model = content_type.model_class()
 
+        if for_csv_import:
+            field_class = CSVModelChoiceField
+            # For CSV import, determine to_field_name from the field configuration
+            to_field_name = getattr(field, 'to_field_name', None) or 'name'
+            return field_class(
+                queryset=model.objects.all(),
+                required=field.required,
+                initial=field.default,
+                to_field_name=to_field_name,
+            )
+        else:
+            from utilities.forms.fields import DynamicModelChoiceField
             field_class = DynamicModelChoiceField
-
-        return field_class(
-            queryset=model.objects.all(),
-            required=field.required,
-            initial=field.default,
-            query_params=(
-                field.related_object_filter
-                if hasattr(field, "related_object_filter")
-                else None
-            ),
-            selector=True,
-        )
+            return field_class(
+                queryset=model.objects.all(),
+                required=field.required,
+                initial=field.default,
+                query_params=(
+                    field.related_object_filter
+                    if hasattr(field, "related_object_filter")
+                    else None
+                ),
+                selector=True,
+            )
 
     def get_filterform_field(self, field, **kwargs):
         return None
@@ -658,19 +668,30 @@ def get_form_field(self, field, for_csv_import=False, **kwargs):
             # This is a regular NetBox model
             model = content_type.model_class()
 
-        from utilities.forms.fields import DynamicModelMultipleChoiceField
-
-        return DynamicModelMultipleChoiceField(
-            queryset=model.objects.all(),
-            required=field.required,
-            initial=field.default,
-            query_params=(
-                field.related_object_filter
-                if hasattr(field, "related_object_filter")
-                else None
-            ),
-            selector=True,
-        )
+        if for_csv_import:
+            field_class = CSVModelMultipleChoiceField
+            # For CSV import, determine to_field_name from the field configuration
+            to_field_name = getattr(field, 'to_field_name', None) or 'name'
+            return field_class(
+                queryset=model.objects.all(),
+                required=field.required,
+                initial=field.default,
+                to_field_name=to_field_name,
+            )
+        else:
+            from utilities.forms.fields import DynamicModelMultipleChoiceField
+            field_class = DynamicModelMultipleChoiceField
+            return field_class(
+                queryset=model.objects.all(),
+                required=field.required,
+                initial=field.default,
+                query_params=(
+                    field.related_object_filter
+                    if hasattr(field, "related_object_filter")
+                    else None
+                ),
+                selector=True,
+            )
 
     def get_filterform_field(self, field, **kwargs):
         return None

netbox_custom_objects/templates/netbox_custom_objects/custom_object_list.html

@@ -7,7 +7,7 @@
     {% plugin_list_buttons model %}
     {% block extra_controls %}{% endblock %}
     {% custom_object_add_button model custom_object_type %}
-    {# {% custom_object_import_button model %} #}
+    {% custom_object_import_button model custom_object_type %}
     {% custom_object_export_button model %}
   </div>
 {% endblock controls %}

netbox_custom_objects/templatetags/custom_object_buttons.py

@@ -203,9 +203,12 @@ def custom_object_add_button(model, custom_object_type, action="add"):
 
 
 @register.inclusion_tag("buttons/import.html")
-def custom_object_import_button(model, action="bulk_import"):
+def custom_object_import_button(model, custom_object_type, action="bulk_import"):
     try:
-        url = reverse(get_viewname(model, action))
+        viewname = get_viewname(model, action)
+        url = reverse(
+            viewname, kwargs={"custom_object_type": custom_object_type.name.lower()}
+        )
     except NoReverseMatch:
         url = None
 

netbox_custom_objects/urls.py

@@ -49,6 +49,11 @@
         views.CustomObjectBulkDeleteView.as_view(),
         name="customobject_bulk_delete",
     ),
+    path(
+        "<str:custom_object_type>/bulk-import/",
+        views.CustomObjectBulkImportView.as_view(),
+        name="customobject_bulk_import",
+    ),
     path(
         "<str:custom_object_type>/<int:pk>/",
         views.CustomObjectView.as_view(),

netbox_custom_objects/views.py

@@ -14,7 +14,11 @@
 from extras.models import JournalEntry
 from extras.tables import JournalEntryTable
 from netbox.filtersets import BaseFilterSet
-from netbox.forms import NetBoxModelBulkEditForm, NetBoxModelFilterSetForm
+from netbox.forms import (
+    NetBoxModelBulkEditForm,
+    NetBoxModelFilterSetForm,
+    NetBoxModelImportForm,
+)
 from netbox.views import generic
 from netbox.views.generic.mixins import TableMixin
 from utilities.forms import ConfirmationForm
@@ -31,7 +35,7 @@
 from . import field_types, filtersets, forms, tables
 from .models import CustomObject, CustomObjectType, CustomObjectTypeField
 
-logger = logging.getLogger('netbox_custom_objects.views')
+logger = logging.getLogger("netbox_custom_objects.views")
 
 
 class CustomJournalEntryForm(JournalEntryForm):
@@ -123,7 +127,9 @@ def get_table(self, data, request, bulk_actions=True):
                 attrs[field.name] = field_type.get_table_column_field(field)
             except NotImplementedError:
                 logger.debug(
-                    "table mixin: {} field is not implemented; using a default column".format(field.name)
+                    "table mixin: {} field is not implemented; using a default column".format(
+                        field.name
+                    )
                 )
             # Define a method "render_table_column" method on any FieldType to customize output
             # See https://django-tables2.readthedocs.io/en/latest/pages/custom-data.html#table-render-foo-methods
@@ -568,8 +574,17 @@ def get_queryset(self, request):
         return model.objects.all()
 
     def get_form(self, queryset):
+        meta = type(
+            "Meta",
+            (),
+            {
+                "model": queryset.model,
+                "fields": "__all__",
+            },
+        )
+
         attrs = {
-            "model": queryset.model,
+            "Meta": meta,
             "__module__": "database.forms",
         }
 
@@ -578,7 +593,9 @@ def get_form(self, queryset):
             try:
                 attrs[field.name] = field_type.get_annotated_form_field(field)
             except NotImplementedError:
-                logger.debug("bulk edit form: {} field is not supported".format(field.name))
+                logger.debug(
+                    "bulk edit form: {} field is not supported".format(field.name)
+                )
 
         form = type(
             f"{queryset.model._meta.object_name}BulkEditForm",
@@ -612,6 +629,67 @@ def get_queryset(self, request):
         return model.objects.all()
 
 
+@register_model_view(CustomObject, "bulk_import", path="import", detail=False)
+class CustomObjectBulkImportView(generic.BulkImportView):
+    queryset = None
+    model_form = None
+
+    def get(self, request, custom_object_type):
+        # Necessary because get() in BulkImportView only takes request and no **kwargs
+        return super().get(request)
+
+    def post(self, request, custom_object_type):
+        # Necessary because post() in BulkImportView only takes request and no **kwargs
+        return super().post(request)
+
+    def setup(self, request, *args, **kwargs):
+        super().setup(request, *args, **kwargs)
+        self.queryset = self.get_queryset(request)
+        self.model_form = self.get_model_form(self.queryset)
+
+    def get_queryset(self, request):
+        if self.queryset:
+            return self.queryset
+        custom_object_type = self.kwargs.get("custom_object_type", None)
+        self.custom_object_type = CustomObjectType.objects.get(
+            name__iexact=custom_object_type
+        )
+        model = self.custom_object_type.get_model()
+        return model.objects.all()
+
+    def get_model_form(self, queryset):
+        meta = type(
+            "Meta",
+            (),
+            {
+                "model": queryset.model,
+                "fields": "__all__",
+            },
+        )
+
+        attrs = {
+            "Meta": meta,
+            "__module__": "database.forms",
+        }
+
+        for field in self.custom_object_type.fields.all():
+            field_type = field_types.FIELD_TYPE_CLASS[field.type]()
+            try:
+                attrs[field.name] = field_type.get_annotated_form_field(
+                    field, for_csv_import=True
+                )
+            except NotImplementedError:
+                print(f"bulk import form: {field.name} field is not supported")
+
+        form = type(
+            f"{queryset.model._meta.object_name}BulkImportForm",
+            (NetBoxModelImportForm,),
+            attrs,
+        )
+
+        return form
+
+
 class CustomObjectJournalView(ConditionalLoginRequiredMixin, View):
     """
     Custom journal view for CustomObject instances.