path: root/patchwork/filters.py

# Patchwork - automated patch tracking system
# Copyright (C) 2008 Jeremy Kerr <jk@ozlabs.org>
#
# SPDX-License-Identifier: GPL-2.0-or-later

import collections
from urllib.parse import quote

from django.contrib.auth.models import User
from django.utils.html import escape
from django.utils.safestring import mark_safe

from patchwork.models import Person
from patchwork.models import Series
from patchwork.models import State


class Filter(object):
    #: The 'name' of the filter, to be displayed in the filter UI.
    name = None
    #: The querystring parameter to filter on.
    param = None

    def __init__(self, filters):
        self.filters = filters
        self.applied = False

    @property
    def condition(self):
        """The current condition of the filter, to be displayed in the
           filter UI"""
        raise NotImplementedError

    @property
    def key(self):
        """The key for this filter, to appear in the querystring. A key of
           None will remove the param=key pair from the querystring."""
        raise NotImplementedError

    @key.setter
    def key(self, key):
        raise NotImplementedError

    @property
    def url_without_me(self):
        return self.filters.querystring_without_filter(self)

    @property
    def kwargs(self):
        raise NotImplementedError

    @property
    def form(self):
        raise NotImplementedError

    def set_status(self, *kwargs):
        """Views can call this to force a specific filter status. For example,
           a user's todo page needs to setup the delegate filter to show
           that user's delegated patches"""
        pass

    def parse(self, values):
        if self.param not in values:
            return
        self.key = values[self.param]

    def __str__(self):
        return '%s: %s' % (self.name, self.kwargs)


class SeriesFilter(Filter):
    name = 'Series'
    param = 'series'

    def __init__(self, filters):
        super(SeriesFilter, self).__init__(filters)
        self.series = None

    @property
    def condition(self):
        if self.series:
            return self.series.name
        return ''

    @property
    def key(self):
        if self.series:
            return self.series.id
        return

    @key.setter
    def key(self, key):
        self.series = None

        key = key.strip()
        if not key:
            return

        try:
            self.series = Series.objects.get(id=int(key))
        except (ValueError, Series.DoesNotExist):
            return

        self.applied = True

    @property
    def kwargs(self):
        if self.series:
            return {'series': self.series}
        return {}

    @property
    def form(self):
        return mark_safe('<input type="text" name="series" '
                         'id="series_input" class="form-control">')


class SubmitterFilter(Filter):
    name = 'Submitter'
    param = 'submitter'

    def __init__(self, filters):
        super(SubmitterFilter, self).__init__(filters)
        self.person = None
        self.person_match = None

    @property
    def condition(self):
        if self.person:
            return self.person.name
        elif self.person_match:
            return self.person_match
        return ''

    @property
    def key(self):
        if self.person:
            return self.person.id
        return self.person_match

    @key.setter
    def key(self, key):
        self.person = None
        self.person_match = None

        key = key.strip()
        if not key:
            return

        try:
            self.person = Person.objects.get(id=int(key))
        except (ValueError, Person.DoesNotExist):
            pass
        else:
            self.applied = True
            return

        people = Person.objects.filter(name__icontains=key)
        if not people:
            return

        self.person_match = key
        self.applied = True

    @property
    def kwargs(self):
        if self.person:
            user = self.person.user
            if user:
                return {'submitter__in':
                        Person.objects.filter(user=user).values('pk').query}
            return {'submitter': self.person}
        elif self.person_match:
            return {'submitter__name__icontains': self.person_match}

        return {}

    @property
    def form(self):
        return mark_safe('<input type="text" name="submitter" '
                         'id="submitter_input" class="form-control">')


