3543835887

Build Type

github

Committed by GitHub

Commit Message

<a href="https://github.com/kobotoolbox/kpi/commit/<a class=hub.com/kobotoolbox/kpi/commit/<a class="double-link" href="https://git"><a class=hub.com/kobotoolbox/kpi/commit/<a class="double-link" href="https://git"><a class=hub.com/kobotoolbox/kpi/commit/64fc634a0585a568fff12902975dbc2d8011e279">64fc634a0<a href="https://github.com/kobotoolbox/kpi/commit/64fc634a0585a568fff12902975dbc2d8011e279">&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/kobotoolbox/kpi/commit/&lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/kobotoolbox/kpi/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/kobotoolbox/kpi/commit/64fc634a0585a568fff12902975dbc2d8011e279&quot;&gt;64fc634a0&lt;/a&gt;&lt;a href=&quot;https://github.com/kobotoolbox/kpi/commit/64fc634a0585a568fff12902975dbc2d8011e279&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/kobotoolbox/kpi/commit/64fc634a0585a568fff12902975dbc2d&lt;/a&gt;8011e279">&quot;&gt;Merge &lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/kobotoolbox/kpi/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/kobotoolbox/kpi/commit/<a class="double-link" href="https://github.com/kobotoolbox/kpi/commit/d2cb14d56c2a64a8f2a776c34a7b49a2777a735f">d2cb14d56</a><a href="https://github.com/kobotoolbox/kpi/commit/64fc634a0585a568fff12902975dbc2d8011e279">&amp;quot;&amp;gt;d2cb14d56&amp;lt;/a&amp;gt;&amp;quot;&amp;gt;d2cb14d56&amp;lt;/a&amp;gt;&amp;lt;a href=&amp;quot;https://github.com/kobotoolbox/kpi/commit/64fc634a0585a568fff12902975dbc2d8011e&lt;/a&gt;279&quot;&gt; into &lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/kobotoolbox/kpi/commit/<a class="double-link" href="https://github.com/kobotoolbox/kpi/commit/844db382d">844db382d">844db382d</a>

Pull Request Pull Request #4160: Fix 404 when date range parameters are omitted

Run Details

2473 of 4170 branches covered (59.3%)

34 of 34 new or added lines in 2 files covered. (100.0%)

10803 of 14320 relevant lines covered (75.44%)

1.51 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

26.21

/kobo/apps/superuser_stats/views.py

# coding: utf-8
import re
from datetime import datetime, date

from django.contrib.auth.decorators import user_passes_test
from django.core.files.storage import get_storage_class
from django.http import HttpResponse, StreamingHttpResponse, Http404
from django.urls import reverse
from django.utils import timezone

from kobo.settings.base import KOBOFORM_URL
from .tasks import (
    generate_country_report,
    generate_continued_usage_report,
    generate_domain_report,
    generate_forms_count_by_submission_range,
    generate_media_storage_report,
    generate_user_count_by_organization,
    generate_user_statistics_report,
    generate_user_details_report,
    generate_user_report,
)


def _base_filename_to_full_filename(base_filename, username):
    return '__'.join([
        username,
        base_filename
    ])


