291348 and 291349: Enhance batch administration functionality and templates

src/country_workspace/admin/base.py

@@ -1,11 +1,23 @@
 from admin_extra_buttons.mixins import ExtraButtonsMixin
 from adminfilters.mixin import AdminAutoCompleteSearchMixin, AdminFiltersMixin
 from django.contrib import admin
+from django import forms
+
 from adminactions import actions
 
 
 class BaseModelAdmin(ExtraButtonsMixin, AdminAutoCompleteSearchMixin, AdminFiltersMixin, admin.ModelAdmin):
-    pass
+    @property
+    def media(self) -> forms.Media:
+        base = super().media
+        return base + forms.Media(
+            js=[],
+            css={
+                "screen": [
+                    "admin/admin_extra.css",
+                ],
+            },
+        )
 
 
 actions.add_to_site(admin.site)

src/country_workspace/admin/batch.py

@@ -1,9 +1,12 @@
 from admin_extra_buttons.buttons import LinkButton
-from admin_extra_buttons.decorators import link
+from admin_extra_buttons.decorators import button, link
 from adminfilters.autocomplete import AutoCompleteFilter, LinkedAutoCompleteFilter
 from django.contrib import admin
-from django.http import HttpRequest
+from django.db.models import QuerySet
+from django.http import HttpRequest, HttpResponse
+from django.shortcuts import render
 from django.urls import reverse
+from django.utils.translation import gettext as _
 
 from ..models import Batch
 from .base import BaseModelAdmin
@@ -24,14 +27,59 @@ class BatchAdmin(BaseModelAdmin):
     search_fields = ("name",)
     ordering = ("-import_date",)
 
+    def get_queryset(self, request: HttpRequest) -> QuerySet[Batch]:
+        return super().get_queryset(request).select_related("program", "program__beneficiary_group", "country_office")
+
     def has_add_permission(self, request: HttpRequest) -> bool:
         return False
 
+    def _get_beneficiary_labels(self, batch: Batch) -> tuple[str, str]:
+        if batch.program.beneficiary_group:
+            beneficiary_group = batch.program.beneficiary_group
+            group_label = beneficiary_group.group_label_plural or beneficiary_group.group_label or _("Household")
+            member_label = beneficiary_group.member_label_plural or beneficiary_group.member_label or _("Individual")
+            return group_label, member_label
+        return _("Household"), _("Individual")
+
+    @button(change_list=False, label="All Beneficiaries")
+    def beneficiaries(self, request: HttpRequest, pk: str) -> HttpResponse:
+        batch: Batch = self.get_object(request, pk)
+        households = batch.household_set.all()
+        individuals = batch.individual_set.all()
+        context = {
+            "batch": batch,
+            "households": households,
+            "individuals": individuals,
+            **self.admin_site.each_context(request),
+            "opts": self.model._meta,
+        }
+        return render(request, "admin/country_workspace/batch_beneficiaries.html", context)
+
+    @link(change_list=False)
+    def households(self, button: LinkButton) -> None:
+        obj: Batch = button.context["original"]
+
+        if not obj.household_set.exists():
+            button.visible = False
+            return
+
+        if obj.program and obj.program.beneficiary_group:
+            if not obj.program.beneficiary_group.master_detail:
+                button.visible = False
+                return
+
+            group_label, _ = self._get_beneficiary_labels(obj)
+            button.label = group_label
+        base = reverse("admin:country_workspace_household_changelist")
+        button.href = f"{base}?batch__exact={obj.pk}"
+
     @link(change_list=False)
-    def members(self, button: LinkButton) -> None:
+    def individuals(self, button: LinkButton) -> None:
+        obj: Batch = button.context["original"]
+        _, member_label = self._get_beneficiary_labels(obj)
+        button.label = member_label
         base = reverse("admin:country_workspace_individual_changelist")
-        obj = button.context["original"]
-        button.href = f"{base}?household__exact={obj.pk}"
+        button.href = f"{base}?batch__exact={obj.pk}"
 
     @link(change_list=True, change_form=False)
     def view_in_workspace(self, btn: "LinkButton") -> None:

