1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
/*
 * This file is part of mailpot
 *
 * Copyright 2020 - Manos Pitsidianakis
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program. If not, see <https://www.gnu.org/licenses/>.
 */

//! Template database model: [`Template`].

use super::*;

/// A named template.
#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, Eq)]
pub struct Template {
    /// Database primary key.
    pub pk: i64,
    /// Name.
    pub name: String,
    /// Associated list foreign key, optional.
    pub list: Option<i64>,
    /// Subject template.
    pub subject: Option<String>,
    /// Extra headers template.
    pub headers_json: Option<serde_json::Value>,
    /// Body template.
    pub body: String,
}

impl std::fmt::Display for Template {
    fn fmt(&self, fmt: &mut std::fmt::Formatter) -> std::fmt::Result {
        write!(fmt, "{:?}", self)
    }
}

impl Template {
    /// Template name for generic list help e-mail.
    pub const GENERIC_HELP: &str = "generic-help";
    /// Template name for generic failure e-mail.
    pub const GENERIC_FAILURE: &str = "generic-failure";
    /// Template name for generic success e-mail.
    pub const GENERIC_SUCCESS: &str = "generic-success";
    /// Template name for subscription confirmation e-mail.
    pub const SUBSCRIPTION_CONFIRMATION: &str = "subscription-confirmation";
    /// Template name for unsubscription confirmation e-mail.
    pub const UNSUBSCRIPTION_CONFIRMATION: &str = "unsubscription-confirmation";
    /// Template name for subscription request notice e-mail (for list owners).
    pub const SUBSCRIPTION_REQUEST_NOTICE_OWNER: &str = "subscription-notice-owner";
    /// Template name for subscription request acceptance e-mail (for the
    /// candidates).
    pub const SUBSCRIPTION_REQUEST_CANDIDATE_ACCEPT: &str = "subscription-notice-candidate-accept";
    /// Template name for admin notices.
    pub const ADMIN_NOTICE: &str = "admin-notice";

    /// Render a message body from a saved named template.
    pub fn render(&self, context: minijinja::value::Value) -> Result<melib::Draft> {
        use melib::{Draft, HeaderName};

        let env = minijinja::Environment::new();
        let mut draft: Draft = Draft {
            body: env.render_named_str("body", &self.body, &context)?,
            ..Draft::default()
        };
        if let Some(ref subject) = self.subject {
            draft.headers.insert(
                HeaderName::new_unchecked("Subject"),
                env.render_named_str("subject", subject, &context)?,
            );
        }

        Ok(draft)
    }

    /// Template name for generic failure e-mail.
    pub fn default_generic_failure() -> Self {
        Self {
            pk: -1,
            name: Self::GENERIC_FAILURE.to_string(),
            list: None,
            subject: Some(
                "{{ subject if subject else \"Your e-mail was not processed successfully.\" }}"
                    .to_string(),
            ),
            headers_json: None,
            body: "{{ details|safe if details else \"The list owners and administrators have been \
                   notified.\" }}"
                .to_string(),
        }
    }

    /// Create a plain template for generic success e-mails.
    pub fn default_generic_success() -> Self {
        Self {
            pk: -1,
            name: Self::GENERIC_SUCCESS.to_string(),
            list: None,
            subject: Some(
                "{{ subject if subject else \"Your e-mail was processed successfully.\" }}"
                    .to_string(),
            ),
            headers_json: None,
            body: "{{ details|safe if details else \"\" }}".to_string(),
        }
    }

    /// Create a plain template for subscription confirmation.
    pub fn default_subscription_confirmation() -> Self {
        Self {
            pk: -1,
            name: Self::SUBSCRIPTION_CONFIRMATION.to_string(),
            list: None,
            subject: Some(
                "{% if list and (list.id or list.name) %}{% if list.id %}[{{ list.id }}] {% endif \
                 %}You have successfully subscribed to {{ list.name if list.name else list.id \
                 }}{% else %}You have successfully subscribed to this list{% endif %}."
                    .to_string(),
            ),
            headers_json: None,
            body: "{{ details|safe if details else \"\" }}".to_string(),
        }
    }

    /// Create a plain template for unsubscription confirmations.
    pub fn default_unsubscription_confirmation() -> Self {
        Self {
            pk: -1,
            name: Self::UNSUBSCRIPTION_CONFIRMATION.to_string(),
            list: None,
            subject: Some(
                "{% if list and (list.id or list.name) %}{% if list.id %}[{{ list.id }}] {% endif \
                 %}You have successfully unsubscribed from {{ list.name if list.name else list.id \
                 }}{% else %}You have successfully unsubscribed from this list{% endif %}."
                    .to_string(),
            ),
            headers_json: None,
            body: "{{ details|safe if details else \"\" }}".to_string(),
        }
    }

    /// Create a plain template for admin notices.
    pub fn default_admin_notice() -> Self {
        Self {
            pk: -1,
            name: Self::ADMIN_NOTICE.to_string(),
            list: None,
            subject: Some(
                "{% if list %}An error occured with list {{ list.id }}{% else %}An error \
                 occured{% endif %}"
                    .to_string(),
            ),
            headers_json: None,
            body: "{{ details|safe if details else \"\" }}".to_string(),
        }
    }

    /// Create a plain template for subscription requests for list owners.
    pub fn default_subscription_request_owner() -> Self {
        Self {
            pk: -1,
            name: Self::SUBSCRIPTION_REQUEST_NOTICE_OWNER.to_string(),
            list: None,
            subject: Some("Subscription request for {{ list.id }} by {{ candidate }}".to_string()),
            headers_json: None,
            body: "Candidate primary key: {{ candidate.pk }}\n\n{{ details|safe if details else \
                   \"\" }}"
                .to_string(),
        }
    }

    /// Create a plain template for subscription requests for candidates.
    pub fn default_subscription_request_candidate_accept() -> Self {
        Self {
            pk: -1,
            name: Self::SUBSCRIPTION_REQUEST_CANDIDATE_ACCEPT.to_string(),
            list: None,
            subject: Some("Your subscription to {{ list.id }} is now active.".to_string()),
            headers_json: None,
            body: "{{ details|safe if details else \"\" }}".to_string(),
        }
    }

    /// Create a plain template for generic list help replies.
    pub fn default_generic_help() -> Self {
        Self {
            pk: -1,
            name: Self::GENERIC_HELP.to_string(),
            list: None,
            subject: Some("{{ subject if subject else \"Help for mailing list\" }}".to_string()),
            headers_json: None,
            body: "{{ details }}".to_string(),
        }
    }
}