Tighter sponsors html, every pageview gets ~10kB lighter.

[wolnelektury.git] / apps / funding / models.py

diff --git a/apps/funding/models.py b/apps/funding/models.py
index a088a07..800a15a 100644 (file)
--- a/apps/funding/models.py
+++ b/apps/funding/models.py
@@ -2,21 +2,45 @@
 # This file is part of Wolnelektury, licensed under GNU Affero GPLv3 or later.
 # Copyright © Fundacja Nowoczesna Polska. See NOTICE for more information.
 #
 # This file is part of Wolnelektury, licensed under GNU Affero GPLv3 or later.
 # Copyright © Fundacja Nowoczesna Polska. See NOTICE for more information.
 #

+from datetime import date, datetime
+from urllib import urlencode

 from django.core.urlresolvers import reverse
 from django.core.urlresolvers import reverse

+from django.core.mail import send_mail
+from django.conf import settings
+from django.template.loader import render_to_string

 from django.db import models
 from django.db import models

-from django.utils.translation import ugettext_lazy as _, ugettext as __
-from datetime import date, datetime
+from django.utils.timezone import utc
+from django.utils.translation import ugettext_lazy as _, override
+import getpaid
+from catalogue.models import Book
+from catalogue.utils import get_random_hash, related_tag_name
+from polls.models import Poll
+from django.contrib.sites.models import Site
+from . import app_settings

 
 
 class Offer(models.Model):
 
 
 class Offer(models.Model):

+    """ A fundraiser for a particular book. """

     author = models.CharField(_('author'), max_length=255)
     title = models.CharField(_('title'), max_length=255)
     slug = models.SlugField(_('slug'))
     author = models.CharField(_('author'), max_length=255)
     title = models.CharField(_('title'), max_length=255)
     slug = models.SlugField(_('slug'))

-    book_url = models.URLField(_('book URL'), blank=True)
-    redakcja_url = models.URLField(_('redakcja URL'), blank=True)
+    description = models.TextField(_('description'), blank=True)

     target = models.DecimalField(_('target'), decimal_places=2, max_digits=10)
     target = models.DecimalField(_('target'), decimal_places=2, max_digits=10)

-    start = models.DateField(_('start'))
-    end = models.DateField(_('end'))
+    start = models.DateField(_('start'), db_index=True)
+    end = models.DateField(_('end'), db_index=True)
+    redakcja_url = models.URLField(_('redakcja URL'), blank=True)
+    book = models.ForeignKey(Book, null=True, blank=True,
+        help_text=_('Published book.'))
+    cover = models.ImageField(_('Cover'), upload_to='funding/covers')
+    poll = models.ForeignKey(Poll, help_text=_('Poll'), null=True, blank=True, on_delete=models.SET_NULL)
+
+    notified_near = models.DateTimeField(_('Near-end notifications sent'), blank=True, null=True)
+    notified_end = models.DateTimeField(_('End notifications sent'), blank=True, null=True)
+
+    def cover_img_tag(self):
+        return u'<img src="%s" />' % self.cover.url
+    cover_img_tag.short_description = _('Cover preview')
+    cover_img_tag.allow_tags = True

 
     class Meta:
         verbose_name = _('offer')
 
     class Meta:
         verbose_name = _('offer')


@@ -24,57 +48,150 @@ class Offer(models.Model):
         ordering = ['-end']
 
     def __unicode__(self):
         ordering = ['-end']
 
     def __unicode__(self):

-        return u"%s – %s" % (self.author, self.title)
+        return u"%s - %s" % (self.author, self.title)

 
     def get_absolute_url(self):
         return reverse('funding_offer', args=[self.slug])
 
 
     def get_absolute_url(self):
         return reverse('funding_offer', args=[self.slug])
 

+    def save(self, *args, **kw):
+        published_now = (self.book_id is not None and
+            self.pk is not None and
+            type(self).objects.values('book').get(pk=self.pk)['book'] != self.book_id)
+        retval = super(Offer, self).save(*args, **kw)
+        if published_now:
+            self.notify_published()
+        return retval
+
+    def is_current(self):
+        return self.start <= date.today() <= self.end and self == self.current()
+
+    def is_win(self):
+        return self.sum() >= self.target
+
+    def remaining(self):
+        if self.is_current():
+            return None
+        if self.is_win():
+            return self.sum() - self.target
+        else:
+            return self.sum()
+

     @classmethod
     def current(cls):
     @classmethod
     def current(cls):

+        """ Returns current fundraiser or None.
+
+        Current fundraiser is the one that:
+        - has already started,
+        - hasn't yet ended,
+        - if there's more than one of those, it's the one that ends last.
+
+        """

         today = date.today()
         today = date.today()

-        objects = cls.objects.filter(start__lte=today, end__gte=today)
+        objects = cls.objects.filter(start__lte=today, end__gte=today).order_by('-end')

         try:
             return objects[0]
         except IndexError:
             return None
 
         try:
             return objects[0]
         except IndexError:
             return None
 

