Skip to content

contact_serializer#

ContactResponseSerializer#

Bases: Serializer

Source code in src/apps/core/serializers/contact_serializer.py 
10
11
class ContactResponseSerializer(serializers.Serializer):
    recipient_count = serializers.IntegerField(read_only=True)

ContactRolesSerializer#

Bases: Serializer

Dataset role email information serializer.

Serializes dataset instance into a dict of role to boolean mappings that tells if there exists one or more email addresses for a role.

Source code in src/apps/core/serializers/contact_serializer.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
class ContactRolesSerializer(serializers.Serializer):
    """Dataset role email information serializer.

    Serializes dataset instance into a dict of role to boolean mappings
    that tells if there exists one or more email addresses for a role.
    """

    def get_fields(self):
        return {role: serializers.BooleanField() for role, _ in DatasetActor.RoleChoices.choices}

    def to_representation(self, instance: Dataset):
        data = self.get_initial()
        for actor in instance.actors.all():
            if actor.get_email():
                for role in actor.roles:
                    data[role] = True

        return super().to_representation(instance=data)

ContactSerializer#

Bases: Serializer

Send email to dataset actors with specific roles.

Requires Dataset as "dataset" in context.

Source code in src/apps/core/serializers/contact_serializer.py 
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
class ContactSerializer(serializers.Serializer):
    """Send email to dataset actors with specific roles.

    Requires Dataset as "dataset" in context.
    """

    reply_to = serializers.EmailField()
    subject = serializers.CharField(min_length=1, max_length=255)
    body = serializers.CharField(min_length=1, max_length=2000)
    role = ListValidChoicesField(choices=DatasetActor.RoleChoices.choices)
    service = serializers.ChoiceField(choices=("etsin",))

    def get_recipients_for_role(self, dataset: Dataset, role: str):
        recipients = set()
        actors = dataset.actors.filter(roles__contains=[role])
        for actor in actors:
            if email := actor.get_email():
                recipients.add(email)
        return list(recipients)

    def get_message_body(
        self, dataset: Dataset, reply_to: str, user_subject: str, user_body: str
    ) -> str:
        """Create body for an email message to be sent.

        Arguments:
            persistent_identifier (str): Preferred identifier of dataset.
            user_email (str): The email of the sender.
            user_subject (str): Email subject.
            user_body (str): Email body.

        Returns:
            str: Email message body with all arguments.

        """
        now = timezone.now()
        identifier = dataset.persistent_identifier or dataset.id

        meta_en = format_multiline(
            """
            The message below was sent via Fairdata Etsin Service \\
            on {date:%B} {date.day}, {date.year}.
            It concerns a dataset with identifier "{identifier}".
            Original sender: {reply_to}.

            Note!
            This message was sent as a notification from the Etsin Service.
            Do not reply to the sender of this message but directly to the \\
            original sender's email: {reply_to}.
            """,
            date=now,
            identifier=identifier,
            reply_to=reply_to,
        )

        meta_fi = format_multiline(
            """
            Allaoleva viesti on lähetetty Fairdata Etsin -palvelun kautta \\
            {date.day}.{date.month}.{date.year}.
            Viesti koskee tutkimusaineistoa, jonka tunniste on "{identifier}".
            Alkuperäinen lähettäjä: {reply_to}.

            Huom!
            Tämän viestin lähetti Etsin-palvelu.
            Älä vastaa suoraan tämän viestin lähettäjälle, \\
            vaan alkuperäiselle viestin lähettäjälle: {reply_to}.
            """,
            date=now,
            identifier=identifier,
            reply_to=reply_to,
        )

        msg = "Subject / Aihe: {0}\nMessage / Viesti: {1}".format(user_subject, user_body)
        return "{0}\n--------------\n\n{1}\n--------------\n\n{2}".format(meta_en, meta_fi, msg)

    def get_message_subject(self):
        """Get email message subject."""
        return "Message from Etsin / Viesti Etsimestä"

    def save(self) -> int:
        """Send message to dataset actors.

        Returns:
            The number of recipients.
        """
        dataset = self.context["dataset"]
        reply_to = self.validated_data["reply_to"]
        subject = self.get_message_subject()
        body = self.get_message_body(
            dataset,
            reply_to=reply_to,
            user_subject=self.validated_data["subject"],
            user_body=self.validated_data["body"],
        )

        recipients = self.get_recipients_for_role(
            dataset=dataset, role=self.validated_data["role"]
        )

        send_mail(subject=subject, body=body, recipients=recipients, reply_to=reply_to)
        return len(recipients)

