Skip to content

Commit d36db61

Browse files
committed
filters: Add label query filter
The filter allows filtering by project-specific and global labels. It also supports negative filtering. Prepending a label name with a minus sign excludes patches with that label from search results.
1 parent 6803caa commit d36db61

2 files changed

Lines changed: 89 additions & 3 deletions

File tree

‎patchwork/filters.py‎

Lines changed: 71 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@
1313
from patchwork.models import Person
1414
from patchwork.models import Series
1515
from patchwork.models import State
16+
from patchwork.models import exclude_submissions_by_labels
17+
from patchwork.models import filter_submissions_by_labels
1618

1719

1820
class Filter(object):
@@ -519,13 +521,71 @@ def set_status(self, *args, **kwargs):
519521
self.forced = True
520522

521523

524+
class LabelsFilter(Filter):
525+
name = 'Labels'
526+
param = 'labels'
527+
528+
def __init__(self, filters):
529+
super(LabelsFilter, self).__init__(filters)
530+
self.labels = None
531+
532+
@property
533+
def condition(self):
534+
return self.labels
535+
536+
@property
537+
def key(self):
538+
return self.labels
539+
540+
@key.setter
541+
def key(self, key):
542+
key = key.strip()
543+
if not key:
544+
return
545+
546+
self.labels = key
547+
self.applied = True
548+
549+
@property
550+
def kwargs(self):
551+
return None
552+
553+
def q(self, queryset):
554+
label_names = self.labels.split(' ')
555+
if len(label_names) == 0:
556+
return queryset
557+
558+
labels_pos, labels_neg = [], []
559+
for label in label_names:
560+
if not label.startswith('-'):
561+
labels_pos.append(label)
562+
else:
563+
labels_neg.append(label[1:])
564+
565+
queryset = exclude_submissions_by_labels(queryset, labels_neg)
566+
queryset = filter_submissions_by_labels(queryset, labels_pos)
567+
return queryset
568+
569+
@property
570+
def form(self):
571+
value = ''
572+
if self.labels:
573+
value = escape(self.labels)
574+
# labels value escaped above
575+
return mark_safe( # noqa: S308
576+
'<input type="text" id="labels_input" name="%s" '
577+
'class="form-control" value="%s">' % (self.param, value)
578+
)
579+
580+
522581
FILTERS = [
523582
SeriesFilter,
524583
SubmitterFilter,
525584
StateFilter,
526585
SearchFilter,
527586
ArchiveFilter,
528587
DelegateFilter,
588+
LabelsFilter,
529589
]
530590

531591

@@ -555,14 +615,22 @@ def available_filters(self):
555615

556616
def apply(self, queryset):
557617
kwargs = collections.OrderedDict()
618+
q_filters = []
558619
for f in self._filters:
559620
if f.applied:
560-
kwargs.update(f.kwargs)
621+
if f.kwargs is not None:
622+
kwargs.update(f.kwargs)
623+
else:
624+
q_filters.append(f)
561625

562-
if not kwargs:
626+
if not kwargs and not q_filters:
563627
return queryset
564628

565-
return queryset.filter(**kwargs)
629+
queryset = queryset.filter(**kwargs)
630+
for f in q_filters:
631+
queryset = f.q(queryset)
632+
633+
return queryset
566634

567635
def querystring(self, remove=None):
568636
params = self.params

‎patchwork/models.py‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -504,6 +504,24 @@ class Meta:
504504
abstract = True
505505

506506

507+
def exclude_submissions_by_labels(queryset, labels):
508+
if len(labels) > 0:
509+
queryset = queryset.exclude(labels__name__in=labels)
510+
511+
return queryset
512+
513+
514+
def filter_submissions_by_labels(queryset, labels):
515+
if len(labels) > 0:
516+
queryset = (
517+
queryset.filter(labels__name__in=labels)
518+
.annotate(num_labels=models.Count('labels', distinct=True))
519+
.filter(num_labels__gte=len(labels))
520+
)
521+
522+
return queryset
523+
524+
507525
class Cover(SubmissionMixin):
508526
def get_absolute_url(self):
509527
return reverse(

0 commit comments

Comments
 (0)