src/club/models.py

   1 # This file is part of Wolnelektury, licensed under GNU Affero GPLv3 or later.
   2 # Copyright © Fundacja Nowoczesna Polska. See NOTICE for more information.
   3 #
   4 from datetime import datetime, timedelta
   5 import os
   6 import tempfile
   7 from django.apps import apps
   8 from django.conf import settings
   9 from django.contrib.sites.models import Site
  10 from django.core.mail import send_mail, EmailMessage
  11 from django.urls import reverse
  12 from django.db import models
  13 from django import template
  14 from django.utils.timezone import now
  15 from django.utils.translation import ugettext_lazy as _, ungettext, ugettext, get_language
  16 from django_countries.fields import CountryField
  17 from catalogue.utils import get_random_hash
  18 from messaging.states import Level
  19 from reporting.utils import render_to_pdf
  20 from .payment_methods import methods
  21 from .payu import models as payu_models
  22 from . import utils
  23
  24
  25 class Club(models.Model):
  26     min_amount = models.IntegerField(_('minimum amount'))
  27     min_for_year = models.IntegerField(_('minimum amount for year'))
  28     single_amounts = models.CharField(_('proposed amounts for single payment'), max_length=255)
  29     default_single_amount = models.IntegerField(_('default single amount'))
  30     monthly_amounts = models.CharField(_('proposed amounts for monthly payments'), max_length=255)
  31     default_monthly_amount = models.IntegerField(_('default monthly amount'))
  32
  33     class Meta:
  34         verbose_name = _('club')
  35         verbose_name_plural = _('clubs')
  36
  37     def __str__(self):
  38         return 'Klub'
  39
  40     def proposed_single_amounts(self):
  41         return [int(x) for x in self.single_amounts.split(',')]
  42
  43     def proposed_monthly_amounts(self):
  44         return [int(x) for x in self.monthly_amounts.split(',')]
  45
  46
  47 class Consent(models.Model):
  48     order = models.IntegerField()
  49     active = models.BooleanField(default=True)
  50     text = models.CharField(max_length=2048)
  51     required = models.BooleanField()
  52
  53     class Meta:
  54         ordering = ['order']
  55
  56     def __str__(self):
  57         return self.text
  58
  59
  60 class Schedule(models.Model):
  61     """ Represents someone taking up a plan. """
  62     key = models.CharField(_('key'), max_length=255, unique=True)
  63     email = models.EmailField(_('email'))
  64     membership = models.ForeignKey('Membership', verbose_name=_('membership'), null=True, blank=True, on_delete=models.SET_NULL)
  65     amount = models.DecimalField(_('amount'), max_digits=10, decimal_places=2)
  66     method = models.CharField(_('method'), max_length=32, choices=[
  67         (m.slug, m.name) for m in methods
  68         ])
  69     monthly = models.BooleanField(_('monthly'), default=True)
  70     yearly = models.BooleanField(_('yearly'), default=False)
  71
  72     source = models.CharField(_('source'), max_length=255, blank=True)
  73
  74     is_cancelled = models.BooleanField(_('cancelled'), default=False)
  75     payed_at = models.DateTimeField(_('payed at'), null=True, blank=True)
  76     started_at = models.DateTimeField(_('started at'), auto_now_add=True)
  77     expires_at = models.DateTimeField(_('expires_at'), null=True, blank=True)
  78     email_sent = models.BooleanField(default=False)
  79
  80     first_name = models.CharField(max_length=255, blank=True)
  81     last_name = models.CharField(max_length=255, blank=True)
  82     phone = models.CharField(max_length=255, blank=True)
  83     postal = models.CharField(max_length=255, blank=True)
  84     postal_code = models.CharField(max_length=255, blank=True)
  85     postal_town = models.CharField(max_length=255, blank=True)
  86     postal_country = CountryField(default='PL', blank=True)
  87
  88     consent = models.ManyToManyField(Consent)
  89
  90     class Meta:
  91         verbose_name = _('schedule')
  92         verbose_name_plural = _('schedules')
  93
  94     def __str__(self):
  95         return self.key
  96
  97     def save(self, *args, **kwargs):
  98         if not self.key:
  99             self.key = get_random_hash(self.email)
 100         super(Schedule, self).save(*args, **kwargs)
 101         self.update_contact()
 102
 103     def initiate_payment(self, request):
 104         return self.get_payment_method().initiate(request, self)
 105
 106     def pay(self, request):
 107         return self.get_payment_method().pay(request, self)
 108
 109     def get_absolute_url(self):
 110         return reverse('club_schedule', args=[self.key])
 111
 112     def get_thanks_url(self):
 113         return reverse('club_thanks', args=[self.key])
 114
 115     def get_payment_method(self):
 116         return [m for m in methods if m.slug == self.method][0]
 117
 118     def is_expired(self):
 119         return self.expires_at is not None and self.expires_at <= now()
 120
 121     def is_active(self):
 122         return self.payed_at is not None and (self.expires_at is None or self.expires_at > now())
 123
 124     def is_recurring(self):
 125         return self.monthly or self.yearly
 126
 127     def set_payed(self):
 128         since = self.expires_at
 129         n = now()
 130         if since is None or since < n:
 131             since = n
 132         new_exp = self.get_next_installment(since)
 133         if self.payed_at is None:
 134             self.payed_at = n
 135         if self.expires_at is None or self.expires_at < new_exp:
 136             self.expires_at = new_exp
 137             self.save()
 138
 139         if not self.email_sent:
 140             self.send_email()
 141
 142     def get_next_installment(self, date):
 143         if self.yearly:
 144             return utils.add_year(date)
 145         if self.monthly:
 146             return utils.add_month(date)
 147         club = Club.objects.first()
 148         if club is not None and self.amount >= club.min_for_year:
 149             return utils.add_year(date)
 150         return utils.add_month(date)
 151
 152     def send_email(self):
 153         ctx = {'schedule': self}
 154         send_mail(
 155             template.loader.render_to_string('club/email/thanks_subject.txt', ctx).strip(),
 156             template.loader.render_to_string('club/email/thanks.txt', ctx),
 157             settings.CONTACT_EMAIL, [self.email], fail_silently=False)
 158         self.email_sent = True
 159         self.save()
 160
 161     def update_contact(self):
 162         Contact = apps.get_model('messaging', 'Contact')
 163         if not self.payed_at:
 164             level = Level.TRIED
 165             since = self.started_at
 166         else:
 167             since = self.payed_at
 168             if self.is_recurring():
 169                 level = Level.RECURRING
 170             else:
 171                 level = Level.SINGLE
 172         Contact.update(self.email, level, since, self.expires_at)
 173
 174
 175
 176
 177
 178 class Membership(models.Model):
 179     """ Represents a user being recognized as a member of the club. """
 180     user = models.OneToOneField(settings.AUTH_USER_MODEL, verbose_name=_('user'), on_delete=models.CASCADE)
 181     created_at = models.DateTimeField(_('created at'), auto_now_add=True)
 182     name = models.CharField(_('name'), max_length=255, blank=True)
 183     manual = models.BooleanField(_('manual'), default=False)
 184     notes = models.CharField(_('notes'), max_length=2048, blank=True)
 185     updated_at = models.DateField(_('updated at'), auto_now=True, blank=True)
 186
 187     class Meta:
 188         verbose_name = _('membership')
 189         verbose_name_plural = _('memberships')
 190
 191     def __str__(self):
 192         return str(self.user)
 193
 194     def save(self, *args, **kwargs):
 195         super().save(*args, **kwargs)
 196         self.update_contact()
 197
 198     def update_contact(self):
 199         email = self.user.email
 200         if not email:
 201             return
 202
 203         Contact = apps.get_model('messaging', 'Contact')
 204         if self.manual:
 205             Contact.update(email, Level.MANUAL_MEMBER, self.updated_at)
 206         else:
 207             Contact.reset(email)
 208
 209     @classmethod
 210     def is_active_for(cls, user):
 211         if user.is_anonymous:
 212             return False
 213         try:
 214             membership = user.membership
 215         except cls.DoesNotExist:
 216             return False
 217         if membership.manual:
 218             return True
 219         return Schedule.objects.filter(
 220                 expires_at__gt=now(),
 221                 membership__user=user,
 222             ).exists()
 223
 224
 225 class ReminderEmail(models.Model):
 226     days_before = models.SmallIntegerField(_('days before'))
 227     subject = models.CharField(_('subject'), max_length=1024)
 228     body = models.TextField(_('body'))
 229
 230     class Meta:
 231         verbose_name = _('reminder email')
 232         verbose_name_plural = _('reminder emails')
 233         ordering = ['days_before']
 234
 235     def __str__(self):
 236         if self.days_before >= 0:
 237             return ungettext('a day before expiration', '%d days before expiration', n=self.days_before)
 238         else:
 239             return ungettext('a day after expiration', '%d days after expiration', n=-self.days_before)
 240
 241
 242 class Ambassador(models.Model):
 243     name = models.CharField(_('name'), max_length=255)
 244     photo = models.ImageField(_('photo'), blank=True)
 245     text = models.CharField(_('text'), max_length=1024)
 246
 247     class Meta:
 248         verbose_name = _('ambassador')
 249         verbose_name_plural = _('ambassadors')
 250         ordering = ['name']
 251
 252     def __str__(self):
 253         return self.name
 254
 255
 256 ########
 257 #      #
 258 # PayU #
 259 #      #
 260 ########
 261
 262 class PayUOrder(payu_models.Order):
 263     schedule = models.ForeignKey(Schedule, on_delete=models.CASCADE)
 264
 265     def get_amount(self):
 266         return self.schedule.amount
 267
 268     def get_buyer(self):
 269         return {
 270             "email": self.schedule.email,
 271             "language": get_language(),
 272         }
 273
 274     def get_continue_url(self):
 275         return "https://{}{}".format(
 276             Site.objects.get_current().domain,
 277             self.schedule.get_thanks_url())
 278
 279     def get_description(self):
 280         return ugettext('Towarzystwo Przyjaciół Wolnych Lektur')
 281
 282     def is_recurring(self):
 283         return self.schedule.get_payment_method().is_recurring
 284
 285     def get_card_token(self):
 286         return self.schedule.payucardtoken_set.order_by('-created_at').first()
 287
 288     def get_notify_url(self):
 289         return "https://{}{}".format(
 290             Site.objects.get_current().domain,
 291             reverse('club_payu_notify', args=[self.pk]))
 292
 293     def status_updated(self):
 294         if self.status == 'COMPLETED':
 295             self.schedule.set_payed()
 296
 297
 298     @classmethod
 299     def send_receipt(cls, email, year):
 300         Contact = apps.get_model('messaging', 'Contact')
 301         Funding = apps.get_model('funding', 'Funding')
 302         BillingAgreement = apps.get_model('paypal', 'BillingAgreement')
 303         payments = []
 304
 305         try:
 306             contact = Contact.objects.get(email=email)
 307         except Contact.DoesNotExist:
 308             funding = Funding.objects.filter(
 309                 email=email,
 310                 payed_at__year=year,
 311                 notifications=True).order_by('payed_at').first()
 312             if funding is None:
 313                 print('no notifications')
 314                 return
 315             optout = funding.wl_optout_url()
 316         else:
 317             if contact.level == Level.OPT_OUT:
 318                 print('opt-out')
 319                 return
 320             optout = contact.wl_optout_url()
 321
 322         qs = cls.objects.filter(status='COMPLETED', schedule__email=email, completed_at__year=year).order_by('completed_at')
 323         for order in qs:
 324             payments.append({
 325                 'timestamp': order.completed_at,
 326                 'amount': order.get_amount(),
 327             })
 328
 329         for ba in BillingAgreement.objects.filter(schedule__email=email):
 330             payments.extend(ba.get_donations(year))
 331
 332         fundings = Funding.objects.filter(
 333             email=email,
 334             payed_at__year=year
 335         ).order_by('payed_at')
 336         for funding in fundings:
 337             payments.append({
 338                 'timestamp': funding.payed_at,
 339                 'amount': funding.amount,
 340             })
 341
 342         if not payments: return
 343
 344         payments.sort(key=lambda x: x['timestamp'])
 345
 346         ctx = {
 347             "email": email,
 348             "year": year,
 349             "next_year": year + 1,
 350             "total": sum(x['amount'] for x in payments),
 351             "payments": payments,
 352             "optout": optout,
 353         }
 354         temp = tempfile.NamedTemporaryFile(prefix='receipt-', suffix='.pdf', delete=False)
 355         temp.close()
 356         render_to_pdf(temp.name, 'club/receipt.texml', ctx, {
 357             "fnp.eps": os.path.join(settings.STATIC_ROOT, "img/fnp.eps"),
 358             })
 359
 360         message = EmailMessage(
 361                 'Odlicz darowiznę na Wolne Lektury od podatku',
 362                 template.loader.render_to_string('club/receipt_email.txt', ctx),
 363                 settings.CONTACT_EMAIL, [email]
 364             )
 365         with open(temp.name, 'rb') as f:
 366             message.attach('wolnelektury-darowizny.pdf', f.read(), 'application/pdf')
 367         message.send()
 368         os.unlink(f.name)
 369
 370
 371 class PayUCardToken(payu_models.CardToken):
 372     schedule = models.ForeignKey(Schedule, on_delete=models.CASCADE)
 373
 374
 375 class PayUNotification(payu_models.Notification):
 376     order = models.ForeignKey(PayUOrder, models.CASCADE, related_name='notification_set')