Schedule Reports

rocky/katalogus/views/change_clearance_level.py

@@ -12,6 +12,7 @@
 class ChangeClearanceLevel(OrganizationPermissionRequiredMixin, SchedulerView, SinglePluginView, TemplateView):
     template_name = "change_clearance_level.html"
     permission_required = "tools.can_set_clearance_level"
+    task_type = "boefje"
 
     def setup(self, request, *args, **kwargs):
         super().setup(request, *args, **kwargs)

rocky/reports/forms.py

@@ -1,6 +1,8 @@
+from datetime import datetime, timezone
+
 from django import forms
 from django.utils.translation import gettext_lazy as _
-from tools.forms.base import BaseRockyForm
+from tools.forms.base import BaseRockyForm, DateInput
 
 from reports.report_types.definitions import Report
 
@@ -28,3 +30,108 @@ def __init__(self, report_types: set[Report], *args, **kwargs):
         super().__init__(*args, **kwargs)
         report_types_choices = ((report_type.id, report_type.name) for report_type in report_types)
         self.fields["report_type"].choices = report_types_choices
+
+
+class ReportScheduleStartDateChoiceForm(BaseRockyForm):
+    choose_date = forms.ChoiceField(
+        label="",
+        required=False,
+        widget=forms.RadioSelect(attrs={"class": "submit-on-click"}),
+        choices=(("today", _("Today")), ("schedule", _("Different date"))),
+        initial="today",
+    )
+
+
+class ReportScheduleStartDateForm(BaseRockyForm):
+    start_date = forms.DateField(
+        label="",
+        widget=DateInput(format="%Y-%m-%d"),
+        initial=lambda: datetime.now(tz=timezone.utc).date(),
+        required=True,
+    )
+
+
+class ReportRecurrenceChoiceForm(BaseRockyForm):
+    choose_recurrence = forms.ChoiceField(
+        label="",
+        required=False,
+        widget=forms.RadioSelect(attrs={"class": "submit-on-click"}),
+        choices=(("once", _("No, just once")), ("repeat", _("Yes, repeat"))),
+        initial="once",
+    )
+
+
+class ReportScheduleRecurrenceForm(BaseRockyForm):
+    recurrence = forms.ChoiceField(
+        label="",
+        required=False,
+        widget=forms.Select(attrs={"form": "generate_report"}),
+        choices=[
+            ("daily", _("Daily")),
+            ("weekly", _("Weekly")),
+            ("monthly", _("Monthly")),
+            ("yearly", _("Yearly")),
+        ],
+    )
+
+
+class CustomReportScheduleForm(BaseRockyForm):
+    start_date = forms.DateField(
+        label=_("Start date"),
+        widget=DateInput(format="%Y-%m-%d"),
+        initial=lambda: datetime.now(tz=timezone.utc).date(),
+        required=False,
+    )
+    repeating_number = forms.IntegerField(initial=1, required=False, min_value=1, max_value=100)
+    repeating_term = forms.ChoiceField(
+        widget=forms.Select,
+        choices=[
+            ("day", _("day")),
+            ("week", _("week")),
+            ("month", _("month")),
+            ("year", _("year")),
+        ],
+    )
+    on_weekdays = forms.ChoiceField(
+        widget=forms.RadioSelect,
+        choices=[
+            ("monday", "M"),
+            ("tuesday", "T"),
+            ("wednesday", "W"),
+            ("thursday", "T"),
+            ("friday", "F"),
+            ("saturday", "S"),
+            ("sunday", "S"),
+        ],
+    )
+    recurrence_ends = forms.ChoiceField(
+        widget=forms.RadioSelect,
+        choices=[
+            ("never", _("Never")),
+            ("on", _("On")),  # user choses a specific date
+            ("after", _("After")),  # after how many occurrences? Shows drop down with occurrences
+        ],
+    )
+
+    end_date = forms.DateField(
+        label=_(""),
+        widget=forms.HiddenInput(),
+        initial=lambda: datetime.now(tz=timezone.utc).date(),
+        required=False,
+    )
+
+
+class ParentReportNameForm(BaseRockyForm):
+    parent_report_name = forms.CharField(
+        label=_("Report name format"), required=False, initial="{report type} for {ooi}"
+    )
+
+
+class ChildReportNameForm(BaseRockyForm):
+    child_report_name = forms.CharField(
+        label=_("Subreports name format"), required=True, initial="{report type} for {ooi}"
+    )
+
+
+class ReportNameForm(ParentReportNameForm, ChildReportNameForm):
+    pass

