mirror of
https://github.com/netbox-community/netbox.git
synced 2024-05-10 07:54:54 +00:00
126 lines
4.2 KiB
Python
126 lines
4.2 KiB
Python
from django import forms
|
|
from django.contrib.contenttypes.models import ContentType
|
|
from django.db.models import Q
|
|
|
|
from extras.choices import *
|
|
from extras.models import *
|
|
from utilities.forms import BulkEditForm, CSVModelForm
|
|
|
|
__all__ = (
|
|
'CustomFieldModelCSVForm',
|
|
'CustomFieldModelBulkEditForm',
|
|
'CustomFieldModelFilterForm',
|
|
'CustomFieldModelForm',
|
|
'CustomFieldsMixin',
|
|
)
|
|
|
|
|
|
class CustomFieldsMixin:
|
|
"""
|
|
Extend a Form to include custom field support.
|
|
"""
|
|
def __init__(self, *args, **kwargs):
|
|
self.custom_fields = []
|
|
|
|
super().__init__(*args, **kwargs)
|
|
|
|
self._append_customfield_fields()
|
|
|
|
def _get_content_type(self):
|
|
"""
|
|
Return the ContentType of the form's model.
|
|
"""
|
|
if not hasattr(self, 'model'):
|
|
raise NotImplementedError(f"{self.__class__.__name__} must specify a model class.")
|
|
return ContentType.objects.get_for_model(self.model)
|
|
|
|
def _get_form_field(self, customfield):
|
|
return customfield.to_form_field()
|
|
|
|
def _append_customfield_fields(self):
|
|
"""
|
|
Append form fields for all CustomFields assigned to this object type.
|
|
"""
|
|
content_type = self._get_content_type()
|
|
|
|
# Append form fields; assign initial values if modifying and existing object
|
|
for customfield in CustomField.objects.filter(content_types=content_type):
|
|
field_name = f'cf_{customfield.name}'
|
|
self.fields[field_name] = self._get_form_field(customfield)
|
|
|
|
# Annotate the field in the list of CustomField form fields
|
|
self.custom_fields.append(field_name)
|
|
|
|
|
|
class CustomFieldModelForm(CustomFieldsMixin, forms.ModelForm):
|
|
"""
|
|
Extend ModelForm to include custom field support.
|
|
"""
|
|
def _get_content_type(self):
|
|
return ContentType.objects.get_for_model(self._meta.model)
|
|
|
|
def _get_form_field(self, customfield):
|
|
if self.instance.pk:
|
|
form_field = customfield.to_form_field(set_initial=False)
|
|
form_field.initial = self.instance.custom_field_data.get(customfield.name, None)
|
|
return form_field
|
|
|
|
return customfield.to_form_field()
|
|
|
|
def clean(self):
|
|
|
|
# Save custom field data on instance
|
|
for cf_name in self.custom_fields:
|
|
key = cf_name[3:] # Strip "cf_" from field name
|
|
value = self.cleaned_data.get(cf_name)
|
|
empty_values = self.fields[cf_name].empty_values
|
|
# Convert "empty" values to null
|
|
self.instance.custom_field_data[key] = value if value not in empty_values else None
|
|
|
|
return super().clean()
|
|
|
|
|
|
class CustomFieldModelCSVForm(CSVModelForm, CustomFieldModelForm):
|
|
|
|
def _get_form_field(self, customfield):
|
|
return customfield.to_form_field(for_csv_import=True)
|
|
|
|
|
|
class CustomFieldModelBulkEditForm(BulkEditForm):
|
|
|
|
def __init__(self, *args, **kwargs):
|
|
super().__init__(*args, **kwargs)
|
|
|
|
self.custom_fields = []
|
|
self.obj_type = ContentType.objects.get_for_model(self.model)
|
|
|
|
# Add all applicable CustomFields to the form
|
|
custom_fields = CustomField.objects.filter(content_types=self.obj_type)
|
|
for cf in custom_fields:
|
|
# Annotate non-required custom fields as nullable
|
|
if not cf.required:
|
|
self.nullable_fields.append(cf.name)
|
|
self.fields[cf.name] = cf.to_form_field(set_initial=False, enforce_required=False)
|
|
# Annotate this as a custom field
|
|
self.custom_fields.append(cf.name)
|
|
|
|
|
|
class CustomFieldModelFilterForm(forms.Form):
|
|
|
|
def __init__(self, *args, **kwargs):
|
|
|
|
self.obj_type = ContentType.objects.get_for_model(self.model)
|
|
|
|
super().__init__(*args, **kwargs)
|
|
|
|
# Add all applicable CustomFields to the form
|
|
self.custom_field_filters = []
|
|
custom_fields = CustomField.objects.filter(content_types=self.obj_type).exclude(
|
|
Q(filter_logic=CustomFieldFilterLogicChoices.FILTER_DISABLED) |
|
|
Q(type=CustomFieldTypeChoices.TYPE_JSON)
|
|
)
|
|
for cf in custom_fields:
|
|
field_name = f'cf_{cf.name}'
|
|
self.fields[field_name] = cf.to_form_field(set_initial=True, enforce_required=False)
|
|
self.custom_field_filters.append(field_name)
|