Merge pull request #238 from PROCOLLAB-github/feature/admin-mass-mail

Mass mailing from admin

Author: yakser

mailing/constants.py

@@ -7,3 +7,6 @@ def get_default_mailing_schema() -> dict[str, dict[str, str]]:
         "text": {"title": "Основной текст письма"},
         "button_text": {"title": "Текст кнопки", "default": "Кнопка"},
     }
+
+
+MAILING_USERS_BATCH_SIZE = 100

mailing/utils.py

@@ -1,4 +1,7 @@
 from typing import Dict, List, Union
+from .constants import MAILING_USERS_BATCH_SIZE
+from .models import MailingSchema
+from users.models import CustomUser
 
 import django.db.models
 from django.contrib.auth import get_user_model
@@ -9,29 +12,64 @@
 User = get_user_model()
 
 
+def prepare_mail_data(post_data) -> dict:
+    users = post_data.getlist("users[]")
+    schema_id = post_data["schemas"]
+    subject = post_data["subject"]
+    mail_schema = MailingSchema.objects.get(pk=schema_id)
+    context = {}
+    for variable_name in mail_schema.schema:
+        key_in_post = "field-" + variable_name
+        if key_in_post in post_data:
+            context[variable_name] = post_data[key_in_post]
+    users_to_send = CustomUser.objects.filter(pk__in=users)
+    data_dict = {
+        "users_to_send": users_to_send,
+        "subject": subject,
+        "mail_schema_template": mail_schema.template,
+        "context": context,
+    }
+    return data_dict
+
+
+def create_message_groups(messages: list) -> list[list]:
+    grouped_messages: list[list] = [
+        messages[message: message + MAILING_USERS_BATCH_SIZE]
+        for message in range(0, len(messages), MAILING_USERS_BATCH_SIZE)
+    ]
+    return grouped_messages
+
+
 def send_mail(
-    user: User,
-    subject: str,
-    template_string: str,
-    template_context: Union[
-        Dict,
-        List,
-    ] = None,
-    connection=None,
+        user: User,
+        subject: str,
+        template_string: str,
+        template_context: Union[
+            Dict,
+            List,
+        ] = None,
+        connection=None,
 ):
     return send_mass_mail([user], subject, template_string, template_context, connection)
 
 
