import itertools from string import ascii_uppercase from contextlib import suppress 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, current_app, send_file, ) from flask_login import login_required, current_user from flask_weasyprint import HTML, render_pdf from notifications_utils.columns import Columns from notifications_utils.recipients import RecipientCSV, first_column_headings, validate_and_format_phone_number from app.main import main from app.main.forms import CsvUploadForm, ChooseTimeForm, get_furthest_possible_scheduled_time from app.main.uploader import ( s3upload, s3download ) from app import job_api_client, service_api_client, current_service, user_api_client from app.utils import ( user_has_permissions, get_errors_for_csv, Spreadsheet, get_help_argument, get_template, png_from_pdf, ) def get_page_headings(template_type): return { 'email': 'Email templates', 'sms': 'Text message templates', 'letter': 'Letter templates' }[template_type] 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): return { 'email': ['test@example.com'] if use_example_as_example else [current_user.email_address], 'sms': ['07700 900321'] if use_example_as_example else [validate_and_format_phone_number( current_user.mobile_number, human_readable=True )], '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'] ] }[template.template_type] + get_example_csv_fields(template.placeholders, use_example_as_example, submitted_fields) def get_example_letter_address(key): return { 'address line 1': 'A. Name', 'address line 2': '123 Example Street', 'address line 3': 'Example town', 'postcode': 'XM4 5HQ' }.get(key, '') @main.route("/services//send/", methods=['GET']) @login_required @user_has_permissions('view_activity', 'send_texts', 'send_emails', 'manage_templates', 'manage_api_keys', admin_override=True, any_=True) def choose_template(service_id, template_type): if template_type not in ['email', 'sms', 'letter']: abort(404) if not current_service['can_send_letters'] and template_type == 'letter': abort(403) return render_template( 'views/templates/choose.html', templates=[ get_template( template, current_service, letter_preview_url=url_for('.view_template', service_id=service_id, template_id=template['id']), ) for template in service_api_client.get_service_templates(service_id)['data'] if template['template_type'] == template_type ], template_type=template_type, page_heading=get_page_headings(template_type) ) @main.route("/services//send//csv", methods=['GET', 'POST']) @login_required @user_has_permissions('send_texts', 'send_emails', 'send_letters') def send_messages(service_id, template_id): template = get_template( service_api_client.get_service_template(service_id, template_id)['data'], current_service, show_recipient=True, letter_preview_url=url_for('.view_template', service_id=service_id, template_id=template_id), ) form = CsvUploadForm() if form.validate_on_submit(): try: 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 } return redirect(url_for('.check_messages', service_id=service_id, upload_id=upload_id, template_type=template.template_type)) except (UnicodeDecodeError, BadZipFile, XLRDError): flash('Couldn’t read {}. Try using a different file format.'.format( form.file.data.filename )) column_headings = first_column_headings[template.template_type] + list(template.placeholders) return render_template( 'views/send.html', template=template, column_headings=list(ascii_uppercase[:len(column_headings)]), example=[column_headings, get_example_csv_rows(template)], form=form ) @main.route("/services//send/.csv", methods=['GET']) @login_required @user_has_permissions('send_texts', 'send_emails', 'send_letters', 'manage_templates', any_=True) def get_example_csv(service_id, template_id): template = get_template( service_api_client.get_service_template(service_id, template_id)['data'], current_service ) return Spreadsheet.from_rows([ 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) } @main.route("/services//send//test", methods=['GET', 'POST']) @login_required @user_has_permissions('send_texts', 'send_emails', 'send_letters') def send_test(service_id, template_id): file_name = current_app.config['TEST_MESSAGE_FILENAME'] template = get_template( service_api_client.get_service_template(service_id, template_id)['data'], current_service, show_recipient=True, letter_preview_url=url_for('.view_template', service_id=service_id, template_id=template_id), ) if len(template.placeholders) == 0 or request.method == 'POST': upload_id = s3upload( service_id, { 'file_name': file_name, 'data': Spreadsheet.from_rows([ first_column_headings[template.template_type] + list(template.placeholders), get_example_csv_rows(template, use_example_as_example=False, submitted_fields=request.form) ]).as_csv_data }, current_app.config['AWS_REGION'] ) session['upload_data'] = { "template_id": template_id, "original_file_name": file_name } 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 request.args.get('help') else 0 )) return render_template( 'views/send-test.html', template=template, recipient_columns=first_column_headings[template.template_type], example=[get_example_csv_rows(template, use_example_as_example=False)], help=get_help_argument() ) @main.route("/services//send//from-api", methods=['GET']) @login_required def send_from_api(service_id, template_id): return render_template( 'views/send-from-api.html', template=get_template( service_api_client.get_service_template(service_id, template_id)['data'], current_service, letter_preview_url=url_for('.view_template', service_id=service_id, template_id=template_id) ) ) def _check_messages(service_id, template_type, upload_id, 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(get_check_messages_back_url(service_id, template_type)) 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) if not contents: flash('There was a problem reading your upload file') template = get_template( service_api_client.get_service_template( service_id, session['upload_data'].get('template_id') )['data'], current_service, show_recipient=True, letter_preview_url=url_for( '.check_messages', service_id=service_id, template_type=template_type, upload_id=upload_id ) if not letters_as_pdf else None ) recipients = RecipientCSV( contents, template_type=template.template_type, placeholders=template.placeholders, max_initial_rows_shown=50, max_errors_shown=50, whitelist=itertools.chain.from_iterable( [user.name, user.mobile_number, user.email_address] for user in users ) if current_service['restricted'] else None, remaining_messages=remaining_messages ) if request.args.get('from_test'): extra_args = {'help': 1} if request.args.get('help', '0') != '0' else {} if len(template.placeholders): back_link = url_for( '.send_test', service_id=service_id, template_id=template.id, **extra_args ) else: back_link = url_for( '.choose_template', service_id=service_id, template_type=template.template_type, **extra_args ) choose_time_form = None else: back_link = url_for('.send_messages', service_id=service_id, template_id=template.id) choose_time_form = ChooseTimeForm() with suppress(StopIteration): template.values = next(recipients.rows) first_recipient = template.values.get( Columns.make_key(recipients.recipient_column_headers[0]), '' ) session['upload_data']['notification_count'] = len(list(recipients.rows)) session['upload_data']['valid'] = not recipients.has_errors return dict( recipients=recipients, first_recipient=first_recipient, template=template, errors=recipients.has_errors, row_errors=get_errors_for_csv(recipients, template.template_type), count_of_recipients=session['upload_data']['notification_count'], 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 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, choose_time_form=choose_time_form, back_link=back_link, help=get_help_argument() ) @main.route("/services///check/", methods=['GET']) @login_required @user_has_permissions('send_texts', 'send_emails', 'send_letters') def check_messages(service_id, template_type, upload_id): return render_template( 'views/check.html', **_check_messages(service_id, template_type, upload_id) ) @main.route("/services///check/.pdf", methods=['GET']) @login_required @user_has_permissions('send_texts', 'send_emails', 'send_letters') def check_messages_as_pdf(service_id, template_type, upload_id): template = _check_messages( service_id, template_type, upload_id, letters_as_pdf=True )['template'] return render_pdf(HTML(string=str(template))) @main.route("/services///check/.png", methods=['GET']) @login_required @user_has_permissions('send_texts', 'send_emails', 'send_letters') def check_messages_as_png(service_id, template_type, upload_id): return send_file(**png_from_pdf( check_messages_as_pdf(service_id, template_type, upload_id) )) @main.route("/services///check/", methods=['POST']) @login_required @user_has_permissions('send_texts', 'send_emails', 'send_letters') def recheck_messages(service_id, template_type, upload_id): if not session.get('upload_data'): return redirect(url_for('main.choose_template', service_id=service_id, template_type=template_type)) return send_messages(service_id, session['upload_data'].get('template_id')) @main.route("/services//start-job/", 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')) ) @main.route("/services//end-tour/") @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 get_check_messages_back_url(service_id, template_type): if get_help_argument(): # if the user is on the introductory tour, then they should be redirected back to the beginning of the tour - # but to do that we need to find the template_id of the example template. That template *should* be the only # template for that service, but it's possible they've opened another tab and deleted it for example. In that # case we should just redirect back to the main page as they clearly know what they're doing. templates = service_api_client.get_service_templates(service_id)['data'] if len(templates) == 1: return url_for('.send_test', service_id=service_id, template_id=templates[0]['id'], help=1) return url_for('main.choose_template', service_id=service_id, template_type=template_type)