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