[#1427] Implemented OpenZaak status translation

Author: Bart van der Schoor

src/open_inwoner/cms/cases/views/mixins.py

@@ -19,7 +19,7 @@
     fetch_single_case_type,
     fetch_single_status_type,
 )
-from open_inwoner.openzaak.models import OpenZaakConfig
+from open_inwoner.openzaak.models import OpenZaakConfig, StatusTranslation
 from open_inwoner.openzaak.utils import format_zaak_identificatie, is_zaak_visible
 from open_inwoner.utils.mixins import PaginationMixin
 from open_inwoner.utils.views import LogMixin
@@ -141,6 +141,7 @@ def get_cases(self) -> List[Zaak]:
     def process_cases(self, cases: List[Zaak]) -> List[dict]:
         # Prepare data for frontend
         config = OpenZaakConfig.get_solo()
+        status_translate = StatusTranslation.objects.get_lookup()
 
         updated_cases = []
         for case in cases:
@@ -150,7 +151,7 @@ def process_cases(self, cases: List[Zaak]) -> List[dict]:
                 "start_date": case.startdatum,
                 "end_date": getattr(case, "einddatum", None),
                 "description": case.zaaktype.omschrijving,
-                "current_status": glom(
+                "current_status": status_translate.from_glom(
                     case, "status.statustype.omschrijving", default=""
                 ),
             }

src/open_inwoner/cms/cases/views/status.py

@@ -23,7 +23,7 @@
     create_klant,
     fetch_klant_for_bsn,
 )
-from open_inwoner.openzaak.api_models import Zaak
+from open_inwoner.openzaak.api_models import Status, Zaak
 from open_inwoner.openzaak.cases import (
     connect_case_with_document,
     fetch_case_information_objects,
@@ -41,6 +41,7 @@
 )
 from open_inwoner.openzaak.models import (
     OpenZaakConfig,
+    StatusTranslation,
     ZaakTypeConfig,
     ZaakTypeInformatieObjectTypeConfig,
 )
@@ -49,6 +50,7 @@
     get_role_name_display,
     is_info_object_visible,
 )
+from open_inwoner.utils.translate import TranslationLookup
 from open_inwoner.utils.views import CommonPageMixin, LogMixin
 
 from ..forms import CaseContactForm, CaseUploadForm
@@ -110,6 +112,7 @@ def get_context_data(self, **kwargs):
         if self.case:
             self.log_case_access(self.case.identificatie)
             config = OpenZaakConfig.get_solo()
+            status_translate = StatusTranslation.objects.get_lookup()
 
             documents = self.get_case_document_files(self.case)
 
@@ -147,12 +150,12 @@ def get_context_data(self, **kwargs):
                     self.case, "uiterlijke_einddatum_afdoening", None
                 ),
                 "description": self.case.zaaktype.omschrijving,
-                "current_status": glom(
+                "current_status": status_translate.from_glom(
                     self.case,
                     "status.statustype.omschrijving",
                     default=_("No data available"),
                 ),
-                "statuses": statuses,
+                "statuses": self.get_statuses_data(statuses, status_translate),
                 "documents": documents,
                 "allowed_file_extensions": sorted(config.allowed_file_extensions),
             }
@@ -221,6 +224,19 @@ def get_initiator_display(self, case: Zaak) -> str:
             return ""
         return ", ".join([get_role_name_display(r) for r in roles])
 
+    def get_statuses_data(
+        self, statuses: List[Status], lookup: TranslationLookup
+    ) -> List[dict]:
+        return [
+            {
+                "date": s.datum_status_gezet,
+                "label": lookup.from_glom(
+                    s, "statustype.omschrijving", default=_("No data available")
+                ),
+            }
+            for s in statuses
+        ]
+
     def get_case_document_files(self, case: Zaak) -> List[SimpleFile]:
         case_info_objects = fetch_case_information_objects(case.url)
 

src/open_inwoner/openzaak/admin.py

@@ -1,19 +1,23 @@
 from django.contrib import admin, messages
 from django.core.exceptions import ValidationError
-from django.db.models import BooleanField, Count, Exists, ExpressionWrapper, Q
+from django.db.models import BooleanField, Count, ExpressionWrapper, Q
 from django.forms.models import BaseInlineFormSet
 from django.utils.translation import gettext_lazy as _, ngettext
 
