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