Merge pull request #598 from PROCOLLAB-github/feature/auto_sending_email

Toksi86 · web-flow · commit 468bf9df155e · 2026-01-30T12:28:18.000+05:00
Добавлена рассылка писем об окончании срока подачи проектов на программу
diff --git a/mailing/migrations/0008_mailing_scenario_log.py b/mailing/migrations/0008_mailing_scenario_log.py
@@ -0,0 +1,59 @@
+from django.conf import settings
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("partner_programs", "0015_partnerprogram_publish_projects_after_finish"),
+        ("mailing", "0007_alter_mailingschema_options_and_more"),
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="MailingScenarioLog",
+            fields=[
+                ("id", models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name="ID")),
+                ("scenario_code", models.CharField(max_length=128)),
+                ("scheduled_for", models.DateField()),
+                ("status", models.CharField(choices=[("pending", "Pending"), ("sent", "Sent"), ("failed", "Failed")], default="pending", max_length=16)),
+                ("sent_at", models.DateTimeField(blank=True, null=True)),
+                ("error", models.TextField(blank=True, null=True)),
+                ("datetime_created", models.DateTimeField(auto_now_add=True)),
+                ("datetime_updated", models.DateTimeField(auto_now=True)),
+                (
+                    "program",
+                    models.ForeignKey(
+                        on_delete=models.deletion.CASCADE,
+                        related_name="mailing_scenario_logs",
+                        to="partner_programs.partnerprogram",
+                    ),
+                ),
+                (
+                    "user",
+                    models.ForeignKey(
+                        on_delete=models.deletion.CASCADE,
+                        related_name="mailing_scenario_logs",
+                        to=settings.AUTH_USER_MODEL,
+                    ),
+                ),
+            ],
+            options={
+                "verbose_name": "Лог сценария рассылки",
+                "verbose_name_plural": "Логи сценариев рассылки",
+                "unique_together": {("scenario_code", "program", "user", "scheduled_for")},
+            },
+        ),
+        migrations.AddIndex(
+            model_name="mailingscenariolog",
+            index=models.Index(fields=["scenario_code", "scheduled_for"], name="mailing_ma_scenari_73b1f9_idx"),
+        ),
+        migrations.AddIndex(
+            model_name="mailingscenariolog",
+            index=models.Index(fields=["program", "scheduled_for"], name="mailing_ma_program_b9dcf9_idx"),
+        ),
+        migrations.AddIndex(
+            model_name="mailingscenariolog",
+            index=models.Index(fields=["user", "scheduled_for"], name="mailing_ma_user_id_0e2a92_idx"),
+        ),
+    ]
diff --git a/mailing/models.py b/mailing/models.py
@@ -1,6 +1,7 @@
 import os
 import uuid
 
+from django.conf import settings
 from django.db import models
 from .constants import get_default_mailing_schema
 
@@ -22,3 +23,47 @@ class Meta:
 
     def __str__(self):
         return f"MailingSchema<{self.name}>"
