Fix stored filter controls

.. also added the name of each involved template to that template as an
html comment, for ease of debugging.

Author: hmpf

src/argus/htmx/incident/filter.py

@@ -15,6 +15,9 @@
 QuerySetFilter = filter_backend.QuerySetFilter
 LOG = logging.getLogger(__name__)
 
+MIN_LEVEL = min(Level).value
+MAX_LEVEL = max(Level).value
+
 
 class RangeInput(forms.NumberInput):
     template_name = "django/forms/widgets/range.html"
@@ -53,9 +56,9 @@ class IncidentFilterForm(forms.Form):
         help_text='Press "Enter" after each completed tag',
     )
     maxlevel = forms.IntegerField(
-        widget=RangeInput(attrs={"step": "1", "min": min(Level).value, "max": max(Level).value}),
+        widget=RangeInput(attrs={"step": "1", "min": MIN_LEVEL, "max": MAX_LEVEL}),
         label="Level <=",
-        initial=max(Level).value,
+        initial=MAX_LEVEL,
         required=False,
     )
 
@@ -64,7 +67,7 @@ class IncidentFilterForm(forms.Form):
         "acked": None,
         "sourceSystemIds": [],
         "tags": "",
-        "maxlevel": max(Level).value,
+        "maxlevel": MAX_LEVEL,
     }
 
     def __init__(self, *args, **kwargs):
@@ -117,9 +120,13 @@ def to_filterblob(self):
 
         filterblob = {}
 
-        filterblob["open"] = self._open_tristate()
+        open = self._open_tristate()
+        if open is not None:
+            filterblob["open"] = open
 
-        filterblob["acked"] = self._acked_tristate()
+        acked = self._acked_tristate()
+        if acked is not None:
+            filterblob["acked"] = acked
 
         sourceSystemIds = self.cleaned_data.get("sourceSystemIds", [])
         if sourceSystemIds:
@@ -129,7 +136,7 @@ def to_filterblob(self):
         if tags:
             filterblob["tags"] = [tag.strip() for tag in tags.split(",")]
 
-        maxlevel = self.cleaned_data.get("maxlevel", 0)
+        maxlevel = self.cleaned_data.get("maxlevel", MAX_LEVEL)
         if maxlevel:
             filterblob["maxlevel"] = maxlevel
 
@@ -193,6 +200,7 @@ def incident_list_filter(request, qs, use_empty_filter=False):
 
 def _convert_filterblob(filterblob):
     """Converts values in filterblob so it can be used as valid input for IncidentFilterForm"""
+    filterblob = filterblob.copy()
     if "tags" in filterblob.keys():
         filterblob["tags"] = ", ".join(filterblob["tags"])
 

src/argus/htmx/incident/views.py

@@ -113,10 +113,26 @@ def incident_update(request: HtmxHttpRequest, action: str):
     return HttpResponseClientRefresh()
 
 
+def set_selected_filter(request, filter_obj):
+    if filter_obj:
+        request.session["selected_filter_pk"] = str(filter_obj.pk)
+        request.session["selected_filter_name"] = filter_obj.name
+    else:
+        request.session["selected_filter_pk"] = None
+        request.session.pop("selected_filter_name", None)
+
+
+def get_selected_filter(request):
+    filter_id = request.session.get("selected_filter_pk", None)
+    if filter_id:
+        return get_object_or_404(Filter, pk=filter_id, user=request.user)
+    return None
+
+
 @require_GET
 def filter_form(request: HtmxHttpRequest):
+    set_selected_filter(request, None)
     LOG = logging.getLogger(__name__ + ".filter_form")
-    request.session["selected_filter"] = None
     incident_list_filter = get_filter_function()
     filter_form, _ = incident_list_filter(request, None)
     context = {"filter_form": filter_form}
@@ -135,7 +151,7 @@ def create_filter(request: HtmxHttpRequest):
         filterblob = filter_form.to_filterblob()
         _, filter_obj = create_named_filter(request, filter_name, filterblob)
         if filter_obj:
-            request.session["selected_filter"] = str(filter_obj.id)
+            set_selected_filter(request, filter_obj)
             return HttpResponseClientRefresh()
     messages.error(request, "Failed to create filter")
     return HttpResponseBadRequest()
