src/funding/models.py

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