@user_passes_test(lambda u: u.is_superuser)
def country_report(request):
    """
    Generates a report which counts the number of submissions and forms
    per country as reported by the user
    """
    today = timezone.now().date()
    base_filename = 'country-report_{}_{}_{}.csv'.format(
        re.sub('[^a-zA-Z0-9]', '-', request.META['HTTP_HOST']),
        today,
        datetime.now().microsecond
    )

    # Get the date filters from the query and set defaults
    if not (start_date := request.GET.get('start_date')):
        start_date = f'{today}'

    if not (end_date := request.GET.get('end_date')):
        end_date = f'{today}'

    # Generate the CSV file
    filename = _base_filename_to_full_filename(
        base_filename, request.user.username)
    generate_country_report.delay(filename, start_date, end_date)

    url = f"{KOBOFORM_URL}{reverse('superuser_stats:countries_report')}"
    template_ish = (
        f'<html><head><title>Countries report</title></head>'
        f'<body>Your report is being generated. Once finished, it will be '
        f'available at <a href="{base_filename}">{base_filename}</a>.<br>'
        f'If you receive a 404, please refresh your browser periodically until '
        f'your request succeeds.<br><br>'
        f'To select a date range, add a <code style="background: lightgray">?</code> at the end of the URL and set the '
        f'<code style="background: lightgray">start_date</code> parameter to <code style="background: lightgray">YYYY-MM-DD</code> and/or the '
        f'<code style="background: lightgray">end_date</code> parameter to <code style="background: lightgray">YYYY-MM-DD</code>.<br><br>'
        f'<b>Example:</b><br>'
        f'<a href="{url}?start_date={today}&end_date={today}">'
        f'  {url}?start_date={today}&end_date={today}'
        f'</a>'
        f'<p>The default start_date and end_date is today\'s date.</p>'
        f'</body></html>'
    )

    return HttpResponse(template_ish)


@user_passes_test(lambda u: u.is_superuser)
def continued_usage_report(request):
    """
    Tracks users usage over a given year with the last day being set by
    'end_date'
    """
    today = timezone.now().date()
    base_filename = 'continued-usage-report_{}_{}_{}.csv'.format(
        re.sub('[^a-zA-Z0-9]', '-', request.META['HTTP_HOST']),
        today,
        timezone.now().microsecond
    )

    # Get the date filters from the query and set defaults
    if not (end_date := request.GET.get('end_date')):
        end_date = str(today)

    # Generate the CSV file
    filename = _base_filename_to_full_filename(
        base_filename, request.user.username)
    generate_continued_usage_report.delay(filename, end_date)

    url = f"{KOBOFORM_URL}{reverse('superuser_stats:continued_usage_report')}"
    template_ish = (
        f'<html><head><title>Continued usage report</title></head>'
        f'<body>Your report is being generated. Once finished, it will be '
        f'available at <a href="{base_filename}">{base_filename}</a>.<br>'
        f'If you receive a 404, please refresh your browser periodically until '
        f'your request succeeds.<br><br>'
        f'To select an end date, add a <code style="background: lightgray">?</code> at the end of the URL and set the '
        f'<code style="background: lightgray">end_date</code> parameter to <code style="background: lightgray">YYYY-MM-DD</code>.<br><br>'
        f'<b>Example:</b><br>'
        f'<a href="{url}?end_date={today}">'
        f'  {url}?end_date={today}'
        f'</a>'
        f'<p>The default end date is {today}.</p>'
        f'</body></html>'
    )

    return HttpResponse(template_ish)


@user_passes_test(lambda u: u.is_superuser)
def domain_report(request):
    """
    Generates a report which counts the amount of users
    with the same email address domain
    """
    # Generate the file basename
    today = timezone.now().date()
    base_filename = 'domain-report_{}_{}_{}.csv'.format(
        re.sub('[^a-zA-Z0-9]', '-', request.META['HTTP_HOST']),
        today,
        timezone.now().microsecond
    )

    # Get the date filters from the query and set defaults
    if not (start_date := request.GET.get('start_date')):
        start_date = f'{today}'

    if not (end_date := request.GET.get('end_date')):
        end_date = f'{today}'

    # Generate the CSV file
    filename = _base_filename_to_full_filename(
        base_filename, request.user.username)

    generate_domain_report.delay(filename, start_date, end_date)

    # Generate page text
    url = f"{KOBOFORM_URL}{reverse('superuser_stats:domains_report')}"
    template_ish = (
        f'<html><head><title>Domains report</title></head>'
        f'<body>Your report is being generated. Once finished, it will be '
        f'available at <a href="{base_filename}">{base_filename}</a>.<br>'
        f'If you receive a 404, please refresh your browser periodically until '
        f'your request succeeds.<br><br>'
        f'To select a date range, add a <code style="background: lightgray">?</code> at the end of the URL and set the '
        f'<code style="background: lightgray">start_date</code> parameter to <code style="background: lightgray">YYYY-MM-DD</code> and/or the '
        f'<code style="background: lightgray">end_date</code> parameter to <code style="background: lightgray">YYYY-MM-DD</code>.<br><br>'
        f'<b>Example:</b><br>'
        f'<a href="{url}?start_date={today}&end_date={today}">'
        f'  {url}?start_date={today}&end_date={today}'
        f'</a>'
        f'<p>The default start_date and end_date is today\'s date, but submissions '
        f'count will be 0 unless the range includes first of the month.</p>'
        f'</body></html>'
    )

    return HttpResponse(template_ish)


