fixes #2930: info about perks in admin.
[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 and self == self.current()
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
82         Current fundraiser is the one that:
83         - has already started,
84         - hasn't yet ended,
85         - if there's more than one of those, it's the one that ends last.
86
87         """
88         today = date.today()
89         objects = cls.objects.filter(start__lte=today, end__gte=today).order_by('-end')
90         try:
91             return objects[0]
92         except IndexError:
93             return None
94
95     @classmethod
96     def past(cls):
97         """ QuerySet for all past fundraisers. """
98         objects = cls.public()
99         current = cls.current()
100         if current is not None:
101             objects = objects.exclude(pk=current.pk)
102         return objects
103
104     @classmethod
105     def public(cls):
106         """ QuerySet for all current and past fundraisers. """
107         today = date.today()
108         return cls.objects.filter(start__lte=today)
109
110     def get_perks(self, amount=None):
111         """ Finds all the perks for the offer.
112         
113         If amount is provided, returns the perks you get for it.
114
115         """
116         perks = Perk.objects.filter(
117                 models.Q(offer=self) | models.Q(offer=None)
118             ).exclude(end_date__lt=date.today())
119         if amount is not None:
120             perks = perks.filter(price__lte=amount)
121         return perks
122
123     def funding_payed(self):
124         """ QuerySet for all completed payments for the offer. """
125         return Funding.payed().filter(offer=self)
126
127     def funders(self):
128         return self.funding_payed().order_by('-amount', 'payed_at')
129
130     def sum(self):
131         """ The money gathered. """
132         return self.funding_payed().aggregate(s=models.Sum('amount'))['s'] or 0
133
134     def notify_all(self, subject, template_name, extra_context=None):
135         Funding.notify_funders(
136             subject, template_name, extra_context,
137             query_filter=models.Q(offer=self)
138         )
139
140     def notify_end(self, force=False):
141         if not force and self.notified_end: return
142         assert not self.is_current()
143         self.notify_all(
144             _('The fundraiser has ended!'),
145             'funding/email/end.txt', {
146                 'offer': self,
147                 'is_win': self.is_win(),
148                 'remaining': self.remaining(),
149                 'current': self.current(),
150             })
151         self.notified_end = datetime.now()
152         self.save()
153
154     def notify_near(self, force=False):
155         if not force and self.notified_near: return
156         assert self.is_current()
157         sum_ = self.sum()
158         need = self.target - sum_
159         self.notify_all(
160             _('The fundraiser will end soon!'),
161             'funding/email/near.txt', {
162                 'days': (self.end - date.today()).days + 1,
163                 'offer': self,
164                 'is_win': self.is_win(),
165                 'sum': sum_,
166                 'need': need,
167             })
168         self.notified_near = datetime.now()
169         self.save()
170
171     def notify_published(self):
172         assert self.book is not None
173         self.notify_all(
174             _('The book you helped fund has been published.'),
175             'funding/email/published.txt', {
176                 'offer': self,
177                 'book': self.book,
178                 'author': ", ".join(a[0] for a in self.book.related_info()['tags']['author']),
179                 'current': self.current(),
180             })
181
182
183 class Perk(models.Model):
184     """ A perk offer.
185     
186     If no attached to a particular Offer, applies to all.
187
188     """
189     offer = models.ForeignKey(Offer, verbose_name=_('offer'), null=True, blank=True)
190     price = models.DecimalField(_('price'), decimal_places=2, max_digits=10)
191     name = models.CharField(_('name'), max_length=255)
192     long_name = models.CharField(_('long name'), max_length=255)
193     end_date = models.DateField(_('end date'), null=True, blank=True)
194
195     class Meta:
196         verbose_name = _('perk')
197         verbose_name_plural = _('perks')
198         ordering = ['-price']
199
200     def __unicode__(self):
201         return "%s (%s%s)" % (self.name, self.price, u" for %s" % self.offer if self.offer else "")
202
203
204 class Funding(models.Model):
205     """ A person paying in a fundraiser.
206
207     The payment was completed if and only if payed_at is set.
208
209     """
210     offer = models.ForeignKey(Offer, verbose_name=_('offer'))
211     name = models.CharField(_('name'), max_length=127, blank=True)
212     email = models.EmailField(_('email'), blank=True, db_index=True)
213     amount = models.DecimalField(_('amount'), decimal_places=2, max_digits=10)
214     payed_at = models.DateTimeField(_('payed at'), null=True, blank=True, db_index=True)
215     perks = models.ManyToManyField(Perk, verbose_name=_('perks'), blank=True)
216     language_code = models.CharField(max_length = 2, null = True, blank = True)
217     notifications = models.BooleanField(_('notifications'), default=True, db_index=True)
218     notify_key = models.CharField(max_length=32)
219
220     class Meta:
221         verbose_name = _('funding')
222         verbose_name_plural = _('fundings')
223         ordering = ['-payed_at']
224
225     @classmethod
226     def payed(cls):
227         """ QuerySet for all completed payments. """
228         return cls.objects.exclude(payed_at=None)
229
230     def __unicode__(self):
231         return unicode(self.offer)
232
233     def get_absolute_url(self):
234         return reverse('funding_funding', args=[self.pk])
235
236     def perk_names(self):
237         return ", ".join(perk.name for perk in self.perks.all())
238
239     def get_disable_notifications_url(self):
240         return "%s?%s" % (reverse("funding_disable_notifications"),
241             urlencode({
242                 'email': self.email,
243                 'key': self.notify_key,
244             }))
245
246     def save(self, *args, **kwargs):
247         if self.email and not self.notify_key:
248             self.notify_key = get_random_hash(self.email)
249         return super(Funding, self).save(*args, **kwargs)
250
251     @classmethod
252     def notify_funders(cls, subject, template_name, extra_context=None,
253                 query_filter=None, payed_only=True):
254         funders = cls.objects.exclude(email="").filter(notifications=True)
255         if payed_only:
256             funders = funders.exclude(payed_at=None)
257         if query_filter is not None:
258             funders = funders.filter(query_filter)
259         emails = set()
260         for funder in funders:
261             if funder.email in emails:
262                 continue
263             emails.add(funder.email)
264             funder.notify(subject, template_name, extra_context)
265
266     def notify(self, subject, template_name, extra_context=None):
267         context = {
268             'funding': self,
269             'site': Site.objects.get_current(),
270         }
271         if extra_context:
272             context.update(extra_context)
273         with override(self.language_code or app_settings.DEFAULT_LANGUAGE):
274             send_mail(subject,
275                 render_to_string(template_name, context),
276                 getattr(settings, 'CONTACT_EMAIL', 'wolnelektury@nowoczesnapolska.org.pl'),
277                 [self.email],
278                 fail_silently=False
279             )
280
281     def disable_notifications(self):
282         """Disables all notifications for this e-mail address."""
283         type(self).objects.filter(email=self.email).update(notifications=False)
284
285
286 # Register the Funding model with django-getpaid for payments.
287 getpaid.register_to_payment(Funding, unique=False, related_name='payment')
288
289
290 class Spent(models.Model):
291     """ Some of the remaining money spent on a book. """
292     book = models.ForeignKey(Book)
293     amount = models.DecimalField(_('amount'), decimal_places=2, max_digits=10)
294     timestamp = models.DateField(_('when'))
295
296     class Meta:
297         verbose_name = _('money spent on a book')
298         verbose_name_plural = _('money spent on books')
299         ordering = ['-timestamp']
300
301     def __unicode__(self):
302         return u"Spent: %s" % unicode(self.book)
303
304
305 def new_payment_query_listener(sender, order=None, payment=None, **kwargs):
306     """ Set payment details for getpaid. """
307     payment.amount = order.amount
308     payment.currency = 'PLN'
309 getpaid.signals.new_payment_query.connect(new_payment_query_listener)
310
311
312 def user_data_query_listener(sender, order, user_data, **kwargs):
313     """ Set user data for payment. """
314     user_data['email'] = order.email
315 getpaid.signals.user_data_query.connect(user_data_query_listener)
316
317 def payment_status_changed_listener(sender, instance, old_status, new_status, **kwargs):
318     """ React to status changes from getpaid. """
319     if old_status != 'paid' and new_status == 'paid':
320         instance.order.payed_at = datetime.now()
321         instance.order.save()
322         if instance.order.email:
323             instance.order.notify(
324                 _('Thank you for your support!'),
325                 'funding/email/thanks.txt'
326             )
327 getpaid.signals.payment_status_changed.connect(payment_status_changed_listener)