wbmailing 2.2.1__py2.py3-none-any.whl

wbmailing/viewsets/buttons/mailing_lists.py

@@ -0,0 +1,91 @@
+from django.dispatch import receiver
+from django.utils.translation import gettext as _
+from rest_framework.reverse import reverse
+from wbcore.contrib.directory.viewsets import (
+    CompanyModelViewSet,
+    EntryModelViewSet,
+    PersonModelViewSet,
+)
+from wbcore.contrib.icons import WBIcon
+from wbcore.enums import RequestType
+from wbcore.metadata.configs import buttons as bt
+from wbcore.metadata.configs.buttons.view_config import ButtonViewConfig
+from wbcore.signals.instance_buttons import add_instance_button
+
+
+class MailingListSubcriptionRequestButtonConfig(ButtonViewConfig):
+    def get_custom_buttons(self):
+        if not hasattr(self.view.kwargs, "pk"):
+            user = self.request.user
+            if user.is_superuser or user.has_perm("wbmailing.administrate_mailinglistsubscriberchangerequest"):
+                return {
+                    bt.ActionButton(
+                        method=RequestType.GET,
+                        identifiers=("wbmailing:mailinglistsubscriberchangerequest",),
+                        endpoint=reverse(
+                            "wbmailing:mailinglistsubscriberchangerequest-approveall", args=[], request=self.request
+                        ),
+                        label=_("Approve All"),
+                        description_fields=_(
+                            """
+                        <p>Do you really want to approve all pending subscriptions requests?</p>
+                        """
+                        ),
+                        action_label=_("Approving all pending subscription requests"),
+                        title=_("Approve all pending subscription requests"),
+                    )
+                }
+        return {}
+
+
+class MailingListButtonConfig(ButtonViewConfig):
+    def get_custom_instance_buttons(self):
+        return {
+            bt.WidgetButton(key="mailevent_chart", label=_("Mail Penetration"), icon=WBIcon.FEEDBACK.icon),
+        }
+
+    def get_custom_list_instance_buttons(self):
+        return self.get_custom_instance_buttons()
+
+
+class MailingListEmailContactThroughModelButtonConfig(ButtonViewConfig):
+    def get_custom_list_instance_buttons(self):
+        return {
+            bt.WidgetButton(key="requests", label="Changes Request History", icon=WBIcon.DATA_LIST.icon),
+            bt.ActionButton(
+                method=RequestType.PATCH,
+                identifiers=("directory:email_contacts",),
+                key="delete_from_mailinglist",
+                label=_("Delete"),
+                icon=WBIcon.DELETE.icon,
+                description_fields=_(
+                    "<p> Are you sure you want to delete {{_entry.computed_str}} from this mailinglist? Check with your compliance team if you are not sure</p>"
+                ),
+                title=_("Delete"),
+                action_label=_("Deletion"),
+            ),
+            bt.ActionButton(
+                method=RequestType.PATCH,
+                identifiers=("directory:email_contacts",),
+                key="unsubscribe",
+                label=_("Unsubscribe"),
+                icon=WBIcon.UNDO.icon,
+                description_fields=_(
+                    "<p> Are you sure you want to unsubscribe {{_entry.computed_str}} from this mailinglist? Until the entry exists, the user won't be able to resubscribe</p>"
+                ),
+                title=_("Unsubscribe"),
+                action_label=_("Unsubscribing"),
+            ),
+        }
+
+
+@receiver(add_instance_button, sender=PersonModelViewSet)
+@receiver(add_instance_button, sender=EntryModelViewSet)
+@receiver(add_instance_button, sender=CompanyModelViewSet)
+def crm_adding_instance_buttons_ep(sender, many, *args, **kwargs):
+    if not many:
+        return bt.DropDownButton(
+            label=_("Mailing"),
+            icon=WBIcon.UNFOLD.icon,
+            buttons=(bt.WidgetButton(key="mailinglist", label=_("Mailing"), icon=WBIcon.MAIL.icon),),
+        )

wbmailing/viewsets/buttons/mails.py

