0e05e1dcdb320a7557c235a91bb6aea88da4a9a6
[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 django.core.urlresolvers import reverse
7 from django.core.mail import send_mail
8 from django.conf import settings
9 from django.template.loader import render_to_string
10 from django.db import models
11 from django.utils.translation import ugettext_lazy as _, ugettext as __
12 import getpaid
13 from catalogue.models import Book
14 from polls.models import Poll
15
16
17 class Offer(models.Model):
18     """ A fundraiser for a particular book. """
19     author = models.CharField(_('author'), max_length=255)
20     title = models.CharField(_('title'), max_length=255)
21     slug = models.SlugField(_('slug'))
22     description = models.TextField(_('description'), blank=True)
23     target = models.DecimalField(_('target'), decimal_places=2, max_digits=10)
24     start = models.DateField(_('start'), db_index=True)
25     end = models.DateField(_('end'), db_index=True)
26     due = models.DateField(_('due'),
27         help_text=_('When will it be published if the money is raised.'))
28     redakcja_url = models.URLField(_('redakcja URL'), blank=True)
29     book = models.ForeignKey(Book, null=True, blank=True,
30         help_text=_('Published book.'))
31     cover = models.ImageField(_('Cover'), upload_to = 'funding/covers')
32     poll = models.ForeignKey(Poll, help_text = _('Poll'),  null = True, on_delete = models.SET_NULL)
33         
34     def cover_img_tag(self):
35         return u'<img src="%s" />' % self.cover.url
36     cover_img_tag.short_description = _('Cover preview')
37     cover_img_tag.allow_tags = True
38         
39     class Meta:
40         verbose_name = _('offer')
41         verbose_name_plural = _('offers')
42         ordering = ['-end']
43
44     def __unicode__(self):
45         return u"%s - %s" % (self.author, self.title)
46
47     def get_absolute_url(self):
48         return reverse('funding_offer', args=[self.slug])
49
50     def is_current(self):
51         return self.start <= date.today() <= self.end
52
53     def is_win(self):
54         return self.sum() >= self.target
55
56     def remaining(self):
57         if self.is_current():
58             return None
59         if self.is_win():
60             return self.sum() - self.target
61         else:
62             return self.sum()
63
64     @classmethod
65     def current(cls):
66         """ Returns current fundraiser or None. """
67         today = date.today()
68         objects = cls.objects.filter(start__lte=today, end__gte=today)
69         try:
70             return objects[0]
71         except IndexError:
72             return None
73
74     @classmethod
75     def past(cls):
76         """ QuerySet for all current and past fundraisers. """
77         today = date.today()
78         return cls.objects.filter(end__lt=today)
79
80     @classmethod
81     def public(cls):
82         """ QuerySet for all current and past fundraisers. """
83         today = date.today()
84         return cls.objects.filter(start__lte=today)
85
86     def get_perks(self, amount=None):
87         """ Finds all the perks for the offer.
88         
89         If amount is provided, returns the perks you get for it.
90
91         """
92         perks = Perk.objects.filter(
93                 models.Q(offer=self) | models.Q(offer=None)
94             ).exclude(end_date__lt=date.today())
95         if amount is not None:
96             perks = perks.filter(price__lte=amount)
97         return perks
98
99     def funding_payed(self):
100         """ QuerySet for all completed payments for the offer. """
101         return Funding.payed().filter(offer=self)
102
103     def sum(self):
104         """ The money gathered. """
105         return self.funding_payed().aggregate(s=models.Sum('amount'))['s'] or 0
106
107
108 class Perk(models.Model):
109     """ A perk offer.
110     
111     If no attached to a particular Offer, applies to all.
112
113     """
114     offer = models.ForeignKey(Offer, verbose_name=_('offer'), null=True, blank=True)
115     price = models.DecimalField(_('price'), decimal_places=2, max_digits=10)
116     name = models.CharField(_('name'), max_length=255)
117     description = models.TextField(_('description'), blank=True)
118     end_date = models.DateField(_('end date'), null=True, blank=True)
119
120     class Meta:
121         verbose_name = _('perk')
122         verbose_name_plural = _('perks')
123         ordering = ['-price']
124
125     def __unicode__(self):
126         return "%s (%s%s)" % (self.name, self.price, u" for %s" % self.offer if self.offer else "")
127
128
129 class Funding(models.Model):
130     """ A person paying in a fundraiser.
131
132     The payment was completed if and only if payed_at is set.
133
134     """
135     offer = models.ForeignKey(Offer, verbose_name=_('offer'))
136     name = models.CharField(_('name'), max_length=127, blank=True)
137     email = models.EmailField(_('email'), blank=True)
138     amount = models.DecimalField(_('amount'), decimal_places=2, max_digits=10)
139     payed_at = models.DateTimeField(_('payed at'), null=True, blank=True, db_index=True)
140     perks = models.ManyToManyField(Perk, verbose_name=_('perks'), blank=True)
141
142     # Any additional info needed for perks?
143
144     @classmethod
145     def payed(cls):
146         """ QuerySet for all completed payments. """
147         return cls.objects.exclude(payed_at=None)
148
149     class Meta:
150         verbose_name = _('funding')
151         verbose_name_plural = _('fundings')
152         ordering = ['-payed_at']
153
154     def __unicode__(self):
155         return unicode(self.offer)
156
157     def get_absolute_url(self):
158         return reverse('funding_funding', args=[self.pk])
159
160 # Register the Funding model with django-getpaid for payments.
161 getpaid.register_to_payment(Funding, unique=False, related_name='payment')
162
163
164 class Spent(models.Model):
165     """ Some of the remaining money spent on a book. """
166     book = models.ForeignKey(Book)
167     amount = models.DecimalField(_('amount'), decimal_places=2, max_digits=10)
168     timestamp = models.DateField(_('when'))
169
170     class Meta:
171         verbose_name = _('money spent on a book')
172         verbose_name_plural = _('money spent on books')
173         ordering = ['-timestamp']
174
175     def __unicode__(self):
176         return u"Spent: %s" % unicode(self.book)
177
178
179 def new_payment_query_listener(sender, order=None, payment=None, **kwargs):
180     """ Set payment details for getpaid. """
181     payment.amount = order.amount
182     payment.currency = 'PLN'
183 getpaid.signals.new_payment_query.connect(new_payment_query_listener)
184
185
186 def user_data_query_listener(sender, order, user_data, **kwargs):
187     """ Set user data for payment. """
188     user_data['email'] = order.email
189 getpaid.signals.user_data_query.connect(user_data_query_listener)
190
191 def payment_status_changed_listener(sender, instance, old_status, new_status, **kwargs):
192     """ React to status changes from getpaid. """
193     if old_status != 'paid' and new_status == 'paid':
194         instance.order.payed_at = datetime.now()
195         instance.order.save()
196         if instance.order.email:
197             send_thank_you_email(instance.order.name, instance.order.email)
198 getpaid.signals.payment_status_changed.connect(payment_status_changed_listener)
199
200 def send_thank_you_email(name, address):
201     send_mail(_('Thank you for your support!'), 
202             render_to_string('funding/email.txt', dict(name = name)),
203             getattr(settings, 'CONTACT_EMAIL', 'wolnelektury@nowoczesnapolska.org.pl'),
204             [address],
205             fail_silently=False
206             )
207