rocky/reports/templates/forms/report_form_fields.html

@@ -20,3 +20,8 @@
 {% for required_optional_plugin, plugins_ in plugins.items %}
     {% for plugin in plugins_ %}<input type="hidden" name="plugin" value="{{ plugin.id }}">{% endfor %}
 {% endfor %}
+{% if request.POST.choose_recurrence %}
+    <input type="hidden"
+           name="choose_recurrence"
+           value="{{ request.POST.choose_recurrence }}">
+{% endif %}

rocky/reports/templates/partials/export_report_settings.html

@@ -7,68 +7,52 @@
 <section>
     <div>
         {% if selected_oois and selected_report_types %}
-            <h2>{% translate "Report name" %}</h2>
-            {% include "partials/return_button.html" with btn_text="Change selection" %}
-
+            <h2>{% translate "Report schedule" %}</h2>
             <p>
                 {% blocktranslate trimmed %}
-                    Give your report a custom name and optionally add the reports' reference date
-                    to the name. To do so you can select a standard option or use a <a href="https://strftime.org/" target="_blank">Python
-                    strftime code</a> in the report name.
+                    When scheduling your report, you have two options. You can either choose to generate it just once now,
+                    or set it to run automatically at regular intervals, like daily, weekly,
+                    or monthly. If you need the report just for a single occasion, select the one-time option.
                 {% endblocktranslate %}
             </p>
+            {% include "partials/return_button.html" with btn_text="Change selection" %}
+
+            <form class="inline" method="post" action="{{ current }}">
+                {% csrf_token %}
+                {% include "forms/report_form_fields.html" %}
+
+                <h3>{% translate "Recurrence" %}</h3>
+                {% include "partials/form/fieldset.html" with fields=report_schedule_form_recurrence_choice %}
+
+                {% if is_scheduled_report %}
+                    {% include "partials/form/fieldset.html" with fields=report_schedule_form_recurrence %}
+
+                {% endif %}
+            </form>
             <form id="generate_report" class="inline" method="post" action="{{ next }}">
-                <table id="report-name-table">
-                    <caption class="visually-hidden">{% translate "Report names:" %}</caption>
-                    <thead>
-                        <tr>
-                            <th scope="col" colspan="2">
-                                {% translate "Name" %} <span class="nota-bene" aria-hidden>{% translate "(Required)" %}</span>
-                            </th>
-                            <th scope="col">{% translate "Add reference date" %}</th>
-                        </tr>
-                    </thead>
-                    <tbody>
-                        {% for report_name in reports %}
-                            {% with report_id=report_name|slugify %}
-                                <input type="hidden" name="old_report_name" value="{{ report_name }}" />
-                                <tr>
-                                    <td>
-                                        <div>
-                                            <input id="{{ report_id }}"
-                                                   class="name-input"
-                                                   name="report_name"
-                                                   type="text"
-                                                   value="{{ report_name }}"
-                                                   required
-                                                   minlength="3" />
-                                        </div>
-                                    </td>
-                                    <td>
-                                        <button type="button"
-                                                class="icon ti-arrow-back-up action-button reset-button hidden"
-                                                aria-label="{% translate "Reset" %}"></button>
-                                    </td>
-                                    <td>
-                                        <select class="reference-date" name="reference_date">
-                                            <option value="">{% translate "No reference date" %}</option>
-                                            <option value="%b %d %Y, %H:%M">{% translate "Day" %} ({{ created_at|date:"N jS Y, H:i" }})</option>
-                                            <option value="week">{% translate "Week" %} ({% translate "Week" %} {{ created_at|date:"W, Y" }})</option>
-                                            <option value="%b, %Y">{% translate "Month" %} ({{ created_at|date:"N, Y" }})</option>
-                                            <option value="%Y">{% translate "Year" %} ({{ created_at|date:"Y" }})</option>
-                                        </select>
-                                    </td>
-                                </tr>
-                            {% endwith %}
-                        {% endfor %}
-                    </tbody>
-                </table>
                 {% csrf_token %}
