src/club/models.py

   1 # This file is part of Wolne Lektury, licensed under GNU Affero GPLv3 or later.
   2 # Copyright © Fundacja Wolne Lektury. See NOTICE for more information.
   3 #
   4 from datetime import datetime, timedelta
   5 from decimal import Decimal
   6 import os
   7 import tempfile
   8 from django.apps import apps
   9 from django.conf import settings
  10 from django.contrib.sites.models import Site
  11 from django.core.mail import send_mail, EmailMessage
  12 from django.urls import reverse
  13 from django.db import models
  14 from django import template
  15 from django.utils.timezone import now, utc
  16 from django.utils.translation import get_language
  17 from django_countries.fields import CountryField
  18 from catalogue.utils import get_random_hash
  19 from messaging.states import Level
  20 from reporting.utils import render_to_pdf
  21 from .payment_methods import methods
  22 from .payu import models as payu_models
  23 from .civicrm import report_activity
  24 from . import utils
  25
  26
  27 class Club(models.Model):
  28     min_amount = models.IntegerField('minimalna kwota')
  29     min_for_year = models.IntegerField('minimalna kwota na rok')
  30     default_single_amount = models.IntegerField('domyślna kwota dla pojedynczej wpłaty')
  31     default_monthly_amount = models.IntegerField('domyślna kwota dla miesięcznych wpłat')
  32
  33     class Meta:
  34         verbose_name = 'towarzystwo'
  35         verbose_name_plural = 'towarzystwa'
  36
  37     def __str__(self):
  38         return 'Klub'
  39
  40     def get_amounts(self):
  41         c = {}
  42         single = list(self.singleamount_set.all())
  43         monthly = list(self.monthlyamount_set.all())
  44         for tag, amounts in ('single', single), ('monthly', monthly):
  45             wide_spot = narrow_spot = 0
  46             for i, p in enumerate(amounts):
  47                 if p.wide:
  48                     # Do we have space for xl?
  49                     if wide_spot < 2:
  50                         p.box_variant = 'xl'
  51                         wide_spot += 2
  52                     else:
  53                         p.box_variant = 'card'
  54                         wide_spot += 1
  55                     narrow_spot = 0
  56                 elif p.description:
  57                     p.box_variant = 'card'
  58                     if narrow_spot:
  59                         amounts[i-1].box_variant = 'bar'
  60                     wide_spot += 1
  61                     narrow_spot = 0
  62                 else:
  63                     p.box_variant = 'half'
  64                     wide_spot += 1
  65                     narrow_spot += 1
  66                 wide_spot %= 3
  67                 narrow_spot %= 2
  68             c[tag] = amounts
  69             c[f'{tag}_wide_spot'] = wide_spot
  70         return c
  71
  72     def get_description_for_amount(self, amount, monthly):
  73         amounts = self.monthlyamount_set if monthly else self.singleamount_set
  74         amount = amounts.all().filter(amount__lte=amount).last()
  75         return amount.description if amount is not None else ''
  76
  77     @property
  78     def paypal_enabled(self):
  79         print("ENABLED?", settings.PAYPAL_ENABLED)
  80         return settings.PAYPAL_ENABLED
  81
  82
  83 class SingleAmount(models.Model):
  84     club = models.ForeignKey(Club, models.CASCADE)
  85     amount = models.IntegerField()
  86     description = models.TextField(blank=True)
  87     wide = models.BooleanField(default=False)
  88
  89     class Meta:
  90         ordering = ['amount']
  91
  92 class MonthlyAmount(models.Model):
  93     club = models.ForeignKey(Club, models.CASCADE)
  94     amount = models.IntegerField()
  95     description = models.TextField(blank=True)
  96     wide = models.BooleanField(default=False)
  97
  98     class Meta:
  99         ordering = ['amount']
 100
 101
 102 class Consent(models.Model):
 103     order = models.IntegerField()
 104     active = models.BooleanField(default=True)
 105     text = models.CharField(max_length=2048)
 106     required = models.BooleanField()
 107
 108     class Meta:
 109         ordering = ['order']
 110
 111     def __str__(self):
 112         return self.text
 113
 114
 115 class Schedule(models.Model):
 116     """ Represents someone taking up a plan. """
 117     key = models.CharField('klucz', max_length=255, unique=True)
 118     email = models.EmailField('e-mail')
 119     membership = models.ForeignKey(
 120         'Membership', verbose_name='członkostwo',
 121         null=True, blank=True, on_delete=models.SET_NULL)
 122     amount = models.DecimalField('kwota', max_digits=10, decimal_places=2)
 123     method = models.CharField('metoda płatności', max_length=32, choices=[
 124         (m.slug, m.name) for m in methods
 125         ])
 126     monthly = models.BooleanField('miesięcznie', default=True)
 127     yearly = models.BooleanField('rocznie', default=False)
 128
 129     source = models.CharField('źródło', max_length=255, blank=True)
 130
 131     is_cancelled = models.BooleanField('anulowany', default=False)
 132     payed_at = models.DateTimeField('opłacona', null=True, blank=True)
 133     started_at = models.DateTimeField('start', auto_now_add=True)
 134     expires_at = models.DateTimeField('wygasa', null=True, blank=True)
 135     email_sent = models.BooleanField(default=False)
 136
 137     first_name = models.CharField(max_length=255, blank=True)
 138     last_name = models.CharField(max_length=255, blank=True)
 139     phone = models.CharField(max_length=255, blank=True)
 140     postal = models.CharField(max_length=255, blank=True)
 141     postal_code = models.CharField(max_length=255, blank=True)
 142     postal_town = models.CharField(max_length=255, blank=True)
 143     postal_country = CountryField(default='PL', blank=True)
 144
 145     consent = models.ManyToManyField(Consent)
 146
 147     class Meta:
 148         verbose_name = 'harmonogram'
 149         verbose_name_plural = 'harmonogramy'
 150
 151     def __str__(self):
 152         return self.key
 153
 154     def save(self, *args, **kwargs):
 155         if not self.key:
 156             self.key = get_random_hash(self.email)
 157         super(Schedule, self).save(*args, **kwargs)
 158         self.update_contact()
 159
 160     def get_description(self):
 161         club = Club.objects.first()
 162         return club.get_description_for_amount(self.amount, self.monthly)
 163
 164     def is_custom_amount(self):
 165         club = Club.objects.first()
 166         if not self.amount:
 167             return False
 168         if self.monthly:
 169             return not club.monthlyamount_set.filter(amount=self.amount).exists()
 170         else:
 171             return not club.singleamount_set.filter(amount=self.amount).exists()
 172
 173     def initiate_payment(self, request):
 174         return self.get_payment_method().initiate(request, self)
 175
 176     def pay(self, request):
 177         return self.get_payment_method().pay(request, self)
 178
 179     def get_absolute_url(self):
 180         return reverse('club_schedule', args=[self.key])
 181
 182     def get_thanks_url(self):
 183         return reverse('club_thanks', args=[self.key])
 184
 185     def get_payment_method(self):
 186         return [m for m in methods if m.slug == self.method][0]
 187
 188     def get_payment_methods(self):
 189         for method in methods:
 190             if (self.monthly or self.yearly) and method.is_recurring:
 191                 yield method
 192             elif not (self.monthly or self.yearly) and method.is_onetime:
 193                 yield method
 194
 195     def is_expired(self):
 196         return self.expires_at is not None and self.expires_at <= now()
 197
 198     def is_active(self):
 199         return self.payed_at is not None and (self.expires_at is None or self.expires_at > now())
 200
 201     def is_recurring(self):
 202         return self.monthly or self.yearly
 203
 204     def n_paypal_payments(self, since, until):
 205         # TODO: pull BA payments.
 206         t = self.payed_at
 207         if t is None: return 0
 208         c = 0
 209         until = min(until, now())
 210         t += timedelta(days=1)
 211         while t < until:
 212             if t >= since:
 213                 c += 1
 214             m = datetime(t.year, t.month, 1)
 215             t += ((m + timedelta(days=31)).replace(day=1)) - m
 216         return c
 217
 218     def set_payed(self):
 219         since = self.expires_at
 220         n = now()
 221         if since is None or since < n:
 222             since = n
 223         new_exp = self.get_next_installment(since)
 224         if self.payed_at is None:
 225             self.payed_at = n
 226         if self.expires_at is None or self.expires_at < new_exp:
 227             self.expires_at = new_exp
 228             self.save()
 229
 230         if not self.email_sent:
 231             self.send_email()
 232
 233     def get_next_installment(self, date):
 234         if self.yearly:
 235             return utils.add_year(date)
 236         if self.monthly:
 237             return utils.add_month(date)
 238         club = Club.objects.first()
 239         if club is not None and self.amount >= club.min_for_year:
 240             return utils.add_year(date)
 241         return utils.add_month(date)
 242
 243     def get_other_active_recurring(self):
 244         schedules = type(self).objects.exclude(
 245             monthly=False, yearly=False
 246         ).filter(is_cancelled=False, expires_at__gt=now()).exclude(pk=self.pk)
 247         mine_q = models.Q(email=self.email)
 248         if self.membership is not None:
 249             mine_q |= models.Q(membership__user=self.membership.user)
 250         schedules = schedules.filter(mine_q)
 251         return schedules.order_by('-expires_at').first()
 252
 253     def send_email(self):
 254         ctx = {'schedule': self}
 255         send_mail(
 256             template.loader.render_to_string('club/email/thanks_subject.txt', ctx).strip(),
 257             template.loader.render_to_string('club/email/thanks.txt', ctx),
 258             settings.CONTACT_EMAIL, [self.email], fail_silently=False)
 259         self.email_sent = True
 260         self.save()
 261
 262     def send_email_failed_recurring(self):
 263         ctx = {
 264             'schedule': self,
 265             'other': self.get_other_active_recurring(),
 266         }
 267         send_mail(
 268             'Darowizna na Wolne Lektury — problem z płatnością',
 269             template.loader.render_to_string('club/email/failed_recurring.txt', ctx),
 270             settings.CONTACT_EMAIL, [self.email], fail_silently=False
 271         )
 272
 273     def update_contact(self):
 274         Contact = apps.get_model('messaging', 'Contact')
 275         if not self.payed_at:
 276             level = Level.TRIED
 277             since = self.started_at
 278         else:
 279             since = self.payed_at
 280             if self.is_recurring():
 281                 level = Level.RECURRING
 282             else:
 283                 level = Level.SINGLE
 284         Contact.update(self.email, level, since, self.expires_at)
 285
 286
 287
 288
 289
 290 class Membership(models.Model):
 291     """ Represents a user being recognized as a member of the club. """
 292     user = models.OneToOneField(settings.AUTH_USER_MODEL, verbose_name='użytkownik', on_delete=models.CASCADE)
 293     created_at = models.DateTimeField('utworzone', auto_now_add=True)
 294     name = models.CharField('nazwa', max_length=255, blank=True)
 295     manual = models.BooleanField('ustawione ręcznie', default=False)
 296     notes = models.CharField('notatki', max_length=2048, blank=True)
 297     updated_at = models.DateField('aktualizacja', auto_now=True, blank=True)
 298
 299     class Meta:
 300         verbose_name = 'członkostwo'
 301         verbose_name_plural = 'członkostwa'
 302
 303     def __str__(self):
 304         return str(self.user)
 305
 306     def save(self, *args, **kwargs):
 307         super().save(*args, **kwargs)
 308         self.update_contact()
 309
 310     def update_contact(self):
 311         email = self.user.email
 312         if not email:
 313             return
 314
 315         Contact = apps.get_model('messaging', 'Contact')
 316         if self.manual:
 317             Contact.update(email, Level.MANUAL_MEMBER, datetime.combine(self.updated_at, datetime.min.time(), utc))
 318         else:
 319             Contact.reset(email)
 320
 321     @classmethod
 322     def is_active_for(cls, user):
 323         if user.is_anonymous:
 324             return False
 325         try:
 326             membership = user.membership
 327         except cls.DoesNotExist:
 328             return False
 329         if membership.manual:
 330             return True
 331         return Schedule.objects.filter(
 332                 expires_at__gt=now(),
 333                 membership__user=user,
 334             ).exists()
 335
 336
 337 class ReminderEmail(models.Model):
 338     days_before = models.SmallIntegerField('dni przed')
 339     subject = models.CharField('temat', max_length=1024)
 340     body = models.TextField('treść')
 341
 342     class Meta:
 343         verbose_name = 'email z przypomnieniem'
 344         verbose_name_plural = 'e-maile z przypomnieniem'
 345         ordering = ['days_before']
 346
 347     def __str__(self):
 348         if self.days_before >= 0:
 349             return '%d dni przed wygaśnięciem' % self.days_before
 350         else:
 351             return '%d dni po wygaśnięciu' % -self.days_before
 352
 353
 354 class Ambassador(models.Model):
 355     name = models.CharField('imię i nazwisko', max_length=255)
 356     photo = models.ImageField('zdjęcie', blank=True)
 357     text = models.CharField('tekst', max_length=1024)
 358
 359     class Meta:
 360         verbose_name = 'ambasador'
 361         verbose_name_plural = 'ambasadorowie'
 362         ordering = ['name']
 363
 364     def __str__(self):
 365         return self.name
 366
 367
 368 ########
 369 #      #
 370 # PayU #
 371 #      #
 372 ########
 373
 374 class PayUOrder(payu_models.Order):
 375     schedule = models.ForeignKey(Schedule, on_delete=models.CASCADE)
 376
 377     def get_amount(self):
 378         return self.schedule.amount
 379
 380     def get_buyer(self):
 381         return {
 382             "email": self.schedule.email,
 383             "language": get_language(),
 384         }
 385
 386     def get_description(self):
 387         return 'Wolne Lektury'
 388
 389     def is_recurring(self):
 390         return self.schedule.get_payment_method().is_recurring
 391
 392     def get_card_token(self):
 393         return self.schedule.payucardtoken_set.order_by('-created_at').first()
 394
 395     def get_notify_url(self):
 396         return "https://{}{}".format(
 397             Site.objects.get_current().domain,
 398             reverse('club_payu_notify', args=[self.pk]))
 399
 400     def get_thanks_url(self):
 401         return self.schedule.get_thanks_url()
 402
 403     def status_updated(self):
 404         if self.status == 'COMPLETED':
 405             self.schedule.set_payed()
 406
 407         elif self.status == 'CANCELED' or self.status.startswith('ERR-'):
 408             if self.is_recurring() and self.schedule.expires_at:
 409                 self.schedule.send_email_failed_recurring()
 410
 411         self.report_activity()
 412
 413     @property
 414     def updated_at(self):
 415         try:
 416             return self.notification_set.all().order_by('-received_at')[0].received_at
 417         except IndexError:
 418             return None
 419
 420     def report_activity(self):
 421         if self.status not in ['COMPLETED', 'CANCELED', 'REJECTED']:
 422             return
 423
 424         if self.status != 'COMPLETED':
 425             name = settings.CIVICRM_ACTIVITIES['Failed contribution']
 426         elif self.is_recurring():
 427             name = settings.CIVICRM_ACTIVITIES['Recurring contribution']
 428         else:
 429             name = settings.CIVICRM_ACTIVITIES['Contribution']
 430
 431         report_activity.delay(
 432             self.schedule.email,
 433             self.schedule.key,
 434             f'payu:{self.id}',
 435             name,
 436             self.updated_at,
 437             {
 438                 'kwota': self.schedule.amount,
 439             }
 440         )
 441
 442     @classmethod
 443     def generate_receipt(cls, email, year):
 444         # TODO: abstract out
 445         Contact = apps.get_model('messaging', 'Contact')
 446         Funding = apps.get_model('funding', 'Funding')
 447         BillingAgreement = apps.get_model('paypal', 'BillingAgreement')
 448         DirectDebit = apps.get_model('pz', 'DirectDebit')
 449         Payment = apps.get_model('pz', 'Payment')
 450
 451         payments = []
 452
 453         optout = None
 454         try:
 455             contact = Contact.objects.get(email=email)
 456         except Contact.DoesNotExist:
 457             funding = Funding.objects.filter(
 458                 email=email,
 459                 completed_at__year=year,
 460                 notifications=True).order_by('completed_at').first()
 461             if funding is None:
 462                 print('no notifications')
 463                 if not DirectDebit.objects.filter(email=email, optout=False).exists():
 464                     return
 465             else:
 466                 optout = funding.wl_optout_url()
 467         else:
 468             if contact.level == Level.OPT_OUT:
 469                 print('opt-out')
 470                 return
 471             optout = contact.wl_optout_url()
 472
 473         qs = cls.objects.filter(status='COMPLETED', schedule__email=email, completed_at__year=year).order_by('completed_at')
 474         for order in qs:
 475             payments.append({
 476                 'timestamp': order.completed_at,
 477                 'amount': order.get_amount(),
 478             })
 479
 480         for ba in BillingAgreement.objects.filter(schedule__email=email):
 481             payments.extend(ba.get_donations(year))
 482
 483         fundings = Funding.objects.filter(
 484             email=email,
 485             completed_at__year=year
 486         ).order_by('completed_at')
 487         for funding in fundings:
 488             payments.append({
 489                 'timestamp': funding.completed_at,
 490                 'amount': funding.amount,
 491             })
 492
 493         for pa in Payment.objects.filter(
 494                 debit__email=email,
 495                 realised=True,
 496                 is_dd=True,
 497                 booking_date__year=year
 498         ):
 499             payments.append({
 500                 'timestamp': datetime(pa.booking_date.year, pa.booking_date.month, pa.booking_date.day, tzinfo=utc),
 501                 'amount': Decimal(str(pa.debit.amount) + '.00')
 502             })
 503
 504
 505         if not payments: return
 506
 507         payments.sort(key=lambda x: x['timestamp'])
 508
 509         ctx = {
 510             "email": email,
 511             "year": year,
 512             "total": sum(x['amount'] for x in payments),
 513             "payments": payments,
 514         }
 515         temp = tempfile.NamedTemporaryFile(prefix='receipt-', suffix='.pdf', delete=False)
 516         temp.close()
 517         render_to_pdf(temp.name, 'club/receipt.texml', ctx, {
 518             "wl.eps": os.path.join(settings.STATIC_ROOT, "img/wl.eps"),
 519             })
 520
 521         with open(temp.name, 'rb') as f:
 522             content = f.read()
 523         os.unlink(f.name)
 524         return content, optout, payments
 525
 526     @classmethod
 527     def send_receipt(cls, email, year, resend=False):
 528         receipt = cls.generate_receipt(email, year)
 529         if receipt:
 530             content, optout, payments = receipt
 531         else:
 532             return
 533         ctx = {
 534             "email": email,
 535             "year": year,
 536             "next_year": year + 1,
 537             "total": sum(x['amount'] for x in payments),
 538             "payments": payments,
 539             "optout": optout,
 540             "resend": resend,
 541         }
 542         message = EmailMessage(
 543                 'Odlicz darowiznę na Wolne Lektury od podatku',
 544                 template.loader.render_to_string('club/receipt_email.txt', ctx),
 545                 settings.CLUB_CONTACT_EMAIL, [email]
 546             )
 547         message.attach('wolnelektury-darowizny.pdf', content, 'application/pdf')
 548         message.send()
 549
 550
 551 class PayUCardToken(payu_models.CardToken):
 552     schedule = models.ForeignKey(Schedule, on_delete=models.CASCADE)
 553
 554
 555 class PayUNotification(payu_models.Notification):
 556     order = models.ForeignKey(PayUOrder, models.CASCADE, related_name='notification_set')