+    @classmethod
+    def past(cls):
+        """ QuerySet for all past fundraisers. """
+        objects = cls.public()
+        current = cls.current()
+        if current is not None:
+            objects = objects.exclude(pk=current.pk)
+        return objects
+

     @classmethod
     def public(cls):
     @classmethod
     def public(cls):

+        """ QuerySet for all current and past fundraisers. """

         today = date.today()
         today = date.today()

-        return cls.objects.filter(start__lte=today)        
+        return cls.objects.filter(start__lte=today)

 
     def get_perks(self, amount=None):
 
     def get_perks(self, amount=None):

+        """ Finds all the perks for the offer.
+
+        If amount is provided, returns the perks you get for it.
+
+        """

         perks = Perk.objects.filter(
                 models.Q(offer=self) | models.Q(offer=None)
         perks = Perk.objects.filter(
                 models.Q(offer=self) | models.Q(offer=None)

-            )
+            ).exclude(end_date__lt=date.today())

         if amount is not None:
             perks = perks.filter(price__lte=amount)
         return perks
 
         if amount is not None:
             perks = perks.filter(price__lte=amount)
         return perks
 

-    def fund(self, name, email, amount):
-        funding = self.funding_set.create(
-            name=name, email=email, amount=amount,
-            payed_at=datetime.now())
-        funding.perks = self.get_perks(amount)
-        return funding
+    def funding_payed(self):
+        """ QuerySet for all completed payments for the offer. """
+        return Funding.payed().filter(offer=self)
+
+    def funders(self):
+        return self.funding_payed().order_by('-amount', 'payed_at')

 
     def sum(self):
 
     def sum(self):

-        return self.funding_set.aggregate(s=models.Sum('amount'))['s'] or 0
+        """ The money gathered. """
+        return self.funding_payed().aggregate(s=models.Sum('amount'))['s'] or 0

 
 

-    def state(self):
-        if self.sum() >= self.target:
-            return 'win'
-        elif self.start <= date.today() <= self.end:
-            return 'running'
-        else:
-            return 'lose'
+    def notify_all(self, subject, template_name, extra_context=None):
+        Funding.notify_funders(
+            subject, template_name, extra_context,
+            query_filter=models.Q(offer=self)
+        )
+
+    def notify_end(self, force=False):
+        if not force and self.notified_end: return
+        assert not self.is_current()
+        self.notify_all(
+            _('The fundraiser has ended!'),
+            'funding/email/end.txt', {
+                'offer': self,
+                'is_win': self.is_win(),
+                'remaining': self.remaining(),
+                'current': self.current(),
+            })
+        self.notified_end = datetime.utcnow().replace(tzinfo=utc)
+        self.save()
+
+    def notify_near(self, force=False):
+        if not force and self.notified_near: return
+        assert self.is_current()
+        sum_ = self.sum()
+        need = self.target - sum_
+        self.notify_all(
+            _('The fundraiser will end soon!'),
+            'funding/email/near.txt', {
+                'days': (self.end - date.today()).days + 1,
+                'offer': self,
+                'is_win': self.is_win(),
+                'sum': sum_,
+                'need': need,
+            })
+        self.notified_near = datetime.utcnow().replace(tzinfo=utc)
+        self.save()
+
+    def notify_published(self):
+        assert self.book is not None
+        self.notify_all(
+            _('The book you helped fund has been published.'),
+            'funding/email/published.txt', {
+                'offer': self,
+                'book': self.book,
+                'author': ", ".join(related_tag_name(a) for a in self.book.related_info()['tags']['author']),
+                'current': self.current(),
+            })

 
 
 class Perk(models.Model):
 
 
 class Perk(models.Model):

+    """ A perk offer.
+
+    If no attached to a particular Offer, applies to all.
+
+    """

     offer = models.ForeignKey(Offer, verbose_name=_('offer'), null=True, blank=True)
     price = models.DecimalField(_('price'), decimal_places=2, max_digits=10)
     name = models.CharField(_('name'), max_length=255)
     offer = models.ForeignKey(Offer, verbose_name=_('offer'), null=True, blank=True)
     price = models.DecimalField(_('price'), decimal_places=2, max_digits=10)
     name = models.CharField(_('name'), max_length=255)

-    description = models.TextField(_('description'), blank=True)
+    long_name = models.CharField(_('long name'), max_length=255)
+    end_date = models.DateField(_('end date'), null=True, blank=True)

 
     class Meta:
         verbose_name = _('perk')
 
     class Meta:
         verbose_name = _('perk')


@@ -86,17 +203,126 @@ class Perk(models.Model):
 
 
 class Funding(models.Model):
 
 
 class Funding(models.Model):

+    """ A person paying in a fundraiser.
+
+    The payment was completed if and only if payed_at is set.
+
+    """

     offer = models.ForeignKey(Offer, verbose_name=_('offer'))
     offer = models.ForeignKey(Offer, verbose_name=_('offer'))