src/country_workspace/admin/household.py

@@ -1,6 +1,6 @@
 from admin_extra_buttons.buttons import LinkButton
 from admin_extra_buttons.decorators import button, link
-from adminfilters.filters import LinkedAutoCompleteFilter
+from adminfilters.filters import LinkedAutoCompleteFilter, AutoCompleteFilter
 from django.contrib import admin, messages
 from django.urls import reverse
 from django.utils.translation import gettext as _
@@ -20,6 +20,7 @@ class HouseholdAdmin(BaseModelAdmin):
         ("batch__country_office", LinkedAutoCompleteFilter.factory(parent=None)),
         ("batch__program", LinkedAutoCompleteFilter.factory(parent="batch__country_office")),
         ("batch", LinkedAutoCompleteFilter.factory(parent="batch__program")),
+        ("batch", AutoCompleteFilter),
         IsValidFilter,
         "removed",
     )

src/country_workspace/admin/individual.py

@@ -1,7 +1,7 @@
 from typing import TYPE_CHECKING
 
 from admin_extra_buttons.decorators import link
-from adminfilters.autocomplete import LinkedAutoCompleteFilter
+from adminfilters.autocomplete import LinkedAutoCompleteFilter, AutoCompleteFilter
 from django.contrib import admin
 from django.urls import reverse
 
@@ -23,6 +23,7 @@ class IndividualAdmin(BaseModelAdmin):
         ("batch__country_office", LinkedAutoCompleteFilter.factory(parent=None)),
         ("batch__program", LinkedAutoCompleteFilter.factory(parent="batch__country_office")),
         ("batch", LinkedAutoCompleteFilter.factory(parent="batch__program")),
+        ("batch", AutoCompleteFilter),
         IsValidFilter,
         "removed",
     )

src/country_workspace/web/static/admin/admin_extra.css

@@ -0,0 +1,26 @@
+.object-tools select.aeb-button {
+    margin: 0;
+    padding:.2rem .1rem .2rem .3rem; /* top right bottom left */
+    height: 1.6rem;
+    line-height: 1.25rem;
+
+    background: var(--object-tools-bg);
+    color: var(--object-tools-fg);
+
+    font: 400 .7rem/1.25rem var(--font-family-primary);
+    text-transform: uppercase;
+
+    border: 0;
+    border-radius: 1rem;
+    cursor: pointer;
+    vertical-align: middle;
+}
+
+.object-tools select.aeb-button:hover {
+    background: var(--object-tools-hover-bg);
+}
+
+.object-tools select.aeb-button option {
+    background: var(--object-tools-bg);
+    color: var(--object-tools-fg);
+}

src/country_workspace/web/templates/admin/country_workspace/batch_beneficiaries.html