class StateFilter(Filter):
    name = 'State'
    param = 'state'
    any_key = '*'
    action_req_str = 'Action Required'

    def __init__(self, filters):
        super(StateFilter, self).__init__(filters)
        self.state = None
        # The state filter is enabled by default (to hide patches that don't
        # require action)
        self.applied = True

    @property
    def condition(self):
        if self.state:
            return self.state.name
        return self.action_req_str

    @property
    def key(self):
        if self.state is not None:
            return self.state.id
        if not self.applied:
            return '*'
        return None

    @key.setter
    def key(self, key):
        self.state = None

        if key == self.any_key:
            self.applied = False
            return

        try:
            self.state = State.objects.get(id=int(key))
        except (ValueError, State.DoesNotExist):
            return

        self.applied = True

    @property
    def url_without_me(self):
        # Because the filter is enabled by default, we need to add something to
        # the querystring if we disable it
        qs = self.filters.querystring_without_filter(self)
        if qs != '?':
            qs += '&'
        return qs + '%s=%s' % (self.param, self.any_key)

    @property
    def kwargs(self):
        if self.state is not None:
            return {'state': self.state}

        return {'state__in': State.objects.filter(
            action_required=True).values('pk').query}

    @property
    def form(self):
        out = '<select name="%s" class="form-control">' % self.param

        selected = ''
        if not self.applied:
            selected = 'selected'
        out += '<option %s value="%s">any</option>' % (selected, self.any_key)

        selected = ''
        if self.applied and self.state is None:
            selected = 'selected'
        out += '<option %s value="">%s</option>' % (
            selected, self.action_req_str)

        for state in State.objects.all():
            selected = ''
            if self.state and self.state == state:
                selected = ' selected="true"'

            out += '<option value="%d" %s>%s</option>' % (
                state.id, selected, escape(state.name))
        out += '</select>'
        return mark_safe(out)


class SearchFilter(Filter):
    name = 'Search'
    param = 'q'

    def __init__(self, filters):
        super(SearchFilter, self).__init__(filters)
        self.search = None

    @property
    def condition(self):
        return self.search

    @property
    def key(self):
        return self.search

    @key.setter
    def key(self, key):
        key = key.strip()
        if not key:
            return

        self.search = key
        self.applied = True

    @property
    def kwargs(self):
        return {'name__icontains': self.search}

    @property
    def form(self):
        value = ''
        if self.search:
            value = escape(self.search)
        return mark_safe('<input name="%s" class="form-control" value="%s">' %
                         (self.param, value))


class ArchiveFilter(Filter):
    name = 'Archived'
    param = 'archive'
    param_map = {
        True: 'true',
        False: '',
        None: 'both'
    }
    description_map = {
        True: 'Yes',
        False: 'No',
        None: 'Both'
    }

    def __init__(self, filters):
        super(ArchiveFilter, self).__init__(filters)
        self.archive_state = False
        # The archive filter is enabled by default (to hide archived patches)
        self.applied = True

    @property
    def condition(self):
        return self.description_map[self.archive_state]

    @property
    def key(self):
        # NOTE(stephenfin): this is a shortcut to ensure we don't both
        # including the 'archive' querystring filter for the default case
        if self.archive_state is False:
            return None
        return self.param_map[self.archive_state]

    @key.setter
    def key(self, key):
        self.archive_state = False
        self.applied = True
        for (k, v) in self.param_map.items():
            if key == v:
                self.archive_state = k
        if self.archive_state is None:
            self.applied = False

    @property
    def url_without_me(self):
        # As with StateFilter, because this filter is enabled by default,
        # disabling it will actually add something to the querystring
        qs = self.filters.querystring_without_filter(self)
        if qs != '?':
            qs += '&'
        return qs + 'archive=both'

    @property
    def kwargs(self):
        if self.archive_state is None:
            return {}
        return {'archived': self.archive_state}

    @property
    def form(self):
        s = ''
        for b in [False, True, None]:
            label = self.description_map[b]
            selected = ''
            if self.archive_state == b:
                selected = 'checked'
            s += ('<label class="checkbox-inline">'
                  ' <input type="radio" name="%(param)s" '
                  '%(selected)s value="%(value)s">%(label)s'
                  '</label>') % \
                {'label': label,
                 'param': self.param,
                 'selected': selected,
                 'value': self.param_map[b]
                 }
        return mark_safe(s)


