Funding changes.

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

diff --git a/src/funding/models.py b/src/funding/models.py
index e36b732..7d0e742 100644 (file)
--- a/src/funding/models.py
+++ b/src/funding/models.py
@@ -1,23 +1,25 @@
-# -*- coding: utf-8 -*-

 # 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
 # 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 urllib.parse import urlencode

 from django.conf import settings
 from django.contrib.sites.models import Site
 from django.conf import settings
 from django.contrib.sites.models import Site

-from django.core.urlresolvers import reverse

 from django.core.mail import send_mail
 from django.db import models
 from django.core.mail import send_mail
 from django.db import models

+from django.dispatch import receiver

 from django.template.loader import render_to_string
 from django.template.loader import render_to_string

+from django.urls import reverse
+from django.utils.html import mark_safe

 from django.utils.timezone import utc
 from django.utils.timezone import utc

-from django.utils.translation import ugettext_lazy as _, override
-import getpaid
-from ssify import flush_ssi_includes
+from django.utils.translation import gettext_lazy as _, override

 from catalogue.models import Book
 from catalogue.utils import get_random_hash
 from polls.models import Poll
 from catalogue.models import Book
 from catalogue.utils import get_random_hash
 from polls.models import Poll

+import club.payu.models
+from wolnelektury.utils import cached_render, clear_cached_renders

 from . import app_settings
 from . import app_settings

+from . import utils

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


@@ -30,8 +32,7 @@ class Offer(models.Model):
     start = models.DateField(_('start'), db_index=True)
     end = models.DateField(_('end'), db_index=True)
     redakcja_url = models.URLField(_('redakcja URL'), blank=True)
     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.'))
+    book = models.ForeignKey(Book, models.PROTECT, 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)
 
     cover = models.ImageField(_('Cover'), upload_to='funding/covers')
     poll = models.ForeignKey(Poll, help_text=_('Poll'), null=True, blank=True, on_delete=models.SET_NULL)
 


@@ -39,46 +40,41 @@ class Offer(models.Model):
     notified_end = models.DateTimeField(_('End notifications sent'), blank=True, null=True)
 
     def cover_img_tag(self):
     notified_end = models.DateTimeField(_('End notifications sent'), blank=True, null=True)
 
     def cover_img_tag(self):

-        return u'<img src="%s" />' % self.cover.url
+        return mark_safe('<img src="%s" />' % self.cover.url)

     cover_img_tag.short_description = _('Cover preview')
     cover_img_tag.short_description = _('Cover preview')

-    cover_img_tag.allow_tags = True

 
     class Meta:
         verbose_name = _('offer')
         verbose_name_plural = _('offers')
         ordering = ['-end']
 
 
     class Meta:
         verbose_name = _('offer')
         verbose_name_plural = _('offers')
         ordering = ['-end']
 

-    def __unicode__(self):
-        return u"%s - %s" % (self.author, self.title)
+    def __str__(self):
+        return "%s - %s" % (self.author, self.title)

 
     def get_absolute_url(self):
         return reverse('funding_offer', args=[self.slug])
 
     def save(self, *args, **kw):
 
     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
+        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)
             type(self).objects.values('book').get(pk=self.pk)['book'] != self.book_id)
         retval = super(Offer, self).save(*args, **kw)

-        self.flush_includes()
+        self.clear_cache()

         if published_now:
             self.notify_published()
         return retval
 
         if published_now:
             self.notify_published()
         return retval
 

-    def flush_includes(self):
-        flush_ssi_includes([
-            template % (self.pk, lang)
-            for template in [
-                '/wesprzyj/o/%d/top-bar.%s.html',
-                '/wesprzyj/o/%d/detail-bar.%s.html',
-                '/wesprzyj/o/%d/list-bar.%s.html',
-                '/wesprzyj/o/%d/status.%s.html',
-                '/wesprzyj/o/%d/status-more.%s.html',
-                ] + [
-                    '/wesprzyj/o/%%d/fundings/%d.%%s.html' % page
-                    for page in range(1, len(self.funding_payed()) // 10 + 2)
-                ]
-            for lang in [lc for (lc, _ln) in settings.LANGUAGES]
-            ])
+    def get_payu_payment_title(self):
+        return utils.sanitize_payment_title(str(self))
+
+    def clear_cache(self):
+        clear_cached_renders(self.top_bar)
+        clear_cached_renders(self.top_bar_2022)
+        clear_cached_renders(self.list_bar)
+        clear_cached_renders(self.detail_bar)
+        clear_cached_renders(self.detail_bar_2022)
+        clear_cached_renders(self.status)
+        clear_cached_renders(self.status_more)

 
     def is_current(self):
         return self.start <= date.today() <= self.end and self == self.current()
 
     def is_current(self):
         return self.start <= date.today() <= self.end and self == self.current()


@@ -144,7 +140,7 @@ class Offer(models.Model):
         return Funding.payed().filter(offer=self)
 
     def funders(self):
         return Funding.payed().filter(offer=self)
 
     def funders(self):

-        return self.funding_payed().order_by('-amount', 'payed_at')
+        return self.funding_payed().order_by('-amount', 'completed_at')

 
     def sum(self):
         """ The money gathered. """
 
     def sum(self):
         """ The money gathered. """


@@ -157,7 +153,8 @@ class Offer(models.Model):
         )
 
     def notify_end(self, force=False):
         )
 
     def notify_end(self, force=False):