@@ -0,0 +1,98 @@
+from django.utils.translation import gettext as _
+from django.utils.translation import gettext_lazy
+from rest_framework.reverse import reverse
+from wbcore import serializers as wb_serializers
+from wbcore.contrib.icons import WBIcon
+from wbcore.enums import RequestType
+from wbcore.metadata.configs import buttons as bt
+from wbcore.metadata.configs.buttons.view_config import ButtonViewConfig
+from wbcore.metadata.configs.display.instance_display.shortcuts import (
+    create_simple_display,
+)
+from wbmailing.models import MassMail
+
+
+class MassMailButtonConfig(ButtonViewConfig):
+    def get_custom_instance_buttons(self):
+        class SendTestMailActionButtonSerializer(wb_serializers.Serializer):
+            to_test_email = wb_serializers.CharField(label=gettext_lazy("Send To"), default=self.request.user.email)
+
+            class Meta:
+                fields = ["to_test_email"]
+
+        return {
+            bt.ActionButton(
+                method=RequestType.PATCH,
+                identifiers=("wbmailing:entry-mailinglist",),
+                action_label=_("Sending test mail"),
+                key="send_test_mail",
+                description_fields=_("<p>Are you sure you want to send a test mail?</p>"),
+                serializer=SendTestMailActionButtonSerializer,
+                icon=WBIcon.CHART_SWITCHES.icon,
+                title=_("Test Mail"),
+                label=_("Test Mail"),
+                instance_display=create_simple_display([["to_test_email"]]),
+            ),
+            bt.WidgetButton(key="mails", label=_("Mails' Status"), icon=WBIcon.MAIL_OPEN.icon),
+        }
+
+
+class MailButtonConfig(ButtonViewConfig):
+    def get_custom_instance_buttons(self):
+        title = gettext_lazy("Resend Mail")
+        action_label = gettext_lazy("Resending mail")
+        description = gettext_lazy("<p>Are you sure you want to resend the mail?</p>")
+        icon = WBIcon.REPLACE.icon
+        try:
+            mail = self.view.get_object()
+            if not mail.events.exists():
+                title = gettext_lazy("Send Mail")
+                action_label = gettext_lazy("Sending mail")
+                description = gettext_lazy("<p>Are you sure you want to send the mail?</p>")
+                icon = WBIcon.SEND.icon
+        except AssertionError:
+            pass
+        return {
+            bt.ActionButton(
+                method=RequestType.PATCH,
+                identifiers=("wbmailing:mail",),
+                action_label=action_label,
+                key="resend_mail",
+                description_fields=description,
+                icon=icon,
+                title=title,
+                label=title,
+            )
+        }
+
+    def get_custom_list_instance_buttons(self):
+        return self.get_custom_instance_buttons()
+
+
+class MailStatusMassMailButtonConfig(ButtonViewConfig):
+    def get_custom_buttons(self):
+        if not self.view.kwargs.get("pk", None) and (mass_mail_id := self.view.kwargs.get("mass_mail_id", None)):
+            mass_mail = MassMail.objects.get(id=mass_mail_id)
+            if mass_mail.status == MassMail.Status.SENT:
+                return {
+                    bt.ActionButton(
+                        method=RequestType.PATCH,
+                        identifiers=("wbmailing:massmail",),
+                        endpoint=reverse(
+                            "wbmailing:massmail-mailstatus-resendbouncedmails",
+                            args=[mass_mail_id],
+                            request=self.request,
+                        ),
+                        label=_("Resend Bounced Emails"),
+                        description_fields=_(
+                            """
+                        <p>Do not abuse this function! Doing so will likely degrade your mailing reputation.</p>
+                        <p>If you are sure, please confirm</>
+                        <p>
+                        """
+                        ),
+                        action_label=_("Resending bounced emails"),
+                        title=_("Resend Bounced Emails"),
+                    )
+                }
+        return set()

wbmailing/viewsets/display/__init__.py

@@ -0,0 +1,16 @@
+from .mailing_lists import (
+    EmailContactMailingListDisplayConfig,
+    MailingListDisplayConfig,
+    MailingListEntryCompanyDisplayConfig,
+    MailingListEntryDisplayConfig,
+    MailingListSubscriberChangeRequestDisplayConfig,
+    MailingListSubscriberRequestEntryDisplayConfig,
+    MailingListSubscriberRequestMailingListDisplayConfig,
+)
+from .mails import (
+    MailDisplayConfig,
+    MailEventDisplayConfig,
+    MailStatusMassMailDisplayConfig,
+    MailTemplateDisplayConfig,
+    MassMailDisplayConfig,
+)

wbmailing/viewsets/display/mailing_lists.py

