src/funding/models.py

   1
   2 # This file is part of Wolnelektury, licensed under GNU Affero GPLv3 or later.
   3 # Copyright © Fundacja Nowoczesna Polska. See NOTICE for more information.
   4 #
   5 from datetime import date, datetime
   6 from urllib.parse import urlencode
   7 from django.conf import settings
   8 from django.contrib.sites.models import Site
   9 from django.core.mail import send_mail
  10 from django.db import models
  11 from django.dispatch import receiver
  12 from django.template.loader import render_to_string
  13 from django.urls import reverse
  14 from django.utils.html import mark_safe
  15 from django.utils.timezone import utc
  16 from django.utils.translation import gettext_lazy as _, override
  17 from catalogue.models import Book
  18 from catalogue.utils import get_random_hash
  19 from polls.models import Poll
  20 import club.payu.models
  21 from wolnelektury.utils import cached_render, clear_cached_renders
  22 from . import app_settings
  23 from . import utils
  24
  25
  26 class Offer(models.Model):
  27     """ A fundraiser for a particular book. """
  28     author = models.CharField(_('author'), max_length=255)
  29     title = models.CharField(_('title'), max_length=255)
  30     slug = models.SlugField(_('slug'))
  31     description = models.TextField(_('description'), blank=True)
  32     target = models.DecimalField(_('target'), decimal_places=2, max_digits=10)
  33     start = models.DateField(_('start'), db_index=True)
  34     end = models.DateField(_('end'), db_index=True)
  35     redakcja_url = models.URLField(_('redakcja URL'), blank=True)
  36     book = models.ForeignKey(Book, models.PROTECT, null=True, blank=True, help_text=_('Published book.'))
  37     cover = models.ImageField(_('Cover'), upload_to='funding/covers')
  38     poll = models.ForeignKey(Poll, help_text=_('Poll'), null=True, blank=True, on_delete=models.SET_NULL)
  39
  40     notified_near = models.DateTimeField(_('Near-end notifications sent'), blank=True, null=True)
  41     notified_end = models.DateTimeField(_('End notifications sent'), blank=True, null=True)
  42
  43     def cover_img_tag(self):
  44         return mark_safe('<img src="%s" />' % self.cover.url)
  45     cover_img_tag.short_description = _('Cover preview')
  46
  47     class Meta:
  48         verbose_name = _('offer')
  49         verbose_name_plural = _('offers')
  50         ordering = ['-end']
  51
  52     def __str__(self):
  53         return "%s - %s" % (self.author, self.title)
  54
  55     def get_absolute_url(self):
  56         return reverse('funding_offer', args=[self.slug])
  57
  58     def save(self, *args, **kw):
  59         published_now = (
  60             self.book_id is not None and self.pk is not None and
  61             type(self).objects.values('book').get(pk=self.pk)['book'] != self.book_id)
  62         retval = super(Offer, self).save(*args, **kw)
  63         self.clear_cache()
  64         if published_now:
  65             self.notify_published()
  66         return retval
  67
  68     def get_payu_payment_title(self):
  69         return utils.sanitize_payment_title(str(self))
  70
  71     def clear_cache(self):
  72         clear_cached_renders(self.top_bar)
  73         clear_cached_renders(self.top_bar_2022)
  74         clear_cached_renders(self.list_bar)
  75         clear_cached_renders(self.detail_bar)
  76         clear_cached_renders(self.detail_bar_2022)
  77         clear_cached_renders(self.status)
  78         clear_cached_renders(self.status_more)
  79
  80     def is_current(self):
  81         return self.start <= date.today() <= self.end and self == self.current()
  82
  83     def is_win(self):
  84         return self.sum() >= self.target
  85
  86     def remaining(self):
  87         if self.is_current():
  88             return None
  89         if self.is_win():
  90             return self.sum() - self.target
  91         else:
  92             return self.sum()
  93
  94     @classmethod
  95     def current(cls):
  96         """ Returns current fundraiser or None.
  97
  98         Current fundraiser is the one that:
  99         - has already started,
 100         - hasn't yet ended,
 101         - if there's more than one of those, it's the one that ends last.
 102
 103         """
 104         today = date.today()
 105         objects = cls.objects.filter(start__lte=today, end__gte=today).order_by('-end')
 106         try:
 107             return objects[0]
 108         except IndexError:
 109             return None
 110
 111     @classmethod
 112     def past(cls):
 113         """ QuerySet for all past fundraisers. """
 114         objects = cls.public()
 115         current = cls.current()
 116         if current is not None:
 117             objects = objects.exclude(pk=current.pk)
 118         return objects
 119
 120     @classmethod
 121     def public(cls):
 122         """ QuerySet for all current and past fundraisers. """
 123         today = date.today()
 124         return cls.objects.filter(start__lte=today)
 125
 126     def get_perks(self, amount=None):
 127         """ Finds all the perks for the offer.
 128
 129         If amount is provided, returns the perks you get for it.
 130
 131         """
 132         perks = Perk.objects.filter(
 133                 models.Q(offer=self) | models.Q(offer=None)
 134             ).exclude(end_date__lt=date.today())
 135         if amount is not None:
 136             perks = perks.filter(price__lte=amount)
 137         return perks
 138
 139     def funding_payed(self):
 140         """ QuerySet for all completed payments for the offer. """
 141         return Funding.payed().filter(offer=self)
 142
 143     def funders(self):
 144         return self.funding_payed().order_by('-amount', 'completed_at')
 145
 146     def sum(self):
 147         """ The money gathered. """
 148         return self.funding_payed().aggregate(s=models.Sum('amount'))['s'] or 0
 149
 150     def notify_all(self, subject, template_name, extra_context=None):
 151         Funding.notify_funders(
 152             subject, template_name, extra_context,
 153             query_filter=models.Q(offer=self)
 154         )
 155
 156     def notify_end(self, force=False):
 157         if not force and self.notified_end:
 158             return
 159         assert not self.is_current()
 160         self.notify_all(
 161             _('The fundraiser has ended!'),
 162             'funding/email/end.txt', {
 163                 'offer': self,
 164                 'is_win': self.is_win(),
 165                 'remaining': self.remaining(),
 166                 'current': self.current(),
 167             })
 168         self.notified_end = datetime.utcnow().replace(tzinfo=utc)
 169         self.save()
 170
 171     def notify_near(self, force=False):
 172         if not force and self.notified_near:
 173             return
 174         assert self.is_current()
 175         sum_ = self.sum()
 176         need = self.target - sum_
 177         self.notify_all(
 178             _('The fundraiser will end soon!'),
 179             'funding/email/near.txt', {
 180                 'days': (self.end - date.today()).days + 1,
 181                 'offer': self,
 182                 'is_win': self.is_win(),
 183                 'sum': sum_,
 184                 'need': need,
 185             })
 186         self.notified_near = datetime.utcnow().replace(tzinfo=utc)
 187         self.save()
 188
 189     def notify_published(self):
 190         assert self.book is not None
 191         self.notify_all(
 192             _('The book you helped fund has been published.'),
 193             'funding/email/published.txt', {
 194                 'offer': self,
 195                 'book': self.book,
 196                 'author': self.book.pretty_title(),
 197                 'current': self.current(),
 198             })
 199
 200     def basic_info(self):
 201         offer_sum = self.sum()
 202         return {
 203             'offer': self,
 204             'sum': offer_sum,
 205             'is_current': self.is_current(),
 206             'is_win': offer_sum >= self.target,
 207             'missing': self.target - offer_sum,
 208             'percentage': min(100, 100 * offer_sum / self.target),
 209
 210             'show_title': True,
 211             'show_title_calling': True,
 212         }
 213
 214     @cached_render('funding/includes/funding.html')
 215     def top_bar(self):
 216         ctx = self.basic_info()
 217         ctx.update({
 218             'link': True,
 219             'closeable': True,
 220             'add_class': 'funding-top-header',
 221         })
 222         return ctx
 223
 224     @cached_render('funding/includes/funding.html')
 225     def list_bar(self):
 226         ctx = self.basic_info()
 227         ctx.update({
 228             'link': True,
 229             'show_title_calling': False,
 230         })
 231         return ctx
 232
 233     @cached_render('funding/includes/funding.html')
 234     def detail_bar(self):
 235         ctx = self.basic_info()
 236         ctx.update({
 237             'show_title': False,
 238         })
 239         return ctx
 240
 241     @cached_render('funding/includes/offer_status.html')
 242     def status(self):
 243         return {'offer': self}
 244
 245     @cached_render('funding/includes/offer_status_more.html')
 246     def status_more(self):
 247         return {'offer': self}
 248
 249     @cached_render('funding/2022/includes/funding.html')
 250     def top_bar_2022(self):
 251         ctx = self.basic_info()
 252         ctx.update({
 253             'link': True,
 254             'closeable': True,
 255             'add_class': 'funding-top-header',
 256         })
 257         return ctx
 258
 259     @cached_render('funding/2022/includes/funding.html')
 260     def detail_bar_2022(self):
 261         ctx = self.basic_info()
 262         ctx.update({
 263             'show_title': False,
 264         })
 265         return ctx
 266
 267
 268 class Perk(models.Model):
 269     """ A perk offer.
 270
 271     If no attached to a particular Offer, applies to all.
 272
 273     """
 274     offer = models.ForeignKey(Offer, models.CASCADE, verbose_name=_('offer'), null=True, blank=True)
 275     price = models.DecimalField(_('price'), decimal_places=2, max_digits=10)
 276     name = models.CharField(_('name'), max_length=255)
 277     long_name = models.CharField(_('long name'), max_length=255)
 278     end_date = models.DateField(_('end date'), null=True, blank=True)
 279
 280     class Meta:
 281         verbose_name = _('perk')
 282         verbose_name_plural = _('perks')
 283         ordering = ['-price']
 284
 285     def __str__(self):
 286         return "%s (%s%s)" % (self.name, self.price, " for %s" % self.offer if self.offer else "")
 287
 288
 289 class Funding(club.payu.models.Order):
 290     """ A person paying in a fundraiser.
 291
 292     The payment was completed if and only if completed_at is set.
 293
 294     """
 295     offer = models.ForeignKey(Offer, models.PROTECT, verbose_name=_('offer'))
 296     customer_ip = models.GenericIPAddressField(_('customer IP'), null=True)
 297
 298     name = models.CharField(_('name'), max_length=127, blank=True)
 299     email = models.EmailField(_('email'), blank=True, db_index=True)
 300     user = models.ForeignKey(settings.AUTH_USER_MODEL, models.SET_NULL, blank=True, null=True)
 301     amount = models.DecimalField(_('amount'), decimal_places=2, max_digits=10)
 302     perks = models.ManyToManyField(Perk, verbose_name=_('perks'), blank=True)
 303     language_code = models.CharField(max_length=2, null=True, blank=True)
 304     notifications = models.BooleanField(_('notifications'), default=True, db_index=True)
 305     notify_key = models.CharField(max_length=32)
 306
 307     class Meta:
 308         verbose_name = _('funding')
 309         verbose_name_plural = _('fundings')
 310         ordering = ['-completed_at', 'pk']
 311
 312     @classmethod
 313     def payed(cls):
 314         """ QuerySet for all completed payments. """
 315         return cls.objects.exclude(completed_at=None)
 316
 317     def __str__(self):
 318         return str(self.offer)
 319
 320     def get_amount(self):
 321         return self.amount
 322
 323     def get_buyer(self):
 324         return {
 325             "email": self.email,
 326             "language": self.language_code,
 327         }
 328
 329     def get_description(self):
 330         return self.offer.get_payu_payment_title()
 331
 332     def get_thanks_url(self):
 333         return reverse('funding_thanks')
 334
 335     def status_updated(self):
 336         if self.status == 'COMPLETED':
 337             if self.email:
 338                 self.notify(
 339                     _('Thank you for your support!'),
 340                     'funding/email/thanks.txt'
 341                 )
 342
 343     def get_notify_url(self):
 344         return "https://{}{}".format(
 345             Site.objects.get_current().domain,
 346             reverse('funding_payu_notify', args=[self.pk]))
 347
 348     def perk_names(self):
 349         return ", ".join(perk.name for perk in self.perks.all())
 350
 351     def get_disable_notifications_url(self):
 352         return "%s?%s" % (
 353             reverse("funding_disable_notifications"),
 354             urlencode({
 355                 'email': self.email,
 356                 'key': self.notify_key,
 357             }))
 358
 359     def wl_optout_url(self):
 360         return 'https://wolnelektury.pl' + self.get_disable_notifications_url()
 361
 362     def save(self, *args, **kwargs):
 363         if self.email and not self.notify_key:
 364             self.notify_key = get_random_hash(self.email)
 365         ret = super(Funding, self).save(*args, **kwargs)
 366         self.offer.clear_cache()
 367         return ret
 368
 369     @classmethod
 370     def notify_funders(cls, subject, template_name, extra_context=None, query_filter=None, payed_only=True):
 371         funders = cls.objects.exclude(email="").filter(notifications=True)
 372         if payed_only:
 373             funders = funders.exclude(completed_at=None)
 374         if query_filter is not None:
 375             funders = funders.filter(query_filter)
 376         emails = set()
 377         for funder in funders:
 378             if funder.email in emails:
 379                 continue
 380             emails.add(funder.email)
 381             funder.notify(subject, template_name, extra_context)
 382
 383     def notify(self, subject, template_name, extra_context=None):
 384         context = {
 385             'funding': self,
 386             'site': Site.objects.get_current(),
 387         }
 388         if extra_context:
 389             context.update(extra_context)
 390         with override(self.language_code or app_settings.DEFAULT_LANGUAGE):
 391             send_mail(
 392                 subject, render_to_string(template_name, context), settings.CONTACT_EMAIL, [self.email],
 393                 fail_silently=False)
 394
 395     def disable_notifications(self):
 396         """Disables all notifications for this e-mail address."""
 397         type(self).objects.filter(email=self.email).update(notifications=False)
 398
 399
 400 class PayUNotification(club.payu.models.Notification):
 401     order = models.ForeignKey(Funding, models.CASCADE, related_name='notification_set')
 402
 403
 404 class Spent(models.Model):
 405     """ Some of the remaining money spent on a book. """
 406     book = models.ForeignKey(Book, models.PROTECT)
 407     amount = models.DecimalField(_('amount'), decimal_places=2, max_digits=10)
 408     timestamp = models.DateField(_('when'))
 409
 410     class Meta:
 411         verbose_name = _('money spent on a book')
 412         verbose_name_plural = _('money spent on books')
 413         ordering = ['-timestamp']
 414
 415     def __str__(self):
 416         return "Spent: %s" % str(self.book)
 417