+def send_group_messages(messages: list) -> int:
+    connection = mail.get_connection()
+    num_sent = connection.send_messages(messages)
+    connection.close()
+    return num_sent
+
+
 def send_mass_mail(
-    users: django.db.models.QuerySet | List[User],
-    subject: str,
-    template_string: str,
-    template_context: Union[
-        Dict,
-        List,
-    ] = None,
-    connection=None,
-) -> None:
+        users: django.db.models.QuerySet | List[User],
+        subject: str,
+        template_string: str,
+        template_context: Union[
+            Dict,
+            List,
+        ] = None,
+        connection=None,
+) -> int:
     """
     Begin mailing to specified users, sending rendered template with template_text arg.
     Throws an error if template render is unsuccessful.
@@ -45,16 +83,18 @@ def send_mass_mail(
     if template_context is None:
         template_context = {}
 
-    connection = connection or mail.get_connection()
     template = Template(template_string)
     messages = []
     for user in users:
         template_context["user"] = user
         html_msg = template.render(Context(template_context))
         plain_msg = template.render(Context(template_context))
-        msg = EmailMultiAlternatives(
-            subject, plain_msg, None, [user.email], connection=connection
-        )
+        msg = EmailMultiAlternatives(subject, plain_msg, None, [user.email])
         msg.attach_alternative(html_msg, "text/html")
         messages.append(msg)
-    return connection.send_messages(messages)
+
+    grouped_messages = create_message_groups(messages)
+    num_sent: int = 0
+    for group in grouped_messages:
+        num_sent += send_group_messages(group)
+    return num_sent

mailing/views.py

@@ -6,21 +6,18 @@
 from users.models import CustomUser
 from .utils import send_mass_mail
 from .models import MailingSchema
+from .utils import prepare_mail_data
 
 
 class SendMailView(APIView):
-    def post(self, request):
-        users = request.POST.getlist("users[]")
-        schema_id = request.POST["schemas"]
-        subject = request.POST["subject"]
-        mail_schema = MailingSchema.objects.get(pk=schema_id)
-        context = {}
-        for variable_name in mail_schema.schema:
-            key_in_post = "field-" + variable_name
-            if key_in_post in request.POST:
-                context[variable_name] = request.POST[key_in_post]
-        users_to_send = CustomUser.objects.filter(pk__in=users)
-        send_mass_mail(users_to_send, subject, mail_schema.template, context)
+    def post(self, request) -> JsonResponse:
+        mail_data: dict = prepare_mail_data(request.POST)
+        send_mass_mail(
+            mail_data["users_to_send"],
+            mail_data["subject"],
+            mail_data["mail_schema_template"],
+            mail_data["context"],
+        )
         return JsonResponse({"detail": "ok"})
 
 

templates/admin/change_list.html

@@ -0,0 +1,107 @@
+{% extends "admin/base_site.html" %}
+{% load i18n admin_urls static admin_list %}
+
+{% block extrastyle %}
+{{ block.super }}
+<link rel="stylesheet" href="{% static 'admin/css/changelists.css'%}">
+<link rel="stylesheet" href="{% static 'admin/css/forms.css' %}">
+{% if cl.formset or action_form %}
+<script src="{% url 'admin:jsi18n' %}"></script>
+{% endif %}
+{{ media.css }}
+{% if not actions_on_top and not actions_on_bottom %}
+<style>
+      #changelist table thead th:first-child {width: inherit}
+
+
+</style>
+{% endif %}
+{% endblock %}
+
+{% block extrahead %}
+{{ block.super }}
+{{ media.js }}
+<script src="{% static 'admin/js/filters.js' %}" defer></script>
+{% endblock %}
+
+{% block bodyclass %}{{ block.super }} app-{{ opts.app_label }} model-{{ opts.model_name }} change-list{% endblock %}
+
+{% if not is_popup %}
+{% block breadcrumbs %}
+<div class="breadcrumbs">
+    <a href="{% url 'admin:index' %}">{% translate 'Home' %}</a>
+    &rsaquo; <a href="{% url 'admin:app_list' app_label=cl.opts.app_label %}">{{ cl.opts.app_config.verbose_name }}</a>
+    &rsaquo; {{ cl.opts.verbose_name_plural|capfirst }}
+</div>
+{% endblock %}
+{% endif %}
+
+{% block coltype %}{% endblock %}
+
+{% block content %}
+<div id="content-main">
+    {% block object-tools %}
+    <ul class="object-tools">
+        {% block object-tools-items %}
+        {% change_list_object_tools %}
+        {% endblock %}
+    </ul>
+    {% endblock %}
+    {% if cl.formset and cl.formset.errors %}
+    <p class="errornote">
+        {% blocktranslate count counter=cl.formset.total_error_count %}Please correct the error below.{% plural %}Please
+        correct the errors below.{% endblocktranslate %}
+    </p>
+    {{ cl.formset.non_form_errors }}
+    {% endif %}
+    <div class="module{% if cl.has_filters %} filtered{% endif %}" id="changelist">
+        <div class="changelist-form-container">
+            {% block search %}{% search_form cl %}{% endblock %}
+            {% block date_hierarchy %}{% if cl.date_hierarchy %}{% date_hierarchy cl %}{% endif %}{% endblock %}
+
+            <form id="changelist-form" method="post" {% if cl.formset and cl.formset.is_multipart %}
+                  enctype="multipart/form-data" {% endif %} novalidate>{% csrf_token %}
+                {% if cl.formset %}
+                <div>{{ cl.formset.management_form }}</div>
+                {% endif %}
+
+                {% block result_list %}
+                {% if action_form and actions_on_top and cl.show_admin_actions %}{% admin_actions %}{% endif %}
+                {% result_list cl %}
+                {% if action_form and actions_on_bottom and cl.show_admin_actions %}{% admin_actions %}{% endif %}
+                {% endblock %}
+                {% block pagination %}{% pagination cl %}{% endblock %}
+                <div class="submit-row" id="mailing_btn">
+                    <input type="button" class="mailing-btn" value="Рассылка" onclick="mailing()"/>
+                </div>
+                <br>
+                <script>
+                    function mailing() {
+                        window.open("{% url 'admin:user_mass_mail' %}", '_blank').focus()
+                    }
+                    window.onload = function() {
+                    var currentURL = window.location.href;
+                    currentURL = currentURL.split('/');
+                    if (currentURL.at(-2) != "customuser")
+                    {
+                        const button = document.getElementById("mailing_btn");
+                        button.setAttribute("style", "display:none;");
+                    }
+                    };
+                </script>
+            </form>
+        </div>
+        {% block filters %}
+        {% if cl.has_filters %}
+        <div id="changelist-filter">
+            <h2>{% translate 'Filter' %}</h2>
+            {% if cl.has_active_filters %}<h3 id="changelist-filter-clear">
+            <a href="{{ cl.clear_all_filters_qs }}">&#10006; {% translate "Clear all filters" %}</a>
+        </h3>{% endif %}
+            {% for spec in cl.filter_specs %}{% admin_list_filter cl spec %}{% endfor %}
+        </div>
+        {% endif %}
+        {% endblock %}
+    </div>
+</div>
+{% endblock %}

users/admin.py

@@ -163,9 +163,18 @@ def get_urls(self):
                 self.admin_site.admin_view(self.force_verify),
                 name="force_verify",
             ),
+            path(
+                "mailing/",
+                self.admin_site.admin_view(self.mass_mail),
+                name="user_mass_mail",
+            ),
         ]
         return custom_urls + default_urls
 
+    def mass_mail(self, request):
+        users = CustomUser.objects.all()
+        return MailingTemplateRender().render_template(request, None, users, None)
+
     def mailing(self, request, user_object):
         user = CustomUser.objects.get(pk=user_object)
         users = [user]