+
+
+class MailingScenarioLog(models.Model):
+    class Status(models.TextChoices):
+        PENDING = "pending", "Pending"
+        SENT = "sent", "Sent"
+        FAILED = "failed", "Failed"
+
+    scenario_code = models.CharField(max_length=128)
+    program = models.ForeignKey(
+        "partner_programs.PartnerProgram",
+        on_delete=models.CASCADE,
+        related_name="mailing_scenario_logs",
+    )
+    user = models.ForeignKey(
+        settings.AUTH_USER_MODEL,
+        on_delete=models.CASCADE,
+        related_name="mailing_scenario_logs",
+    )
+    scheduled_for = models.DateField()
+    status = models.CharField(
+        max_length=16, choices=Status.choices, default=Status.PENDING
+    )
+    sent_at = models.DateTimeField(null=True, blank=True)
+    error = models.TextField(null=True, blank=True)
+    datetime_created = models.DateTimeField(auto_now_add=True)
+    datetime_updated = models.DateTimeField(auto_now=True)
+
+    class Meta:
+        verbose_name = "Лог сценария рассылки"
+        verbose_name_plural = "Логи сценариев рассылки"
+        unique_together = ("scenario_code", "program", "user", "scheduled_for")
+        indexes = [
+            models.Index(fields=["scenario_code", "scheduled_for"]),
+            models.Index(fields=["program", "scheduled_for"]),
+            models.Index(fields=["user", "scheduled_for"]),
+        ]
+
+    def __str__(self):
+        return (
+            f"MailingScenarioLog<{self.scenario_code}> "
+            f"program={self.program_id} user={self.user_id} "
+            f"date={self.scheduled_for} status={self.status}"
+        )
diff --git a/mailing/scenarios.py b/mailing/scenarios.py
@@ -0,0 +1,63 @@
+from dataclasses import dataclass
+from datetime import date
+from enum import Enum
+from typing import Callable
+
+from partner_programs.models import PartnerProgram
+from users.models import CustomUser
+
+FRONTEND_BASE_URL = "https://app.procollab.ru"
+
+
+class TriggerType(Enum):
+    PROGRAM_SUBMISSION_DEADLINE = "program_submission_deadline"
+
+
+class RecipientRule(Enum):
+    ALL_PARTICIPANTS = "all_participants"
+    NO_PROJECT_IN_PROGRAM = "no_project_in_program"
+
+
+ContextBuilder = Callable[[PartnerProgram, CustomUser, date], dict]
+
+
+@dataclass(frozen=True)
+class Scenario:
+    code: str
+    trigger: TriggerType
+    offset_days: int
+    template_name: str
+    subject: str
+    recipient_rule: RecipientRule
+    context_builder: ContextBuilder
+
+
+def _build_submission_deadline_context(offset_days: int) -> ContextBuilder:
+    def _builder(program: PartnerProgram, user: CustomUser, deadline_date: date) -> dict:
+        deadline_str = deadline_date.strftime("%d.%m.%Y")
+        return {
+            "preview_text": f"До окончания подачи проектов осталось {offset_days} дней",
+            "title": "Пора подать проект",
+            "text": (
+                f"До окончания подачи проектов в программе «{program.name}» "
+                f"осталось {offset_days} дней. "
+                f"Пожалуйста, подайте проект и сформируйте команду до {deadline_str}."
+            ),
+            "button_text": "Подать проект",
+            "button_link": f"{FRONTEND_BASE_URL}/office/program/{program.id}",
+        }
+
+    return _builder
+
+
+SCENARIOS: tuple[Scenario, ...] = (
+    Scenario(
+        code="program_submission_deadline_minus_10_no_project",
+        trigger=TriggerType.PROGRAM_SUBMISSION_DEADLINE,
+        offset_days=10,
+        template_name="email/generic-template-0.html",
+        subject="Procollab | Подача проекта",
+        recipient_rule=RecipientRule.NO_PROJECT_IN_PROGRAM,
+        context_builder=_build_submission_deadline_context(10),
+    ),
+)
diff --git a/mailing/tasks.py b/mailing/tasks.py
@@ -0,0 +1,129 @@
+import logging
+from datetime import timedelta
+
+from django.utils import timezone
+
+from mailing.models import MailingScenarioLog
+from mailing.scenarios import RecipientRule, SCENARIOS, TriggerType
+from mailing.utils import send_mass_mail_from_template
+from partner_programs.selectors import (
+    program_participants,
+    program_participants_without_project,
+    programs_with_submission_deadline_on,
+)
+from procollab.celery import app
+
+logger = logging.getLogger(__name__)
+
+
+def _get_programs_for_scenario(scenario, target_date):
+    match scenario.trigger:
+        case TriggerType.PROGRAM_SUBMISSION_DEADLINE:
+            return programs_with_submission_deadline_on(target_date)
+        case _:
+            raise ValueError(f"Unsupported trigger: {scenario.trigger}")
+
+
+def _get_recipients(scenario, program_id: int):
+    match scenario.recipient_rule:
+        case RecipientRule.ALL_PARTICIPANTS:
+            return program_participants(program_id)
+        case RecipientRule.NO_PROJECT_IN_PROGRAM:
+            return program_participants_without_project(program_id)
+        case _:
+            raise ValueError(f"Unsupported recipient rule: {scenario.recipient_rule}")
+
+
+def _deadline_date(program):
+    deadline = program.datetime_project_submission_ends or program.datetime_registration_ends
+    return timezone.localtime(deadline).date()
+
+
+def _send_scenario_for_program(scenario, program, scheduled_for):
+    recipients = _get_recipients(scenario, program.id)
+    if not recipients.exists():
+        return 0
+
+    pending_or_sent_ids = MailingScenarioLog.objects.filter(
+        scenario_code=scenario.code,
+        program=program,
+        scheduled_for=scheduled_for,
+        status__in=[
+            MailingScenarioLog.Status.PENDING,
+            MailingScenarioLog.Status.SENT,
+        ],
+    ).values_list("user_id", flat=True)
+
+    recipients_to_send = recipients.exclude(id__in=pending_or_sent_ids)
+    user_ids = list(recipients_to_send.values_list("id", flat=True))
+    if not user_ids:
+        return 0
+
+    MailingScenarioLog.objects.filter(
+        scenario_code=scenario.code,
+        program=program,
+        scheduled_for=scheduled_for,
+        status=MailingScenarioLog.Status.FAILED,
+        user_id__in=user_ids,
+    ).update(status=MailingScenarioLog.Status.PENDING, error="", sent_at=None)
+
+    logs = [
+        MailingScenarioLog(
+            scenario_code=scenario.code,
+            program=program,
+            user_id=user_id,
+            scheduled_for=scheduled_for,
+            status=MailingScenarioLog.Status.PENDING,
+        )
+        for user_id in user_ids
+    ]
+    MailingScenarioLog.objects.bulk_create(logs, ignore_conflicts=True)
+
+    deadline_date = _deadline_date(program)
+
+    def context_builder(user):
+        return scenario.context_builder(program, user, deadline_date)
+
+    try:
+        send_mass_mail_from_template(
+            recipients_to_send,
+            scenario.subject,
+            scenario.template_name,
+            context_builder=context_builder,
+        )
+    except Exception as exc:
+        MailingScenarioLog.objects.filter(
+            scenario_code=scenario.code,
+            program=program,
+            scheduled_for=scheduled_for,
+            status=MailingScenarioLog.Status.PENDING,
+            user_id__in=user_ids,
+        ).update(status=MailingScenarioLog.Status.FAILED, error=str(exc))
+        logger.exception(
+            "Scenario %s failed for program %s", scenario.code, program.id
+        )
+        return 0
+
+    MailingScenarioLog.objects.filter(
+        scenario_code=scenario.code,
+        program=program,
+        scheduled_for=scheduled_for,
+        status=MailingScenarioLog.Status.PENDING,
+        user_id__in=user_ids,
+    ).update(
+        status=MailingScenarioLog.Status.SENT, sent_at=timezone.now(), error=""
+    )
+    return len(user_ids)
+
+
+@app.task
+def run_program_mailings() -> int:
+    today = timezone.localdate()
+    total_sent = 0
+    for scenario in SCENARIOS:
+        target_date = today + timedelta(days=scenario.offset_days)
+        programs = _get_programs_for_scenario(scenario, target_date)
+        for program in programs:
+            total_sent += _send_scenario_for_program(scenario, program, today)
+    logger.info("Program mailings sent: %s", total_sent)
+    return total_sent
diff --git a/mailing/utils.py b/mailing/utils.py
@@ -11,6 +11,7 @@
 from django.core import mail
 from django.core.mail import EmailMultiAlternatives
 from django.template import Context, Template
