class SignalCategoryRemovedAfterFilterSet(FilterSet):
after = filters.IsoDateTimeFilter(field_name='category_assignment__created_at', lookup_expr='gte')
before = filters.IsoDateTimeFilter(field_name='category_assignment__created_at', lookup_expr='lte')
category_slug = filters.ModelMultipleChoiceFilter(
method='category_filter',
queryset=Category.objects.all(),
to_field_name='slug',
field_name='category_assignment__category__slug',
)
def category_filter(self, queryset, name, value):
# TODO: Get categories from user permissions, can be added after PR
# https://github.com/Amsterdam/signals/pull/202 has been approved and merged
if len(value):
# We need to check the given categories
categories_to_check = [v.id for v in value]
else:
# A list of category id's that the currently logged in user has permissions for
categories_to_check = Category.objects.all().values_list('id', flat=True)
return queryset.filter(
Q(category_assignment__isnull=False) &
Q(categories__id__in=categories_to_check) &
~Q(category_assignment__category_id__in=categories_to_check)
)
class SignalsOpenPerCategoryCountFilterSet(FilterSet):
start = filters.IsoDateTimeFilter(field_name='created_at',
lookup_expr='gte')
end = filters.IsoDateTimeFilter(field_name='created_at', lookup_expr='lte')
def filter_queryset(self, queryset):
queryset = queryset.exclude(status__state__in=[
workflow.AFGEHANDELD, workflow.GEANNULEERD, workflow.GESPLITST
]).filter(category_assignment__deadline_factor_3__lt=timezone.now())
return super().filter_queryset(queryset)
class SignalsReopenRequestedPerCategoryCountFilterSet(FilterSet):
start = filters.IsoDateTimeFilter(field_name='status__created_at',
lookup_expr='gte')
end = filters.IsoDateTimeFilter(field_name='status__created_at',
lookup_expr='lte')
def filter_queryset(self, queryset):
queryset = queryset.filter(
status__state=workflow.VERZOEK_TOT_HEROPENEN)
return super().filter_queryset(queryset)
class WorkerFilter(filterset.FilterSet):
name = filters.CharFilter()
last_heartbeat = filters.IsoDateTimeFilter()
online = filters.BooleanFilter(method='filter_online')
missing = filters.BooleanFilter(method='filter_missing')
class Meta:
model = Worker
fields = {
'name': NAME_FILTER_OPTIONS,
'last_heartbeat': DATETIME_FILTER_OPTIONS,
'online': ['exact'],
'missing': ['exact']
}
def filter_online(self, queryset, name, value):
online_workers = Worker.objects.online_workers()
if value:
return queryset.filter(pk__in=online_workers)
else:
return queryset.exclude(pk__in=online_workers)
def filter_missing(self, queryset, name, value):
missing_workers = Worker.objects.missing_workers()
if value:
return queryset.filter(pk__in=missing_workers)
else:
return queryset.exclude(pk__in=missing_workers)
class TaskFilter(filterset.FilterSet):
state = filters.CharFilter()
worker = HyperlinkRelatedFilter()
started_at = filters.IsoDateTimeFilter(name='started_at')
finished_at = filters.IsoDateTimeFilter(name='finished_at')
parent = HyperlinkRelatedFilter()
class Meta:
model = Task
fields = {
'state': ['exact', 'in'],
'worker': ['exact', 'in'],
'started_at': DATETIME_FILTER_OPTIONS,
'finished_at': DATETIME_FILTER_OPTIONS,
'parent': ['exact']
}
class SignalPromotedToParentFilter(FilterSet):
after = filters.IsoDateTimeFilter(method='after_filter')
def after_filter(self, queryset, name, value):
"""
Filters a Parent Signal on the created date of the first child Signal
"""
return queryset.annotate(
min_child_created_at=Min('children__created_at')).filter(
min_child_created_at__gte=value)
def filter_queryset(self, queryset):
queryset = super().filter_queryset(queryset=queryset)
# Only return Signals of categories that a user can access
return queryset.filter_for_user(user=self.request.user).distinct()
class ExporterFilter(filterset.FilterSet):
"""
Plugin exporter filter should:
- inherit from this class
- add any specific filters if needed
- define a `Meta` class which should:
- specify a plugin exporter model for which filter is defined
- extend `fields` with specific ones
"""
name = filters.CharFilter()
last_export = filters.IsoDateTimeFilter()
class Meta:
model = Exporter
fields = {
'name': NAME_FILTER_OPTIONS,
'last_export': DATETIME_FILTER_OPTIONS
}
class RepositoryVersionFilter(filterset.FilterSet):
# e.g.
# /?number=4
# /?number__range=4,6
# /?created__gte=2018-04-12T19:45
# /?created__range=2018-04-12T19:45,2018-04-13T20:00
# /?content=http://localhost:8000/pulp/api/v3/content/file/fb8ad2d0-03a8-4e36-a209-77763d4ed16c/
number = filters.NumberFilter()
created = filters.IsoDateTimeFilter()
content = RepositoryVersionContentFilter()
class Meta:
model = RepositoryVersion
fields = {
'number': ['exact', 'lt', 'lte', 'gt', 'gte', 'range'],
'created': DATETIME_FILTER_OPTIONS,
'content': ['exact', 'in']
}
class SignalFilterSet(FilterSet):
id = filters.NumberFilter()
address_text = filters.CharFilter(field_name='location__address_text', lookup_expr='icontains')
area_code = filters.ChoiceFilter(field_name='location__area_code', choices=area_choices)
area_type_code = filters.ChoiceFilter(field_name='location__area_type_code', choices=area_type_choices)
buurt_code = filters.MultipleChoiceFilter(field_name='location__buurt_code', choices=buurt_choices)
category_id = filters.MultipleChoiceFilter(field_name='category_assignment__category_id',
choices=category_choices)
category_slug = filters.ModelMultipleChoiceFilter(
queryset=_get_child_category_queryset(),
to_field_name='slug',
field_name='category_assignment__category__slug',
)
contact_details = filters.MultipleChoiceFilter(method='contact_details_filter', choices=contact_details_choices)
created_before = filters.IsoDateTimeFilter(field_name='created_at', lookup_expr='lte')
directing_department = filters.MultipleChoiceFilter(
method='directing_department_filter',
choices=department_choices
)
created_after = filters.IsoDateTimeFilter(field_name='created_at', lookup_expr='gte')
feedback = filters.ChoiceFilter(method='feedback_filter', choices=feedback_choices)
has_changed_children = filters.MultipleChoiceFilter(method='has_changed_children_filter', choices=boolean_choices)
kind = filters.MultipleChoiceFilter(method='kind_filter', choices=kind_choices) # SIG-2636
incident_date = filters.DateFilter(field_name='incident_date_start', lookup_expr='date')
incident_date_before = filters.DateFilter(field_name='incident_date_start', lookup_expr='date__gte')
incident_date_after = filters.DateFilter(field_name='incident_date_start', lookup_expr='date__lte')
maincategory_slug = filters.ModelMultipleChoiceFilter(
queryset=_get_parent_category_queryset(),
to_field_name='slug',
field_name='category_assignment__category__parent__slug',
)
note_keyword = filters.CharFilter(method='note_keyword_filter')
priority = filters.MultipleChoiceFilter(field_name='priority__priority', choices=Priority.PRIORITY_CHOICES)
source = filters.MultipleChoiceFilter(choices=source_choices)
stadsdeel = filters.MultipleChoiceFilter(field_name='location__stadsdeel', choices=stadsdelen_choices)
status = filters.MultipleChoiceFilter(field_name='status__state', choices=status_choices)
type = filters.MultipleChoiceFilter(field_name='type_assignment__name', choices=Type.CHOICES)
updated_before = filters.IsoDateTimeFilter(field_name='updated_at', lookup_expr='lte')
updated_after = filters.IsoDateTimeFilter(field_name='updated_at', lookup_expr='gte')
def _cleanup_form_data(self):
"""
Cleanup the form data
"""
self.form.cleaned_data.pop('category_slug', None)
self.form.cleaned_data.pop('maincategory_slug', None)
if not self.form.cleaned_data.get('area_code', None) or not self.form.cleaned_data.get('area_type_code', None):
self.form.cleaned_data.pop('area_code', None)
self.form.cleaned_data.pop('area_type_code', None)
def filter_queryset(self, queryset):
"""
Add custom category filtering to the filter_queryset
"""
if not self.form.cleaned_data['category_id']:
main_categories = self.form.cleaned_data['maincategory_slug']
sub_categories = self.form.cleaned_data['category_slug']
if main_categories or sub_categories:
queryset = queryset.filter(
Q(category_assignment__category__parent_id__in=[c.pk for c in main_categories]) |
Q(category_assignment__category_id__in=[c.pk for c in sub_categories])
)
self._cleanup_form_data()
queryset = super(SignalFilterSet, self).filter_queryset(queryset=queryset)
return queryset.distinct()
# Custom filter functions
def contact_details_filter(self, queryset, name, value):
"""
Filter `signals.Signal` instances according to presence of contact details.
"""
choices = value # we have a MultipleChoiceFilter ...
# Deal with all choices selected, or none selected:
if len(choices) == len(contact_details_choices()):
# No filters are present, or ... all filters are present. In that
# case we want all Signal instances with an email address, or a
# phone number, or none of those (according to) the UX design.
# This is the same as not filtering, hence in both cases just
# return the queryset.
return queryset
# Set-up our Q objects for the individual options.
has_no_email = (Q(reporter__email__isnull=True) | Q(reporter__email=''))
has_no_phone = (Q(reporter__phone__isnull=True) | Q(reporter__phone=''))
is_anonymous = has_no_email & has_no_phone
q_objects = {
'email': ~has_no_email,
'phone': ~has_no_phone,
'none': is_anonymous,
}
# The individual choices have to be combined using logical OR:
q_total = q_objects[choices.pop()]
while choices:
q_total |= q_objects[choices.pop()]
return queryset.filter(q_total)
def directing_department_filter(self, queryset, name, value):
"""
Filter Signals on directing department.
* A directing department can only be set on a Parent Signal
* When providing the option "null" select all parent Signals without one or more directing departments
* When providing on or more department codes as options select all parent Signals which match directing
departments
Example 1: "?directing_department=ASC" will select all parent Signals where ASC is the directing department
Example 2: "?directing_department=ASC&directing_department=null" will select all parent Signals without a
directing department OR ASC as the directing department
Example 3: "?directing_department=null" will select all parent Signals without a directing department
"""
choices = value # we have a MultipleChoiceFilter ...
if len(choices) == len(department_choices()):
# No filters are present, or ... all filters are present. In that case we want all Signal instances
return queryset
# Directing departments are only set on parent Signals
parent_q_filter = (Q(parent__isnull=True) & Q(children__isnull=False))
if 'null' in choices and len(choices) == 1:
# "?directing_department=null" will select all parent Signals without a directing department
return queryset.filter(
parent_q_filter &
(
Q(directing_departments_assignment__isnull=True) |
Q(directing_departments_assignment__departments__isnull=True)
)
)
elif 'null' in choices and len(choices) > 1:
# "?directing_department=ASC&directing_department=null" will select all parent Signals without a directing
# department OR ASC as the directing department
choices.pop(choices.index('null'))
return queryset.filter(
parent_q_filter & (
Q(directing_departments_assignment__isnull=True) |
Q(directing_departments_assignment__departments__isnull=True) |
Q(directing_departments_assignment__departments__code__in=choices)
)
)
elif len(choices):
# "?directing_department=ASC" will select all parent Signals where ASC is the directing department
return queryset.filter(
parent_q_filter &
Q(directing_departments_assignment__departments__code__in=choices)
)
return queryset
def feedback_filter(self, queryset, name, value):
# Only signals that have feedback
queryset = queryset.annotate(feedback_count=Count('feedback')).filter(feedback_count__gte=1)
if value in ['satisfied', 'not_satisfied']:
is_satisfied = True if value == 'satisfied' else False
queryset = queryset.annotate(
feedback_max_created_at=Max('feedback__created_at'),
feedback_max_submitted_at=Max('feedback__submitted_at')
).filter(
feedback__is_satisfied=is_satisfied,
feedback__submitted_at__isnull=False,
feedback__created_at=F('feedback_max_created_at'),
feedback__submitted_at=F('feedback_max_submitted_at')
)
elif value == 'not_received':
queryset = queryset.annotate(
feedback_max_created_at=Max('feedback__created_at')
).filter(
feedback__submitted_at__isnull=True,
feedback__created_at=F('feedback_max_created_at')
)
return queryset
def kind_filter(self, queryset, name, value):
choices = value # we have a MultipleChoiceFilter ...
if (len(choices) == len(kind_choices())
or {'signal', 'parent_signal', 'child_signal'} == set(choices)
or {'parent_signal', 'exclude_parent_signal'} == set(choices)):
return queryset
q_objects = {
'signal': (Q(parent__isnull=True) & Q(children__isnull=True)),
'parent_signal': (Q(parent__isnull=True) & Q(children__isnull=False)),
'exclude_parent_signal': ~(Q(parent__isnull=True) & Q(children__isnull=False)),
'child_signal': (Q(parent__isnull=False)),
}
q_filter = q_objects[choices.pop()]
while choices:
q_filter |= q_objects[choices.pop()]
return queryset.filter(q_filter) if q_filter else queryset
def note_keyword_filter(self, queryset, name, value):
return queryset.filter(notes__text__icontains=value)
def has_changed_children_filter(self, queryset, name, value):
# we have a MultipleChoiceFilter ...
choices = list(set(map(lambda x: True if x in [True, 'True', 'true', 1] else False, value)))
q_filter = Q(children__isnull=False)
if len(choices) == 2:
return queryset.filter(q_filter)
if True in choices:
q_filter &= Q(updated_at__lt=F('children__updated_at')) # noqa Selects all parent signals with changes in the child signals
if False in choices:
q_filter &= Q(updated_at__gt=F('children__updated_at')) # noqa Selects all parent signals with NO changes in the child signals
return queryset.filter(q_filter)
class SignalFilter(FilterSet):
id = filters.NumberFilter()
created_before = filters.IsoDateTimeFilter(field_name='created_at', lookup_expr='lte')
created_after = filters.IsoDateTimeFilter(field_name='created_at', lookup_expr='gte')
updated_before = filters.IsoDateTimeFilter(field_name='updated_at', lookup_expr='lte')
updated_after = filters.IsoDateTimeFilter(field_name='updated_at', lookup_expr='gte')
status = filters.MultipleChoiceFilter(field_name='status__state', choices=status_choices)
maincategory_slug = filters.ModelMultipleChoiceFilter(
queryset=_get_parent_category_queryset(),
to_field_name='slug',
field_name='category_assignment__category__parent__slug',
)
# category_slug, because we will soon be using one type of category, instead of main vs sub
# categories. This way the naming in the API will remain consistent
category_slug = filters.ModelMultipleChoiceFilter(
queryset=_get_child_category_queryset(),
to_field_name='slug',
field_name='category_assignment__category__slug',
)
priority = filters.ChoiceFilter(field_name='priority__priority',
choices=Priority.PRIORITY_CHOICES)
stadsdeel = filters.MultipleChoiceFilter(field_name='location__stadsdeel',
choices=STADSDELEN)
buurt_code = filters.MultipleChoiceFilter(field_name='location__buurt_code',
choices=buurt_choices)
address_text = filters.CharFilter(field_name='location__address_text',
lookup_expr='icontains')
incident_date = filters.DateFilter(field_name='incident_date_start', lookup_expr='date')
incident_date_before = filters.DateFilter(field_name='incident_date_start',
lookup_expr='date__gte')
incident_date_after = filters.DateFilter(field_name='incident_date_start',
lookup_expr='date__lte')
source = filters.MultipleChoiceFilter(choices=source_choices)
feedback = filters.ChoiceFilter(method='feedback_filter', choices=feedback_choices)
def feedback_filter(self, queryset, name, value):
# Only signals that have feedback
queryset = queryset.annotate(feedback_count=Count('feedback')).filter(feedback_count__gte=1)
if value in ['satisfied', 'not_satisfied']:
is_satisfied = True if value == 'satisfied' else False
queryset = queryset.annotate(
feedback_max_created_at=Max('feedback__created_at'),
feedback_max_submitted_at=Max('feedback__submitted_at')
).filter(
feedback__is_satisfied=is_satisfied,
feedback__submitted_at__isnull=False,
feedback__created_at=F('feedback_max_created_at'),
feedback__submitted_at=F('feedback_max_submitted_at')
)
elif value == 'not_received':
queryset = queryset.annotate(
feedback_max_created_at=Max('feedback__created_at')
).filter(
feedback__submitted_at__isnull=True,
feedback__created_at=F('feedback_max_created_at')
)
return queryset
def _categories_filter(self, queryset, main_categories, sub_categories):
if not main_categories and not sub_categories:
return queryset
queryset = queryset.filter(
Q(category_assignment__category__parent_id__in=[c.pk for c in main_categories]) |
Q(category_assignment__category_id__in=[c.pk for c in sub_categories])
)
return queryset
def filter_queryset(self, queryset):
main_categories = []
sub_categories = []
for name, value in self.form.cleaned_data.items():
if name.lower() == 'maincategory_slug':
main_categories = value
elif name.lower() == 'category_slug':
sub_categories = value
else:
queryset = self.filters[name].filter(queryset, value)
return self._categories_filter(queryset=queryset,
main_categories=main_categories,
sub_categories=sub_categories)
class SignalFilter(FilterSet):
id = filters.NumberFilter()
country = filters.MultipleChoiceFilter(field_name='country')
city = filters.MultipleChoiceFilter(field_name='city')
created_before = filters.IsoDateTimeFilter(field_name='created_at',
lookup_expr='lte')
created_after = filters.IsoDateTimeFilter(field_name='created_at',
lookup_expr='gte')
updated_before = filters.IsoDateTimeFilter(field_name='updated_at',
lookup_expr='lte')
updated_after = filters.IsoDateTimeFilter(field_name='updated_at',
lookup_expr='gte')
status = filters.MultipleChoiceFilter(field_name='status__state',
choices=status_choices)
maincategory_slug = filters.ModelMultipleChoiceFilter(
queryset=_get_parent_category_queryset(),
to_field_name='slug',
field_name='category_assignment__category__parent__slug',
)
# category_slug, because we will soon be using one type of category, instead of main vs sub
# categories. This way the naming in the API will remain consistent
category_slug = filters.ModelMultipleChoiceFilter(
queryset=_get_child_category_queryset(),
to_field_name='slug',
field_name='category_assignment__category__slug',
)
category_filter_label = filters.ModelMultipleChoiceFilter(
queryset=_get_parent_category_queryset(),
to_field_name='filter_label',
field_name='category_assignment__category__filter_label',
)
priority = filters.MultipleChoiceFilter(field_name='priority__priority',
choices=Priority.PRIORITY_CHOICES)
stadsdeel = filters.MultipleChoiceFilter(field_name='location__stadsdeel',
choices=stadsdelen)
buurt_code = filters.MultipleChoiceFilter(
field_name='location__buurt_code', choices=buurt_choices)
address_text = filters.CharFilter(field_name='location__address_text',
lookup_expr='icontains')
incident_date = filters.DateFilter(field_name='incident_date_start',
lookup_expr='date')
incident_date_before = filters.DateFilter(field_name='incident_date_start',
lookup_expr='date__gte')
incident_date_after = filters.DateFilter(field_name='incident_date_start',
lookup_expr='date__lte')
source = filters.MultipleChoiceFilter(choices=source_choices)
feedback = filters.ChoiceFilter(method='feedback_filter',
choices=feedback_choices)
contact_details = filters.MultipleChoiceFilter(
method='contact_details_filter',
choices=contact_details_choices,
)
# SIG-2148 Filter on Signal Type
type = filters.MultipleChoiceFilter(method='type_filter',
choices=Type.CHOICES)
note_keyword = filters.CharFilter(method='note_keyword_filter', )
directing_department = filters.MultipleChoiceFilter(
field_name='directing_departments_assignment__departments__code',
choices=department_choices)
def feedback_filter(self, queryset, name, value):
# Only signals that have feedback
queryset = queryset.annotate(feedback_count=Count('feedback')).filter(
feedback_count__gte=1)
if value in ['satisfied', 'not_satisfied']:
is_satisfied = True if value == 'satisfied' else False
queryset = queryset.annotate(
feedback_max_created_at=Max('feedback__created_at'),
feedback_max_submitted_at=Max(
'feedback__submitted_at')).filter(
feedback__is_satisfied=is_satisfied,
feedback__submitted_at__isnull=False,
feedback__created_at=F('feedback_max_created_at'),
feedback__submitted_at=F('feedback_max_submitted_at'))
elif value == 'not_received':
queryset = queryset.annotate(
feedback_max_created_at=Max('feedback__created_at')).filter(
feedback__submitted_at__isnull=True,
feedback__created_at=F('feedback_max_created_at'))
return queryset
def _categories_filter(self, queryset, main_categories, sub_categories):
if not main_categories and not sub_categories:
return queryset
queryset = queryset.filter(
Q(category_assignment__category__parent_id__in=[
c.pk for c in main_categories
]) | Q(category_assignment__category_id__in=[
c.pk for c in sub_categories
]))
return queryset
def filter_queryset(self, queryset):
main_categories = []
sub_categories = []
for name, value in self.form.cleaned_data.items():
if name.lower() == 'maincategory_slug':
main_categories = value
elif name.lower() == 'category_slug':
sub_categories = value
else:
queryset = self.filters[name].filter(queryset, value)
return self._categories_filter(queryset=queryset,
main_categories=main_categories,
sub_categories=sub_categories)
def contact_details_filter(self, queryset, name, value):
"""
Filter `signals.Signal` instances according to presence of contact details.
"""
# Set-up our Q objects for the individual options.
has_no_email = (Q(reporter__email__isnull=True)
| Q(reporter__email=''))
has_no_phone = (Q(reporter__phone__isnull=True)
| Q(reporter__phone=''))
is_anonymous = has_no_email & has_no_phone
q_objects = {
'email': ~has_no_email,
'phone': ~has_no_phone,
'none': is_anonymous,
}
choices = value # we have a MultipleChoiceFilter ...
# Deal with all choices selected, or none selected:
if len(choices) == len(contact_details_choices):
# No filters are present, or ... all filters are present. In that
# case we want all Signal instances with an email address, or a
# phone number, or none of those (according to) the UX design.
# This is the same as not filtering, hence in both cases just
# return the queryset.
return queryset
# The individual choices have to be combined using logical OR:
q_total = q_objects[choices.pop()]
while choices:
q_total |= q_objects[choices.pop()]
return queryset.filter(q_total)
def type_filter(self, queryset, name, value):
return queryset.annotate(type_assignment_id=Max('types__id')).filter(
types__id=F('type_assignment_id'), types__name__in=value)
def note_keyword_filter(self, queryset, name, value):
return queryset.filter(notes__text__icontains=value).distinct()