+from import_export.admin import ImportExportMixin
+from import_export.formats import base_formats
 from solo.admin import SingletonModelAdmin
 
 from .models import (
     CatalogusConfig,
     OpenZaakConfig,
+    StatusTranslation,
     UserCaseInfoObjectNotification,
     UserCaseStatusNotification,
     ZaakTypeConfig,
     ZaakTypeInformatieObjectTypeConfig,
 )
+from .resources.import_resource import StatusTranslationImportResource
 
 
 @admin.register(OpenZaakConfig)
@@ -316,3 +320,29 @@ class UserCaseInfoObjectNotificationAdmin(admin.ModelAdmin):
 
     def has_change_permission(self, request, obj=None):
         return False
+
+
+@admin.register(StatusTranslation)
+class StatusTranslationAdmin(ImportExportMixin, admin.ModelAdmin):
+    fields = [
+        "status",
+        "translation",
+    ]
+    search_fields = [
+        "status",
+        "translation",
+    ]
+    list_display = [
+        "id",
+        "status",
+        "translation",
+    ]
+    list_editable = [
+        "status",
+        "translation",
+    ]
+    ordering = ("status",)
+
+    # import-export
+    resource_class = StatusTranslationImportResource
+    formats = [base_formats.XLSX, base_formats.CSV]

src/open_inwoner/openzaak/managers.py

@@ -4,7 +4,8 @@
 from django.db import IntegrityError, models, transaction
 
 from open_inwoner.accounts.models import User
-from open_inwoner.openzaak.api_models import Zaak, ZaakType
+from open_inwoner.openzaak.api_models import ZaakType
+from open_inwoner.utils.translate import TranslationLookup
 
 if TYPE_CHECKING:
     from open_inwoner.openzaak.models import (
@@ -148,3 +149,8 @@ def filter_questions_enabled_for_case_type(self, case_type: ZaakType):
             return self.none()
 
         return self.filter_case_type(case_type).filter(questions_enabled=True)
+
+
+class StatusTranslationQuerySet(models.QuerySet):
+    def get_lookup(self):
+        return TranslationLookup(self.values_list("status", "translation"))

src/open_inwoner/openzaak/migrations/0021_statustranslation.py

@@ -0,0 +1,44 @@
+# Generated by Django 3.2.20 on 2023-08-25 08:07
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        (
+            "openzaak",
+            "0020_rename_contact_moments_enabled_zaaktypeconfig_contact_form_enabled",
+        ),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="StatusTranslation",
+            fields=[
+                (
+                    "id",
+                    models.AutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                (
+                    "status",
+                    models.CharField(
+                        max_length=255, unique=True, verbose_name="Status tekst"
+                    ),
+                ),
+                (
+                    "translation",
+                    models.CharField(max_length=255, verbose_name="Vertaling"),
+                ),
+            ],
+            options={
+                "verbose_name": "Status vertaling",
+                "verbose_name_plural": "Status vertalingen",
+            },
+        ),
+    ]

src/open_inwoner/openzaak/models.py

@@ -10,6 +10,7 @@
 from zgw_consumers.constants import APITypes
 
 from open_inwoner.openzaak.managers import (
+    StatusTranslationQuerySet,
     UserCaseInfoObjectNotificationManager,
     UserCaseStatusNotificationManager,
     ZaakTypeConfigQueryset,
@@ -346,3 +347,21 @@ class Meta:
                 fields=["user", "case_uuid", "zaak_info_object_uuid"],
             )
         ]
+
+
+class StatusTranslation(models.Model):
+    status = models.CharField(
+        verbose_name=_("Status tekst"),
+        max_length=255,
+        unique=True,
+    )
+    translation = models.CharField(
+        verbose_name=_("Vertaling"),
+        max_length=255,
+    )
+
+    objects = StatusTranslationQuerySet.as_manager()
+
+    class Meta:
+        verbose_name = _("Status vertaling")
+        verbose_name_plural = _("Status vertalingen")

src/open_inwoner/openzaak/resources/__init__.py

