Source code for shuup.campaigns.models.context_conditions

from typing import Any, Optional, Type

from django.db import models
from django.utils import timezone
from django.utils.translation import gettext_lazy as _
from polymorphic.models import PolymorphicModel

from shuup.campaigns.utils.time_range import is_in_time_range
from shuup.core.models import AnonymousContact, Contact, ContactGroup


[docs] class ContextCondition(PolymorphicModel): model: Optional[Type[Any]] = None identifier = "context_condition" name = _("Context Condition") description = _("Context Condition") active = models.BooleanField(default=True)
[docs] def matches(self, context): return False
[docs] class ContactGroupCondition(ContextCondition): model = ContactGroup identifier = "contact_group_condition" name = _("Contact Group") contact_groups = models.ManyToManyField(ContactGroup, verbose_name=_("contact groups"))
[docs] def matches(self, context): customer = context.customer if context.customer is not None else AnonymousContact() customers_groups = customer.groups.all() return self.contact_groups.filter(pk__in=customers_groups).exists()
@property def description(self): return _("Limit the campaign to members of the selected contact groups.") @property def values(self): return self.contact_groups @values.setter def values(self, values): self.contact_groups = values
[docs] class ContactCondition(ContextCondition): model = Contact identifier = "contact_condition" name = _("Contact") contacts = models.ManyToManyField(Contact, verbose_name=_("contacts"))
[docs] def matches(self, context): customer = context.customer return bool(customer and self.contacts.filter(pk=customer.pk).exists())
@property def description(self): return _("Limit the campaign to selected contacts.") @property def values(self): return self.contacts @values.setter def values(self, values): self.contacts = values
[docs] class HourCondition(ContextCondition): identifier = "hour_condition" name = _("Day and hour") hour_start = models.TimeField( verbose_name=_("start time"), help_text=_("12pm is considered noon and 12am as midnight."), ) hour_end = models.TimeField( verbose_name=_("end time"), help_text=_("12pm is considered noon and 12am as midnight. End time is not considered match."), ) days = models.CharField(max_length=255, verbose_name=_("days"))
[docs] def matches(self, context): return is_in_time_range(timezone.now(), self.hour_start, self.hour_end, self.values)
@property def description(self): return _("Limit the campaign to selected days.") @property def values(self): return list(map(int, self.days.split(","))) if self.days else [] @values.setter def values(self, values): self.days = ",".join(values)