@user_passes_test(lambda u: u.is_superuser)
def forms_count_by_submission_report(request):
    """
    generates a report counting the number of forms within a
    submission range
    """
    today = timezone.now().date()
    base_filename = 'form-count-by-submissions-count-report_{}_{}_{}.csv'.format(
        re.sub('[^a-zA-Z0-9]', '-', request.META['HTTP_HOST']),
        today,
        datetime.now().microsecond
    )
    filename = _base_filename_to_full_filename(
        base_filename, request.user.username
    )
    generate_forms_count_by_submission_range.delay(filename)
    template_ish = (
        f'<html><head><title>Forms count by submissions count report.</title></head>'
        f'<body>Your report is being generated. Once finished, it will be '
        f'available at <a href="{base_filename}">{base_filename}</a>.<br>'
        f'If you receive a 404, please refresh your browser periodically until '
        f'your request succeeds.'
        f'</body></html>'
    )
    return HttpResponse(template_ish)


@user_passes_test(lambda u: u.is_superuser)
def media_storage(request):
    """
    Generates a report which totals the amount of GB a user
    has stored
    """
    base_filename = 'media_storage_report_{}_{}_{}.csv'.format(
        re.sub('[^a-zA-Z0-9]', '-', request.META['HTTP_HOST']),
        date.today(),
        datetime.now().microsecond
    )
    filename = _base_filename_to_full_filename(
        base_filename, request.user.username)
    generate_media_storage_report.delay(filename)
    template_ish = (
        f'<html><head><title>Media storage report</title></head>'
        f'<body>Your report is being generated. Once finished, it will be '
        f'available at <a href="{base_filename}">{base_filename}</a>.<br>'
        f'If you receive a 404, please refresh your browser periodically until '
        f'your request succeeds.'
        f'</body></html>'
    ).format(base_filename)
    return HttpResponse(template_ish)


@user_passes_test(lambda u: u.is_superuser)
def user_count_by_organization(request):
    """
    Generates a report that counts the number of users per organization
    """
    # Generate the file basename
    base_filename = 'user-count-by-organization_{}_{}_{}.csv'.format(
        re.sub('[^a-zA-Z0-9]', '-', request.META['HTTP_HOST']),
        date.today(),
        datetime.now().microsecond
    )

    # Generate the CSV file
    filename = _base_filename_to_full_filename(
        base_filename, request.user.username)
    generate_user_count_by_organization.delay(filename)

    # Generate page text
    template_ish = (
        f'<html><head><title>Users by organization report</title></head>'
        f'<body>Your report is being generated. Once finished, it will be '
        f'available at <a href="{base_filename}">{base_filename}</a>.<br>'
        f'If you receive a 404, please refresh your browser periodically until '
        f'your request succeeds.</body></html>'
    )

    return HttpResponse(template_ish)