@@ -0,0 +1,33 @@
+from django.utils.translation import ugettext_lazy as _
+
+from import_export import fields, resources
+from import_export.exceptions import ImportExportError
+
+from open_inwoner.openzaak.models import StatusTranslation
+
+
+class StatusTranslationImportResource(resources.ModelResource):
+    def before_import(self, dataset, using_transactions, dry_run, **kwargs):
+        # Validate that file contains all the headers
+        missing_headers = set(self.get_diff_headers()) - set(dataset.headers)
+        if missing_headers:
+            missing_headers = ",\n".join(missing_headers)
+            raise ImportExportError(_(f"Missing required headers: {missing_headers}"))
+
+        return super().before_import(dataset, using_transactions, dry_run, **kwargs)
+
+    def get_or_init_instance(self, instance_loader, row):
+        # Replace newlines from excel
+        for key, value in row.items():
+            if isinstance(value, str):
+                row[key] = value.replace("_x000D_", "\n")
+
+        return super().get_or_init_instance(instance_loader, row)
+
+    status = fields.Field(column_name="status", attribute="status")
+    translation = fields.Field(column_name="translation", attribute="translation")
+
+    class Meta:
+        model = StatusTranslation
+        import_id_fields = ("status",)
+        fields = ("status", "translation")

src/open_inwoner/openzaak/resources/import_resource.py

@@ -11,6 +11,7 @@
 from open_inwoner.openzaak.api_models import Notification, Rol, ZaakType
 from open_inwoner.openzaak.models import (
     CatalogusConfig,
+    StatusTranslation,
     ZaakTypeConfig,
     ZaakTypeInformatieObjectTypeConfig,
 )
@@ -120,6 +121,14 @@ class Meta:
         model = Notification
 
 
+class StatusTranslationFactory(factory.django.DjangoModelFactory):
+    status = factory.Faker("pystr", max_chars=50)
+    translation = factory.Faker("pystr", max_chars=80)
+
+    class Meta:
+        model = StatusTranslation
+
+
 def generate_rol(
     type_: str,
     identification: dict,

src/open_inwoner/openzaak/tests/factories.py

@@ -24,6 +24,7 @@
 from open_inwoner.accounts.tests.factories import UserFactory
 from open_inwoner.cms.cases.views.status import SimpleFile
 from open_inwoner.openzaak.tests.factories import (
+    StatusTranslationFactory,
     ZaakTypeConfigFactory,
     ZaakTypeInformatieObjectTypeConfigFactory,
 )
@@ -350,6 +351,8 @@ def _setUpMocks(self, m):
         )
 
     def test_status_is_retrieved_when_user_logged_in_via_digid(self, m):
+        self.maxDiff = None
+
         self._setUpMocks(m)
         status_new_obj, status_finish_obj = factory(
             Status, [self.status_new, self.status_finish]
@@ -370,7 +373,16 @@ def test_status_is_retrieved_when_user_logged_in_via_digid(self, m):
                 "end_date_legal": datetime.date(2022, 1, 5),
                 "description": "Coffee zaaktype",
                 "current_status": "Finish",
-                "statuses": [status_new_obj, status_finish_obj],
+                "statuses": [
+                    {
+                        "date": datetime.datetime(2021, 1, 12),
+                        "label": "Initial request",
+                    },
+                    {
+                        "date": datetime.datetime(2021, 3, 12),
+                        "label": "Finish",
+                    },
+                ],
                 # only one visible information object
                 "documents": [self.informatie_object_file],
                 "initiator": "Foo Bar van der Bazz",
@@ -407,6 +419,24 @@ def test_page_reformats_zaak_identificatie(self, m):
 
         spy_format.assert_called_once()
 
+    def test_page_translates_statuses(self, m):
+        st1 = StatusTranslationFactory(
+            status=self.status_type_new["omschrijving"],
+            translation="Translated First Status Type",
+        )
+        st2 = StatusTranslationFactory(
+            status=self.status_type_finish["omschrijving"],
+            translation="Translated Second Status Type",
+        )
+        self._setUpMocks(m)
+        response = self.app.get(
+            self.case_detail_url, user=self.user, headers={"HX-Request": "true"}
+        )
+        self.assertNotContains(response, st1.status)
+        self.assertNotContains(response, st2.status)
+        self.assertContains(response, st1.translation)
+        self.assertContains(response, st2.translation)
+
     def test_when_accessing_case_detail_a_timelinelog_is_created(self, m):
         self._setUpMocks(m)