def view_job(service_id, job_id):
job = job_api_client.get_job(service_id, job_id)['data']
if job['job_status'] == 'cancelled':
abort(404)
filter_args = parse_filter_args(request.args)
filter_args['status'] = set_status_filters(filter_args)
total_notifications = job.get('notification_count', 0)
processed_notifications = job.get('notifications_delivered', 0) + job.get(
'notifications_failed', 0)
template = service_api_client.get_service_template(
service_id=service_id,
template_id=job['template'],
version=job['template_version'])['data']
return render_template(
'views/jobs/job.html',
finished=(total_notifications == processed_notifications),
uploaded_file_name=job['original_file_name'],
template_id=job['template'],
status=request.args.get('status', ''),
updates_url=url_for(
".view_job_updates",
service_id=service_id,
job_id=job['id'],
status=request.args.get('status', ''),
),
partials=get_job_partials(job, template),
just_sent=bool(
request.args.get('just_sent') == 'yes'
and template['template_type'] == 'letter'))
def view_job_csv(service_id, job_id):
job = job_api_client.get_job(service_id, job_id)['data']
template = service_api_client.get_service_template(
service_id=service_id,
template_id=job['template'],
version=job['template_version'])['data']
filter_args = parse_filter_args(request.args)
filter_args['status'] = set_status_filters(filter_args)
return Response(stream_with_context(
generate_notifications_csv(
service_id=service_id,
job_id=job_id,
status=filter_args.get('status'),
page=request.args.get('page', 1),
page_size=5000,
format_for_csv=True,
template_type=template['template_type'],
)),
mimetype='text/csv',
headers={
'Content-Disposition':
'inline; filename="{} - {}.csv"'.format(
template['name'],
format_datetime_short(job['created_at']))
})
def download_notifications_csv(service_id):
filter_args = parse_filter_args(request.args)
filter_args['status'] = set_status_filters(filter_args)
service_data_retention_days = current_service.get_days_of_retention(
filter_args.get('message_type')[0])
return Response(
stream_with_context(
generate_notifications_csv(
service_id=service_id,
job_id=None,
status=filter_args.get('status'),
page=request.args.get('page', 1),
page_size=10000,
format_for_csv=True,
template_type=filter_args.get('message_type'),
limit_days=service_data_retention_days,
)),
mimetype='text/csv',
headers={
'Content-Disposition':
'inline; filename="{} - {} - {} report.csv"'.format(
format_date_numeric(
datetime.now().strftime("%Y-%m-%dT%H:%M:%S.%fZ")),
filter_args['message_type'][0], current_service.name)
})
def view_job_csv(service_id, job_id):
job = job_api_client.get_job(service_id, job_id)["data"]
template = service_api_client.get_service_template(
service_id=service_id,
template_id=job["template"],
version=job["template_version"],
)["data"]
filter_args = parse_filter_args(request.args)
filter_args["status"] = set_status_filters(filter_args)
return Response(
stream_with_context(
generate_notifications_csv(
service_id=service_id,
job_id=job_id,
status=filter_args.get("status"),
page=request.args.get("page", 1),
page_size=5000,
format_for_csv=True,
template_type=template["template_type"],
)),
mimetype="text/csv",
headers={
"Content-Disposition":
'inline; filename="{} - {}.csv"'.format(
template["name"], format_datetime_short(job["created_at"]))
},
)
def view_job(service_id, job_id):
job = Job.from_id(job_id, service_id=current_service.id)
if job.cancelled:
abort(404)
filter_args = parse_filter_args(request.args)
filter_args['status'] = set_status_filters(filter_args)
just_sent_message = 'Your {} been sent. Printing starts {} at 5:30pm.'.format(
'letter has' if job.notification_count == 1 else 'letters have',
printing_today_or_tomorrow(job.created_at))
return render_template(
'views/jobs/job.html',
job=job,
status=request.args.get('status', ''),
updates_url=url_for(
".view_job_updates",
service_id=service_id,
job_id=job.id,
status=request.args.get('status', ''),
),
partials=get_job_partials(job),
just_sent=request.args.get('just_sent') == 'yes',
just_sent_message=just_sent_message,
)
def view_job_csv(service_id, job_id):
job = Job.from_id(job_id, service_id=service_id)
filter_args = parse_filter_args(request.args)
filter_args['status'] = set_status_filters(filter_args)
return Response(
stream_with_context(
generate_notifications_csv(
service_id=service_id,
job_id=job_id,
status=filter_args.get('status'),
page=request.args.get('page', 1),
page_size=5000,
format_for_csv=True,
template_type=job.template_type,
)
),
mimetype='text/csv',
headers={
'Content-Disposition': 'inline; filename="{} - {}.csv"'.format(
job.template['name'],
format_datetime_short(job.created_at)
)
}
)
def get_job_partials(job, template):
filter_args = parse_filter_args(request.args)
filter_args['status'] = set_status_filters(filter_args)
notifications = notification_api_client.get_notifications_for_service(
job['service'], job['id'], status=filter_args['status'])
if template['template_type'] == 'letter':
# there might be no notifications if the job has only just been created and the tasks haven't run yet
if notifications['notifications']:
postage = notifications['notifications'][0]['postage']
else:
postage = template['postage']
counts = render_template(
'partials/jobs/count-letters.html',
total=job.get('notification_count', 0),
delivery_estimate=get_letter_timings(
job['created_at'], postage=postage).earliest_delivery,
)
else:
counts = render_template('partials/count.html',
counts=_get_job_counts(job),
status=filter_args['status'])
service_data_retention_days = current_service.get_days_of_retention(
template['template_type'])
return {
'counts':
counts,
'notifications':
render_template(
'partials/jobs/notifications.html',
notifications=list(
add_preview_of_content_to_notifications(
notifications['notifications'])),
more_than_one_page=bool(
notifications.get('links', {}).get('next')),
percentage_complete=(job['notifications_requested'] /
job['notification_count'] * 100),
download_link=url_for('.view_job_csv',
service_id=current_service.id,
job_id=job['id'],
status=request.args.get('status')),
time_left=get_time_left(
job['created_at'],
service_data_retention_days=service_data_retention_days),
job=job,
template=template,
template_version=job['template_version'],
),
'status':
render_template('partials/jobs/status.html', job=job),
}
def get_job_partials(job):
filter_args = parse_filter_args(request.args)
filter_args['status'] = set_status_filters(filter_args)
notifications = job.get_notifications(status=filter_args['status'])
if job.template_type == 'letter':
counts = render_template(
'partials/jobs/count-letters.html',
job=job,
)
else:
counts = render_template(
'partials/count.html',
counts=_get_job_counts(job),
status=filter_args['status'],
notifications_deleted=(job.status == 'finished'
and not notifications['notifications']),
)
service_data_retention_days = current_service.get_days_of_retention(
job.template_type)
return {
'counts':
counts,
'notifications':
render_template(
'partials/jobs/notifications.html',
notifications=list(
add_preview_of_content_to_notifications(
notifications['notifications'])),
more_than_one_page=bool(
notifications.get('links', {}).get('next')),
download_link=url_for('.view_job_csv',
service_id=current_service.id,
job_id=job.id,
status=request.args.get('status')),
time_left=get_time_left(
job.created_at,
service_data_retention_days=service_data_retention_days),
job=job,
service_data_retention_days=service_data_retention_days,
),
'status':
render_template('partials/jobs/status.html',
job=job,
letter_print_day=get_letter_printing_statement(
"created", job.created_at)),
}
def view_job(service_id, job_id):
job = job_api_client.get_job(service_id, job_id)["data"]
if job["job_status"] == "cancelled":
abort(404)
filter_args = parse_filter_args(request.args)
filter_args["status"] = set_status_filters(filter_args)
total_notifications = job.get("notification_count", 0)
processed_notifications = job.get("notifications_delivered", 0) + job.get(
"notifications_failed", 0)
template = service_api_client.get_service_template(
service_id=service_id,
template_id=job["template"],
version=job["template_version"],
)["data"]
just_sent_message = "Your {} been sent. Printing starts {} at 5:30pm.".format(
"letter has" if job["notification_count"] == 1 else "letters have",
printing_today_or_tomorrow(),
)
partials = get_job_partials(job, template)
can_cancel_letter_job = partials["can_letter_job_be_cancelled"]
return render_template(
"views/jobs/job.html",
finished=(total_notifications == processed_notifications),
uploaded_file_name=job["original_file_name"],
template_id=job["template"],
job_id=job_id,
status=request.args.get("status", ""),
updates_url=url_for(
".view_job_updates",
service_id=service_id,
job_id=job["id"],
status=request.args.get("status", ""),
),
partials=partials,
just_sent=bool(
request.args.get("just_sent") == "yes"
and template["template_type"] == "letter"),
just_sent_message=just_sent_message,
can_cancel_letter_job=can_cancel_letter_job,
)
def view_job(service_id, job_id):
job = job_api_client.get_job(service_id, job_id)['data']
if job['job_status'] == 'cancelled':
abort(404)
filter_args = parse_filter_args(request.args)
filter_args['status'] = set_status_filters(filter_args)
total_notifications = job.get('notification_count', 0)
processed_notifications = job.get('notifications_delivered', 0) + job.get('notifications_failed', 0)
template = service_api_client.get_service_template(
service_id=service_id,
template_id=job['template'],
version=job['template_version']
)['data']
just_sent_message = 'Your {} been sent. Printing starts {} at 5:30pm.'.format(
'letter has' if job['notification_count'] == 1 else 'letters have',
printing_today_or_tomorrow()
)
partials = get_job_partials(job, template)
can_cancel_letter_job = partials["can_letter_job_be_cancelled"]
return render_template(
'views/jobs/job.html',
finished=(total_notifications == processed_notifications),
uploaded_file_name=job['original_file_name'],
template_id=job['template'],
job_id=job_id,
status=request.args.get('status', ''),
updates_url=url_for(
".view_job_updates",
service_id=service_id,
job_id=job['id'],
status=request.args.get('status', ''),
),
partials=partials,
just_sent=bool(
request.args.get('just_sent') == 'yes'
and template['template_type'] == 'letter'
),
just_sent_message=just_sent_message,
can_cancel_letter_job=can_cancel_letter_job,
)
def get_job_partials(job, template):
filter_args = parse_filter_args(request.args)
filter_args['status'] = set_status_filters(filter_args)
notifications = notification_api_client.get_notifications_for_service(
job['service'], job['id'], status=filter_args['status'])
if template['template_type'] == 'letter':
# there might be no notifications if the job has only just been created and the tasks haven't run yet
if notifications['notifications']:
postage = notifications['notifications'][0]['postage']
else:
postage = template['postage']
counts = render_template(
'partials/jobs/count-letters.html',
total=job.get('notification_count', 0),
delivery_estimate=get_letter_timings(
job['created_at'], postage=postage).earliest_delivery,
)
else:
counts = render_template('partials/count.html',
counts=_get_job_counts(job),
status=filter_args['status'])
service_data_retention_days = current_service.get_days_of_retention(
template['template_type'])
can_letter_job_be_cancelled = False
if template["template_type"] == "letter":
not_cancellable = [
n for n in notifications["notifications"]
if n["status"] not in CANCELLABLE_JOB_LETTER_STATUSES
]
job_created = job["created_at"][:-6]
if not letter_can_be_cancelled(
"created",
datetime.strptime(
job_created,
'%Y-%m-%dT%H:%M:%S.%f')) or len(not_cancellable) != 0:
can_letter_job_be_cancelled = False
else:
can_letter_job_be_cancelled = True
return {
'counts':
counts,
'notifications':
render_template(
'partials/jobs/notifications.html',
notifications=list(
add_preview_of_content_to_notifications(
notifications['notifications'])),
more_than_one_page=bool(
notifications.get('links', {}).get('next')),
percentage_complete=(job['notifications_requested'] /
job['notification_count'] * 100),
download_link=url_for('.view_job_csv',
service_id=current_service.id,
job_id=job['id'],
status=request.args.get('status')),
time_left=get_time_left(
job['created_at'],
service_data_retention_days=service_data_retention_days),
job=job,
template=template,
template_version=job['template_version'],
),
'status':
render_template('partials/jobs/status.html',
job=job,
template_type=template["template_type"],
letter_print_day=get_letter_printing_statement(
"created", job["created_at"])),
'can_letter_job_be_cancelled':
can_letter_job_be_cancelled,
}
def get_notifications(service_id, message_type, status_override=None):
# TODO get the api to return count of pages as well.
page = get_page_from_request()
if page is None:
abort(404,
"Invalid page argument ({}).".format(request.args.get('page')))
filter_args = parse_filter_args(request.args)
filter_args['status'] = set_status_filters(filter_args)
service_data_retention_days = None
if message_type is not None:
service_data_retention_days = current_service.get_days_of_retention(
message_type)
if request.path.endswith('csv') and current_user.has_permissions(
'view_activity'):
return Response(generate_notifications_csv(
service_id=service_id,
page=page,
page_size=5000,
template_type=[message_type],
status=filter_args.get('status'),
limit_days=service_data_retention_days),
mimetype='text/csv',
headers={
'Content-Disposition':
'inline; filename="notifications.csv"'
})
notifications = notification_api_client.get_notifications_for_service(
service_id=service_id,
page=page,
template_type=[message_type] if message_type else [],
status=filter_args.get('status'),
limit_days=service_data_retention_days,
to=request.form.get('to', ''),
)
url_args = {
'message_type': message_type,
'status': request.args.get('status')
}
prev_page = None
if 'links' in notifications and notifications['links'].get('prev', None):
prev_page = generate_previous_dict('main.view_notifications',
service_id,
page,
url_args=url_args)
next_page = None
if 'links' in notifications and notifications['links'].get('next', None):
next_page = generate_next_dict('main.view_notifications', service_id,
page, url_args)
if message_type:
download_link = url_for('.view_notifications_csv',
service_id=current_service.id,
message_type=message_type,
status=request.args.get('status'))
else:
download_link = None
return {
'service_data_retention_days':
service_data_retention_days,
'counts':
render_template('views/activity/counts.html',
status=request.args.get('status'),
status_filters=get_status_filters(
current_service, message_type,
service_api_client.get_service_statistics(
service_id,
today_only=False,
limit_days=service_data_retention_days))),
'notifications':
render_template(
'views/activity/notifications.html',
notifications=list(
add_preview_of_content_to_notifications(
notifications['notifications'])),
page=page,
limit_days=service_data_retention_days,
prev_page=prev_page,
next_page=next_page,
status=request.args.get('status'),
message_type=message_type,
download_link=download_link,
),
}
def get_notifications(service_id, message_type, status_override=None):
# TODO get the api to return count of pages as well.
page = get_page_from_request()
if page is None:
abort(
404, "Invalid page argument ({}) reverting to page 1.".format(
request.args['page'], None))
if message_type not in ['email', 'sms', 'letter']:
abort(404)
filter_args = parse_filter_args(request.args)
filter_args['status'] = set_status_filters(filter_args)
if request.path.endswith('csv'):
return Response(generate_notifications_csv(
service_id=service_id,
page=page,
page_size=5000,
template_type=[message_type],
status=filter_args.get('status'),
limit_days=current_app.config['ACTIVITY_STATS_LIMIT_DAYS']),
mimetype='text/csv',
headers={
'Content-Disposition':
'inline; filename="notifications.csv"'
})
notifications = notification_api_client.get_notifications_for_service(
service_id=service_id,
page=page,
template_type=[message_type],
status=filter_args.get('status'),
limit_days=current_app.config['ACTIVITY_STATS_LIMIT_DAYS'],
to=request.form.get('to', ''),
)
url_args = {
'message_type': message_type,
'status': request.args.get('status')
}
prev_page = None
if 'links' in notifications and notifications['links'].get('prev', None):
prev_page = generate_previous_dict('main.view_notifications',
service_id,
page,
url_args=url_args)
next_page = None
if 'links' in notifications and notifications['links'].get('next', None):
next_page = generate_next_dict('main.view_notifications', service_id,
page, url_args)
return {
'counts':
render_template('views/activity/counts.html',
status=request.args.get('status'),
status_filters=get_status_filters(
current_service, message_type,
service_api_client.get_detailed_service(service_id)
['data']['statistics'])),
'notifications':
render_template('views/activity/notifications.html',
notifications=list(
add_preview_of_content_to_notifications(
notifications['notifications'])),
page=page,
prev_page=prev_page,
next_page=next_page,
status=request.args.get('status'),
message_type=message_type,
download_link=url_for(
'.view_notifications_csv',
service_id=current_service['id'],
message_type=message_type,
status=request.args.get('status'))),
}
def get_job_partials(job, template):
filter_args = parse_filter_args(request.args)
filter_args["status"] = set_status_filters(filter_args)
notifications = notification_api_client.get_notifications_for_service(
job["service"], job["id"], status=filter_args["status"])
if template["template_type"] == "letter":
# there might be no notifications if the job has only just been created and the tasks haven't run yet
if notifications["notifications"]:
postage = notifications["notifications"][0]["postage"]
else:
postage = template["postage"]
counts = render_template(
"partials/jobs/count-letters.html",
total=job.get("notification_count", 0),
delivery_estimate=get_letter_timings(
job["created_at"], postage=postage).earliest_delivery,
)
else:
counts = render_template(
"partials/count.html",
counts=_get_job_counts(job),
status=filter_args["status"],
)
service_data_retention_days = current_service.get_days_of_retention(
template["template_type"])
can_letter_job_be_cancelled = False
if template["template_type"] == "letter":
not_cancellable = [
n for n in notifications["notifications"]
if n["status"] not in CANCELLABLE_JOB_LETTER_STATUSES
]
job_created = job["created_at"][:-6]
if (not letter_can_be_cancelled(
"created",
datetime.strptime(job_created, "%Y-%m-%dT%H:%M:%S.%f"))
or len(not_cancellable) != 0):
can_letter_job_be_cancelled = False
else:
can_letter_job_be_cancelled = True
return {
"counts":
counts,
"notifications":
render_template(
"partials/jobs/notifications.html",
notifications=list(
add_preview_of_content_to_notifications(
notifications["notifications"])),
more_than_one_page=bool(
notifications.get("links", {}).get("next")),
percentage_complete=(job["notifications_requested"] /
job["notification_count"] * 100),
download_link=url_for(
".view_job_csv",
service_id=current_service.id,
job_id=job["id"],
status=request.args.get("status"),
),
available_until_date=get_available_until_date(
job["created_at"],
service_data_retention_days=service_data_retention_days,
),
job=job,
template=template,
template_version=job["template_version"],
),
"status":
render_template(
"partials/jobs/status.html",
job=job,
template=template,
template_type=template["template_type"],
template_version=job["template_version"],
letter_print_day=get_letter_printing_statement(
"created", job["created_at"]),
),
"can_letter_job_be_cancelled":
can_letter_job_be_cancelled,
}
def get_notifications(service_id, message_type, status_override=None):
# TODO get the api to return count of pages as well.
page = get_page_from_request()
if page is None:
abort(404,
"Invalid page argument ({}).".format(request.args.get("page")))
if message_type not in ["email", "sms", "letter", None]:
abort(404)
filter_args = parse_filter_args(request.args)
filter_args["status"] = set_status_filters(filter_args)
service_data_retention_days = current_app.config.get(
"ACTIVITY_STATS_LIMIT_DAYS", None)
if message_type is not None:
service_data_retention_days = current_service.get_days_of_retention(
message_type)
if request.path.endswith("csv") and current_user.has_permissions(
"view_activity"):
return Response(
generate_notifications_csv(
service_id=service_id,
page=page,
page_size=5000,
template_type=[message_type],
status=filter_args.get("status"),
limit_days=service_data_retention_days,
),
mimetype="text/csv",
headers={
"Content-Disposition": 'inline; filename="notifications.csv"'
},
)
notifications = notification_api_client.get_notifications_for_service(
service_id=service_id,
page=page,
template_type=[message_type] if message_type else [],
status=filter_args.get("status"),
limit_days=service_data_retention_days,
to=request.form.get("to", ""),
)
url_args = {
"message_type": message_type,
"status": request.args.get("status")
}
prev_page = None
if "links" in notifications and notifications["links"].get("prev", None):
prev_page = generate_previous_dict("main.view_notifications",
service_id,
page,
url_args=url_args)
next_page = None
if "links" in notifications and notifications["links"].get("next", None):
next_page = generate_next_dict("main.view_notifications", service_id,
page, url_args)
if message_type:
download_link = url_for(
".view_notifications_csv",
service_id=current_service.id,
message_type=message_type,
status=request.args.get("status"),
)
else:
download_link = None
return {
"service_data_retention_days":
service_data_retention_days,
"counts":
render_template(
"views/activity/counts.html",
status=request.args.get("status"),
status_filters=get_status_filters(
current_service,
message_type,
service_api_client.get_service_statistics(
service_id,
today_only=False,
limit_days=service_data_retention_days),
),
),
"notifications":
render_template(
"views/activity/notifications.html",
notifications=list(
add_preview_of_content_to_notifications(
notifications["notifications"])),
page=page,
limit_days=service_data_retention_days,
prev_page=prev_page,
next_page=next_page,
status=request.args.get("status"),
message_type=message_type,
download_link=download_link,
),
}