-                <button type="submit" form="generate_report">
-                    {% include "forms/report_form_fields.html" %}
+                {% include "forms/report_form_fields.html" %}
+
+                {% if show_listed_report_names %}
+                    {% include "partials/report_names_header.html" %}
+                    {% include "partials/report_names_form.html" %}
+
+                    <button type="submit" form="generate_report">
+                        {% translate "Generate report" %}<span class="icon ti-chevron-right" aria-hidden="true"></span>
+                    </button>
+                {% endif %}
+                {% if is_scheduled_report %}
+                    {% include "partials/report_names_header.html" %}
+                    {% include "partials/form/fieldset.html" with fields=report_parent_name_form %}
+
+                    {% if reports|length > 1 %}
+                        {% include "partials/form/fieldset.html" with fields=report_child_name_form %}
 
-                    {% translate "Generate report" %}<span class="icon ti-chevron-right" aria-hidden="true"></span>
-                </button>
+                    {% endif %}
+                    <button type="submit" form="generate_report">
+                        {% translate "Generate report" %}<span class="icon ti-chevron-right" aria-hidden="true"></span>
+                    </button>
+                {% endif %}
             </form>
         {% else %}
             {% include "partials/return_button.html" with btn_text="Go back" %}
@@ -79,5 +63,6 @@ <h2>{% translate "Report name" %}</h2>
 {% block html_at_end_body %}
     {% compress js %}
         <script src="{% static "js/renameReports.js" %}" nonce="{{ request.csp_nonce }}" type="module"></script>
+        <script src="{% static "js/autoSubmit.js" %}" nonce="{{ request.csp_nonce }}" type="module"></script>
     {% endcompress %}
 {% endblock html_at_end_body %}

rocky/reports/templates/partials/report_names_form.html

@@ -0,0 +1,52 @@
+{% load i18n %}
+{% load static %}
+{% load report_extra %}
+{% load ooi_extra %}
+{% load compress %}
+
+<table id="report-name-table">
+    <caption class="visually-hidden">{% translate "Report names:" %}</caption>
+    <thead>
+        <tr>
+            <th scope="col" colspan="2">
+                {% translate "Name" %} <span class="nota-bene" aria-hidden>{% translate "(Required)" %}</span>
+            </th>
+            <th scope="col">{% translate "Add reference date" %}</th>
+        </tr>
+    </thead>
+    <tbody>
+        {% for report_name in reports %}
+            {% with report_id=report_name|slugify %}
+                <input type="hidden" name="old_report_name" value="{{ report_name }}" />
+                <tr>
+                    <td>
+                        <div>
+                            <input id="{{ report_id }}"
+                                   class="name-input"
+                                   name="report_name"
+                                   type="text"
+                                   value="{{ report_name }}"
+                                   required
+                                   minlength="3" />
+                        </div>
+                    </td>
+                    <td>
+                        <button type="button"
+                                class="icon ti-arrow-back-up action-button reset-button hidden"
+                                aria-label="{% translate "Reset" %}"></button>
+                    </td>
+                    <td>
+                        <select class="reference-date" name="reference_date">
+                            <option value="">{% translate "No reference date" %}</option>
+                            <option value="%b %d %Y, %H:%M">{% translate "Day" %} ({{ created_at|date:"N jS Y, H:i" }})</option>
+                            <option value="week">{% translate "Week" %} ({% translate "Week" %} {{ created_at|date:"W, Y" }})</option>
+                            <option value="%b, %Y">{% translate "Month" %} ({{ created_at|date:"N, Y" }})</option>
+                            <option value="%Y">{% translate "Year" %} ({{ created_at|date:"Y" }})</option>
+                        </select>
+                    </td>
+                </tr>
+            {% endwith %}
+        {% endfor %}
+    </tbody>
+</table>
+{% csrf_token %}

rocky/reports/templates/partials/report_names_header.html

@@ -0,0 +1,11 @@
+{% load i18n %}
+{% load static %}
+
+<h2>{% translate "Report name" %}</h2>
+<p>
+    {% blocktranslate trimmed %}
+        Give your report a custom name and optionally add the reports' reference date
+        to the name. To do so you can select a standard option or use a <a href="https://strftime.org/" target="_blank">Python
+        strftime code</a> in the report name.
+    {% endblocktranslate %}
+</p>