Fix #531 -- Make placeholders replace in subject (#594)

Placeholders in subject were not being replaced because there was
no `.format()` called on the subject.

This commit creates a context dict that is used for both the body
and the subject. It is then replaced using `.format_map()`

Fixes https://github.com/pretix/pretix/issues/531
This commit is contained in:
Sanket Dasgupta
2017-10-07 21:46:13 +05:30
committed by Raphael Michel
parent 96dd4e02f3
commit 58938fc07c
5 changed files with 55 additions and 14 deletions

View File

@@ -82,6 +82,7 @@ def mail(email: str, subject: str, template: Union[str, LazyI18nString],
'invoice_company': ''
})
body, body_md = render_mail(template, context)
subject = str(subject).format_map(context)
sender = sender or (event.settings.get('mail_from') if event else settings.MAIL_FROM)
subject = str(subject)

View File

@@ -23,7 +23,11 @@ class MailForm(forms.Form):
super().__init__(*args, **kwargs)
self.fields['subject'] = I18nFormField(
widget=I18nTextInput, required=True,
locales=event.settings.get('locales')
locales=event.settings.get('locales'),
help_text=_("Available placeholders: {expire_date}, {event}, {code}, {date}, {url}, "
"{invoice_name}, {invoice_company}"),
validators=[PlaceholderValidator(['{expire_date}', '{event}', '{code}', '{date}', '{url}',
'{invoice_name}', '{invoice_company}'])]
)
self.fields['message'] = I18nFormField(
widget=I18nTextarea, required=True,

View File

@@ -78,24 +78,33 @@ class SenderView(EventPermissionRequiredMixin, FormView):
if self.request.POST.get("action") == "preview":
for l in self.request.event.settings.locales:
with language(l):
self.output[l] = []
self.output[l].append(
_('Subject: {subject}').format(subject=form.cleaned_data['subject'].localize(l)))
message = form.cleaned_data['message'].localize(l)
preview_text = message.format(
code='ORDER1234',
event=self.request.event.name,
date=date_format(now(), 'SHORT_DATE_FORMAT'),
expire_date=date_format(now() + timedelta(days=7), 'SHORT_DATE_FORMAT'),
url=build_absolute_uri(self.request.event, 'presale:event.order', kwargs={
context_dict = {
'code': 'ORDER1234',
'event': self.request.event.name,
'date': date_format(now(), 'SHORT_DATE_FORMAT'),
'expire_date': date_format(now() + timedelta(days=7), 'SHORT_DATE_FORMAT'),
'url': build_absolute_uri(self.request.event, 'presale:event.order', kwargs={
'order': 'ORDER1234',
'secret': 'longrandomsecretabcdef123456'
}),
invoice_name=_('John Doe'),
invoice_company=_('Sample Company LLC'),
)
'invoice_name': _('John Doe'),
'invoice_company': _('Sample Company LLC')
}
self.output[l] = []
subject = form.cleaned_data['subject'].localize(l)
preview_subject = subject.format_map(context_dict)
self.output[l].append(
_('Subject: {subject}').format(subject=preview_subject))
message = form.cleaned_data['message'].localize(l)
preview_text = message.format_map(context_dict)
self.output[l].append(preview_text)
return self.get(self.request, *self.args, **self.kwargs)
for o in orders:

View File

@@ -89,3 +89,13 @@ def test_send_mail_with_user_locale(env):
assert len(djmail.outbox) == 1
assert djmail.outbox[0].subject == 'Benutzer'
assert 'The language code used for rendering this e-mail is de.' in djmail.outbox[0].body
@pytest.mark.django_db
def test_sendmail_placeholder(env):
djmail.outbox = []
event, user, organizer = env
mail('dummy@dummy.dummy', '{event} Test subject', 'mailtest.txt', {"event": event}, event)
assert len(djmail.outbox) == 1
assert djmail.outbox[0].to == [user.email]
assert djmail.outbox[0].subject == 'Dummy Test subject'

View File

@@ -213,3 +213,20 @@ def test_sendmail_subevents(logged_in_client, sendmail_url, event, order):
assert response.status_code == 200
assert 'Subevent FOO' in response.rendered_content
@pytest.mark.django_db
def test_sendmail_placeholder(logged_in_client, sendmail_url, event, order):
djmail.outbox = []
response = logged_in_client.post(sendmail_url,
{'sendto': 'n',
'subject_0': '{code} Test subject',
'message_0': 'This is a test file for sending mails.',
'action': 'preview'
},
follow=True)
assert response.status_code == 200
assert 'ORDER1234' in response.rendered_content
assert len(djmail.outbox) == 0