@@ -152,11 +168,12 @@ def update_filter(request: HtmxHttpRequest, pk: int):
         filter_obj.save()
 
         # Immediately select the newly updated filter - keep or not?
-        # request.session["selected_filter"] = str(filter_obj.id)
+        # set_selected_filter(request, filter_obj)
 
         messages.success(request, f"Updated filter '{filter_obj.name}'.")
         return HttpResponseClientRefresh()
-    messages.error(request, f"Failed to update filter '{filter_obj.name}'.")
+    errors = f": {filter_form.errors}" if filter_form.errors else ""
+    messages.error(request, f'Failed to update filter "{filter_obj.name}": {errors}')
     return HttpResponseBadRequest()
 
 
@@ -166,8 +183,8 @@ def delete_filter(request: HtmxHttpRequest, pk: int):
     deleted_id = filter_obj.delete()
     if deleted_id:
         messages.success(request, f"Deleted filter {filter_obj.name}.")
-        if request.session.get("selected_filter") == str(pk):
-            request.session["selected_filter"] = None
+        if request.session.get("selected_filter_pk") == str(pk):
+            set_selected_filter(request, None)
         return HttpResponseClientRefresh()
 
 
@@ -185,22 +202,25 @@ def get_existing_filters(request: HtmxHttpRequest):
 
 @require_GET
 def filter_select(request: HtmxHttpRequest):
+    context = {}
+    template_name = "htmx/incident/_incident_list_filter_incidents.html"
+
     filter_id = request.GET.get("filter", None)
-    if filter_id and get_object_or_404(Filter, id=filter_id):
-        request.session["selected_filter"] = filter_id
-        incident_list_filter = get_filter_function()
-        filter_form, _ = incident_list_filter(request, None)
-        context = {"filter_form": filter_form}
-        return render(request, "htmx/incident/_incident_filterbox.html", context=context)
+    if filter_id:
+        use_empty_filter = False
+        filter_obj = get_object_or_404(Filter, id=filter_id)
+        set_selected_filter(request, filter_obj)
     else:
-        request.session["selected_filter"] = None
-        if request.htmx.trigger:
-            incident_list_filter = get_filter_function()
-            filter_form, _ = incident_list_filter(request, None, use_empty_filter=True)
-            context = {"filter_form": filter_form}
-            return render(request, "htmx/incident/_incident_filterbox.html", context=context)
-        else:
-            return retarget(HttpResponse(), "#incident-filter-select")
+        use_empty_filter = True
+        set_selected_filter(request, None)
+
+    if request.htmx.trigger:
+        incident_list_filter = get_filter_function()
+        filter_form, _ = incident_list_filter(request, None, use_empty_filter=use_empty_filter)
+        context["filter_form"] = filter_form
+        return render(request, template_name, context=context)
+
+    return retarget(HttpResponse(), "#incident-filter-select")
 
 
 def dedupe_querydict(querydict: QueryDict):
@@ -254,6 +274,10 @@ def incident_list(request: HtmxHttpRequest) -> HttpResponse:
     total_count = qs.count()
     last_refreshed = make_aware(datetime.now())
 
+    # Stored filters
+    existing_filters = Filter.objects.filter(user=request.user)
+
+    # Get filters storable in Filter.filter
     incident_list_filter = get_filter_function()
     filter_form, qs = incident_list_filter(request, qs)
 