@user_passes_test(lambda u: u.is_superuser)
def user_report(request):
    """
    Generates a detailed report with a users details
    """
    base_filename = 'user-report_{}_{}_{}.csv'.format(
        re.sub('[^a-zA-Z0-9]', '-', request.META['HTTP_HOST']),
        date.today(),
        datetime.now().microsecond
    )
    filename = _base_filename_to_full_filename(
        base_filename, request.user.username)
    generate_user_report.delay(filename)
    template_ish = (
        f'<html><head><title>Users report</title></head>'
        f'<body>Your report is being generated. Once finished, it will be '
        f'available at <a href="{base_filename}">{base_filename}</a>.<br>'
        f'If you receive a 404, please refresh your browser periodically until '
        f'your request succeeds.'
        f'</body></html>'
    )
    return HttpResponse(template_ish)


@user_passes_test(lambda u: u.is_superuser)
def user_statistics_report(request):
    """
    View for the User Statistics Report
    Generates a detailed report of a user's activity
    over a period of time
    """
    base_filename = 'user-statistics-report_{}_{}_{}.csv'.format(
        re.sub('[^a-zA-Z0-9]', '-', request.META['HTTP_HOST']),
        date.today(),
        datetime.now().microsecond
    )

    # Get the date filters from the query and set defaults
    today = timezone.now().date()
    first_of_month = today.replace(day=1)
    if start_month := request.GET.get('start_month'):
        start_date = f'{start_month}-1'
    else:
        start_date = str(first_of_month)
        start_month = first_of_month.strftime('%Y-%m')

    if end_month := request.GET.get('end_month'):
        end_date = f'{end_month}-01'
    else:
        end_date = str(first_of_month)
        end_month = first_of_month.strftime('%Y-%m')

    # Generate the CSV file
    filename = _base_filename_to_full_filename(
        base_filename, request.user.username)
    generate_user_statistics_report.delay(filename, start_date, end_date)

    url = f"{KOBOFORM_URL}{reverse('superuser_stats:user_statistics_report')}"
    template_ish = (
        f'<html><head><title>User statistics report</title></head>'
        f'<body>Your report is being generated. Once finished, it will be '
        f'available at <a href="{base_filename}">{base_filename}</a>.<br>If you '
        f'receive a 404, please refresh your browser periodically until your '
        f'request succeeds.<br><br>'
        f'To select a date range, add a <code style="background: lightgray">?</code> at the end of the URL and set the '
        f'<code style="background: lightgray">start_month</code> parameter to <code style="background: lightgray">YYYY-MM</code> and/or the '
        f'<code style="background: lightgray">end_month</code> parameter to <code style="background: lightgray">YYYY-MM</code>.<br><br>'
        f'<b>Example:</b><br>'
        f'<a href="{url}?start_month={start_month}&end_month={end_month}">'
        f'  {url}?start_month={start_month}&end_month={end_month}'
        f'</a>'
        f'<p>The default range is current month: {today.strftime("%B %Y")}.</p>'
        f'</body></html>'
    )
    return HttpResponse(template_ish)


def user_details_report(request):
    base_filename = 'user-details-report_{}_{}_{}.csv'.format(
        re.sub('[^a-zA-Z0-9]', '-', request.META['HTTP_HOST']),
        date.today(),
        datetime.now().microsecond,
    )
    filename = _base_filename_to_full_filename(
        base_filename, request.user.username
    )
    generate_user_details_report.delay(filename)
    template_ish = (
        f'<html><head><title>User details report</title></head>'
        f'<body>Your report is being generated. Once finished, it will be '
        f'available at <a href="{base_filename}">{base_filename}</a>.<br>'
        f'If you receive a 404, please refresh your browser periodically until '
        f'your request succeeds.'
        f'</body></html>'
    )
    return HttpResponse(template_ish)


@user_passes_test(lambda u: u.is_superuser)
def retrieve_reports(request, base_filename):
    """
    Retrieves the generated report from the storage system
    or returns a 404
    """
    filename = _base_filename_to_full_filename(
        base_filename, request.user.username)
    default_storage = get_storage_class()()
    if not default_storage.exists(filename):
        raise Http404
    # File is intentionally left open so it can be read by the streaming
    # response
    f = default_storage.open(filename)
    response = StreamingHttpResponse(f, content_type='text/csv')
    response['Content-Disposition'] = f'attachment;filename="{base_filename}"'
    return response