get_message_body(dataset, reply_to, user_subject, user_body) #

Create body for an email message to be sent.

Parameters:

Name Type Description Default
persistent_identifier str

Preferred identifier of dataset.

 required
user_email str

The email of the sender.

 required
user_subject str

Email subject.

 required
user_body str

Email body.

 required

Returns:

Name Type Description
str str

Email message body with all arguments.
Source code in src/apps/core/serializers/contact_serializer.py 
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
def get_message_body(
    self, dataset: Dataset, reply_to: str, user_subject: str, user_body: str
) -> str:
    """Create body for an email message to be sent.

    Arguments:
        persistent_identifier (str): Preferred identifier of dataset.
        user_email (str): The email of the sender.
        user_subject (str): Email subject.
        user_body (str): Email body.

    Returns:
        str: Email message body with all arguments.

    """
    now = timezone.now()
    identifier = dataset.persistent_identifier or dataset.id

    meta_en = format_multiline(
        """
        The message below was sent via Fairdata Etsin Service \\
        on {date:%B} {date.day}, {date.year}.
        It concerns a dataset with identifier "{identifier}".
        Original sender: {reply_to}.

        Note!
        This message was sent as a notification from the Etsin Service.
        Do not reply to the sender of this message but directly to the \\
        original sender's email: {reply_to}.
        """,
        date=now,
        identifier=identifier,
        reply_to=reply_to,
    )

    meta_fi = format_multiline(
        """
        Allaoleva viesti on lähetetty Fairdata Etsin -palvelun kautta \\
        {date.day}.{date.month}.{date.year}.
        Viesti koskee tutkimusaineistoa, jonka tunniste on "{identifier}".
        Alkuperäinen lähettäjä: {reply_to}.

        Huom!
        Tämän viestin lähetti Etsin-palvelu.
        Älä vastaa suoraan tämän viestin lähettäjälle, \\
        vaan alkuperäiselle viestin lähettäjälle: {reply_to}.
        """,
        date=now,
        identifier=identifier,
        reply_to=reply_to,
    )

    msg = "Subject / Aihe: {0}\nMessage / Viesti: {1}".format(user_subject, user_body)
    return "{0}\n--------------\n\n{1}\n--------------\n\n{2}".format(meta_en, meta_fi, msg)

get_message_subject() #

Get email message subject.

Source code in src/apps/core/serializers/contact_serializer.py 
109
110
111
def get_message_subject(self):
    """Get email message subject."""
    return "Message from Etsin / Viesti Etsimestä"

save() #

Send message to dataset actors.

Returns:

Type Description
int

The number of recipients.
Source code in src/apps/core/serializers/contact_serializer.py 
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
def save(self) -> int:
    """Send message to dataset actors.

    Returns:
        The number of recipients.
    """
    dataset = self.context["dataset"]
    reply_to = self.validated_data["reply_to"]
    subject = self.get_message_subject()
    body = self.get_message_body(
        dataset,
        reply_to=reply_to,
        user_subject=self.validated_data["subject"],
        user_body=self.validated_data["body"],
    )

    recipients = self.get_recipients_for_role(
        dataset=dataset, role=self.validated_data["role"]
    )

    send_mail(subject=subject, body=body, recipients=recipients, reply_to=reply_to)
    return len(recipients)