Files
notifications-admin/app/main/views/send.py
T

872 lines
30 KiB
Python
Raw Normal View History

import itertools
from string import ascii_uppercase
2017-10-03 14:08:25 +01:00
from orderedset import OrderedSet
from zipfile import BadZipFile
from xlrd.biffh import XLRDError
from werkzeug.routing import RequestRedirect
from flask import (
request,
render_template,
redirect,
url_for,
flash,
abort,
session,
2016-12-20 14:38:34 +00:00
current_app,
)
2016-02-17 14:20:55 +00:00
from flask_login import login_required, current_user
2016-12-20 14:38:34 +00:00
2017-06-29 15:31:44 +01:00
from notifications_python_client.errors import HTTPError
from notifications_utils.recipients import (
RecipientCSV,
first_column_headings,
optional_address_columns,
)
2015-12-10 21:15:20 +00:00
from app.main import main
from app.main.forms import (
CsvUploadForm,
ChooseTimeForm,
SetSenderForm,
get_placeholder_form_instance
)
2017-07-28 15:17:50 +01:00
from app.main.s3_client import (
s3upload,
s3download
)
2017-06-22 16:00:14 +01:00
from app import job_api_client, service_api_client, current_service, user_api_client, notification_api_client
from app.utils import (
user_has_permissions,
get_errors_for_csv,
Spreadsheet,
get_help_argument,
get_template,
email_or_sms_not_enabled,
)
2017-05-11 12:01:51 +01:00
from app.template_previews import TemplatePreview, get_page_count_for_letter
2016-02-22 17:17:18 +00:00
2016-03-01 15:53:58 +00:00
def get_page_headings(template_type):
2016-04-01 10:42:23 +01:00
return {
'email': 'Email templates',
2016-11-08 13:12:07 +00:00
'sms': 'Text message templates',
'letter': 'Letter templates'
2016-04-01 10:42:23 +01:00
}[template_type]
2016-03-01 15:53:58 +00:00
def get_example_csv_fields(column_headers, use_example_as_example, submitted_fields):
if use_example_as_example:
return ["example" for header in column_headers]
elif submitted_fields:
return [submitted_fields.get(header) for header in column_headers]
else:
return list(column_headers)
def get_example_csv_rows(template, use_example_as_example=True, submitted_fields=False):
2016-11-10 13:39:05 +00:00
return {
'email': ['test@example.com'] if use_example_as_example else [current_user.email_address],
'sms': ['07700 900321'] if use_example_as_example else [current_user.mobile_number],
2016-11-11 09:51:20 +00:00
'letter': [
(submitted_fields or {}).get(
key, get_example_letter_address(key) if use_example_as_example else key
)
for key in first_column_headings['letter']
2016-11-10 13:39:05 +00:00
]
}[template.template_type] + get_example_csv_fields(template.placeholders, use_example_as_example, submitted_fields)
2016-04-01 14:31:28 +01:00
2016-11-11 09:51:20 +00:00
def get_example_letter_address(key):
return {
'address line 1': 'A. Name',
'address line 2': '123 Example Street',
'postcode': 'XM4 5HQ'
}.get(key, '')
2016-04-12 14:19:51 +01:00
@main.route("/services/<service_id>/send/<template_id>/csv", methods=['GET', 'POST'])
@login_required
2016-03-03 12:15:24 +00:00
@user_has_permissions('send_texts', 'send_emails', 'send_letters')
2016-02-22 17:17:18 +00:00
def send_messages(service_id, template_id):
session['sender_id'] = None
2017-06-22 16:00:14 +01:00
db_template = service_api_client.get_service_template(service_id, template_id)['data']
2017-05-11 12:01:51 +01:00
if email_or_sms_not_enabled(db_template['template_type'], current_service['permissions']):
return redirect(url_for(
'.action_blocked',
service_id=service_id,
notification_type=db_template['template_type'],
return_to='view_template',
template_id=template_id
))
2016-12-08 11:50:59 +00:00
template = get_template(
2017-06-22 16:00:14 +01:00
db_template,
2016-12-08 11:50:59 +00:00
current_service,
2016-12-20 14:38:34 +00:00
show_recipient=True,
2017-05-11 12:01:51 +01:00
expand_emails=True,
letter_preview_url=url_for(
'.view_letter_template_preview',
service_id=service_id,
template_id=template_id,
filetype='png',
2017-06-22 16:00:14 +01:00
page_count=get_page_count_for_letter(db_template),
),
)
form = CsvUploadForm()
if form.validate_on_submit():
try:
2016-05-15 07:47:50 +01:00
upload_id = s3upload(
service_id,
Spreadsheet.from_file(form.file.data, filename=form.file.data.filename).as_dict,
current_app.config['AWS_REGION']
)
session['upload_data'] = {
"template_id": template_id,
"original_file_name": form.file.data.filename
}
2016-02-22 17:17:18 +00:00
return redirect(url_for('.check_messages',
service_id=service_id,
upload_id=upload_id,
template_type=template.template_type))
except (UnicodeDecodeError, BadZipFile, XLRDError):
flash('Couldnt read {}. Try using a different file format.'.format(
form.file.data.filename
))
2016-11-10 13:39:05 +00:00
column_headings = first_column_headings[template.template_type] + list(template.placeholders)
return render_template(
2016-02-22 17:17:18 +00:00
'views/send.html',
template=template,
2016-11-10 13:39:05 +00:00
column_headings=list(ascii_uppercase[:len(column_headings)]),
example=[column_headings, get_example_csv_rows(template)],
form=form
)
@main.route("/services/<service_id>/send/<template_id>.csv", methods=['GET'])
@login_required
2016-03-30 11:30:18 +01:00
@user_has_permissions('send_texts', 'send_emails', 'send_letters', 'manage_templates', any_=True)
def get_example_csv(service_id, template_id):
2016-12-08 11:50:59 +00:00
template = get_template(
service_api_client.get_service_template(service_id, template_id)['data'], current_service
)
return Spreadsheet.from_rows([
2016-11-10 13:39:05 +00:00
first_column_headings[template.template_type] + list(template.placeholders),
get_example_csv_rows(template)
]).as_csv_data, 200, {
'Content-Type': 'text/csv; charset=utf-8',
'Content-Disposition': 'inline; filename="{}.csv"'.format(template.name)
}
2015-12-10 21:15:20 +00:00
@main.route("/services/<service_id>/send/<template_id>/set-sender", methods=['GET', 'POST'])
@login_required
@user_has_permissions('send_texts', 'send_emails', 'send_letters')
def set_sender(service_id, template_id):
session['sender_id'] = None
redirect_to_one_off = redirect(
url_for('.send_one_off', service_id=service_id, template_id=template_id)
)
template = service_api_client.get_service_template(service_id, template_id)['data']
if template['template_type'] == 'letter':
return redirect_to_one_off
sender_details = get_sender_details(service_id, template['template_type'])
if len(sender_details) <= 1:
return redirect_to_one_off
sender_context = get_sender_context(sender_details, template['template_type'])
form = SetSenderForm(
sender=sender_context['default_id'],
sender_choices=sender_context['value_and_label'],
sender_label=sender_context['description']
)
option_hints = {sender_context['default_id']: '(Default)',
}
if sender_context.get('receives_text_message', None):
option_hints.update({sender_context['receives_text_message']: '(Receives replies)'})
if sender_context.get('default_and_receives', None):
option_hints = {sender_context['default_and_receives']: '(Default and receives replies)'}
if form.validate_on_submit():
session['sender_id'] = form.sender.data
return redirect(url_for('.send_one_off',
service_id=service_id,
template_id=template_id))
return render_template(
'views/templates/set-sender.html',
form=form,
template_id=template_id,
sender_context={'title': sender_context['title'], 'description': sender_context['description']},
option_hints=option_hints
)
def get_sender_context(sender_details, template_type):
context = {
'email': {
2017-11-20 16:47:03 +00:00
'title': 'Where should replies come back to?',
'description': 'Where should replies come back to?',
'field_name': 'email_address'
},
'letter': {
'title': 'Send to one recipient',
2017-11-13 11:31:12 +00:00
'description': 'What should appear in the top right of the letter?',
'field_name': 'contact_block'
},
'sms': {
2017-11-20 16:26:09 +00:00
'title': 'Who should the message come from?',
2017-11-13 11:31:12 +00:00
'description': 'Who should the message come from?',
'field_name': 'sms_sender'
}
}[template_type]
sender_format = context['field_name']
context['default_id'] = next(sender['id'] for sender in sender_details if sender['is_default'])
2017-11-02 14:58:14 +00:00
if template_type == 'sms':
inbound = [sender['id'] for sender in sender_details if sender['inbound_number_id']]
if inbound:
context['receives_text_message'] = next(iter(inbound))
if context['default_id'] == context.get('receives_text_message', None):
context['default_and_receives'] = context['default_id']
context['value_and_label'] = [(sender['id'], sender[sender_format]) for sender in sender_details]
return context
def get_sender_details(service_id, template_type):
api_call = {
'email': service_api_client.get_reply_to_email_addresses,
'letter': service_api_client.get_letter_contacts,
'sms': service_api_client.get_sms_senders
}[template_type]
return api_call(service_id)
@main.route("/services/<service_id>/send/<template_id>/test", endpoint='send_test')
@main.route("/services/<service_id>/send/<template_id>/one-off", endpoint='send_one_off')
@login_required
2016-03-03 12:15:24 +00:00
@user_has_permissions('send_texts', 'send_emails', 'send_letters')
def send_test(service_id, template_id):
session['recipient'] = None
session['placeholders'] = {}
session['send_test_letter_page_count'] = None
db_template = service_api_client.get_service_template(service_id, template_id)['data']
if db_template['template_type'] == 'letter':
session['sender_id'] = None
if email_or_sms_not_enabled(db_template['template_type'], current_service['permissions']):
return redirect(url_for(
'.action_blocked',
service_id=service_id,
notification_type=db_template['template_type'],
return_to='view_template',
template_id=template_id))
return redirect(url_for(
{
'main.send_test': '.send_test_step',
'main.send_one_off': '.send_one_off_step',
}[request.endpoint],
service_id=service_id,
template_id=template_id,
step_index=0,
help=get_help_argument(),
))
def get_notification_check_endpoint(service_id, template):
if template.template_type == 'letter':
return make_and_upload_csv_file(service_id, template)
else:
return redirect(url_for(
'main.check_notification',
service_id=service_id,
template_id=template.id,
# at check phase we should move to help stage 2 ("the template pulls in the data you provide")
help='2' if 'help' in request.args else None
))
@main.route(
"/services/<service_id>/send/<template_id>/test/step-<int:step_index>",
methods=['GET', 'POST'],
endpoint='send_test_step',
)
@main.route(
"/services/<service_id>/send/<template_id>/one-off/step-<int:step_index>",
methods=['GET', 'POST'],
endpoint='send_one_off_step',
)
@login_required
@user_has_permissions('send_texts', 'send_emails', 'send_letters')
def send_test_step(service_id, template_id, step_index):
if {'recipient', 'placeholders'} - set(session.keys()):
return redirect(url_for(
{
'main.send_test_step': '.send_test',
'main.send_one_off_step': '.send_one_off',
}[request.endpoint],
service_id=service_id,
template_id=template_id,
))
2017-06-22 16:00:14 +01:00
db_template = service_api_client.get_service_template(service_id, template_id)['data']
2017-05-11 12:01:51 +01:00
if not session.get('send_test_letter_page_count'):
2017-06-22 16:00:14 +01:00
session['send_test_letter_page_count'] = get_page_count_for_letter(db_template)
email_reply_to = None
sms_sender = None
if db_template['template_type'] == 'email':
email_reply_to = get_email_reply_to_address_from_session(service_id)
elif db_template['template_type'] == 'sms':
sms_sender = get_sms_sender_from_session(service_id)
2016-12-08 11:50:59 +00:00
template = get_template(
2017-06-22 16:00:14 +01:00
db_template,
2016-12-08 11:50:59 +00:00
current_service,
2016-12-20 14:38:34 +00:00
show_recipient=True,
2017-05-11 12:01:51 +01:00
expand_emails=True,
letter_preview_url=url_for(
'.send_test_preview',
service_id=service_id,
template_id=template_id,
filetype='png',
),
page_count=session['send_test_letter_page_count'],
email_reply_to=email_reply_to,
sms_sender=sms_sender
)
2016-04-03 11:30:23 +01:00
placeholders = fields_to_fill_in(
template,
prefill_current_user=(request.endpoint == 'main.send_test_step'),
)
try:
current_placeholder = placeholders[step_index]
except IndexError:
if all_placeholders_in_session(placeholders):
return get_notification_check_endpoint(service_id, template)
return redirect(url_for(
{
'main.send_test_step': '.send_test',
'main.send_one_off_step': '.send_one_off',
}[request.endpoint],
service_id=service_id,
template_id=template_id,
))
2017-06-22 16:00:14 +01:00
optional_placeholder = (current_placeholder in optional_address_columns)
form = get_placeholder_form_instance(
current_placeholder,
dict_to_populate_from=get_normalised_placeholders_from_session(),
optional_placeholder=optional_placeholder,
2017-06-23 13:35:08 +01:00
allow_international_phone_numbers='international_sms' in current_service['permissions'],
)
if form.validate_on_submit():
# if it's the first input (phone/email), we store against `recipient` as well, for easier extraction.
# Only if it's not a letter.
# And only if we're not on the test route, since that will already have the user's own number set
if (
step_index == 0 and
template.template_type != 'letter' and
request.endpoint != 'main.send_test_step'
):
session['recipient'] = form.placeholder_value.data
session['placeholders'][current_placeholder] = form.placeholder_value.data
if all_placeholders_in_session(placeholders):
return get_notification_check_endpoint(service_id, template)
return redirect(url_for(
request.endpoint,
service_id=service_id,
template_id=template_id,
step_index=step_index + 1,
help=get_help_argument(),
))
2017-06-22 16:00:14 +01:00
back_link = get_back_link(service_id, template_id, step_index)
2017-06-29 15:31:44 +01:00
template.values = get_recipient_and_placeholders_from_session(template.template_type)
template.values[current_placeholder] = None
2017-05-25 13:31:51 +01:00
if (
request.endpoint == 'main.send_one_off_step' and
step_index == 0 and
template.template_type != 'letter' and
not (template.template_type == 'sms' and current_user.mobile_number is None)
2017-05-25 13:31:51 +01:00
):
skip_link = (
'Use my {}'.format(first_column_headings[template.template_type][0]),
url_for('.send_test', service_id=service_id, template_id=template.id),
)
else:
skip_link = None
return render_template(
'views/send-test.html',
page_title=get_send_test_page_title(
template.template_type,
get_help_argument(),
entering_recipient=not session['recipient']
),
template=template,
form=form,
2017-05-25 13:31:51 +01:00
skip_link=skip_link,
optional_placeholder=optional_placeholder,
back_link=back_link,
2017-06-01 13:29:30 +01:00
help=get_help_argument(),
)
@main.route("/services/<service_id>/send/<template_id>/test.<filetype>", methods=['GET'])
@login_required
@user_has_permissions('send_texts', 'send_emails', 'send_letters')
def send_test_preview(service_id, template_id, filetype):
if filetype not in ('pdf', 'png'):
abort(404)
2017-06-22 16:00:14 +01:00
db_template = service_api_client.get_service_template(service_id, template_id)['data']
template = get_template(
2017-06-22 16:00:14 +01:00
db_template,
current_service,
letter_preview_url=url_for(
'.send_test_preview',
service_id=service_id,
template_id=template_id,
filetype='png',
),
)
template.values = get_normalised_placeholders_from_session()
return TemplatePreview.from_utils_template(template, filetype, page=request.args.get('page'))
def _check_messages(service_id, template_type, upload_id, preview_row, letters_as_pdf=False):
if not session.get('upload_data'):
# if we just return a `redirect` (302) object here, we'll get errors when we try and unpack in the
# check_messages route - so raise a werkzeug.routing redirect to ensure that doesn't happen.
# NOTE: this is a 301 MOVED PERMANENTLY (httpstatus.es/301), so the browser will cache this redirect, and it'll
# *always* happen for that browser. _check_messages is only used by endpoints that contain `upload_id`, which
# is a one-time-use id (that ties to a given file in S3 that is already deleted if it's not in the session)
raise RequestRedirect(url_for('main.choose_template', service_id=service_id))
2016-02-22 17:17:18 +00:00
users = user_api_client.get_users_for_service(service_id=service_id)
statistics = service_api_client.get_detailed_service_for_today(service_id)['data']['statistics']
remaining_messages = (current_service['message_limit'] - sum(stat['requested'] for stat in statistics.values()))
contents = s3download(service_id, upload_id)
email_reply_to = None
sms_sender = None
if template_type == 'email':
email_reply_to = get_email_reply_to_address_from_session(service_id)
elif template_type == 'sms':
sms_sender = get_sms_sender_from_session(service_id)
2016-12-08 11:50:59 +00:00
template = get_template(
service_api_client.get_service_template(
service_id,
session['upload_data'].get('template_id')
2016-12-08 11:50:59 +00:00
)['data'],
current_service,
2016-12-20 14:38:34 +00:00
show_recipient=True,
letter_preview_url=url_for(
'.check_messages_preview',
2016-12-20 14:38:34 +00:00
service_id=service_id,
template_type=template_type,
upload_id=upload_id,
filetype='png',
row_index=preview_row,
) if not letters_as_pdf else None,
email_reply_to=email_reply_to,
sms_sender=sms_sender
)
recipients = RecipientCSV(
contents,
template_type=template.template_type,
placeholders=template.placeholders,
2016-04-07 14:30:51 +01:00
max_initial_rows_shown=50,
max_errors_shown=50,
whitelist=itertools.chain.from_iterable(
2016-11-08 13:12:07 +00:00
[user.name, user.mobile_number, user.email_address] for user in users
) if current_service['restricted'] else None,
remaining_messages=remaining_messages,
2017-06-23 13:35:08 +01:00
international_sms='international_sms' in current_service['permissions'],
)
if request.args.get('from_test'):
# only happens if generating a letter preview test
back_link = url_for('.send_test', service_id=service_id, template_id=template.id)
2016-08-30 09:27:24 +01:00
choose_time_form = None
else:
back_link = url_for('.send_messages', service_id=service_id, template_id=template.id)
2016-08-30 09:27:24 +01:00
choose_time_form = ChooseTimeForm()
count_of_recipients = len(list(recipients.rows))
2018-01-15 11:35:45 +00:00
if preview_row < 2:
abort(404)
if preview_row < count_of_recipients + 2:
template.values = recipients[preview_row - 2]
elif preview_row > 2:
abort(404)
session['upload_data']['notification_count'] = count_of_recipients
session['upload_data']['valid'] = not recipients.has_errors
2016-12-20 11:56:22 +00:00
return dict(
recipients=recipients,
template=template,
2016-06-03 13:52:15 +01:00
errors=recipients.has_errors,
row_errors=get_errors_for_csv(recipients, template.template_type),
count_of_recipients=count_of_recipients,
2016-03-10 20:03:53 +00:00
count_of_displayed_recipients=(
len(list(recipients.initial_annotated_rows_with_errors))
if any(recipients.rows_with_errors) and not recipients.missing_column_headers else
2016-03-10 20:03:53 +00:00
len(list(recipients.initial_annotated_rows))
),
original_file_name=session['upload_data'].get('original_file_name'),
upload_id=upload_id,
form=CsvUploadForm(),
remaining_messages=remaining_messages,
2016-08-30 09:27:24 +01:00
choose_time_form=choose_time_form,
back_link=back_link,
help=get_help_argument(),
trying_to_send_letters_in_trial_mode=all((
current_service['restricted'],
template.template_type == 'letter',
not request.args.get('from_test'),
)),
2018-01-15 11:25:11 +00:00
required_recipient_columns=OrderedSet(recipients.recipient_column_headers) - optional_address_columns,
preview_row=preview_row,
)
2016-12-20 11:56:22 +00:00
@main.route("/services/<service_id>/<template_type>/check/<upload_id>", methods=['GET'])
@main.route("/services/<service_id>/<template_type>/check/<upload_id>/row-<int:row_index>", methods=['GET'])
2016-12-20 11:56:22 +00:00
@login_required
@user_has_permissions('send_texts', 'send_emails', 'send_letters')
2018-01-15 11:35:45 +00:00
def check_messages(service_id, template_type, upload_id, row_index=2):
data = _check_messages(service_id, template_type, upload_id, row_index)
if (
data['recipients'].too_many_rows or
not data['count_of_recipients'] or
not data['recipients'].has_recipient_columns or
2017-09-14 12:21:40 +01:00
data['recipients'].missing_column_headers
):
return render_template('views/check/column-errors.html', **data)
if data['row_errors']:
return render_template('views/check/row-errors.html', **data)
2017-09-14 12:21:40 +01:00
if (
data['errors'] or
data['trying_to_send_letters_in_trial_mode']
):
return render_template('views/check/column-errors.html', **data)
return render_template('views/check/ok.html', **data)
2016-12-20 11:56:22 +00:00
2017-04-10 17:25:08 +01:00
@main.route("/services/<service_id>/<template_type>/check/<upload_id>.<filetype>", methods=['GET'])
@main.route("/services/<service_id>/<template_type>/check/<upload_id>/row-<int:row_index>.<filetype>", methods=['GET'])
2016-12-20 14:38:34 +00:00
@login_required
@user_has_permissions('send_texts', 'send_emails', 'send_letters')
2018-01-15 11:35:45 +00:00
def check_messages_preview(service_id, template_type, upload_id, filetype, row_index=2):
2017-04-12 12:12:11 +01:00
if filetype not in ('pdf', 'png'):
abort(404)
2016-12-20 14:38:34 +00:00
template = _check_messages(
service_id, template_type, upload_id, row_index, letters_as_pdf=True
2016-12-20 14:38:34 +00:00
)['template']
2017-04-10 17:25:08 +01:00
return TemplatePreview.from_utils_template(template, filetype)
2016-12-20 14:38:34 +00:00
2017-04-10 18:12:00 +01:00
2016-04-05 08:55:43 +01:00
@main.route("/services/<service_id>/<template_type>/check/<upload_id>", methods=['POST'])
@main.route("/services/<service_id>/<template_type>/check/<upload_id>/row-<int:row_index>", methods=['POST'])
2016-04-05 08:55:43 +01:00
@login_required
@user_has_permissions('send_texts', 'send_emails', 'send_letters')
def recheck_messages(service_id, template_type, upload_id, row_index=0):
2016-04-05 08:55:43 +01:00
if not session.get('upload_data'):
return redirect(url_for('main.choose_template', service_id=service_id))
2016-04-05 08:55:43 +01:00
return send_messages(service_id, session['upload_data'].get('template_id'))
@main.route("/services/<service_id>/start-job/<upload_id>", methods=['POST'])
@login_required
@user_has_permissions('send_texts', 'send_emails', 'send_letters')
def start_job(service_id, upload_id):
upload_data = session['upload_data']
if request.files or not upload_data.get('valid'):
# The csv was invalid, validate the csv again
return send_messages(service_id, upload_data.get('template_id'))
session.pop('upload_data')
job_api_client.create_job(
upload_id,
service_id,
upload_data.get('template_id'),
upload_data.get('original_file_name'),
upload_data.get('notification_count'),
scheduled_for=request.form.get('scheduled_for', '')
)
return redirect(
url_for(
'main.view_job',
job_id=upload_id,
service_id=service_id,
help=request.form.get('help'),
just_sent='yes',
)
2016-02-17 15:49:07 +00:00
)
2016-07-01 10:49:54 +01:00
@main.route("/services/<service_id>/end-tour/<example_template_id>")
@login_required
@user_has_permissions('manage_templates')
def go_to_dashboard_after_tour(service_id, example_template_id):
service_api_client.delete_service_template(service_id, example_template_id)
return redirect(
url_for('main.service_dashboard', service_id=service_id)
)
def fields_to_fill_in(template, prefill_current_user=False):
recipient_columns = first_column_headings[template.template_type]
if 'letter' == template.template_type or not prefill_current_user:
return recipient_columns + list(template.placeholders)
2017-06-26 14:56:14 +01:00
session['recipient'] = current_user.mobile_number if template.template_type == 'sms' else current_user.email_address
return list(template.placeholders)
def get_normalised_placeholders_from_session():
return {
key: ''.join(value or [])
for key, value in session.get('placeholders', {}).items()
}
2017-06-29 15:31:44 +01:00
def get_recipient_and_placeholders_from_session(template_type):
2017-06-26 14:56:14 +01:00
placeholders = get_normalised_placeholders_from_session()
if template_type == 'sms':
placeholders['phone_number'] = session['recipient']
else:
placeholders['email_address'] = session['recipient']
return placeholders
def make_and_upload_csv_file(service_id, template):
upload_id = s3upload(
service_id,
Spreadsheet.from_dict(
session['placeholders'],
filename=current_app.config['TEST_MESSAGE_FILENAME']
).as_dict,
current_app.config['AWS_REGION'],
)
session['upload_data'] = {
"template_id": template.id,
"original_file_name": current_app.config['TEST_MESSAGE_FILENAME']
}
return redirect(url_for(
'.check_messages',
upload_id=upload_id,
service_id=service_id,
template_type=template.template_type,
from_test=True,
help=2 if get_help_argument() else 0
))
def all_placeholders_in_session(placeholders):
return all(
get_normalised_placeholders_from_session().get(placeholder, False) not in (False, None)
for placeholder in placeholders
)
def get_send_test_page_title(template_type, help_argument, entering_recipient):
2017-05-25 13:31:51 +01:00
if help_argument:
return 'Example text message'
if template_type == 'letter':
return 'Print a test letter'
if entering_recipient:
return 'Who should this message be sent to?'
return 'Personalise this message'
2017-06-22 16:00:14 +01:00
def get_back_link(service_id, template_id, step_index):
if get_help_argument():
# if we're on the check page, redirect back to the beginning. anywhere else, don't return the back link
if request.endpoint == 'main.check_notification':
return url_for(
'main.send_test',
service_id=service_id,
template_id=template_id,
help=get_help_argument()
)
else:
return None
2017-06-22 16:00:14 +01:00
elif step_index == 0:
return url_for(
'.view_template',
service_id=service_id,
template_id=template_id,
)
else:
return url_for(
request.endpoint,
service_id=service_id,
template_id=template_id,
step_index=step_index - 1,
)
2017-06-23 15:02:20 +01:00
@main.route("/services/<service_id>/template/<template_id>/notification/check", methods=['GET'])
@login_required
@user_has_permissions('send_texts', 'send_emails', 'send_letters')
2017-06-23 15:02:20 +01:00
def check_notification(service_id, template_id):
2017-06-29 15:31:44 +01:00
return _check_notification(service_id, template_id)
def _check_notification(service_id, template_id, exception=None):
2017-06-23 15:02:20 +01:00
db_template = service_api_client.get_service_template(service_id, template_id)['data']
email_reply_to = None
sms_sender = None
if db_template['template_type'] == 'email':
email_reply_to = get_email_reply_to_address_from_session(service_id)
elif db_template['template_type'] == 'sms':
sms_sender = get_sms_sender_from_session(service_id)
2017-06-23 15:02:20 +01:00
template = get_template(
db_template,
current_service,
show_recipient=True,
email_reply_to=email_reply_to,
sms_sender=sms_sender
2017-06-23 15:02:20 +01:00
)
# go back to start of process
back_link = get_back_link(service_id, template_id, 0)
if (
not session.get('recipient') or
not all_placeholders_in_session(template.placeholders)
):
return redirect(back_link)
2017-06-29 15:31:44 +01:00
template.values = get_recipient_and_placeholders_from_session(template.template_type)
2017-06-23 15:02:20 +01:00
return render_template(
'views/notifications/check.html',
template=template,
back_link=back_link,
help=get_help_argument(),
2017-06-29 15:31:44 +01:00
**(get_template_error_dict(exception) if exception else {})
2017-06-23 15:02:20 +01:00
)
2017-06-29 15:31:44 +01:00
def get_template_error_dict(exception):
# TODO: Make API return some computer-friendly identifier as well as the end user error messages
2017-07-27 16:28:49 +01:00
if 'service is in trial mode' in exception.message:
2017-06-29 15:31:44 +01:00
error = 'not-allowed-to-send-to'
2017-07-27 16:28:49 +01:00
elif 'Exceeded send limits' in exception.message:
error = 'too-many-messages'
2017-07-27 16:28:49 +01:00
elif 'Content for template has a character count greater than the limit of' in exception.message:
error = 'message-too-long'
2017-06-29 15:31:44 +01:00
else:
raise exception
return {
'error': error,
'SMS_CHAR_COUNT_LIMIT': current_app.config['SMS_CHAR_COUNT_LIMIT'],
'current_service': current_service,
# used to trigger CSV specific err msg content, so not needed for single notification errors.
'original_file_name': False
2017-06-29 15:31:44 +01:00
}
2017-06-23 15:02:20 +01:00
@main.route("/services/<service_id>/template/<template_id>/notification/check", methods=['POST'])
@login_required
@user_has_permissions('send_texts', 'send_emails', 'send_letters')
2017-06-23 15:02:20 +01:00
def send_notification(service_id, template_id):
if {'recipient', 'placeholders'} - set(session.keys()):
2017-06-23 15:02:20 +01:00
return redirect(url_for(
'.send_one_off',
service_id=service_id,
template_id=template_id,
))
2017-06-29 15:31:44 +01:00
try:
noti = notification_api_client.send_notification(
service_id,
template_id=template_id,
recipient=session['recipient'],
personalisation=session['placeholders'],
sender_id=session['sender_id'] if 'sender_id' in session else None
2017-06-29 15:31:44 +01:00
)
except HTTPError as exception:
current_app.logger.info('Service {} could not send notification: "{}"'.format(
current_service['id'],
exception.message
))
2017-06-29 15:31:44 +01:00
return _check_notification(service_id, template_id, exception)
2017-06-23 15:02:20 +01:00
session.pop('placeholders')
session.pop('recipient')
session.pop('sender_id', None)
2017-06-23 15:02:20 +01:00
return redirect(url_for(
'.view_notification',
service_id=service_id,
notification_id=noti['id'],
help=request.args.get('help')
2017-06-23 15:02:20 +01:00
))
def get_email_reply_to_address_from_session(service_id):
if session.get('sender_id'):
return service_api_client.get_reply_to_email_address(
service_id, session['sender_id']
)['email_address']
def get_sms_sender_from_session(service_id):
if session.get('sender_id'):
return service_api_client.get_sms_sender(
service_id=service_id, sms_sender_id=session['sender_id']
)['sms_sender']