from django import forms
from django.db.models import Q
from django.utils.translation import gettext_lazy as _
from shuup.core.models import ShopProduct, ShopProductVisibility, Supplier
from shuup.front.utils.sorts_and_filters import get_configuration, get_form_field_label
from .product_list_modifiers import (
CommaSeparatedListField,
FilterWidget,
OneChoiceFilterWidget,
SimpleProductListModifier,
)
[docs]
class SupplierProductListFilter(SimpleProductListModifier):
is_active_key = "filter_products_by_supplier"
is_active_label = _("Filter products by supplier")
ordering_key = "filter_products_by_supplier_ordering"
ordering_label = _("Ordering for filter by supplier")
label_key = "filter_products_by_supplier_label"
enable_multiselect_key = "filter_products_by_supplier_multiselect_enabled"
[docs]
def get_fields(self, request, category=None):
shop_products_qs = ShopProduct.objects.filter(shop=request.shop).exclude(
visibility=ShopProductVisibility.NOT_VISIBLE
)
if category:
categories = category.get_descendants(include_self=True)
shop_products_qs = shop_products_qs.filter(
Q(primary_category__in=categories) | Q(categories__in=categories)
)
queryset = Supplier.objects.enabled(shop=request.shop).filter(shop_products__in=shop_products_qs).distinct()
if not queryset.exists():
return
configuration = get_configuration(request.shop, category)
multiselect_enabled = configuration.get(self.enable_multiselect_key)
if multiselect_enabled:
return [
(
"suppliers",
CommaSeparatedListField(
required=False,
label=get_form_field_label("supplier", _("Suppliers")),
widget=FilterWidget(choices=[(supplier.pk, supplier.name) for supplier in queryset]),
),
),
]
return [
(
"supplier",
forms.ModelChoiceField(
queryset=queryset,
empty_label=None,
required=False,
label=get_form_field_label("supplier", _("Suppliers")),
widget=OneChoiceFilterWidget(),
),
),
]
[docs]
def get_filters(self, request, data):
supplier = data.get("supplier")
if supplier:
return Q(shop_products__suppliers=supplier)
suppliers = data.get("suppliers")
if suppliers:
return Q(shop_products__suppliers__in=suppliers)
[docs]
def get_admin_fields(self):
default_fields = super().get_admin_fields()
default_fields[0][1].help_text = _("Enable this to allow products to be filterable by supplier.")
default_fields[1][1].help_text = _(
"Use a numeric value to set the order in which the supplier filters will appear."
)
multiselect_enabled_field = forms.BooleanField(
label=_("Allow multiselect suppliers"),
required=False,
help_text=_("Filter by multiple suppliers at a time."),
)
return default_fields + [
(self.enable_multiselect_key, multiselect_enabled_field),
]