-        if not force and self.notified_end: return
+        if not force and self.notified_end:
+            return

         assert not self.is_current()
         self.notify_all(
             _('The fundraiser has ended!'),
         assert not self.is_current()
         self.notify_all(
             _('The fundraiser has ended!'),


@@ -171,7 +168,8 @@ class Offer(models.Model):
         self.save()
 
     def notify_near(self, force=False):
         self.save()
 
     def notify_near(self, force=False):

-        if not force and self.notified_near: return
+        if not force and self.notified_near:
+            return

         assert self.is_current()
         sum_ = self.sum()
         need = self.target - sum_
         assert self.is_current()
         sum_ = self.sum()
         need = self.target - sum_


@@ -198,6 +196,73 @@ class Offer(models.Model):
                 'current': self.current(),
             })
 
                 'current': self.current(),
             })
 

+    def basic_info(self):
+        offer_sum = self.sum()
+        return {
+            'offer': self,
+            'sum': offer_sum,
+            'is_current': self.is_current(),
+            'is_win': offer_sum >= self.target,
+            'missing': self.target - offer_sum,
+            'percentage': 100 * offer_sum / self.target,
+
+            'show_title': True,
+            'show_title_calling': True,
+        }
+
+    @cached_render('funding/includes/funding.html')
+    def top_bar(self):
+        ctx = self.basic_info()
+        ctx.update({
+            'link': True,
+            'closeable': True,
+            'add_class': 'funding-top-header',
+        })
+        return ctx
+
+    @cached_render('funding/includes/funding.html')
+    def list_bar(self):
+        ctx = self.basic_info()
+        ctx.update({
+            'link': True,
+            'show_title_calling': False,
+        })
+        return ctx
+
+    @cached_render('funding/includes/funding.html')
+    def detail_bar(self):
+        ctx = self.basic_info()
+        ctx.update({
+            'show_title': False,
+        })
+        return ctx
+
+    @cached_render('funding/includes/offer_status.html')
+    def status(self):
+        return {'offer': self}
+
+    @cached_render('funding/includes/offer_status_more.html')
+    def status_more(self):
+        return {'offer': self}
+
+    @cached_render('funding/2022/includes/funding.html')
+    def top_bar_2022(self):
+        ctx = self.basic_info()
+        ctx.update({
+            'link': True,
+            'closeable': True,
+            'add_class': 'funding-top-header',
+        })
+        return ctx
+
+    @cached_render('funding/2022/includes/funding.html')
+    def detail_bar_2022(self):
+        ctx = self.basic_info()
+        ctx.update({
+            'show_title': False,
+        })
+        return ctx
+

 
 class Perk(models.Model):
     """ A perk offer.
 
 class Perk(models.Model):
     """ A perk offer.


@@ -205,7 +270,7 @@ class Perk(models.Model):
     If no attached to a particular Offer, applies to all.
 
     """
     If no attached to a particular Offer, applies to all.
 
     """

-    offer = models.ForeignKey(Offer, verbose_name=_('offer'), null=True, blank=True)
+    offer = models.ForeignKey(Offer, models.CASCADE, verbose_name=_('offer'), null=True, blank=True)

     price = models.DecimalField(_('price'), decimal_places=2, max_digits=10)
     name = models.CharField(_('name'), max_length=255)
     long_name = models.CharField(_('long name'), max_length=255)
     price = models.DecimalField(_('price'), decimal_places=2, max_digits=10)
     name = models.CharField(_('name'), max_length=255)
     long_name = models.CharField(_('long name'), max_length=255)


@@ -216,21 +281,23 @@ class Perk(models.Model):
         verbose_name_plural = _('perks')
         ordering = ['-price']
 
         verbose_name_plural = _('perks')
         ordering = ['-price']
 

-    def __unicode__(self):
-        return "%s (%s%s)" % (self.name, self.price, u" for %s" % self.offer if self.offer else "")
+    def __str__(self):
+        return "%s (%s%s)" % (self.name, self.price, " for %s" % self.offer if self.offer else "")

 
 
 
 