@@ -0,0 +1,118 @@
+{% extends "admin/base_site.html" %}
+{% load i18n admin_urls static %}
+{% block breadcrumbs %}
+    <div class="breadcrumbs">
+        <a href="{% url 'admin:index' %}">{% trans 'Home' %}</a>
+        &rsaquo; <a href="{% url 'admin:app_list' app_label=opts.app_label %}">{{ opts.app_config.verbose_name }}</a>
+        &rsaquo; <a href="{% url opts|admin_urlname:'changelist' %}">{{ opts.verbose_name_plural|capfirst }}</a>
+        &rsaquo; <a href="{% url opts|admin_urlname:'change' batch.pk %}">{{ batch|truncatewords:"18" }}</a>
+        &rsaquo; {% trans 'Beneficiaries' %}
+    </div>
+{% endblock %}
+{% block content %}
+    <div id="content-main">
+        <h1>
+            {% trans 'Beneficiaries for Batch' %}: {{ batch }}
+        </h1>
+        <div class="module">
+            <h2>
+                {% trans 'Households' %} ({{ households.count }})
+            </h2>
+            {% if households %}
+                <table style="width: 100%;">
+                    <thead>
+                        <tr>
+                            <th>
+                                {% trans 'Name' %}
+                            </th>
+                            <th>
+                                {% trans 'ID' %}
+                            </th>
+                            <th>
+                                {% trans 'Status' %}
+                            </th>
+                        </tr>
+                    </thead>
+                    <tbody>
+                        {% for hh in households %}
+                            <tr class="{% cycle 'row1' 'row2' %}">
+                                <td>
+                                    <a href="{% url 'admin:country_workspace_household_change' hh.pk %}">{{ hh.name }}</a>
+                                </td>
+                                <td>
+                                    {{ hh.pk }}
+                                </td>
+                                <td>
+                                    {% if hh.removed %}
+                                        <span style="color: red;">{% trans 'Removed' %}</span>
+                                    {% else %}
+                                        <span style="color: green;">{% trans 'Active' %}</span>
+                                    {% endif %}
+                                </td>
+                            </tr>
+                        {% endfor %}
+                    </tbody>
+                </table>
+            {% else %}
+                <p>
+                    {% trans 'No households found.' %}
+                </p>
+            {% endif %}
+        </div>
+        <div class="module">
+            <h2>
+                {% trans 'Individuals' %} ({{ individuals.count }})
+            </h2>
+            {% if individuals %}
+                <table style="width: 100%;">
+                    <thead>
+                        <tr>
+                            <th>
+                                {% trans 'Name' %}
+                            </th>
+                            <th>
+                                {% trans 'ID' %}
+                            </th>
+                            <th>
+                                {% trans 'Household' %}
+                            </th>
+                            <th>
+                                {% trans 'Status' %}
+                            </th>
+                        </tr>
+                    </thead>
+                    <tbody>
+                        {% for ind in individuals %}
+                            <tr class="{% cycle 'row1' 'row2' %}">
+                                <td>
+                                    <a href="{% url 'admin:country_workspace_individual_change' ind.pk %}">{{ ind.name }}</a>
+                                </td>
+                                <td>
+                                    {{ ind.pk }}
+                                </td>
+                                <td>
+                                    {% if ind.household %}
+                                        <a href="{% url 'admin:country_workspace_household_change' ind.household.pk %}">{{ ind.household.name }}</a>
+                                    {% else %}
+                                        -
+                                    {% endif %}
+                                </td>
+                                <td>
+                                    {% if ind.removed %}
+                                        <span style="color: red;">{% trans 'Removed' %}</span>
+                                    {% else %}
+                                        <span style="color: green;">{% trans 'Active' %}</span>
+                                    {% endif %}
+                                </td>
+                            </tr>
+                        {% endfor %}
+                    </tbody>
+                </table>
+            {% else %}
+                <p>
+                    {% trans 'No individuals found.' %}
+                </p>
+            {% endif %}
+        </div>
+    </div>
+{% endblock %}

src/country_workspace/web/templates/admin/country_workspace/reprocess_confirmation.html

@@ -9,7 +9,7 @@
     </div>
 {% endblock breadcrumbs %}
 {% block content %}
-    <form action="" method="post">
+    <form action="" method="post" id="reprocess-form">
         {% csrf_token %}
         <div>
             <p>

src/country_workspace/workspaces/admin/batch.py

@@ -98,6 +98,18 @@ def imported_records(self, btn: LinkButton) -> None:
         base = reverse("workspace:workspaces_countryhousehold_changelist")
         obj = btn.context["original"]
         btn.href = f"{base}?batch__exact={obj.pk}"
+        if obj.program.beneficiary_group:
+            btn.label = obj.program.beneficiary_group.group_label
+            if not obj.program.beneficiary_group.master_detail:
+                btn.visible = False
+
+    @link(change_list=False, html_attrs={"title": "Shows related Individual records."})
+    def imported_individuals(self, btn: LinkButton) -> None:
+        base = reverse("workspace:workspaces_countryindividual_changelist")
+        obj = btn.context["original"]
+        btn.href = f"{base}?batch__exact={obj.pk}"
+        if obj.program.beneficiary_group:
+            btn.label = obj.program.beneficiary_group.member_label
 
     @button(
         change_list=False,