class DelegateFilter(Filter):
    name = 'Delegate'
    param = 'delegate'
    no_delegate_str = 'Nobody'
    ANY_DELEGATE = object()

    def __init__(self, filters):
        super(DelegateFilter, self).__init__(filters)
        self.delegate = None
        self.delegate_match = None
        self.forced = False

    @property
    def condition(self):
        if self.delegate:
            return str(self.delegate)
        elif self.delegate_match:
            return self.delegate_match
        return ''

    @property
    def key(self):
        if self.delegate:
            return self.delegate.id
        return self.delegate_match

    @key.setter
    def key(self, key):
        self.delegate = None
        self.delegate_match = None

        key = key.strip()
        if not key:
            return

        if key == self.no_delegate_str:
            self.delegate_match = key
            self.applied = True
            return

        try:
            self.delegate = User.objects.get(id=int(key))
        except (ValueError, User.DoesNotExist):
            pass
        else:
            self.applied = True
            return

        delegates = User.objects.filter(username__icontains=key)
        if not delegates:
            return

        self.delegate_match = key
        self.applied = True

    @property
    def kwargs(self):
        if self.delegate:
            return {'delegate': self.delegate}

        if self.delegate_match == self.no_delegate_str:
            return {'delegate__username__isnull': True}

        if self.delegate_match:
            return {'delegate__username__icontains': self.delegate_match}

        return {}

    @property
    def form(self):
        if self.forced:
            return mark_safe('<input type="hidden" value="%s">%s' % (
                self.param, self.condition))

        delegates = User.objects.filter(
            profile__maintainer_projects__isnull=False)

        out = '<select name="delegate" class="form-control">'

        selected = ''
        if not self.applied:
            selected = 'selected'
        out += '<option %s value="">------</option>' % selected

        selected = ''
        if self.applied and self.delegate is None:
            selected = 'selected'
        out += '<option %s value="%s">%s</option>' % (
            selected, self.no_delegate_str, self.no_delegate_str)

        for delegate in delegates:
            selected = ''
            if delegate == self.delegate:
                selected = ' selected'

            out += '<option %s value="%s">%s</option>' % (
                selected, delegate.id, delegate.username)
        out += '</select>'
        return mark_safe(out)

    def set_status(self, *args, **kwargs):
        if 'delegate' in kwargs:
            self.applied = self.forced = True
            self.delegate = kwargs['delegate']

        if self.ANY_DELEGATE in args:
            self.applied = False
            self.forced = True


FILTERS = [
    SeriesFilter,
    SubmitterFilter,
    StateFilter,
    SearchFilter,
    ArchiveFilter,
    DelegateFilter
]


class Filters:

    def __init__(self, request):
        self._filters = [c(self) for c in FILTERS]
        self.values = request.GET

        for f in self._filters:
            f.parse(self.values)

    @property
    def params(self):
        return collections.OrderedDict([
            (f.param, f.key) for f in self._filters if f.key is not None])

    @property
    def applied_filters(self):
        return collections.OrderedDict([
            (x.param, x) for x in self._filters if x.applied])

    @property
    def available_filters(self):
        return self._filters

    def apply(self, queryset):
        kwargs = collections.OrderedDict()
        for f in self._filters:
            if f.applied:
                kwargs.update(f.kwargs)

        if not kwargs:
            return queryset

        return queryset.filter(**kwargs)

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

        for (k, v) in self.values.items():
            if k not in params:
                params[k] = v

        if remove and remove.param in list(params.keys()):
            del params[remove.param]

        def sanitise(s):
            # TODO: should this be unconditional?
            if not isinstance(s, str):
                s = str(s)
            return quote(s.encode('utf-8'))

        return '?' + '&'.join(['%s=%s' % (sanitise(k), sanitise(v))
                               for (k, v) in list(params.items())])

    def querystring_without_filter(self, filter):
        return self.querystring(filter)

    def set_status(self, filterclass, *args, **kwargs):
        for f in self._filters:
            if isinstance(f, filterclass):
                f.set_status(*args, **kwargs)
                return