-    name = models.CharField(_('name'), max_length=127)
-    email = models.EmailField(_('email'))
+    name = models.CharField(_('name'), max_length=127, blank=True)
+    email = models.EmailField(_('email'), blank=True, db_index=True)

     amount = models.DecimalField(_('amount'), decimal_places=2, max_digits=10)
     amount = models.DecimalField(_('amount'), decimal_places=2, max_digits=10)

-    payed_at = models.DateTimeField(_('payed_at'))
+    payed_at = models.DateTimeField(_('payed at'), null=True, blank=True, db_index=True)

     perks = models.ManyToManyField(Perk, verbose_name=_('perks'), blank=True)
     perks = models.ManyToManyField(Perk, verbose_name=_('perks'), blank=True)

+    language_code = models.CharField(max_length=2, null=True, blank=True)
+    notifications = models.BooleanField(_('notifications'), default=True, db_index=True)
+    notify_key = models.CharField(max_length=32)

 
     class Meta:
         verbose_name = _('funding')
         verbose_name_plural = _('fundings')
         ordering = ['-payed_at']
 
 
     class Meta:
         verbose_name = _('funding')
         verbose_name_plural = _('fundings')
         ordering = ['-payed_at']
 

+    @classmethod
+    def payed(cls):
+        """ QuerySet for all completed payments. """
+        return cls.objects.exclude(payed_at=None)
+
+    def __unicode__(self):
+        return unicode(self.offer)
+
+    def get_absolute_url(self):
+        return reverse('funding_funding', args=[self.pk])
+
+    def perk_names(self):
+        return ", ".join(perk.name for perk in self.perks.all())
+
+    def get_disable_notifications_url(self):
+        return "%s?%s" % (reverse("funding_disable_notifications"),
+            urlencode({
+                'email': self.email,
+                'key': self.notify_key,
+            }))
+
+    def save(self, *args, **kwargs):
+        if self.email and not self.notify_key:
+            self.notify_key = get_random_hash(self.email)
+        return super(Funding, self).save(*args, **kwargs)
+
+    @classmethod
+    def notify_funders(cls, subject, template_name, extra_context=None,
+                query_filter=None, payed_only=True):
+        funders = cls.objects.exclude(email="").filter(notifications=True)
+        if payed_only:
+            funders = funders.exclude(payed_at=None)
+        if query_filter is not None:
+            funders = funders.filter(query_filter)
+        emails = set()
+        for funder in funders:
+            if funder.email in emails:
+                continue
+            emails.add(funder.email)
+            funder.notify(subject, template_name, extra_context)
+
+    def notify(self, subject, template_name, extra_context=None):
+        context = {
+            'funding': self,
+            'site': Site.objects.get_current(),
+        }
+        if extra_context:
+            context.update(extra_context)
+        with override(self.language_code or app_settings.DEFAULT_LANGUAGE):
+            send_mail(subject,
+                render_to_string(template_name, context),
+                settings.CONTACT_EMAIL,
+                [self.email],
+                fail_silently=False
+            )
+
+    def disable_notifications(self):
+        """Disables all notifications for this e-mail address."""
+        type(self).objects.filter(email=self.email).update(notifications=False)
+
+
+# Register the Funding model with django-getpaid for payments.
+getpaid.register_to_payment(Funding, unique=False, related_name='payment')
+
+
+class Spent(models.Model):
+    """ Some of the remaining money spent on a book. """
+    book = models.ForeignKey(Book)
+    amount = models.DecimalField(_('amount'), decimal_places=2, max_digits=10)
+    timestamp = models.DateField(_('when'))
+
+    class Meta:
+        verbose_name = _('money spent on a book')
+        verbose_name_plural = _('money spent on books')
+        ordering = ['-timestamp']
+

     def __unicode__(self):
     def __unicode__(self):

-        return "%s payed %s for %s" % (self.name, self.amount, self.offer)
+        return u"Spent: %s" % unicode(self.book)
+
+
+def new_payment_query_listener(sender, order=None, payment=None, **kwargs):
+    """ Set payment details for getpaid. """
+    payment.amount = order.amount
+    payment.currency = 'PLN'
+getpaid.signals.new_payment_query.connect(new_payment_query_listener)
+
+
+def user_data_query_listener(sender, order, user_data, **kwargs):
+    """ Set user data for payment. """
+    user_data['email'] = order.email
+getpaid.signals.user_data_query.connect(user_data_query_listener)
+
+def payment_status_changed_listener(sender, instance, old_status, new_status, **kwargs):
+    """ React to status changes from getpaid. """
+    if old_status != 'paid' and new_status == 'paid':
+        instance.order.payed_at = datetime.utcnow().replace(tzinfo=utc)
+        instance.order.save()
+        if instance.order.email:
+            instance.order.notify(
+                _('Thank you for your support!'),
+                'funding/email/thanks.txt'
+            )
+getpaid.signals.payment_status_changed.connect(payment_status_changed_listener)