netbox/netbox/extras/filters.py

import django_filters

from django.contrib.contenttypes.models import ContentType

from .models import CF_TYPE_SELECT, CustomField


class CustomFieldFilter(django_filters.Filter):
    """
    Filter objects by the presence of a CustomFieldValue. The filter's name is used as the CustomField name.
    """

    def __init__(self, cf_type, *args, **kwargs):
        self.cf_type = cf_type
        super(CustomFieldFilter, self).__init__(*args, **kwargs)

    def filter(self, queryset, value):
        # Skip filter on empty value
        if not value.strip():
            return queryset
        # Treat 0 as None for Select fields
        try:
            if self.cf_type == CF_TYPE_SELECT and int(value) == 0:
                return queryset.exclude(
                    custom_field_values__field__name=self.name,
                )
        except ValueError:
            pass
        return queryset.filter(
            custom_field_values__field__name=self.name,
            custom_field_values__serialized_value=value,
        )


class CustomFieldFilterSet(django_filters.FilterSet):
    """
    Dynamically add a Filter for each CustomField applicable to the parent model.
    """

    def __init__(self, *args, **kwargs):
        super(CustomFieldFilterSet, self).__init__(*args, **kwargs)

        obj_type = ContentType.objects.get_for_model(self._meta.model)
        custom_fields = CustomField.objects.filter(obj_type=obj_type, is_filterable=True)
        for cf in custom_fields:
            self.filters['cf_{}'.format(cf.name)] = CustomFieldFilter(name=cf.name, cf_type=cf.type)