+from django.template.loader import get_template
 
 from .typing import MailDataDict, EmailDataToPrepare
 
@@ -124,3 +125,44 @@ def send_mass_mail(
     for group in grouped_messages:
         num_sent += send_group_messages(group)
     return num_sent
+
+
+def send_mass_mail_from_template(
+    users: django.db.models.QuerySet | List[User],
+    subject: str,
+    template_name: str,
+    template_context: Union[
+        MailDataDict,
+        list,
+        dict,
+    ] = None,
+    context_builder=None,
+    connection=None,
+) -> Annotated[int, "Количество отосланных сообщений"]:
+    """
+    Send emails using a template file from Django template loaders.
+    Allows optional per-user context via context_builder(user) -> dict.
+    """
+    if template_context is None:
+        template_context = {}
+
+    template = get_template(template_name)
+    messages = []
+    for user in users:
+        context = dict(template_context)
+        if context_builder is not None:
+            context.update(context_builder(user))
+        context["user"] = user
+        html_msg = template.render(context)
+        plain_msg = template.render(context)
+        msg = EmailMultiAlternatives(
+            subject, plain_msg, settings.EMAIL_USER, [user.email]
+        )
+        msg.attach_alternative(html_msg, "text/html")
+        messages.append(msg)
+
+    grouped_messages = create_message_groups(messages)
+    num_sent: int = 0
+    for group in grouped_messages:
+        num_sent += send_group_messages(group)
+    return num_sent
diff --git a/partner_programs/selectors.py b/partner_programs/selectors.py
diff --git a/procollab/celery.py b/procollab/celery.py