@@ -305,12 +329,19 @@ def incident_list(request: HtmxHttpRequest) -> HttpResponse:
 
     LOG.debug("GET at end: %s", request.GET)
     context = {
-        "columns": columns,
+        "page_title": "Incidents",
+        "base": base_template,
+        # filter box
         "filter_form": filter_form,
+        # storing filters
+        "stored_filters": existing_filters,
+        # table
+        "columns": columns,
+        # refresh info
         "refresh_info": refresh_info,
         "refresh_info_forms": GET_forms,
-        "page_title": "Incidents",
-        "base": base_template,
+        "filtered_count": filtered_count,
+        "count": total_count,
         "page": page,
         "last_page_num": last_page_num,
         "second_to_last_page": last_page_num - 1,

src/argus/htmx/templates/htmx/_base_confirm_dialog.html

@@ -1,3 +1,4 @@
+<!-- htmx/_base_confirm_dialog -->
 <!-- This confirmation dialog is a special case of the base form modal that needs its own template.
 It can be used as one of several confirm dialogs in DOM, for example as an item in HTML list.
 In this case the item_id attribute must be provided when extending from this template.

src/argus/htmx/templates/htmx/incident/_delete_filter_confirm_dialog.html

@@ -1,6 +1,16 @@
+<!-- htmx/incident/_filter_controls.html -->
 <div class="join join-horizontal items-center">
   {% include "htmx/incident/_filter_select.html" %}
-  {% include "htmx/incident/_filter_create_modal.html" with dialog_id="create-filter-dialog" button_title="Create filter" button_class="btn-sm text-xs join-item" header="Create new filter" explanation="Create new filter from currently selected filter parameters" cancel_text="Cancel" submit_text="Submit" %}
-  {% include "htmx/incident/_filter_update_dropdown.html" %}
-  {% include "htmx/incident/_filter_delete_dropdown.html" %}
+  {% include "htmx/incident/_filter_create_modal.html" with dialog_id="create-filter-dialog" button_title="Save new" button_class="btn-sm text-xs join-item" header="Create new filter" explanation="Create new filter from currently selected filter parameters" cancel_text="Cancel" submit_text="Submit" %}
+  {% with item_id=request.session.selected_filter_pk item_title=request.session.selected_filter_name item_class="btn btn-sm text-xs join-item rounded-l-none! ml-1" %}
+    {% if request.session.selected_filter_pk %}
+      {% url 'htmx:filter-update' pk=request.session.selected_filter_pk as update_filter_url %}
+      {% include "htmx/incident/_filter_controls_confirm_dialog.html" with filter_url=update_filter_url modal_button_name="Update" dialog_id="filter-update-confirm" action="Update filter" confirmation_message="Are you sure you want to override this filter?" %}
+      {% url 'htmx:filter-delete' pk=request.session.selected_filter_pk as delete_filter_url %}
+      {% include "htmx/incident/_filter_controls_confirm_dialog.html" with filter_url=delete_filter_url modal_button_name="Delete" dialog_id="filter-delete-confirm" action="Delete filter" confirmation_message="Are you sure you want to delete this filter?" %}
+    {% else %}
+      <button class="{{ item_class }}" disabled>Update</button>
+      <button class="{{ item_class }}" disabled>Delete</button>
+    {% endif %}
+  {% endwith %}
 </div>

src/argus/htmx/templates/htmx/incident/_filter_controls.html

@@ -1,5 +1,6 @@
+<!-- htmx/incident/_filter_alter_confirm_dialog.html -->
 {% extends "htmx/_base_confirm_dialog.html" %}
 {% block confirm_action_control %}
-  hx-post="{% url 'htmx:filter-update' pk=filter.id %}"
+  hx-post="{{ filter_url }}"
   hx-include="#incident-filter-box fieldset"
 {% endblock confirm_action_control %}

…ident/_update_filter_confirm_dialog.html …ent/_filter_controls_confirm_dialog.htmlsrc/argus/htmx/templates/htmx/incident/_update_filter_confirm_dialog.html renamed to src/argus/htmx/templates/htmx/incident/_filter_controls_confirm_dialog.html src/argus/htmx/templates/htmx/incident/_update_filter_confirm_dialog.html renamed to src/argus/htmx/templates/htmx/incident/_filter_controls_confirm_dialog.html

@@ -1,3 +1,4 @@
+<!-- htmx/incident/_filter_create_modal.html -->
 {% extends "htmx/_base_form_modal.html" %}
 {% block form_control %}
   hx-post="{% url 'htmx:filter-create' %}"

src/argus/htmx/templates/htmx/incident/_filter_create_modal.html

@@ -1,3 +1,4 @@
+<!-- htmx/incident/_incident_filterbox.html -->
 {% load widget_tweaks %}
 <form id="incident-filter-box"
       class="incident-list-param"