-class Funding(models.Model):
+class Funding(club.payu.models.Order):

     """ A person paying in a fundraiser.
 
     """ A person paying in a fundraiser.
 

-    The payment was completed if and only if payed_at is set.
+    The payment was completed if and only if completed_at is set.

 
     """
 
     """

-    offer = models.ForeignKey(Offer, verbose_name=_('offer'))
+    offer = models.ForeignKey(Offer, models.PROTECT, verbose_name=_('offer'))
+    customer_ip = models.GenericIPAddressField(_('customer IP'), null=True)
+    

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

+    user = models.ForeignKey(settings.AUTH_USER_MODEL, models.SET_NULL, blank=True, null=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'), null=True, blank=True, db_index=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)
     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)


@@ -239,42 +306,70 @@ class Funding(models.Model):
     class Meta:
         verbose_name = _('funding')
         verbose_name_plural = _('fundings')
     class Meta:
         verbose_name = _('funding')
         verbose_name_plural = _('fundings')

-        ordering = ['-payed_at']
+        ordering = ['-completed_at', 'pk']

 
     @classmethod
     def payed(cls):
         """ QuerySet for all completed payments. """
 
     @classmethod
     def payed(cls):
         """ QuerySet for all completed payments. """

-        return cls.objects.exclude(payed_at=None)
+        return cls.objects.exclude(completed_at=None)

 
 

-    def __unicode__(self):
-        return unicode(self.offer)
+    def __str__(self):
+        return str(self.offer)

 
 

-    def get_absolute_url(self):
-        return reverse('funding_funding', args=[self.pk])
+    def get_amount(self):
+        return self.amount
+
+    def get_buyer(self):
+        return {
+            "email": self.email,
+            "language": self.language_code,
+        }
+
+    def get_description(self):
+        return self.offer.get_payu_payment_title()
+
+    def get_thanks_url(self):
+        return reverse('funding_thanks')
+
+    def status_updated(self):
+        if self.status == 'COMPLETED':
+            if self.email:
+                self.notify(
+                    _('Thank you for your support!'),
+                    'funding/email/thanks.txt'
+                )
+
+    def get_notify_url(self):
+        return "https://{}{}".format(
+            Site.objects.get_current().domain,
+            reverse('funding_payu_notify', args=[self.pk]))

 
     def perk_names(self):
         return ", ".join(perk.name for perk in self.perks.all())
 
     def get_disable_notifications_url(self):
 
     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"),
+        return "%s?%s" % (
+            reverse("funding_disable_notifications"),

             urlencode({
                 'email': self.email,
                 'key': self.notify_key,
             }))
 
             urlencode({
                 'email': self.email,
                 'key': self.notify_key,
             }))
 

+    def wl_optout_url(self):
+        return 'https://wolnelektury.pl' + self.get_disable_notifications_url()
+

     def save(self, *args, **kwargs):
         if self.email and not self.notify_key:
             self.notify_key = get_random_hash(self.email)
         ret = super(Funding, self).save(*args, **kwargs)
     def save(self, *args, **kwargs):
         if self.email and not self.notify_key:
             self.notify_key = get_random_hash(self.email)
         ret = super(Funding, self).save(*args, **kwargs)

-        self.offer.flush_includes()
+        self.offer.clear_cache()

         return ret
 
     @classmethod
         return ret
 
     @classmethod

-    def notify_funders(cls, subject, template_name, extra_context=None,
-                query_filter=None, payed_only=True):
+    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 = cls.objects.exclude(email="").filter(notifications=True)
         if payed_only:

-            funders = funders.exclude(payed_at=None)
+            funders = funders.exclude(completed_at=None)

         if query_filter is not None:
             funders = funders.filter(query_filter)
         emails = set()
         if query_filter is not None:
             funders = funders.filter(query_filter)
         emails = set()


@@ -292,25 +387,22 @@ class Funding(models.Model):
         if extra_context:
             context.update(extra_context)
         with override(self.language_code or app_settings.DEFAULT_LANGUAGE):
         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
-            )
+            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)
 
 
 
     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 PayUNotification(club.payu.models.Notification):
+    order = models.ForeignKey(Funding, models.CASCADE, related_name='notification_set')

 
 
 class Spent(models.Model):
     """ Some of the remaining money spent on a book. """
 
 
 class Spent(models.Model):
     """ Some of the remaining money spent on a book. """

-    book = models.ForeignKey(Book)
+    book = models.ForeignKey(Book, models.PROTECT)

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


@@ -319,30 +411,6 @@ class Spent(models.Model):
         verbose_name_plural = _('money spent on books')
         ordering = ['-timestamp']
 
         verbose_name_plural = _('money spent on books')
         ordering = ['-timestamp']
 

-    def __unicode__(self):
-        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)
+    def __str__(self):
+        return "Spent: %s" % str(self.book)
+