from datetime import datetime from functools import partial from flask import ( render_template, url_for, session, jsonify, request, abort ) from flask_login import login_required from notifications_utils.recipients import format_phone_number_human_readable from app.main import main from app import ( current_service, job_api_client, service_api_client, template_statistics_client ) from app.statistics_utils import get_formatted_percentage, add_rate_to_job from app.utils import ( user_has_permissions, get_current_financial_year, FAILURE_STATUSES, REQUESTED_STATUSES, ) # This is a placeholder view method to be replaced # when product team makes decision about how/what/when # to view history @main.route("/services//history") @login_required def temp_service_history(service_id): data = service_api_client.get_service_history(service_id)['data'] return render_template('views/temp-history.html', services=data['service_history'], api_keys=data['api_key_history'], events=data['events']) @main.route("/services//dashboard") @login_required @user_has_permissions('view_activity', admin_override=True) def service_dashboard(service_id): if session.get('invited_user'): session.pop('invited_user', None) session['service_id'] = service_id return render_template( 'views/dashboard/dashboard.html', updates_url=url_for(".service_dashboard_updates", service_id=service_id), templates=service_api_client.get_service_templates(service_id)['data'], partials=get_dashboard_partials(service_id) ) @main.route("/services//dashboard.json") @user_has_permissions('view_activity', admin_override=True) def service_dashboard_updates(service_id): return jsonify(**get_dashboard_partials(service_id)) @main.route("/services//template-activity") @login_required @user_has_permissions('view_activity', admin_override=True) def template_history(service_id): year, current_financial_year = requested_and_current_financial_year(request) stats = template_statistics_client.get_monthly_template_statistics_for_service(service_id, year) months = [ { 'name': YYYY_MM_to_datetime(month).strftime('%B'), 'templates_used': aggregate_usage( format_template_stats_to_list(stats.get(month)), sort_key='requested_count' ), } for month in get_months_for_financial_year(year, time_format='%Y-%m') ] return render_template( 'views/dashboard/all-template-statistics.html', months=months, most_used_template_count=max( max(( template['requested_count'] for template in month['templates_used'] ), default=0) for month in months ), years=get_tuples_of_financial_years( partial(url_for, '.template_history', service_id=service_id), end=current_financial_year, ), selected_year=year, ) @main.route("/services//usage") @login_required @user_has_permissions('manage_settings', admin_override=True) def usage(service_id): year, current_financial_year = requested_and_current_financial_year(request) return render_template( 'views/usage.html', months=list(get_free_paid_breakdown_for_billable_units( year, service_api_client.get_billable_units(service_id, year) )), selected_year=year, years=get_tuples_of_financial_years( partial(url_for, '.usage', service_id=service_id), start=current_financial_year - 1, end=current_financial_year + 1, ), **calculate_usage(service_api_client.get_service_usage(service_id, year)) ) @main.route("/services//monthly") @login_required @user_has_permissions('view_activity', admin_override=True) def monthly(service_id): year, current_financial_year = requested_and_current_financial_year(request) return render_template( 'views/dashboard/monthly.html', months=format_monthly_stats_to_list( service_api_client.get_monthly_notification_stats(service_id, year)['data'] ), years=get_tuples_of_financial_years( partial_url=partial(url_for, '.monthly', service_id=service_id), end=current_financial_year, ), selected_year=year, ) @main.route("/services//inbox") @login_required @user_has_permissions('view_activity', admin_override=True) def inbox(service_id): return render_template( 'views/dashboard/inbox.html', partials=get_inbox_partials(service_id), updates_url=url_for('.inbox_updates', service_id=service_id), ) @main.route("/services//inbox.json") @login_required @user_has_permissions('view_activity', admin_override=True) def inbox_updates(service_id): return jsonify(get_inbox_partials(service_id)) def get_inbox_partials(service_id): if 'inbound_sms' not in current_service['permissions']: abort(403) messages_to_show = list() inbound_messages = service_api_client.get_inbound_sms(service_id) for message in inbound_messages: if format_phone_number_human_readable(message['user_number']) not in { format_phone_number_human_readable(message['user_number']) for message in messages_to_show }: messages_to_show.append(message) return {'messages': render_template( 'views/dashboard/_inbox_messages.html', messages=messages_to_show, count_of_messages=len(inbound_messages), count_of_users=len(messages_to_show), )} def aggregate_usage(template_statistics, sort_key='count'): return sorted( template_statistics, key=lambda template_statistic: template_statistic[sort_key], reverse=True ) def get_dashboard_partials(service_id): # all but scheduled and cancelled statuses_to_display = job_api_client.JOB_STATUSES - {'scheduled', 'cancelled'} template_statistics = aggregate_usage( template_statistics_client.get_template_statistics_for_service(service_id, limit_days=7) ) scheduled_jobs = sorted( job_api_client.get_jobs(service_id, statuses=['scheduled'])['data'], key=lambda job: job['scheduled_for'] ) immediate_jobs = [ add_rate_to_job(job) for job in job_api_client.get_jobs(service_id, limit_days=7, statuses=statuses_to_display)['data'] ] service = service_api_client.get_detailed_service(service_id) return { 'upcoming': render_template( 'views/dashboard/_upcoming.html', scheduled_jobs=scheduled_jobs ), 'inbox': render_template( 'views/dashboard/_inbox.html', inbound_sms_summary=( service_api_client.get_inbound_sms_summary(service_id) if 'inbound_sms' in current_service['permissions'] else None ), ), 'totals': render_template( 'views/dashboard/_totals.html', service_id=service_id, statistics=get_dashboard_totals(service['data']['statistics']) ), 'template-statistics': render_template( 'views/dashboard/template-statistics.html', template_statistics=template_statistics, most_used_template_count=max( [row['count'] for row in template_statistics] or [0] ), ), 'has_template_statistics': bool(template_statistics), 'jobs': render_template( 'views/dashboard/_jobs.html', jobs=immediate_jobs ), 'has_jobs': bool(immediate_jobs) } def get_dashboard_totals(statistics): for msg_type in statistics.values(): msg_type['failed_percentage'] = get_formatted_percentage(msg_type['failed'], msg_type['requested']) msg_type['show_warning'] = float(msg_type['failed_percentage']) > 3 return statistics def calculate_usage(usage): # TODO: Don't hardcode these - get em from the API sms_free_allowance = 250000 sms_rate = 0 if len(usage) == 0 else usage[0].get("rate", 0) sms_sent = get_sum_billing_units(breakdown for breakdown in usage if breakdown['notification_type'] == 'sms') emails = [breakdown["billing_units"] for breakdown in usage if breakdown['notification_type'] == 'email'] emails_sent = 0 if len(emails) == 0 else emails[0] return { 'emails_sent': emails_sent, 'sms_free_allowance': sms_free_allowance, 'sms_sent': sms_sent, 'sms_allowance_remaining': max(0, (sms_free_allowance - sms_sent)), 'sms_chargeable': max(0, sms_sent - sms_free_allowance), 'sms_rate': sms_rate, } def format_monthly_stats_to_list(historical_stats): return sorted(( dict( date=key, future=YYYY_MM_to_datetime(key) > datetime.utcnow(), name=YYYY_MM_to_datetime(key).strftime('%B'), **aggregate_status_types(value) ) for key, value in historical_stats.items() ), key=lambda x: x['date']) def YYYY_MM_to_datetime(string): return datetime(int(string[0:4]), int(string[5:7]), 1) def aggregate_status_types(counts_dict): return get_dashboard_totals({ '{}_counts'.format(message_type): { 'failed': sum( stats.get(status, 0) for status in FAILURE_STATUSES ), 'requested': sum( stats.get(status, 0) for status in REQUESTED_STATUSES ) } for message_type, stats in counts_dict.items() }) def get_months_for_financial_year(year, time_format='%B'): return [ month.strftime(time_format) for month in ( get_months_for_year(4, 13, year) + get_months_for_year(1, 4, year + 1) ) if month < datetime.now() ] def get_months_for_year(start, end, year): return [datetime(year, month, 1) for month in range(start, end)] def get_sum_billing_units(billing_units, month=None): if month: return sum(b['billing_units'] * b.get('rate_multiplier', 1) for b in billing_units if b['month'] == month) return sum(b['billing_units'] * b.get('rate_multiplier', 1) for b in billing_units) def get_free_paid_breakdown_for_billable_units(year, billing_units): cumulative = 0 for month in get_months_for_financial_year(year): previous_cumulative = cumulative monthly_usage = get_sum_billing_units(billing_units, month) cumulative += monthly_usage breakdown = get_free_paid_breakdown_for_month( cumulative, previous_cumulative, [billing_month for billing_month in billing_units if billing_month['month'] == month] ) yield { 'name': month, 'paid': breakdown['paid'], 'free': breakdown['free'] } def get_free_paid_breakdown_for_month( cumulative, previous_cumulative, monthly_usage ): allowance = 250000 total_monthly_billing_units = get_sum_billing_units(monthly_usage) if cumulative < allowance: return { 'paid': 0, 'free': total_monthly_billing_units, } elif previous_cumulative < allowance: remaining_allowance = allowance - previous_cumulative return { 'paid': total_monthly_billing_units - remaining_allowance, 'free': remaining_allowance, } else: return { 'paid': total_monthly_billing_units, 'free': 0, } def requested_and_current_financial_year(request): try: return ( int(request.args.get('year', get_current_financial_year())), get_current_financial_year(), ) except ValueError: abort(404) def format_template_stats_to_list(stats_dict): if not stats_dict: return [] for template_id, template in stats_dict.items(): yield dict( requested_count=sum( template['counts'].get(status, 0) for status in REQUESTED_STATUSES ), id=template_id, **template ) def get_tuples_of_financial_years( partial_url, start=2015, end=None, ): return ( ( 'financial year', year, partial_url(year=year), '{} to {}'.format(year, year + 1), ) for year in range(start, end + 1) )