1	# coding: utf-8
2	import re	2✔
3	from datetime import datetime, date	2✔
4
5	from django.contrib.auth.decorators import user_passes_test	2✔
6	from django.core.files.storage import get_storage_class	2✔
7	from django.http import HttpResponse, StreamingHttpResponse, Http404	2✔
8	from django.urls import reverse	2✔
9	from django.utils import timezone	2✔
10
11	from kobo.settings.base import KOBOFORM_URL	2✔
12	from .tasks import (	2✔
13	generate_country_report,
14	generate_continued_usage_report,
15	generate_domain_report,
16	generate_forms_count_by_submission_range,
17	generate_media_storage_report,
18	generate_user_count_by_organization,
19	generate_user_statistics_report,
20	generate_user_details_report,
21	generate_user_report,
22	)
23
24
25	def _base_filename_to_full_filename(base_filename, username):	2✔
26	return '__'.join([	×
27	username,
28	base_filename
29	])
30
31
32	@user_passes_test(lambda u: u.is_superuser)	2!
33	def country_report(request):	2✔
34	"""
35	Generates a report which counts the number of submissions and forms
36	per country as reported by the user
37	"""
38	today = timezone.now().date()	×
39	base_filename = 'country-report_{}_{}_{}.csv'.format(	×
40	re.sub('[^a-zA-Z0-9]', '-', request.META['HTTP_HOST']),
41	today,
42	datetime.now().microsecond
43	)
44
45	# Get the date filters from the query and set defaults
46	if not (start_date := request.GET.get('start_date')):	×
47	start_date = f'{today}'	×
48
49	if not (end_date := request.GET.get('end_date')):	×
50	end_date = f'{today}'	×
51
52	# Generate the CSV file
53	filename = _base_filename_to_full_filename(	×
54	base_filename, request.user.username)
55	generate_country_report.delay(filename, start_date, end_date)	×
56
57	url = f"{KOBOFORM_URL}{reverse('superuser_stats:countries_report')}"	×
58	template_ish = (	×
59	f'<html><head><title>Countries report</title></head>'
60	f'<body>Your report is being generated. Once finished, it will be '
61	f'available at <a href="{base_filename}">{base_filename}</a>.<br>'
62	f'If you receive a 404, please refresh your browser periodically until '
63	f'your request succeeds.<br><br>'
64	f'To select a date range, add a <code style="background: lightgray">?</code> at the end of the URL and set the '
65	f'<code style="background: lightgray">start_date</code> parameter to <code style="background: lightgray">YYYY-MM-DD</code> and/or the '
66	f'<code style="background: lightgray">end_date</code> parameter to <code style="background: lightgray">YYYY-MM-DD</code>.<br><br>'
67	f'<b>Example:</b><br>'
68	f'<a href="{url}?start_date={today}&end_date={today}">'
69	f' {url}?start_date={today}&end_date={today}'
70	f'</a>'
71	f'<p>The default start_date and end_date is today\'s date.</p>'
72	f'</body></html>'
73	)
74
75	return HttpResponse(template_ish)	×
76
77
78	@user_passes_test(lambda u: u.is_superuser)	2!
79	def continued_usage_report(request):	2✔
80	"""
81	Tracks users usage over a given year with the last day being set by
82	'end_date'
83	"""
84	today = timezone.now().date()	×
85	base_filename = 'continued-usage-report_{}_{}_{}.csv'.format(	×
86	re.sub('[^a-zA-Z0-9]', '-', request.META['HTTP_HOST']),
87	today,
88	timezone.now().microsecond
89	)
90
91	# Get the date filters from the query and set defaults
92	if not (end_date := request.GET.get('end_date')):	×
93	end_date = str(today)	×
94
95	# Generate the CSV file
96	filename = _base_filename_to_full_filename(	×
97	base_filename, request.user.username)
98	generate_continued_usage_report.delay(filename, end_date)	×
99
100	url = f"{KOBOFORM_URL}{reverse('superuser_stats:continued_usage_report')}"	×
101	template_ish = (	×
102	f'<html><head><title>Continued usage report</title></head>'
103	f'<body>Your report is being generated. Once finished, it will be '
104	f'available at <a href="{base_filename}">{base_filename}</a>.<br>'
105	f'If you receive a 404, please refresh your browser periodically until '
106	f'your request succeeds.<br><br>'
107	f'To select an end date, add a <code style="background: lightgray">?</code> at the end of the URL and set the '
108	f'<code style="background: lightgray">end_date</code> parameter to <code style="background: lightgray">YYYY-MM-DD</code>.<br><br>'
109	f'<b>Example:</b><br>'
110	f'<a href="{url}?end_date={today}">'
111	f' {url}?end_date={today}'
112	f'</a>'
113	f'<p>The default end date is {today}.</p>'
114	f'</body></html>'
115	)
116
117	return HttpResponse(template_ish)	×
118
119
120	@user_passes_test(lambda u: u.is_superuser)	2!
121	def domain_report(request):	2✔
122	"""
123	Generates a report which counts the amount of users
124	with the same email address domain
125	"""
126	# Generate the file basename
127	today = timezone.now().date()	×
128	base_filename = 'domain-report_{}_{}_{}.csv'.format(	×
129	re.sub('[^a-zA-Z0-9]', '-', request.META['HTTP_HOST']),
130	today,
131	timezone.now().microsecond
132	)
133
134	# Get the date filters from the query and set defaults
135	if not (start_date := request.GET.get('start_date')):	×
136	start_date = f'{today}'	×
137
138	if not (end_date := request.GET.get('end_date')):	×
139	end_date = f'{today}'	×
140
141	# Generate the CSV file
142	filename = _base_filename_to_full_filename(	×
143	base_filename, request.user.username)
144
145	generate_domain_report.delay(filename, start_date, end_date)	×
146
147	# Generate page text
148	url = f"{KOBOFORM_URL}{reverse('superuser_stats:domains_report')}"	×
149	template_ish = (	×
150	f'<html><head><title>Domains report</title></head>'
151	f'<body>Your report is being generated. Once finished, it will be '
152	f'available at <a href="{base_filename}">{base_filename}</a>.<br>'
153	f'If you receive a 404, please refresh your browser periodically until '
154	f'your request succeeds.<br><br>'
155	f'To select a date range, add a <code style="background: lightgray">?</code> at the end of the URL and set the '
156	f'<code style="background: lightgray">start_date</code> parameter to <code style="background: lightgray">YYYY-MM-DD</code> and/or the '
157	f'<code style="background: lightgray">end_date</code> parameter to <code style="background: lightgray">YYYY-MM-DD</code>.<br><br>'
158	f'<b>Example:</b><br>'
159	f'<a href="{url}?start_date={today}&end_date={today}">'
160	f' {url}?start_date={today}&end_date={today}'
161	f'</a>'
162	f'<p>The default start_date and end_date is today\'s date, but submissions '
163	f'count will be 0 unless the range includes first of the month.</p>'
164	f'</body></html>'
165	)
166
167	return HttpResponse(template_ish)	×
168
169
170	@user_passes_test(lambda u: u.is_superuser)	2!
171	def forms_count_by_submission_report(request):	2✔
172	"""
173	generates a report counting the number of forms within a
174	submission range
175	"""
176	today = timezone.now().date()	×
177	base_filename = 'form-count-by-submissions-count-report_{}_{}_{}.csv'.format(	×
178	re.sub('[^a-zA-Z0-9]', '-', request.META['HTTP_HOST']),
179	today,
180	datetime.now().microsecond
181	)
182	filename = _base_filename_to_full_filename(	×
183	base_filename, request.user.username
184	)
185	generate_forms_count_by_submission_range.delay(filename)	×
186	template_ish = (	×
187	f'<html><head><title>Forms count by submissions count report.</title></head>'
188	f'<body>Your report is being generated. Once finished, it will be '
189	f'available at <a href="{base_filename}">{base_filename}</a>.<br>'
190	f'If you receive a 404, please refresh your browser periodically until '
191	f'your request succeeds.'
192	f'</body></html>'
193	)
194	return HttpResponse(template_ish)	×
195
196
197	@user_passes_test(lambda u: u.is_superuser)	2!
198	def media_storage(request):	2✔
199	"""
200	Generates a report which totals the amount of GB a user
201	has stored
202	"""
203	base_filename = 'media_storage_report_{}_{}_{}.csv'.format(	×
204	re.sub('[^a-zA-Z0-9]', '-', request.META['HTTP_HOST']),
205	date.today(),
206	datetime.now().microsecond
207	)
208	filename = _base_filename_to_full_filename(	×
209	base_filename, request.user.username)
210	generate_media_storage_report.delay(filename)	×
211	template_ish = (	×
212	f'<html><head><title>Media storage report</title></head>'
213	f'<body>Your report is being generated. Once finished, it will be '
214	f'available at <a href="{base_filename}">{base_filename}</a>.<br>'
215	f'If you receive a 404, please refresh your browser periodically until '
216	f'your request succeeds.'
217	f'</body></html>'
218	).format(base_filename)
219	return HttpResponse(template_ish)	×
220
221
222	@user_passes_test(lambda u: u.is_superuser)	2!
223	def user_count_by_organization(request):	2✔
224	"""
225	Generates a report that counts the number of users per organization
226	"""
227	# Generate the file basename
228	base_filename = 'user-count-by-organization_{}_{}_{}.csv'.format(	×
229	re.sub('[^a-zA-Z0-9]', '-', request.META['HTTP_HOST']),
230	date.today(),
231	datetime.now().microsecond
232	)
233
234	# Generate the CSV file
235	filename = _base_filename_to_full_filename(	×
236	base_filename, request.user.username)
237	generate_user_count_by_organization.delay(filename)	×
238
239	# Generate page text
240	template_ish = (	×
241	f'<html><head><title>Users by organization report</title></head>'
242	f'<body>Your report is being generated. Once finished, it will be '
243	f'available at <a href="{base_filename}">{base_filename}</a>.<br>'
244	f'If you receive a 404, please refresh your browser periodically until '
245	f'your request succeeds.</body></html>'
246	)
247
248	return HttpResponse(template_ish)	×
249
250
251	@user_passes_test(lambda u: u.is_superuser)	2!
252	def user_report(request):	2✔
253	"""
254	Generates a detailed report with a users details
255	"""
256	base_filename = 'user-report_{}_{}_{}.csv'.format(	×
257	re.sub('[^a-zA-Z0-9]', '-', request.META['HTTP_HOST']),
258	date.today(),
259	datetime.now().microsecond
260	)
261	filename = _base_filename_to_full_filename(	×
262	base_filename, request.user.username)
263	generate_user_report.delay(filename)	×
264	template_ish = (	×
265	f'<html><head><title>Users report</title></head>'
266	f'<body>Your report is being generated. Once finished, it will be '
267	f'available at <a href="{base_filename}">{base_filename}</a>.<br>'
268	f'If you receive a 404, please refresh your browser periodically until '
269	f'your request succeeds.'
270	f'</body></html>'
271	)
272	return HttpResponse(template_ish)	×
273
274
275	@user_passes_test(lambda u: u.is_superuser)	2!
276	def user_statistics_report(request):	2✔
277	"""
278	View for the User Statistics Report
279	Generates a detailed report of a user's activity
280	over a period of time
281	"""
282	base_filename = 'user-statistics-report_{}_{}_{}.csv'.format(	×
283	re.sub('[^a-zA-Z0-9]', '-', request.META['HTTP_HOST']),
284	date.today(),
285	datetime.now().microsecond
286	)
287
288	# Get the date filters from the query and set defaults
289	today = timezone.now().date()	×
290	first_of_month = today.replace(day=1)	×
291	if start_month := request.GET.get('start_month'):	×
292	start_date = f'{start_month}-1'	×
293	else:
294	start_date = str(first_of_month)	×
295	start_month = first_of_month.strftime('%Y-%m')	×
296
297	if end_month := request.GET.get('end_month'):	×
298	end_date = f'{end_month}-01'	×
299	else:
300	end_date = str(first_of_month)	×
301	end_month = first_of_month.strftime('%Y-%m')	×
302
303	# Generate the CSV file
304	filename = _base_filename_to_full_filename(	×
305	base_filename, request.user.username)
306	generate_user_statistics_report.delay(filename, start_date, end_date)	×
307
308	url = f"{KOBOFORM_URL}{reverse('superuser_stats:user_statistics_report')}"	×
309	template_ish = (	×
310	f'<html><head><title>User statistics report</title></head>'
311	f'<body>Your report is being generated. Once finished, it will be '
312	f'available at <a href="{base_filename}">{base_filename}</a>.<br>If you '
313	f'receive a 404, please refresh your browser periodically until your '
314	f'request succeeds.<br><br>'
315	f'To select a date range, add a <code style="background: lightgray">?</code> at the end of the URL and set the '
316	f'<code style="background: lightgray">start_month</code> parameter to <code style="background: lightgray">YYYY-MM</code> and/or the '
317	f'<code style="background: lightgray">end_month</code> parameter to <code style="background: lightgray">YYYY-MM</code>.<br><br>'
318	f'<b>Example:</b><br>'
319	f'<a href="{url}?start_month={start_month}&end_month={end_month}">'
320	f' {url}?start_month={start_month}&end_month={end_month}'
321	f'</a>'
322	f'<p>The default range is current month: {today.strftime("%B %Y")}.</p>'
323	f'</body></html>'
324	)
325	return HttpResponse(template_ish)	×
326
327
328	def user_details_report(request):	2✔
329	base_filename = 'user-details-report_{}_{}_{}.csv'.format(	×
330	re.sub('[^a-zA-Z0-9]', '-', request.META['HTTP_HOST']),
331	date.today(),
332	datetime.now().microsecond,
333	)
334	filename = _base_filename_to_full_filename(	×
335	base_filename, request.user.username
336	)
337	generate_user_details_report.delay(filename)	×
338	template_ish = (	×
339	f'<html><head><title>User details report</title></head>'
340	f'<body>Your report is being generated. Once finished, it will be '
341	f'available at <a href="{base_filename}">{base_filename}</a>.<br>'
342	f'If you receive a 404, please refresh your browser periodically until '
343	f'your request succeeds.'
344	f'</body></html>'
345	)
346	return HttpResponse(template_ish)	×
347
348
349	@user_passes_test(lambda u: u.is_superuser)	2!
350	def retrieve_reports(request, base_filename):	2✔
351	"""
352	Retrieves the generated report from the storage system
353	or returns a 404
354	"""
355	filename = _base_filename_to_full_filename(	×
356	base_filename, request.user.username)
357	default_storage = get_storage_class()()	×
358	if not default_storage.exists(filename):	×
359	raise Http404	×
360	# File is intentionally left open so it can be read by the streaming
361	# response
362	f = default_storage.open(filename)	×
363	response = StreamingHttpResponse(f, content_type='text/csv')	×
364	response['Content-Disposition'] = f'attachment;filename="{base_filename}"'	×
365	return response	×

kobotoolbox / kpi / 3543835887

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous