diff --git a/CHANGES.md b/CHANGES.md index 949dbfb8..8db8fe37 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -9,6 +9,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Added +- Membership `started`/`until` are dates; membership runs one year from joining and early renewal extends from the current end date (admins can edit both dates). Existing rows migrate to `until = Dec 31 of the stored year`. +- Membership records `organization` and `organization_type`; existing members are asked to fill them in on their next visit (`/membership/details`). +- Membership admin lists name, last name, first name, email, organization, type and dates; filters, search and the Excel export are extended. +- Renewal reminders (60/30 days before, on expiry, 30/60 days after) sent by a Celery beat task; `manage.py send_membership_reminders --dry-run` previews them. +- `RegistrationOption.membership_until` (date) replaces `membership_end_year`; `Payment.mark_paid` still accepts the legacy key in stored payment data. - Private team calendar at `/team-calendar/`, served behind login (`@login_required`). ## [0.1.0] - 2022-03-22 diff --git a/README.md b/README.md index 5e388a32..7ad17687 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,7 @@ sequenceDiagram ## Membership -DdS membership runs per calendar year, from January 1st to December 31st. Signing up for DdS membership requires a valid user account. +DdS membership runs for one year from the day of joining; renewing early adds a year to the current end date, and both dates can be adjusted in the admin. Renewal reminders go out automatically 60 and 30 days before the end date, on the day, and 30 and 60 days after (see `deployment.md`, Celery section). Signing up for DdS membership requires a valid user account. ```mermaid sequenceDiagram diff --git a/conftest.py b/conftest.py index 9948e1b8..7080acf4 100644 --- a/conftest.py +++ b/conftest.py @@ -25,7 +25,25 @@ "SLACK_REGISTRATIONS_WEBHOOK": "", "SENTRY_DSN": "", "DEFAULT_FROM_EMAIL": "test@example.com", + "CELERY_TASK_ALWAYS_EAGER": "True", + "CELERY_BROKER_URL": "memory://", } for _key, _value in _TEST_ENV_DEFAULTS.items(): os.environ.setdefault(_key, _value) + + +def pytest_configure(config): + """Run Celery tasks inline during tests. + + pytest-django imports the settings module before this conftest runs, so the + env defaults above do not reach import-time settings such as the Celery + block; configure the app object directly instead. + """ + from django.conf import settings + + # Celery resolves the namespaced Django name (CELERY_*) before its own conf + # overrides, so the attributes have to change on the settings object itself. + settings.CELERY_TASK_ALWAYS_EAGER = True + settings.CELERY_TASK_EAGER_PROPAGATES = True + settings.CELERY_BROKER_URL = "memory://" diff --git a/dds_registration/__init__.py b/dds_registration/__init__.py index 414c06f3..f548c933 100644 --- a/dds_registration/__init__.py +++ b/dds_registration/__init__.py @@ -4,10 +4,13 @@ __timetag__ = "240430-1501" +from .celery import app as celery_app # noqa: E402 + __all__ = ( __version__, __timestamp__, __timetag__, + "celery_app", ) diff --git a/dds_registration/admin.py b/dds_registration/admin.py index 1bc6b798..f04747d0 100644 --- a/dds_registration/admin.py +++ b/dds_registration/admin.py @@ -18,6 +18,7 @@ from .models import ( Event, Membership, + MembershipReminder, Message, Payment, Registration, @@ -63,9 +64,9 @@ def lookups(self, request, model_admin): def queryset(self, request, queryset): if self.value() == "1": - return queryset.filter(until__gte=date.today().year) + return queryset.filter(until__gte=date.today()) if self.value() == "0": - return queryset.filter(until__lt=date.today().year) + return queryset.filter(until__lt=date.today()) class UserAdmin(BaseUserAdmin): @@ -139,41 +140,85 @@ def email_selected_users(self, request, queryset): # mailing_list = models.BooleanField(default=False) +class MembershipReminderInline(admin.TabularInline): + model = MembershipReminder + extra = 0 + can_delete = False + readonly_fields = ["until", "stage", "sent_at"] + + def has_add_permission(self, request, obj=None): + return False + + @admin.register(Membership) class MembershipAdmin(admin.ModelAdmin): fieldsets = ( - (None, {"fields": ("user", "membership_type")}), + ("Member", {"fields": ("user", "membership_type", "organization", "organization_type")}), ("Validity", {"fields": ("started", "until")}), ("Communication", {"fields": ("mailing_list",)}), ) - + inlines = [MembershipReminderInline] list_display = [ - "user", - "started", - "until", - # "paid", - "active", + "full_name", + "last_name", + "first_name", + "email", + "organization", + "organization_type", "membership_type", + "started_iso", + "until_iso", + "active", ] - search_fields = [ - "user__username", - ] - list_filter = [IsActiveFilter, "membership_type"] + list_select_related = ["user"] + search_fields = ["user__email", "user__first_name", "user__last_name", "organization"] + list_filter = [IsActiveFilter, "membership_type", "organization_type"] actions = ["export_current_member_list"] + @admin.display(description="Name", ordering="user__last_name") + def full_name(self, obj): + return obj.user.get_full_name() or obj.user.email + + @admin.display(description="Last name", ordering="user__last_name") + def last_name(self, obj): + return obj.user.last_name + + @admin.display(description="First name", ordering="user__first_name") + def first_name(self, obj): + return obj.user.first_name + + @admin.display(description="Email", ordering="user__email") + def email(self, obj): + return obj.user.email + + @admin.display(description="Started", ordering="started") + def started_iso(self, obj): + return obj.started.isoformat() + + @admin.display(description="Until", ordering="until") + def until_iso(self, obj): + return obj.until.isoformat() + + @admin.display(description="Active", boolean=True, ordering="until") + def active(self, obj): + return obj.active + @admin.action(description="Export all current members to excel") def export_current_member_list(self, request, queryset): - queryset = Membership.objects.filter(until__gte=date.today().year) + queryset = Membership.objects.filter(until__gte=date.today()).select_related("user") df = pd.DataFrame( [ { "email": obj.user.email, "id": obj.user.id, - "name": obj.user.get_full_name(), + "first_name": obj.user.first_name, + "last_name": obj.user.last_name, + "organization": obj.organization, + "organization_type": obj.get_organization_type_display(), "started": obj.started, - "unit": obj.until, + "until": obj.until, "on_mailing_list": obj.mailing_list, - "type": str(obj.membership_type), + "type": obj.get_membership_type_display(), } for obj in queryset ] @@ -190,6 +235,7 @@ def export_current_member_list(self, request, queryset): response["Content-Disposition"] = "attachment; filename=memberships.xlsx" return response + @admin.register(Registration) class RegistrationAdmin(admin.ModelAdmin): readonly_fields = [ diff --git a/dds_registration/celery.py b/dds_registration/celery.py new file mode 100644 index 00000000..c3571e07 --- /dev/null +++ b/dds_registration/celery.py @@ -0,0 +1,11 @@ +"""Celery application; the worker and beat run ``celery -A dds_registration``.""" + +import os + +from celery import Celery + +os.environ.setdefault("DJANGO_SETTINGS_MODULE", "dds_registration.settings") + +app = Celery("dds_registration") +app.config_from_object("django.conf:settings", namespace="CELERY") +app.autodiscover_tasks() diff --git a/dds_registration/core/helpers/create_pdf.py b/dds_registration/core/helpers/create_pdf.py index ed5b7aac..d1fc200b 100644 --- a/dds_registration/core/helpers/create_pdf.py +++ b/dds_registration/core/helpers/create_pdf.py @@ -10,6 +10,7 @@ payment_recipient_address, payment_recipient_name, ) +from ..membership.validity import until_label __all__ = [ "create_invoice_pdf_from_payment", @@ -253,7 +254,7 @@ def get_common_pdf_table_items(payment: Model) -> (list, tuple): ( user.get_full_name(), payment.data["membership"]["label"], - str(payment.data["until"]) + "-12-31", + until_label(payment.data["until"]), payment.data["price"], ), ("", "", "**Total**", payment.data["price"]), diff --git a/dds_registration/core/helpers/dates.py b/dds_registration/core/helpers/dates.py index 24730145..35f88e7b 100644 --- a/dds_registration/core/helpers/dates.py +++ b/dds_registration/core/helpers/dates.py @@ -1,5 +1,7 @@ from datetime import date +from ..membership.validity import add_one_year + def this_year(): return date.today().year @@ -7,3 +9,11 @@ def this_year(): def next_year(): return this_year() + 1 + + +def one_year_from_today(): + return add_one_year(date.today()) + + +def end_of_this_year(): + return date(this_year(), 12, 31) diff --git a/dds_registration/core/membership/__init__.py b/dds_registration/core/membership/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/dds_registration/core/membership/reminders.py b/dds_registration/core/membership/reminders.py new file mode 100644 index 00000000..ac92ae57 --- /dev/null +++ b/dds_registration/core/membership/reminders.py @@ -0,0 +1,93 @@ +"""Which members get a renewal reminder today, and sending one. + +Stages fire at fixed offsets from the membership end date. For a given member only +the latest stage that is already due is considered, so a backlog never produces a +burst of stale emails. Each send is logged in ``MembershipReminder`` keyed on the +end date it was about, which keeps sends idempotent and lets next year's cycle start +clean once the end date moves. +""" + +from datetime import date, timedelta +from typing import Iterator + +from django.template.loader import render_to_string +from loguru import logger + +from ...models import Membership, MembershipReminder +from ..helpers.email import send_email + +STAGES = ( + ("before_60", -60), + ("before_30", -30), + ("expiry", 0), + ("after_30", 30), + ("after_60", 60), +) +WINDOW_DAYS = 60 +PENDING_PAYMENT_STATUSES = ("CREATED", "ISSUED") +RENEW_URL = "https://events.d-d-s.ch/membership/apply" +SUBJECT_TEMPLATE = "dds_registration/membership/reminder/subject.txt" +BODY_TEMPLATE = "dds_registration/membership/reminder/body.txt" + + +def stage_due(until: date, today: date) -> str | None: + """Latest stage whose fire date is on or before ``today``; None when nothing is due yet.""" + due = None + for name, offset in STAGES: + if until + timedelta(days=offset) <= today: + due = name + return due + + +def _has_pending_renewal(membership: Membership) -> bool: + """A renewal invoice is already out: issued within this end date's reminder window, unpaid.""" + payment = membership.payment + return bool( + payment + and payment.status in PENDING_PAYMENT_STATUSES + and payment.data.get("kind") == "membership" + and payment.created >= membership.until - timedelta(days=WINDOW_DAYS) + ) + + +def due_reminders(today: date) -> Iterator[tuple[Membership, str]]: + """Yield ``(membership, stage)`` pairs that should be emailed today.""" + window = ( + Membership.objects.filter( + until__gte=today - timedelta(days=WINDOW_DAYS), + until__lte=today + timedelta(days=WINDOW_DAYS), + ) + .exclude(membership_type="HONORARY") + .select_related("user", "payment") + .order_by("until", "pk") + ) + for membership in window: + stage = stage_due(membership.until, today) + if stage is None or _has_pending_renewal(membership): + continue + if MembershipReminder.objects.filter(membership=membership, until=membership.until, stage=stage).exists(): + continue + yield membership, stage + + +def send_reminder(membership_id: int, until: date, stage: str, today: date | None = None) -> bool: + """Render and send one reminder; return False when it was already sent.""" + today = today or date.today() + membership = Membership.objects.select_related("user").get(pk=membership_id) + if MembershipReminder.objects.filter(membership=membership, until=until, stage=stage).exists(): + return False + context = { + "user": membership.user, + "membership": membership, + "until": until, + "stage": stage, + "days_left": (until - today).days, + "expired": until < today, + "renew_url": RENEW_URL, + } + subject = " ".join(render_to_string(SUBJECT_TEMPLATE, context).split()) + body = render_to_string(BODY_TEMPLATE, context) + send_email(recipient_address=membership.user.email, subject=subject, message=body) + MembershipReminder.objects.create(membership=membership, until=until, stage=stage) + logger.info("Membership reminder {} sent to {}", stage, membership.user.email) + return True diff --git a/dds_registration/core/membership/validity.py b/dds_registration/core/membership/validity.py new file mode 100644 index 00000000..713d39da --- /dev/null +++ b/dds_registration/core/membership/validity.py @@ -0,0 +1,38 @@ +"""Pure date rules for DdS membership validity and renewal. + +A membership runs for one year from its start. Renewing while still active +extends from the current end date; renewing after a lapse restarts from today. +""" + +from datetime import date, timedelta + + +def add_one_year(day: date) -> date: + """Same calendar date next year; Feb 29 becomes Feb 28.""" + try: + return day.replace(year=day.year + 1) + except ValueError: + return day.replace(year=day.year + 1, day=28) + + +def renewal_until(current_until: date | None, today: date) -> date: + """End date after a renewal submitted on ``today``.""" + if current_until is None or current_until < today: + return add_one_year(today) + return add_one_year(current_until) + + +def within_renewal_window(current_until: date | None, today: date, window_days: int) -> bool: + """True when a member may renew: no membership, lapsed, or ending within ``window_days``.""" + if current_until is None: + return True + return current_until - today <= timedelta(days=window_days) + + +def until_label(value) -> str: + """ISO date for an ``until`` value stored as date, ISO string, or legacy year int.""" + if isinstance(value, date): + return value.isoformat() + if isinstance(value, int): + return date(value, 12, 31).isoformat() + return str(value) diff --git a/dds_registration/forms.py b/dds_registration/forms.py index 66cac789..d70c8a02 100644 --- a/dds_registration/forms.py +++ b/dds_registration/forms.py @@ -8,7 +8,7 @@ from django_registration.forms import RegistrationForm as BaseRegistrationForm from prettyjson import PrettyJSONWidget -from .models import MEMBERSHIP_DATA, Event, Payment, RegistrationOption, User +from .models import MEMBERSHIP_DATA, Event, Membership, OrganizationType, Payment, RegistrationOption, User # A text field to use in those TextField's which don't require large texts, but can use one-line text inputs textInputWidget = forms.TextInput(attrs={"class": "vLargeTextField"}) @@ -35,6 +35,18 @@ class MembershipForm(forms.Form): required=True, label="Membership type", ) + organization = forms.CharField( + label="Organization", + max_length=200, + widget=textInputWidget, + required=True, + help_text="University, company, institute, or 'Independent'.", + ) + organization_type = forms.ChoiceField( + choices=[("", "---------")] + list(OrganizationType.choices), + required=True, + label="Type of organization", + ) payment_method = forms.ChoiceField( choices=Payment.METHODS, required=True, @@ -229,3 +241,16 @@ def __init__(self, *args, **kwargs): super().__init__(*args, **kwargs) self.fields["first_name"].required = True self.fields["last_name"].required = True + + +class MembershipDetailsForm(ModelForm): + class Meta: + model = Membership + fields = ["organization", "organization_type"] + widgets = {"organization": textInputWidget} + + def __init__(self, *args, **kwargs): + super().__init__(*args, **kwargs) + self.fields["organization"].required = True + self.fields["organization_type"].required = True + self.fields["organization_type"].choices = [("", "---------")] + list(OrganizationType.choices) diff --git a/dds_registration/management/commands/send_membership_reminders.py b/dds_registration/management/commands/send_membership_reminders.py new file mode 100644 index 00000000..fa08c1dd --- /dev/null +++ b/dds_registration/management/commands/send_membership_reminders.py @@ -0,0 +1,32 @@ +"""Send (or list) today's membership renewal reminders without going through Celery. + +Use ``--dry-run`` on the server before the first automated sweep, and the plain form +for manual catch-up if the worker was down. +""" + +from datetime import date + +from django.core.management.base import BaseCommand + +from ...core.membership.reminders import due_reminders, send_reminder + + +class Command(BaseCommand): + help = "Send membership renewal reminders that are due today (synchronously)." + + def add_arguments(self, parser): + parser.add_argument( + "--today", type=date.fromisoformat, default=None, help="Pretend today is this date (YYYY-MM-DD)" + ) + parser.add_argument("--dry-run", action="store_true", help="List what would be sent, send nothing") + + def handle(self, *args, **options): + today = options["today"] or date.today() + due = list(due_reminders(today)) + for membership, stage in due: + self.stdout.write(f"{membership.user.email}\t{membership.until}\t{stage}") + if options["dry_run"]: + self.stdout.write(f"Dry run: {len(due)} reminder(s) due on {today}") + return + sent = sum(1 for membership, stage in due if send_reminder(membership.pk, membership.until, stage, today=today)) + self.stdout.write(self.style.SUCCESS(f"Sent {sent} reminder(s) for {today}")) diff --git a/dds_registration/middleware/MembershipDetailsMiddleware.py b/dds_registration/middleware/MembershipDetailsMiddleware.py new file mode 100644 index 00000000..46b4c936 --- /dev/null +++ b/dds_registration/middleware/MembershipDetailsMiddleware.py @@ -0,0 +1,41 @@ +"""Send members with an incomplete membership record to the details form.""" + +from django.contrib import messages +from django.shortcuts import redirect +from django.urls import reverse + +from ..models import Membership + +EXEMPT_PREFIXES = ( + "/admin/", + "/accounts/", + "/dashboards/", + "/static/", + "/media/", + "/payments/", + "/membership/", + "/hijack/", + "/captcha/", + "/robots.txt", +) + + +class MembershipDetailsMiddleware: + def __init__(self, get_response): + self.get_response = get_response + + def __call__(self, request): + if self._needs_redirect(request): + messages.info(request, "Please tell us your organization to complete your membership record.") + return redirect(reverse("membership_details")) + return self.get_response(request) + + @staticmethod + def _needs_redirect(request) -> bool: + user = getattr(request, "user", None) + if user is None or not user.is_authenticated or user.is_staff: + return False + if request.path.startswith(EXEMPT_PREFIXES): + return False + membership = Membership.objects.filter(user=user).only("organization", "organization_type").first() + return bool(membership and membership.needs_details) diff --git a/dds_registration/migrations/0025_membership_dates_and_organization.py b/dds_registration/migrations/0025_membership_dates_and_organization.py new file mode 100644 index 00000000..71390470 --- /dev/null +++ b/dds_registration/migrations/0025_membership_dates_and_organization.py @@ -0,0 +1,169 @@ +"""Membership validity as dates, organization fields, reminder log. + +Existing rows keep their entitlement: ``until`` year N becomes N-12-31. ``started`` +uses the linked payment's paid date when known, else Jan 1 of the stored year. +""" + +from datetime import date + +import django.db.models.deletion +from django.db import migrations, models + +import dds_registration.core.helpers.dates + + +MIN_PLAUSIBLE_YEAR = 2000 # production has a RegistrationOption with membership_end_year = 0 + + +def _plausible_year(year) -> int | None: + try: + year = int(year) + except (TypeError, ValueError): + return None + return year if year >= MIN_PLAUSIBLE_YEAR else None + + +def year_to_until(year) -> date: + """Dec 31 of ``year``; a missing or nonsense year (0, None) becomes Dec 31 of the current year.""" + year = _plausible_year(year) or date.today().year + return date(year, 12, 31) + + +def started_from(payment_data, started_year) -> date: + """Join date: the linked payment's paid date when it falls in the stored start year, else Jan 1. + + The linked payment is the *latest* one (renewals replace it), so a paid date from a + later year says nothing about when the member first joined. + """ + year = _plausible_year(started_year) or date.today().year + paid = (payment_data or {}).get("paid_date") + if paid: + try: + paid_date = date.fromisoformat(paid) + except ValueError: + paid_date = None + if paid_date and paid_date.year == year: + return paid_date + return date(year, 1, 1) + + +def forwards(apps, schema_editor): + Membership = apps.get_model("dds_registration", "Membership") + for membership in Membership.objects.select_related("payment").iterator(): + membership.until_date = year_to_until(membership.until) + payment_data = membership.payment.data if membership.payment_id else None + membership.started_date = started_from(payment_data, membership.started) + membership.save(update_fields=["until_date", "started_date"]) + RegistrationOption = apps.get_model("dds_registration", "RegistrationOption") + for option in RegistrationOption.objects.iterator(): + option.membership_until_date = year_to_until(option.membership_end_year) + option.save(update_fields=["membership_until_date"]) + + +def backwards(apps, schema_editor): + Membership = apps.get_model("dds_registration", "Membership") + for membership in Membership.objects.iterator(): + membership.until = membership.until_date.year + membership.started = membership.started_date.year + membership.save(update_fields=["until", "started"]) + RegistrationOption = apps.get_model("dds_registration", "RegistrationOption") + for option in RegistrationOption.objects.iterator(): + option.membership_end_year = option.membership_until_date.year + option.save(update_fields=["membership_end_year"]) + + +ORGANIZATION_TYPES = [ + ("UNIVERSITY", "University"), + ("RESEARCH", "Research institute"), + ("COMPANY", "Company"), + ("CONSULTANCY", "Consultancy"), + ("PUBLIC", "Public sector"), + ("NGO", "NGO / non-profit"), + ("INDEPENDENT", "Independent / freelance"), + ("STUDENT", "Student"), + ("OTHER", "Other"), +] + +REMINDER_STAGES = [ + ("before_60", "60 days before expiry"), + ("before_30", "30 days before expiry"), + ("expiry", "On expiry"), + ("after_30", "30 days after expiry"), + ("after_60", "60 days after expiry"), +] + + +class Migration(migrations.Migration): + + dependencies = [ + ("dds_registration", "0024_event_has_invitation_event_invitation_text_and_more"), + ] + + operations = [ + migrations.AddField( + model_name="membership", + name="organization", + field=models.CharField(blank=True, default="", max_length=200), + ), + migrations.AddField( + model_name="membership", + name="organization_type", + field=models.CharField(blank=True, choices=ORGANIZATION_TYPES, default="", max_length=16), + ), + migrations.AddField(model_name="membership", name="started_date", field=models.DateField(null=True)), + migrations.AddField(model_name="membership", name="until_date", field=models.DateField(null=True)), + migrations.AddField( + model_name="registrationoption", name="membership_until_date", field=models.DateField(null=True) + ), + migrations.CreateModel( + name="MembershipReminder", + fields=[ + ("id", models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name="ID")), + ("until", models.DateField()), + ("stage", models.CharField(choices=REMINDER_STAGES, max_length=16)), + ("sent_at", models.DateTimeField(auto_now_add=True)), + ( + "membership", + models.ForeignKey( + on_delete=django.db.models.deletion.CASCADE, + related_name="reminders", + to="dds_registration.membership", + ), + ), + ], + ), + migrations.AddConstraint( + model_name="membershipreminder", + constraint=models.UniqueConstraint(fields=("membership", "until", "stage"), name="one_reminder_per_stage"), + ), + migrations.RunPython(forwards, backwards), + migrations.RemoveField(model_name="membership", name="started"), + migrations.RemoveField(model_name="membership", name="until"), + migrations.RemoveField(model_name="registrationoption", name="membership_end_year"), + migrations.RenameField(model_name="membership", old_name="started_date", new_name="started"), + migrations.RenameField(model_name="membership", old_name="until_date", new_name="until"), + migrations.RenameField( + model_name="registrationoption", old_name="membership_until_date", new_name="membership_until" + ), + migrations.AlterField( + model_name="membership", + name="started", + field=models.DateField(default=date.today, help_text="Date the member first joined"), + ), + migrations.AlterField( + model_name="membership", + name="until", + field=models.DateField( + default=dds_registration.core.helpers.dates.one_year_from_today, + help_text="Last day the membership is valid (inclusive)", + ), + ), + migrations.AlterField( + model_name="registrationoption", + name="membership_until", + field=models.DateField( + default=dds_registration.core.helpers.dates.end_of_this_year, + help_text="If membership is included, last day it is valid (inclusive)", + ), + ), + ] diff --git a/dds_registration/models.py b/dds_registration/models.py index ed8bd034..442019ae 100644 --- a/dds_registration/models.py +++ b/dds_registration/models.py @@ -31,7 +31,8 @@ ) from .core.helpers.create_certificate import create_certificate_pdf from .core.helpers.create_invitation import create_invitation_pdf -from .core.helpers.dates import this_year +from .core.helpers.dates import end_of_this_year, one_year_from_today, this_year +from .core.membership.validity import until_label from .core.helpers.email import send_email alphabet = string.ascii_lowercase + string.digits @@ -209,7 +210,7 @@ class Payment(Model): # "price": option.price, # "currency": option.currency, # "includes_membership": option.includes_membership, - # "membership_end_year": option.membership_end_year, + # "membership_until": option.membership_until.isoformat(), # } data = models.JSONField(help_text="JSON object", default=dict) @@ -245,9 +246,12 @@ def mark_paid(self): if self.data.get("includes_membership"): user = User.objects.get(id=self.data["user"]["id"]) + granted_until = date.fromisoformat( + until_label(self.data.get("membership_until") or self.data.get("membership_end_year")) + ) try: membership = Membership.objects.get(user=user) - membership.until = max(membership.until, self.data["membership_end_year"]) + membership.until = max(membership.until, granted_until) membership.save() except ObjectDoesNotExist: Membership( @@ -255,7 +259,7 @@ def mark_paid(self): membership_type="NORMAL", payment=self, mailing_list=True, - until=self.data["membership_end_year"], + until=granted_until, ).save() if settings.SLACK_PAYMENTS_WEBHOOK: @@ -338,7 +342,8 @@ def email_invoice(self, extra_address: str | None = None): # TODO: Issue #149: To extract these (and all other hardcoded here, in `send_email` methods?) texts to template files, with substiting names, urls and emails from settings or preferences values? if self.data["kind"] == "membership": subject = f"DdS Membership Invoice {self.invoice_no}" - message = f"Thanks for signing up for Départ de Sentier membership! Membership fees allow us to write awesome open source code, deploy open infrastructure, and run community events without spending all our time fundraising.\n\nYour membership will run until December 31st, {user.membership.until} (Don't worry, you will get a reminder to renew for another year :).\n\nPlease find attached the membership invoice. Your membership is not in force until the bank transfer is received.\n\nYou can change your invoice details here: https://events.d-d-s.ch{reverse('membership_application')}.\n\nIf you have any questions, please contact events@d-d-s.ch." + until_text = user.membership.until.strftime("%-d %B %Y") + message = f"Thanks for signing up for Départ de Sentier membership! Membership fees allow us to write awesome open source code, deploy open infrastructure, and run community events without spending all our time fundraising.\n\nYour membership will run until {until_text} (Don't worry, you will get a reminder to renew for another year :).\n\nPlease find attached the membership invoice. Your membership is not in force until the bank transfer is received.\n\nYou can change your invoice details here: https://events.d-d-s.ch{reverse('membership_application')}.\n\nIf you have any questions, please contact events@d-d-s.ch." else: event = Event.objects.get(id=self.data["event"]["id"]) subject = f"DdS Event {event.title} Registration Invoice {self.invoice_no}" @@ -416,22 +421,40 @@ def public_choice_field_with_prices(self): HUMANS = ("ACADEMIC", "NORMAL", "HONORARY") +class OrganizationType(models.TextChoices): + UNIVERSITY = "UNIVERSITY", "University" + RESEARCH = "RESEARCH", "Research institute" + COMPANY = "COMPANY", "Company" + CONSULTANCY = "CONSULTANCY", "Consultancy" + PUBLIC = "PUBLIC", "Public sector" + NGO = "NGO", "NGO / non-profit" + INDEPENDENT = "INDEPENDENT", "Independent / freelance" + STUDENT = "STUDENT", "Student" + OTHER = "OTHER", "Other" + + class Membership(Model): user = models.OneToOneField(User, on_delete=models.CASCADE) membership_type = models.TextField(choices=MEMBERSHIP_DATA.choices, default=MEMBERSHIP_DATA.default) + organization = models.CharField(max_length=200, blank=True, default="") + organization_type = models.CharField(max_length=16, choices=OrganizationType.choices, blank=True, default="") - started = models.IntegerField(default=this_year) - until = models.IntegerField(default=this_year) + started = models.DateField(default=date.today, help_text="Date the member first joined") + until = models.DateField(default=one_year_from_today, help_text="Last day the membership is valid (inclusive)") payment = models.OneToOneField(Payment, on_delete=models.SET_NULL, null=True, blank=True) mailing_list = models.BooleanField(default=False) @property def active(self) -> bool: - return this_year() <= self.until + return date.today() <= self.until + + @property + def needs_details(self) -> bool: + return not self.organization or not self.organization_type @classmethod def mailinglist_people(cls): - return cls.objects.filter(until__gte=this_year(), mailing_list=True, membership_type__in=HUMANS) + return cls.objects.filter(until__gte=date.today(), mailing_list=True, membership_type__in=HUMANS) def __str__(self): items = [ @@ -443,6 +466,31 @@ def __str__(self): return info +class MembershipReminder(Model): + """One row per reminder email actually sent; keyed on the end date it was about.""" + + STAGES = [ + ("before_60", "60 days before expiry"), + ("before_30", "30 days before expiry"), + ("expiry", "On expiry"), + ("after_30", "30 days after expiry"), + ("after_60", "60 days after expiry"), + ] + + membership = models.ForeignKey(Membership, on_delete=models.CASCADE, related_name="reminders") + until = models.DateField() + stage = models.CharField(max_length=16, choices=STAGES) + sent_at = models.DateTimeField(auto_now_add=True) + + class Meta: + constraints = [ + models.UniqueConstraint(fields=["membership", "until", "stage"], name="one_reminder_per_stage"), + ] + + def __str__(self): + return f"{self.membership.user.email} {self.stage} ({self.until})" + + class Event(Model): code = models.TextField(unique=True, default=random_code) # Show as an input title = models.TextField(unique=True, null=False, blank=False) # Show as an input @@ -473,18 +521,18 @@ class Event(Model): help_text="Maximum number of participants (0 = no limit)", ) has_certificate = models.BooleanField(default=False, help_text="Event has certificate of participation") - certificate_title = models.TextField( - blank=True, null=True, help_text="Certificate title." - ) + certificate_title = models.TextField(blank=True, null=True, help_text="Certificate title.") certificate_text = models.TextField( - blank=True, null=True, help_text="Certificate text. Can include MarkDown. MUST include `{attendee_name}` template variable where the name of the attendee will be substituted." + blank=True, + null=True, + help_text="Certificate text. Can include MarkDown. MUST include `{attendee_name}` template variable where the name of the attendee will be substituted.", ) has_invitation = models.BooleanField(default=False, help_text="Event has letter of invitation") - invitation_title = models.TextField( - blank=True, null=True, help_text="Invtation letter title." - ) + invitation_title = models.TextField(blank=True, null=True, help_text="Invtation letter title.") invitation_text = models.TextField( - blank=True, null=True, help_text="Invitation letter text. Can include MarkDown. MUST include `{attendee_name}` template variable where the name of the attendee will be substituted." + blank=True, + null=True, + help_text="Invitation letter text. Can include MarkDown. MUST include `{attendee_name}` template variable where the name of the attendee will be substituted.", ) free = models.BooleanField(default=False) @@ -548,7 +596,10 @@ def can_register(self, user): if self.max_participants and self.active_registration_count >= self.max_participants: return False if self.application_form: - if user.is_authenticated and Registration.objects.filter(user=user, event__id=self.id, status="SELECTED").count(): + if ( + user.is_authenticated + and Registration.objects.filter(user=user, event__id=self.id, status="SELECTED").count() + ): return self.today_within_registration_band() return self.today_within_application_band() return self.today_within_registration_band() @@ -588,8 +639,8 @@ class RegistrationOption(Model): includes_membership = models.BooleanField( default=False, help_text="Does this registration option include DdS membership?" ) - membership_end_year = models.IntegerField( - default=this_year, help_text="If membership is included, until what year is it valid?" + membership_until = models.DateField( + default=end_of_this_year, help_text="If membership is included, last day it is valid (inclusive)" ) max_participants = models.PositiveIntegerField( default=0, @@ -617,7 +668,7 @@ def vat_percentage(self): @property def form_label(self): if self.includes_membership: - membership = " (includes DdS membership through {})".format(self.membership_end_year) + membership = " (includes DdS membership through {})".format(self.membership_until.isoformat()) else: membership = "" if self.has_vat: @@ -827,17 +878,12 @@ def __str__(self): class Certificate(Model): - registration = models.OneToOneField( - Registration, - related_name="certificate", - on_delete=models.CASCADE - ) + registration = models.OneToOneField(Registration, related_name="certificate", on_delete=models.CASCADE) uuid = models.UUIDField(default=uuid.uuid4, editable=False) def pdf(self): url = "https://{}{}".format( - Site.objects.get_current().domain, - reverse("event_certificate_validation", args=(self.uuid,)) + Site.objects.get_current().domain, reverse("event_certificate_validation", args=(self.uuid,)) ) return create_certificate_pdf( attendee_name=self.registration.user.get_full_name(), @@ -848,17 +894,12 @@ def pdf(self): class InvitationLetter(Model): - registration = models.OneToOneField( - Registration, - related_name="invitation", - on_delete=models.CASCADE - ) + registration = models.OneToOneField(Registration, related_name="invitation", on_delete=models.CASCADE) uuid = models.UUIDField(default=uuid.uuid4, editable=False) def pdf(self): url = "https://{}{}".format( - Site.objects.get_current().domain, - reverse("event_invitation_validation", args=(self.uuid,)) + Site.objects.get_current().domain, reverse("event_invitation_validation", args=(self.uuid,)) ) return create_invitation_pdf( attendee_name=self.registration.user.get_full_name(), diff --git a/dds_registration/settings.py b/dds_registration/settings.py index eb4980ea..a9cdec4e 100644 --- a/dds_registration/settings.py +++ b/dds_registration/settings.py @@ -8,6 +8,7 @@ import environ import sentry_sdk +from celery.schedules import crontab from loguru import logger # Working folder @@ -42,6 +43,8 @@ def random_string(length: int = 32) -> str: SLACK_PAYMENTS_WEBHOOK=(str, ""), SLACK_REGISTRATIONS_WEBHOOK=(str, ""), SENTRY_DSN=(str, ""), + CELERY_BROKER_URL=(str, "redis://127.0.0.1:6379/2"), + CELERY_TASK_ALWAYS_EAGER=(bool, False), ) environ.Env.read_env(os.path.join(BASE_DIR, ".env")) @@ -187,6 +190,7 @@ def random_string(length: int = 32) -> str: "django.contrib.messages.middleware.MessageMiddleware", "django.middleware.clickjacking.XFrameOptionsMiddleware", "hijack.middleware.HijackUserMiddleware", + APP_NAME + ".middleware.MembershipDetailsMiddleware.MembershipDetailsMiddleware", APP_NAME + ".middleware.BeautifulMiddleware.BeautifulMiddleware", # Html content prettifier ] @@ -313,6 +317,22 @@ def random_string(length: int = 32) -> str: # Site config # TODO: Use `Site.objects.get_current().name` (via `from django.contrib.sites.models import Site`) as site title. +# Members may renew this many days before their membership ends. +MEMBERSHIP_RENEWAL_WINDOW_DAYS = 60 + +# Celery: on hubdds the broker is the Redis instance Indico already runs (db0/db1), +# so this app uses db2. In dev and tests tasks run inline (eager). +CELERY_BROKER_URL = env("CELERY_BROKER_URL") +CELERY_TASK_ALWAYS_EAGER = env("CELERY_TASK_ALWAYS_EAGER") or DEBUG +CELERY_TASK_EAGER_PROPAGATES = CELERY_TASK_ALWAYS_EAGER +# Daily at 06:00 UTC (server and TIME_ZONE are UTC): 07:00 CET / 08:00 CEST. +CELERY_BEAT_SCHEDULE = { + "membership-reminders": { + "task": "dds_registration.tasks.membership_reminders.sweep", + "schedule": crontab(hour=6, minute=0), + }, +} + SITE_NAME = "Départ de Sentier Events and Membership Portal" SITE_TITLE = SITE_NAME # TODO: Issue #40: Add proper site description and keywords... diff --git a/dds_registration/tasks/__init__.py b/dds_registration/tasks/__init__.py new file mode 100644 index 00000000..03134324 --- /dev/null +++ b/dds_registration/tasks/__init__.py @@ -0,0 +1 @@ +from .membership_reminders import send_reminder, sweep # noqa: F401 diff --git a/dds_registration/tasks/membership_reminders.py b/dds_registration/tasks/membership_reminders.py new file mode 100644 index 00000000..578aeb97 --- /dev/null +++ b/dds_registration/tasks/membership_reminders.py @@ -0,0 +1,27 @@ +"""Celery entry points for membership renewal reminders.""" + +from datetime import date + +from celery import shared_task + +from ..core.membership import reminders + + +@shared_task(name="dds_registration.tasks.membership_reminders.sweep") +def sweep() -> int: + """Daily beat task: enqueue one send per member who is due today.""" + count = 0 + for membership, stage in reminders.due_reminders(date.today()): + send_reminder.delay(membership.pk, membership.until.isoformat(), stage) + count += 1 + return count + + +@shared_task( + name="dds_registration.tasks.membership_reminders.send_reminder", + autoretry_for=(Exception,), + retry_backoff=True, + max_retries=3, +) +def send_reminder(membership_id: int, until_iso: str, stage: str) -> bool: + return reminders.send_reminder(membership_id, date.fromisoformat(until_iso), stage) diff --git a/dds_registration/templates/dds_registration/billing/stripe_payment.html.django b/dds_registration/templates/dds_registration/billing/stripe_payment.html.django index b3d44673..ec88f23e 100644 --- a/dds_registration/templates/dds_registration/billing/stripe_payment.html.django +++ b/dds_registration/templates/dds_registration/billing/stripe_payment.html.django @@ -27,7 +27,7 @@ {% include "assets/render-messages/render-messages.django" %} -
Payment of {% if payment.data.stripe_charge_in_progress %}{{ payment.data.stripe_charge_in_progress }}{% else %}{{ payment.data.price }}{% endif %} {{ payment.currency_label }} for {% if payment.data.kind == "membership" %}Départ de Sentier membership valid until December 31st, {{ year }}{% else %}{{ payment.data.event.title }} ({{ payment.data.option.item }}){% endif %}.
+Payment of {% if payment.data.stripe_charge_in_progress %}{{ payment.data.stripe_charge_in_progress }}{% else %}{{ payment.data.price }}{% endif %} {{ payment.currency_label }} for {% if payment.data.kind == "membership" %}Départ de Sentier membership valid until {{ until|date:"j F Y" }}{% else %}{{ payment.data.event.title }} ({{ payment.data.option.item }}){% endif %}.