@@ -0,0 +1,175 @@
+from typing import Optional
+
+from django.utils.translation import gettext as _
+from wbcore.contrib.color.enums import WBColor
+from wbcore.metadata.configs import display as dp
+from wbcore.metadata.configs.display.instance_display.shortcuts import (
+    Display,
+    create_simple_display,
+    create_simple_section,
+)
+from wbcore.metadata.configs.display.instance_display.utils import repeat_field
+from wbcore.metadata.configs.display.view_config import DisplayViewConfig
+from wbmailing import models
+
+
+class MailingListDisplayConfig(DisplayViewConfig):
+    def get_list_display(self) -> Optional[dp.ListDisplay]:
+        return dp.ListDisplay(
+            fields=[
+                dp.Field(key="title", label=_("Title")),
+                dp.Field(key="nb_subscribers", label=_("Subscribers")),
+                dp.Field(key="is_public", label=_("Public")),
+            ]
+        )
+
+    def get_instance_display(self) -> Display:
+        return create_simple_display(
+            [["title", "nb_subscribers", "is_public"], [repeat_field(3, "email_contacts_section")]],
+            [
+                create_simple_section(
+                    "email_contacts_section",
+                    _("Email Contacts"),
+                    [["email_contacts"]],
+                    "email_contacts",
+                    collapsed=True,
+                )
+            ],
+        )
+
+
+class MailingListSubscriberChangeRequestDisplayConfig(DisplayViewConfig):
+    def get_list_display(self) -> Optional[dp.ListDisplay]:
+        return dp.ListDisplay(
+            fields=[
+                dp.Field(key="type", label=_("Type")),
+                dp.Field(key="email_contact", label=_("Email Contact")),
+                dp.Field(key="entry_repr", label=_("Entry")),
+                dp.Field(key="requester", label=_("Requester")),
+                dp.Field(key="mailing_list", label=_("Mailing List")),
+                dp.Field(key="created", label=_("Creation Date")),
+                dp.Field(key="expiration_date", label=_("Expiration Date")),
+                dp.Field(key="reason", label=_("Reason")),
+            ],
+            legends=[
+                dp.Legend(
+                    key="status",
+                    items=[
+                        dp.LegendItem(
+                            icon=WBColor.YELLOW_LIGHT.value,
+                            label=models.MailingListSubscriberChangeRequest.Status.PENDING.label,
+                            value=models.MailingListSubscriberChangeRequest.Status.PENDING,
+                        ),
+                        dp.LegendItem(
+                            icon=WBColor.GREEN_LIGHT.value,
+                            label=models.MailingListSubscriberChangeRequest.Status.APPROVED.label,
+                            value=models.MailingListSubscriberChangeRequest.Status.APPROVED,
+                        ),
+                        dp.LegendItem(
+                            icon=WBColor.RED_LIGHT.value,
+                            label=models.MailingListSubscriberChangeRequest.Status.DENIED.label,
+                            value=models.MailingListSubscriberChangeRequest.Status.DENIED,
+                        ),
+                    ],
+                )
+            ],
+            formatting=[
+                dp.Formatting(
+                    column="status",
+                    formatting_rules=[
+                        dp.FormattingRule(
+                            style={"backgroundColor": WBColor.YELLOW_LIGHT.value},
+                            condition=(
+                                "==",
+                                models.MailingListSubscriberChangeRequest.Status.PENDING,
+                            ),
+                        ),
+                        dp.FormattingRule(
+                            style={"backgroundColor": WBColor.GREEN_LIGHT.value},
+                            condition=(
+                                "==",
+                                models.MailingListSubscriberChangeRequest.Status.APPROVED,
+                            ),
+                        ),
+                        dp.FormattingRule(
+                            style={"backgroundColor": WBColor.RED_LIGHT.value},
+                            condition=(
+                                "==",
+                                models.MailingListSubscriberChangeRequest.Status.DENIED,
+                            ),
+                        ),
+                    ],
+                )
+            ],
+        )
+
+    def get_instance_display(self) -> Display:
+        return create_simple_display(
+            [
+                [repeat_field(3, "status")],
+                ["email_contact", "mailing_list", "expiration_date"],
+                [
+                    "requester",
+                    "approver",
+                    ".",
+                ],
+                [
+                    "created",
+                    "updated",
+                    ".",
+                ],
+                [repeat_field(3, "reason")],
+            ]
+        )
+
+
+class MailingListSubscriberRequestMailingListDisplayConfig(MailingListSubscriberChangeRequestDisplayConfig):
+    def get_instance_display(self) -> Display:
+        return create_simple_display(
+            [
+                [repeat_field(2, "status")],
+                ["expiration_date", "email_contact"],
+            ]
+        )
+
+
+class EmailContactMailingListDisplayConfig(DisplayViewConfig):
+    def get_list_display(self) -> Optional[dp.ListDisplay]:
+        return dp.ListDisplay(
+            fields=[
+                dp.Field(key="status", label=_("Status")),
+                dp.Field(key="email_contact", label=_("Email Contact")),
+                dp.Field(key="expiration_date", label=_("Expiration Date")),
+                dp.Field(key="is_pending_request_change", label=_("Pending Change")),
+            ]
+        )
+
+
+class MailingListEntryDisplayConfig(MailingListDisplayConfig):
+    def get_list_display(self) -> Optional[dp.ListDisplay]:
+        return dp.ListDisplay(
+            fields=[
+                dp.Field(key="status", label=_("Status")),
+                dp.Field(key="mailing_list", label=_("Mailing List")),
+                dp.Field(key="is_public", label=_("Public")),
+                dp.Field(key="expiration_date", label=_("Expiration Date")),
+                dp.Field(key="is_pending_request_change", label=_("Pending Change")),
+            ]
+        )
+
+
+class MailingListEntryCompanyDisplayConfig(MailingListEntryDisplayConfig):
+    def get_list_display(self) -> Optional[dp.ListDisplay]:
+        return dp.ListDisplay(
+            fields=[
+                dp.Field(key="title", label=_("Mailing List")),
+                dp.Field(key="is_public", label=_("Public")),
+            ]
+        )
+
+
+class MailingListSubscriberRequestEntryDisplayConfig(MailingListSubscriberChangeRequestDisplayConfig):
+    def get_instance_display(self) -> Display:
+        return create_simple_display(
+            [[repeat_field(3, "status")], ["email_contact", "mailing_list", "expiration_date"]]
+        )