# Testfixes

* fixes test cases

.env.sample

@@ -0,0 +1,46 @@
+# General
+SECRET_KEY=CHANGE_ME
+DEBUG=True
+ALLOWED_HOSTS=127.0.0.1,localhost,example.org
+BASE_URL=http://localhost:8002
+ADMINS=Admin1:mail@example.org,Admin2:mail2@example.org
+
+# Database
+DB_USER=postgres
+DB_PASSWORD=
+DB_NAME=konova
+DB_HOST=127.0.0.1
+DB_PORT=5432
+
+# Redis (for celery)
+REDIS_HOST=CHANGE_ME
+REDIS_PORT=CHANGE_ME
+
+# E-Mail
+SMTP_HOST=localhost
+SMTP_PORT=25
+REPLY_TO_ADDR=ksp-servicestelle@sgdnord.rlp.de
+DEFAULT_FROM_EMAIL=service@ksp.de
+
+# Proxy
+PROXY=CHANGE_ME
+GEOPORTAL_RLP_USER=CHANGE_ME
+GEOPORTAL_RLP_PASSWORD=CHANGE_ME
+
+# Schneider
+SCHNEIDER_BASE_URL=https://schneider.naturschutz.rlp.de
+SCHNEIDER_AUTH_TOKEN=CHANGE_ME
+SCHNEIDER_AUTH_HEADER=auth
+
+# SSO
+SSO_SERVER_BASE_URL=https://login.naturschutz.rlp.de
+OAUTH_CODE_VERIFIER=CHANGE_ME
+OAUTH_CLIENT_ID=CHANGE_ME
+OAUTH_CLIENT_SECRET=CHANGE_ME
+
+# RabbitMQ
+## For connections to EGON
+EGON_RABBITMQ_HOST=CHANGE_ME
+EGON_RABBITMQ_PORT=CHANGE_ME
+EGON_RABBITMQ_USER=CHANGE_ME
+EGON_RABBITMQ_PW=CHANGE_ME

.gitignore

@@ -1,3 +1,6 @@
 # Project exclude paths
 /venv/
-/.idea/
+/.idea/
+/.coverage
+/htmlcov/
+/.env

analysis/forms.py

@@ -13,6 +13,7 @@ from django.utils.translation import gettext_lazy as _
 from codelist.models import KonovaCode
 from codelist.settings import CODELIST_CONSERVATION_OFFICE_ID
 from konova.forms import BaseForm
+from konova.utils import validators
 
 
 class TimespanReportForm(BaseForm):
@@ -22,6 +23,8 @@ class TimespanReportForm(BaseForm):
     date_from = forms.DateField(
         label_suffix="",
         label=_("From"),
+        validators=[validators.reasonable_date],
+        help_text=_("Entries created from..."),
         widget=forms.DateInput(
             attrs={
                 "type": "date",
@@ -34,6 +37,8 @@ class TimespanReportForm(BaseForm):
     date_to = forms.DateField(
         label_suffix="",
         label=_("To"),
+        validators=[validators.reasonable_date],
+        help_text=_("Entries created until..."),
         widget=forms.DateInput(
             attrs={
                 "type": "date",
@@ -53,7 +58,7 @@ class TimespanReportForm(BaseForm):
             code_lists__in=[CODELIST_CONSERVATION_OFFICE_ID],
         ),
         widget=autocomplete.ModelSelect2(
-            url="codes-conservation-office-autocomplete",
+            url="codelist:conservation-office-autocomplete",
             attrs={
                 "data-placeholder": _("Click for selection")
             }

analysis/settings.py

@@ -9,4 +9,8 @@ Created on: 19.10.21
 # Defines the date of the legal publishing of the LKompVzVo
 from django.utils import timezone
 
-LKOMPVZVO_PUBLISH_DATE = timezone.make_aware(timezone.datetime.fromisoformat("2018-06-16"))
+LKOMPVZVO_PUBLISH_DATE = timezone.make_aware(
+    timezone.datetime.fromisoformat(
+        "2018-06-16"
+    )
+).date()

analysis/templates/analysis/reports/detail.html

@@ -3,11 +3,11 @@
 
 {% block body %}
     <div class="row">
-        <div class="col-sm-12 col-md-12 col-lg-6">
+        <div class="col-sm-12 col-md-12 col-lg-12 col-xl-6">
             <h3>{% trans 'Evaluation report' %} {{office.long_name}}</h3>
             <h5>{% trans 'From' %} {{report.date_from.date}} {% trans 'to' %} {{report.date_to.date}}</h5>
         </div>
-        <div class="col-sm-12 col-md-12 col-lg-6">
+        <div class="col-sm-12 col-md-12 col-lg-12 col-xl-6">
             <div class="d-flex justify-content-end">
                 <div class="dropdown">
                     <div class="btn btn" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">
@@ -31,6 +31,6 @@
     {% include 'analysis/reports/includes/intervention/card_intervention.html' %}
     {% include 'analysis/reports/includes/compensation/card_compensation.html' %}
     {% include 'analysis/reports/includes/eco_account/card_eco_account.html' %}
-    {% include 'analysis/reports/includes/old_data/card_old_interventions.html' %}
+    {% include 'analysis/reports/includes/old_data/card_old_data.html' %}
     </div>
 {% endblock %}

analysis/templates/analysis/reports/includes/compensation/amount.html

@@ -15,40 +15,40 @@
         <thead>
         <tr>
             <th scope="col">{% trans 'Area of responsibility' %}</th>
+            <th scope="col">{% trans 'Total' %}</th>
+            <th scope="col">{% trans 'Number single areas' %}</th>
             <th scope="col">{% fa5_icon 'star' %} {% trans 'Checked' %}</th>
             <th scope="col">{% fa5_icon 'bookmark' %} {% trans 'Recorded' %}</th>
-            <th scope="col">{% trans 'Number single areas' %}</th>
-            <th scope="col">{% trans 'Total' %}</th>
         </tr>
         </thead>
         <tbody>
             <tr>
                 <td>{% trans 'Conservation office by law' %}</td>
+                <td>{{report.compensation_report.queryset_registration_office_unb_count|default_if_zero:"-"}}</td>
+                <td>{{report.compensation_report.num_single_surfaces_total_unb|default_if_zero:"-"}}</td>
                 <td>{{report.compensation_report.queryset_registration_office_unb_checked_count|default_if_zero:"-"}}</td>
                 <td>{{report.compensation_report.queryset_registration_office_unb_recorded_count|default_if_zero:"-"}}</td>
-                <td>{{report.compensation_report.num_single_surfaces_total_unb|default_if_zero:"-"}}</td>
-                <td>{{report.compensation_report.queryset_registration_office_unb_count|default_if_zero:"-"}}</td>
             </tr>
             <tr>
                 <td>{% trans 'Land-use planning' %}</td>
+                <td>{{report.compensation_report.queryset_registration_office_tbp_count|default_if_zero:"-"}}</td>
+                <td>{{report.compensation_report.num_single_surfaces_total_tbp|default_if_zero:"-"}}</td>
                 <td>{{report.compensation_report.queryset_registration_office_tbp_checked_count|default_if_zero:"-"}}</td>
                 <td>{{report.compensation_report.queryset_registration_office_tbp_recorded_count|default_if_zero:"-"}}</td>
-                <td>{{report.compensation_report.num_single_surfaces_total_tbp|default_if_zero:"-"}}</td>
-                <td>{{report.compensation_report.queryset_registration_office_tbp_count|default_if_zero:"-"}}</td>
             </tr>
             <tr>
                 <td>{% trans 'Other registration office' %}</td>
+                <td>{{report.compensation_report.queryset_registration_office_other_count|default_if_zero:"-"}}</td>
+                <td>{{report.compensation_report.num_single_surfaces_total_other|default_if_zero:"-"}}</td>
                 <td>{{report.compensation_report.queryset_registration_office_other_checked_count|default_if_zero:"-"}}</td>
                 <td>{{report.compensation_report.queryset_registration_office_other_recorded_count|default_if_zero:"-"}}</td>
-                <td>{{report.compensation_report.num_single_surfaces_total_other|default_if_zero:"-"}}</td>
-                <td>{{report.compensation_report.queryset_registration_office_other_count|default_if_zero:"-"}}</td>
             </tr>
             <tr>
                 <td><strong>{% trans 'Total' %}</strong></td>
+                <td><strong>{{report.compensation_report.queryset_count|default_if_zero:"-"}}</strong></td>
+                <td><strong>{{report.compensation_report.num_single_surfaces_total|default_if_zero:"-"}}</strong></td>
                 <td><strong>{{report.compensation_report.queryset_checked_count|default_if_zero:"-"}}</strong></td>
                 <td><strong>{{report.compensation_report.queryset_recorded_count|default_if_zero:"-"}}</strong></td>
-                <td><strong>{{report.compensation_report.num_single_surfaces_total|default_if_zero:"-"}}</strong></td>
-                <td><strong>{{report.compensation_report.queryset_count|default_if_zero:"-"}}</strong></td>
             </tr>
         </tbody>
     </table>

analysis/templates/analysis/reports/includes/compensation/card_compensation.html

@@ -10,6 +10,7 @@
                                 {% fa5_icon 'leaf' %}
                                 {% trans 'Compensations' %}
                             </h5>
+                            <span>{% trans 'Binding date after' %} 16.06.2018</span>
                         </div>
                     </div>
                 </div>

analysis/templates/analysis/reports/includes/eco_account/amount.html

@@ -10,14 +10,14 @@
     <table class="table table-hover">
         <thead>
             <tr>
-                <th scope="col" class="w-25">{% fa5_icon 'bookmark' %} {% trans 'Recorded' %}</th>
                 <th scope="col">{% trans 'Total' %}</th>
+                <th scope="col" class="w-25">{% fa5_icon 'bookmark' %} {% trans 'Recorded' %}</th>
             </tr>
         </thead>
         <tbody>
             <tr>
-                <td>{{report.eco_account_report.queryset_recorded_count|default_if_zero:"-"}}</td>
                 <td>{{report.eco_account_report.queryset_count|default_if_zero:"-"}}</td>
+                <td>{{report.eco_account_report.queryset_recorded_count|default_if_zero:"-"}}</td>
             </tr>
         </tbody>
     </table>

analysis/templates/analysis/reports/includes/eco_account/card_eco_account.html

@@ -10,6 +10,7 @@
                                 {% fa5_icon 'tree' %}
                                 {% trans 'Eco-Accounts' %}
                             </h5>
+                            <span>{% trans 'Binding date after' %} 16.06.2018</span>
                         </div>
                     </div>
                 </div>

analysis/templates/analysis/reports/includes/eco_account/deductions.html

@@ -1,22 +1,37 @@
 {% load i18n fontawesome_5 ksp_filters %}
 
 <h3>{% trans 'Deductions' %}</h3>
+<strong>
+    {% blocktrans %}
+    Recorded = Counts the deductions whose interventions have been recorded
+    {% endblocktrans %}
+</strong>
 <div class="table-container">
     <table class="table table-hover">
         <thead>
             <tr>
-                <th scope="col">{% fa5_icon 'bookmark' %} {% trans 'Recorded' %}</th>
-                <th scope="col">{% fa5_icon 'bookmark' %} {% trans 'Recorded' %} {% trans 'Surface' %}</th>
                 <th scope="col" class="w-25">{% trans 'Total' %}</th>
                 <th scope="col" class="w-25">{% trans 'Total' %} {% trans 'Surface' %}</th>
+                <th scope="col">{% fa5_icon 'bookmark' %} {% trans 'Recorded' %}</th>
+                <th scope="col">{% fa5_icon 'bookmark' %} {% trans 'Recorded' %} {% trans 'Surface' %}</th>
             </tr>
         </thead>
         <tbody>
             <tr>
-                <td>{{report.eco_account_report.queryset_deductions_recorded_count|default_if_zero:"-"}}</td>
-                <td>{{report.eco_account_report.recorded_deductions_sq_m|default_if_zero:"-"}}m²</td>
                 <td>{{report.eco_account_report.queryset_deductions_count|default_if_zero:"-"}}</td>
-                <td>{{report.eco_account_report.deductions_sq_m|default_if_zero:"-"}}m²</td>
+                <td>
+                    {{report.eco_account_report.deductions_sq_m|default_if_zero:"-"}}
+                    {% if report.eco_account_report.deductions_sq_m > 0 %}
+                        m²
+                    {% endif %}
+                </td>
+                <td>{{report.eco_account_report.queryset_deductions_recorded_count|default_if_zero:"-"}}</td>
+                <td>
+                    {{report.eco_account_report.recorded_deductions_sq_m|default_if_zero:"-"}}
+                    {% if report.eco_account_report.recorded_deductions_sq_m > 0 %}
+                        m²
+                    {% endif %}
+                </td>
             </tr>
         </tbody>
     </table>

analysis/templates/analysis/reports/includes/intervention/amount.html

@@ -14,16 +14,16 @@
     <table class="table table-hover">
         <thead>
             <tr>
+                <th scope="col" class="w-25">{% trans 'Total' %}</th>
                 <th scope="col">{% fa5_icon 'star' %} {% trans 'Checked' %}</th>
                 <th scope="col">{% fa5_icon 'bookmark' %} {% trans 'Recorded' %}</th>
-                <th scope="col" class="w-25">{% trans 'Total' %}</th>
             </tr>
         </thead>
         <tbody>
             <tr>
+                <td>{{report.intervention_report.queryset_count|default_if_zero:"-"}}</td>
                 <td>{{report.intervention_report.queryset_checked_count|default_if_zero:"-"}}</td>
                 <td>{{report.intervention_report.queryset_recorded_count|default_if_zero:"-"}}</td>
-                <td>{{report.intervention_report.queryset_count|default_if_zero:"-"}}</td>
             </tr>
         </tbody>
     </table>

analysis/templates/analysis/reports/includes/intervention/card_intervention.html

@@ -9,6 +9,7 @@
                                 {% fa5_icon 'pencil-ruler' %}
                                 {% trans 'Interventions' %}
                             </h5>
+                            <span>{% trans 'Binding date after' %} 16.06.2018</span>
                         </div>
                     </div>
                 </div>

analysis/templates/analysis/reports/includes/intervention/compensated_by.html

@@ -5,29 +5,29 @@
         <thead>
         <tr>
             <th class="w-25" scope="col">{% trans 'Compensation type' %}</th>
+            <th class="w-25" scope="col">{% trans 'Total' %}</th>
             <th class="w-25" scope="col">{% fa5_icon 'star' %} {% trans 'Checked' %}</th>
             <th class="w-25" scope="col">{% fa5_icon 'bookmark' %} {% trans 'Recorded' %}</th>
-            <th class="w-25" scope="col">{% trans 'Total' %}</th>
         </tr>
         </thead>
         <tbody>
         <tr>
             <th>{% trans 'Compensation' %}</th>
+            <td>{{report.intervention_report.compensation_sum|default_if_zero:"-"}}</td>
             <td>{{report.intervention_report.compensation_sum_checked|default_if_zero:"-"}}</td>
             <td>{{report.intervention_report.compensation_sum_recorded|default_if_zero:"-"}}</td>
-            <td>{{report.intervention_report.compensation_sum|default_if_zero:"-"}}</td>
         </tr>
         <tr>
             <th>{% trans 'Payment' %}</th>
+            <td>{{report.intervention_report.payment_sum|default_if_zero:"-"}}</td>
             <td>{{report.intervention_report.payment_sum_checked|default_if_zero:"-"}}</td>
             <td>{{report.intervention_report.payment_sum_recorded|default_if_zero:"-"}}</td>
-            <td>{{report.intervention_report.payment_sum|default_if_zero:"-"}}</td>
         </tr>
         <tr>
             <th>{% trans 'Deductions' %}</th>
+            <td>{{report.intervention_report.deduction_sum|default_if_zero:"-"}}</td>
             <td>{{report.intervention_report.deduction_sum_checked|default_if_zero:"-"}}</td>
             <td>{{report.intervention_report.deduction_sum_recorded|default_if_zero:"-"}}</td>
-            <td>{{report.intervention_report.deduction_sum|default_if_zero:"-"}}</td>
         </tr>
         </tbody>
     </table>

analysis/templates/analysis/reports/includes/intervention/laws.html

@@ -13,15 +13,15 @@
             <th class="w-25" scope="col">
                 {% trans 'Law' %}
             </th>
+            <th scope="col">
+                {% trans 'Total' %}
+            </th>
             <th scope="col">
                 {% fa5_icon 'star' %} {% trans 'Checked' %}
             </th>
             <th scope="col">
                 {% fa5_icon 'bookmark' %} {% trans 'Recorded' %}
             </th>
-            <th scope="col">
-                {% trans 'Total' %}
-            </th>
         </tr>
         </thead>
         <tbody>
@@ -34,16 +34,16 @@
                     {{law.long_name}}
                 </small>
             </td>
+            <td>{{law.num|default_if_zero:"-"}}</td>
             <td>{{law.num_checked|default_if_zero:"-"}}</td>
             <td>{{law.num_recorded|default_if_zero:"-"}}</td>
-            <td>{{law.num|default_if_zero:"-"}}</td>
         </tr>
         {% endfor %}
         <tr>
             <td><strong>{% trans 'Total' %}</strong></td>
+            <td><strong>{{report.intervention_report.law_sum|default_if_zero:"-"}}</strong></td>
             <td><strong>{{report.intervention_report.law_sum_checked|default_if_zero:"-"}}</strong></td>
             <td><strong>{{report.intervention_report.law_sum_recorded|default_if_zero:"-"}}</strong></td>
-            <td><strong>{{report.intervention_report.law_sum|default_if_zero:"-"}}</strong></td>
         </tr>
         </tbody>
     </table>

analysis/templates/analysis/reports/includes/old_data/amount.html

@@ -14,26 +14,26 @@
     <table class="table table-hover">
         <thead>
             <tr>
-                <th scope="col" class="w-25">{% fa5_icon 'star' %} {% trans 'Type' %}</th>
-                <th scope="col">{% fa5_icon 'bookmark' %} {% trans 'Recorded' %}</th>
+                <th scope="col" class="w-25">{% trans 'Type' %}</th>
                 <th scope="col">{% trans 'Total' %}</th>
+                <th scope="col">{% fa5_icon 'bookmark' %} {% trans 'Recorded' %}</th>
             </tr>
         </thead>
         <tbody>
             <tr>
                 <td>{% trans 'Intervention' %}</td>
-                <td>{{report.old_data_report.queryset_intervention_recorded_count|default_if_zero:"-"}}</td>
                 <td>{{report.old_data_report.queryset_intervention_count|default_if_zero:"-"}}</td>
+                <td>{{report.old_data_report.queryset_intervention_recorded_count|default_if_zero:"-"}}</td>
             </tr>
             <tr>
                 <td>{% trans 'Compensation' %}</td>
-                <td>{{report.old_data_report.queryset_comps_recorded_count|default_if_zero:"-"}}</td>
                 <td>{{report.old_data_report.queryset_comps_count|default_if_zero:"-"}}</td>
+                <td>{{report.old_data_report.queryset_comps_recorded_count|default_if_zero:"-"}}</td>
             </tr>
             <tr>
                 <td>{% trans 'Eco-account' %}</td>
-                <td>{{report.old_data_report.queryset_acc_recorded_count|default_if_zero:"-"}}</td>
                 <td>{{report.old_data_report.queryset_acc_count|default_if_zero:"-"}}</td>
+                <td>{{report.old_data_report.queryset_acc_recorded_count|default_if_zero:"-"}}</td>
             </tr>
         </tbody>
     </table>

analysis/templates/analysis/reports/includes/old_data/card_old_data.html

@@ -10,7 +10,7 @@
                                 {% fa5_icon 'pencil-ruler' %}
                                 {% trans 'Old interventions' %}
                             </h5>
-                            <span>{% trans 'Before' %} 16.06.2018</span>
+                            <span>{% trans 'Binding date before' %} 16.06.2018</span>
                         </div>
                     </div>
                 </div>

analysis/tests.py

@@ -1,3 +0,0 @@
-from django.test import TestCase
-
-# Create your tests here.

analysis/tests/__init__.py

@@ -0,0 +1,7 @@
+"""
+Author: Michel Peltriaux
+Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany
+Contact: ksp-servicestelle@sgdnord.rlp.de
+Created on: 15.08.23
+
+"""

analysis/tests/unit/__init__.py

@@ -0,0 +1,7 @@
+"""
+Author: Michel Peltriaux
+Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany
+Contact: ksp-servicestelle@sgdnord.rlp.de
+Created on: 15.08.23
+
+"""

analysis/tests/unit/test_forms.py

@@ -0,0 +1,47 @@
+"""
+Author: Michel Peltriaux
+Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany
+Contact: ksp-servicestelle@sgdnord.rlp.de
+Created on: 15.08.23
+
+"""
+from datetime import timedelta
+
+from django.urls import reverse
+from django.utils.timezone import now
+from django.utils.translation import gettext_lazy as _
+
+from analysis.forms import TimespanReportForm
+from konova.tests.test_views import BaseTestCase
+
+
+class TimeSpanReportFormTestCase(BaseTestCase):
+    def setUp(self) -> None:
+        super().setUp()
+        eiv = self.create_dummy_intervention()
+
+    def test_init(self):
+        form = TimespanReportForm()
+        self.assertEqual(form.form_title, str(_("Generate report")))
+        self.assertEqual(form.form_caption, str(_("Select a timespan and the desired conservation office") ))
+        self.assertEqual(form.action_url, reverse("analysis:reports"))
+        self.assertFalse(form.show_cancel_btn)
+        self.assertEqual(form.action_btn_label, str(_("Continue")))
+
+    def test_save(self):
+        date_from = now().date() - timedelta(days=365)
+        date_to = now().date()
+        office = self.get_conservation_office_code()
+        data = {
+            "date_from": date_from,
+            "date_to": date_to,
+            "conservation_office": office,
+        }
+        form = TimespanReportForm(data)
+        self.assertTrue(form.is_valid(), msg=f"{form.errors}")
+
+        detail_report_url = form.save()
+        self.assertEqual(
+            detail_report_url,
+            reverse("analysis:report-detail", args=(office.id,)) + f"?df={date_from}&dt={date_to}"
+        )

analysis/tests/unit/test_report.py

@@ -0,0 +1,98 @@
+"""
+Author: Michel Peltriaux
+Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany
+Contact: ksp-servicestelle@sgdnord.rlp.de
+Created on: 17.08.23
+
+"""
+from datetime import timedelta
+
+from django.utils.timezone import now
+
+from analysis.settings import LKOMPVZVO_PUBLISH_DATE
+from analysis.utils.report import TimespanReport
+from konova.sub_settings.django_settings import DEFAULT_DATE_FORMAT
+from konova.tests.test_views import BaseTestCase
+
+
+class TimeSpanReportTestCase(BaseTestCase):
+    def setUp(self) -> None:
+        super().setUp()
+
+        today = now().date()
+        old_date = LKOMPVZVO_PUBLISH_DATE - timedelta(days=1)
+
+        self.conservation_office = self.get_conservation_office_code()
+        self.eiv_old = self.create_dummy_intervention()
+        self.kom_old = self.create_dummy_compensation(interv=self.eiv_old)
+        self.assertNotEqual(self.compensation.intervention, self.kom_old.intervention)
+        self.eiv = self.compensation.intervention
+        self.oek_old = self.create_dummy_eco_account()
+
+        self.eiv_old.responsible.conservation_office = self.conservation_office
+        self.eiv_old.legal.binding_date = old_date
+        self.eiv_old.legal.registration_date = old_date
+
+        self.eiv.responsible.conservation_office = self.conservation_office
+        self.eiv.legal.binding_date = today
+        self.eiv.legal.registration_date = today
+
+        self.eco_account.responsible.conservation_office = self.conservation_office
+        self.eco_account.legal.registration_date = today
+        self.eco_account.legal.binding_date = today
+
+        self.oek_old.responsible.conservation_office = self.conservation_office
+        self.oek_old.legal.registration_date = old_date
+        self.oek_old.legal.binding_date = old_date
+
+        self.eiv.legal.save()
+        self.eiv.responsible.save()
+
+        self.eiv_old.legal.save()
+        self.eiv_old.responsible.save()
+
+        self.eco_account.legal.save()
+        self.eco_account.responsible.save()
+
+        self.oek_old.legal.save()
+        self.oek_old.responsible.save()
+
+        self.deduction.account = self.eco_account
+        self.deduction.intervention = self.eiv
+        self.deduction.save()
+
+    def test_init(self):
+        date_from = now().date() - timedelta(days=365)
+        date_to = now().date()
+        report = TimespanReport(self.conservation_office.id, date_from, date_to)
+
+        self.assertEqual(report.office_id, self.conservation_office.id)
+        self.assertEqual(report.date_from, date_from)
+        self.assertEqual(report.date_to, date_to)
+
+        self.assertIsNotNone(report.intervention_report)
+        self.assertIsNotNone(report.compensation_report)
+        self.assertIsNotNone(report.eco_account_report)
+        self.assertIsNotNone(report.old_data_report)
+
+        self.assertEqual(report.excel_map["date_from"], date_from.strftime(DEFAULT_DATE_FORMAT))
+        self.assertEqual(report.excel_map["date_to"], date_to.strftime(DEFAULT_DATE_FORMAT))
+
+        self.assertEqual(report.old_data_report.queryset_intervention_count, 1)
+        self.assertEqual(report.old_data_report.queryset_intervention_recorded_count, 0)
+        self.assertEqual(report.old_data_report.queryset_comps_count, 1)
+        self.assertEqual(report.old_data_report.queryset_acc_count, 1)
+        self.assertEqual(report.old_data_report.queryset_acc_recorded_count, 0)
+
+        self.assertEqual(report.intervention_report.queryset_count, 1)
+        self.assertEqual(report.intervention_report.queryset_checked_count, 0)
+        self.assertEqual(report.intervention_report.queryset_recorded_count, 0)
+
+        self.assertEqual(report.compensation_report.queryset_count, 1)
+        self.assertEqual(report.compensation_report.queryset_checked_count, 0)
+        self.assertEqual(report.compensation_report.queryset_recorded_count, 0)
+
+        self.assertEqual(report.eco_account_report.queryset_count, 1)
+        self.assertEqual(report.eco_account_report.queryset_recorded_count, 0)
+        self.assertEqual(report.eco_account_report.queryset_deductions_count, 1)
+        self.assertEqual(report.eco_account_report.queryset_deductions_recorded_count, 0)

analysis/utils/excel/excel.py

@@ -108,7 +108,7 @@ class TempExcelFile:
         for _iter_entry in _iter_obj:
             j = 0
             for _iter_attr in _attrs:
-                _new_cell = ws.cell(start_cell.row + i, start_cell.column + j, getattr(_iter_entry, _iter_attr))
+                _new_cell = ws.cell(start_cell.row + i, start_cell.column + j, _iter_entry.get(_iter_attr, "MISSING"))
                 _new_cell.border = border_style
                 j += 1
             i += 1

analysis/utils/report.py

@@ -17,6 +17,7 @@ from compensation.models import Compensation, Payment, EcoAccountDeduction, EcoA
 from intervention.models import Intervention
 from konova.models import Geometry
 from konova.sub_settings.django_settings import BASE_DIR, DEFAULT_DATE_FORMAT
+from konova.sub_settings.lanis_settings import DEFAULT_SRID_RLP
 
 
 class TimespanReport:
@@ -103,9 +104,9 @@ class TimespanReport:
                     "iterable": self.evaluated_laws,
                     "attrs": [
                         "short_name",
+                        "num",
                         "num_checked",
                         "num_recorded",
-                        "num",
                     ]
                 },
                 "i_laws_checked": self.law_sum_checked,
@@ -137,22 +138,36 @@ class TimespanReport:
             ).order_by(
                 "long_name"
             )
-            # Fetch all law ids which are used by any .legal object of an intervention object
-            intervention_laws_total = self.queryset.values_list("legal__laws__id")
-            intervention_laws_checked = self.queryset.filter(checked__isnull=False).values_list("legal__laws__id")
-            intervention_laws_recorded = self.queryset.filter(recorded__isnull=False).values_list(
-                "legal__laws__id")
-            # Count how often which law id appears in the above list, return only the long_name of the law and the resulting
-            # count (here 'num'). This is for keeping the db fetch as small as possible
-            # Compute the sum for total, checked and recorded
-            self.evaluated_laws = laws.annotate(
-                num=Count("id", filter=Q(id__in=intervention_laws_total)),
-                num_checked=Count("id", filter=Q(id__in=intervention_laws_checked)),
-                num_recorded=Count("id", filter=Q(id__in=intervention_laws_recorded)),
-            ).values_list("short_name", "long_name", "num_checked", "num_recorded", "num", named=True)
-            self.law_sum = self.evaluated_laws.aggregate(sum_num=Sum("num"))["sum_num"]
-            self.law_sum_checked = self.evaluated_laws.aggregate(sum_num_checked=Sum("num_checked"))["sum_num_checked"]
-            self.law_sum_recorded = self.evaluated_laws.aggregate(sum_num_recorded=Sum("num_recorded"))["sum_num_recorded"]
+
+            evaluated_laws = []
+            sum_num_checked = 0
+            sum_num_recorded = 0
+            sum_num = 0
+            for law in laws:
+                num = self.queryset.filter(
+                    legal__laws__atom_id=law.atom_id
+                ).count()
+                num_checked = self.queryset_checked.filter(
+                    legal__laws__atom_id=law.atom_id
+                ).count()
+                num_recorded = self.queryset_recorded.filter(
+                    legal__laws__atom_id=law.atom_id
+                ).count()
+                evaluated_laws.append({
+                    "short_name": law.short_name,
+                    "long_name": law.long_name,
+                    "num": num,
+                    "num_checked": num_checked,
+                    "num_recorded": num_recorded,
+                })
+                sum_num += num
+                sum_num_checked += num_checked
+                sum_num_recorded += num_recorded
+
+            self.evaluated_laws = evaluated_laws
+            self.law_sum = sum_num
+            self.law_sum_checked = sum_num_checked
+            self.law_sum_recorded = sum_num_recorded
 
         def _evaluate_compensations(self):
             """ Analyzes the types of compensation distribution
@@ -319,7 +334,7 @@ class TimespanReport:
             return Geometry.objects.filter(
                 id__in=ids
             ).annotate(
-                geom_cast=Cast("geom", MultiPolygonField())
+                geom_cast=Cast("geom", MultiPolygonField(srid=DEFAULT_SRID_RLP))
             ).annotate(
                 num=NumGeometries("geom_cast")
             ).aggregate(
@@ -398,6 +413,7 @@ class TimespanReport:
         def __init__(self, id: str, date_from: str, date_to: str):
             # First fetch all eco account for this office
             self.queryset = EcoAccount.objects.filter(
+                legal__registration_date__gt=LKOMPVZVO_PUBLISH_DATE,
                 responsible__conservation_office__id=id,
                 deleted=None,
                 created__timestamp__date__gte=date_from,
@@ -501,8 +517,8 @@ class TimespanReport:
                 legal__registration_date__lte=LKOMPVZVO_PUBLISH_DATE,
                 responsible__conservation_office__id=id,
                 deleted=None,
-                created__timestamp__gte=date_from,
-                created__timestamp__lte=date_to,
+                created__timestamp__date__gte=date_from,
+                created__timestamp__date__lte=date_to,
             )
             self.queryset_acc_recorded = self.queryset_acc.filter(
                 recorded__isnull=False,

api/admin.py

@@ -1,6 +1,6 @@
 from django.contrib import admin
 
-from api.models.token import APIUserToken
+from api.models.token import APIUserToken, OAuthToken
 
 
 class APITokenAdmin(admin.ModelAdmin):
@@ -17,4 +17,17 @@ class APITokenAdmin(admin.ModelAdmin):
     ]
 
 
+class OAuthTokenAdmin(admin.ModelAdmin):
+    list_display = [
+        "access_token",
+        "refresh_token",
+        "expires_on",
+    ]
+    search_fields = [
+        "access_token",
+        "refresh_token",
+    ]
+
+
 admin.site.register(APIUserToken, APITokenAdmin)
+admin.site.register(OAuthToken, OAuthTokenAdmin)

api/migrations/0002_alter_apiusertoken_valid_until.py

@@ -0,0 +1,18 @@
+# Generated by Django 4.2.6 on 2023-11-30 11:56
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('api', '0001_initial'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='apiusertoken',
+            name='valid_until',
+            field=models.DateField(blank=True, help_text='Token is only valid until this date. Forever if null/blank.', null=True),
+        ),
+    ]

api/migrations/0003_oauthtoken.py

@@ -0,0 +1,26 @@
+# Generated by Django 5.0.4 on 2024-04-30 07:20
+
+import uuid
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('api', '0002_alter_apiusertoken_valid_until'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='OAuthToken',
+            fields=[
+                ('id', models.UUIDField(default=uuid.uuid4, editable=False, primary_key=True, serialize=False)),
+                ('access_token', models.CharField(db_comment='OAuth access token', max_length=255)),
+                ('refresh_token', models.CharField(db_comment='OAuth refresh token', max_length=255)),
+                ('expires_on', models.DateTimeField(db_comment='When the token will be expired')),
+        ],
+            options={
+                'abstract': False,
+            },
+        ),
+    ]

api/models/token.py

@@ -1,7 +1,14 @@
+import json
+from datetime import timedelta
+
+import requests
 from django.core.exceptions import ObjectDoesNotExist
 from django.db import models
 from django.utils import timezone
+from django.utils.timezone import now
 
+from konova.models import UuidModel
+from konova.sub_settings.sso_settings import OAUTH_CLIENT_ID, OAUTH_CLIENT_SECRET, SSO_SERVER_BASE
 from konova.utils.generators import generate_token
 
 
@@ -14,7 +21,7 @@ class APIUserToken(models.Model):
     valid_until = models.DateField(
         blank=True,
         null=True,
-        help_text="Token is only valid until this date",
+        help_text="Token is only valid until this date. Forever if null/blank.",
     )
     is_active = models.BooleanField(
         default=False,
@@ -25,12 +32,11 @@ class APIUserToken(models.Model):
         return self.token
 
     @staticmethod
-    def get_user_from_token(token: str, username: str):
+    def get_user_from_token(token: str):
         """ Getter for the related user object
 
         Args:
             token (str): The used token
-            username (str): The username
 
         Returns:
             user (User): Otherwise None
@@ -39,7 +45,6 @@ class APIUserToken(models.Model):
         try:
             token_obj = APIUserToken.objects.get(
                 token=token,
-                user__username=username
             )
             if not token_obj.is_active:
                 raise PermissionError("Token unverified")
@@ -48,3 +53,105 @@ class APIUserToken(models.Model):
         except ObjectDoesNotExist:
             raise PermissionError("Credentials invalid")
         return token_obj.user
+
+
+class OAuthToken(UuidModel):
+    access_token = models.CharField(
+        max_length=255,
+        blank=False,
+        null=False,
+        db_comment="OAuth access token"
+    )
+    refresh_token = models.CharField(
+        max_length=255,
+        blank=False,
+        null=False,
+        db_comment="OAuth refresh token"
+    )
+    expires_on = models.DateTimeField(
+        db_comment="When the token will be expired"
+    )
+
+    ASSUMED_LATENCY = 1000  # assumed latency between creation and receiving of an access token
+
+    def __str__(self):
+        return str(self.access_token)
+
+    @staticmethod
+    def from_access_token_response(access_token_data: str, received_on):
+        """
+        Creates an OAuthToken based on retrieved access token data (OAuth2.0 specification)
+
+        Args:
+            access_token_data (str): OAuth2.0 response data
+            received_on (): Timestamp when the response has been received
+
+        Returns:
+
+        """
+        oauth_token = OAuthToken()
+        data = json.loads(access_token_data)
+
+        oauth_token.access_token = data.get("access_token")
+        oauth_token.refresh_token = data.get("refresh_token")
+
+        expires_on = received_on + timedelta(
+            seconds=(data.get("expires_in") + OAuthToken.ASSUMED_LATENCY)
+        )
+        oauth_token.expires_on = expires_on
+
+        return oauth_token
+
+    def refresh(self):
+        url = f"{SSO_SERVER_BASE}o/token/"
+        params = {
+            "grant_type": "refresh_token",
+            "refresh_token": self.refresh_token,
+            "client_id": OAUTH_CLIENT_ID,
+            "client_secret": OAUTH_CLIENT_SECRET
+        }
+        response = requests.post(
+            url,
+            params
+        )
+        _now = now()
+        is_response_invalid = response.status_code != 200
+        if is_response_invalid:
+            raise RuntimeError(f"Refreshing token not possible: {response.status_code}")
+
+        response_content = response.content.decode("utf-8")
+        response_content = json.loads(response_content)
+
+        access_token = response_content.get("access_token")
+        refresh_token = response_content.get("refresh_token")
+        expires_in = response_content.get("expires")
+
+        self.access_token = access_token
+        self.refresh_token = refresh_token
+        self.expires_in = expires_in
+        self.save()
+
+        return self
+
+    def update_and_get_user(self):
+        from user.models import User
+        url = f"{SSO_SERVER_BASE}users/oauth/data/"
+
+        access_token = self.access_token
+        response = requests.get(
+            url,
+            headers={
+                "Authorization": f"Bearer {access_token}",
+            }
+        )
+
+        is_response_code_invalid = response.status_code != 200
+        if is_response_code_invalid:
+            raise RuntimeError(f"OAuth user data fetching unsuccessful: {response.status_code}")
+
+        response_content = response.content.decode("utf-8")
+        response_content = json.loads(response_content)
+        user = User.oauth_update_user(response_content)
+
+        return user
+

api/tests/unit/__init__.py

@@ -0,0 +1,7 @@
+"""
+Author: Michel Peltriaux
+Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany
+Contact: ksp-servicestelle@sgdnord.rlp.de
+Created on: 17.08.23
+
+"""

api/tests/unit/test_token.py

@@ -0,0 +1,71 @@
+"""
+Author: Michel Peltriaux
+Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany
+Contact: ksp-servicestelle@sgdnord.rlp.de
+Created on: 17.08.23
+
+"""
+from datetime import timedelta
+
+from django.utils.timezone import now
+
+from api.models import APIUserToken
+from konova.tests.test_views import BaseTestCase
+
+
+class APIUserTokenTestCase(BaseTestCase):
+    def setUp(self) -> None:
+        super().setUp()
+
+        self.token = APIUserToken.objects.create()
+        self.superuser.api_token = self.token
+        self.superuser.save()
+
+    def test_str(self):
+        self.assertEqual(str(self.token), self.token.token)
+
+    def test_get_user_from_token(self):
+        a_day = timedelta(days=1)
+        today = now().date()
+
+        self.assertFalse(self.token.is_active)
+        self.assertIsNone(self.token.valid_until)
+
+        try:
+            #Token not existing --> fail
+            token_user = APIUserToken.get_user_from_token(self.token.token[::-1])
+            self.fail("There should not have been any token")
+        except PermissionError:
+            pass
+
+        try:
+            # Token not active --> fail
+            token_user = APIUserToken.get_user_from_token(self.token.token)
+            self.fail("Token is unverified but token user has been fetchable.")
+        except PermissionError:
+            pass
+        self.token.is_active = True
+        self.token.valid_until = today - a_day
+        self.token.save()
+
+        try:
+            # Token valid until yesterday --> fail
+            token_user = APIUserToken.get_user_from_token(self.token.token)
+            self.fail("Token reached end of lifetime but token user has been fetchable.")
+        except PermissionError:
+            pass
+
+        # Token valid until tomorrow --> success
+        self.token.valid_until = today + a_day
+        self.token.save()
+
+        token_user = APIUserToken.get_user_from_token(self.token.token)
+        self.assertEqual(token_user, self.superuser)
+        del token_user
+
+        # Token valid forever --> success
+        self.token.valid_until = None
+        self.token.save()
+        token_user = APIUserToken.get_user_from_token(self.token.token)
+        self.assertEqual(token_user, self.superuser)
+

api/tests/v1/create/compensation_create_post_body.json

@@ -6,6 +6,7 @@
         "title": "Test_compensation",
         "is_cef": false,
         "is_coherence_keeping": false,
+        "is_pik": false,
         "intervention": "MUST_BE_SET_IN_TEST",
         "before_states": [
         ],

api/tests/v1/create/deduction_create_post_body.json

@@ -1,5 +1,5 @@
 {
     "eco_account": "CHANGE_BEFORE_RUN!!!",
-    "surface": 500.0,
+    "surface": 500.50,
     "intervention": "CHANGE_BEFORE_RUN!!!"
 }

api/tests/v1/create/ecoaccount_create_post_body.json

@@ -5,10 +5,14 @@
     "properties": {
         "title": "Test_ecoaccount",
         "deductable_surface": 10000.0,
+        "is_pik": false,
         "responsible": {
             "conservation_office": null,
             "conservation_file_number": null,
-            "handler": null
+            "handler": {
+                "type": null,
+                "detail": "Someone"
+            }
         },
         "legal": {
             "agreement_date": null

api/tests/v1/create/ema_create_post_body.json

@@ -4,10 +4,14 @@
     ],
     "properties": {
         "title": "Test_ema",
+        "is_pik": false,
         "responsible": {
             "conservation_office": null,
             "conservation_file_number": null,
-            "handler": null
+            "handler": {
+                "type": null,
+                "detail": "Someone"
+            }
         },
         "before_states": [
         ],

api/tests/v1/create/intervention_create_post_body.json

@@ -9,7 +9,10 @@
             "registration_file_number": null,
             "conservation_office": null,
             "conservation_file_number": null,
-            "handler": null
+            "handler": {
+                "type": null,
+                "detail": "Someone"
+            }
         },
         "legal": {
             "registration_date": null,

api/tests/v1/create/test_api_create.py

@@ -109,8 +109,8 @@ class APIV1CreateTestCase(BaseAPIV1TestCase):
         Returns:
 
         """
-        self.intervention.share_with(self.superuser)
-        self.eco_account.share_with(self.superuser)
+        self.intervention.share_with_user(self.superuser)
+        self.eco_account.share_with_user(self.superuser)
 
         url = reverse("api:v1:deduction")
         json_file_path = "api/tests/v1/create/deduction_create_post_body.json"

api/tests/v1/delete/test_api_delete.py

@@ -57,7 +57,7 @@ class APIV1DeleteTestCase(BaseAPIV1TestCase):
 
         """
         test_intervention = self.create_dummy_intervention()
-        test_intervention.share_with(self.superuser)
+        test_intervention.share_with_user(self.superuser)
         url = reverse("api:v1:intervention", args=(str(test_intervention.id),))
         self._test_delete_object(test_intervention, url)
 
@@ -68,7 +68,7 @@ class APIV1DeleteTestCase(BaseAPIV1TestCase):
 
         """
         test_comp = self.create_dummy_compensation()
-        test_comp.share_with(self.superuser)
+        test_comp.share_with_user(self.superuser)
         url = reverse("api:v1:compensation", args=(str(test_comp.id),))
         self._test_delete_object(test_comp, url)
 
@@ -79,7 +79,7 @@ class APIV1DeleteTestCase(BaseAPIV1TestCase):
 
         """
         test_acc = self.create_dummy_eco_account()
-        test_acc.share_with(self.superuser)
+        test_acc.share_with_user(self.superuser)
         url = reverse("api:v1:ecoaccount", args=(str(test_acc.id),))
         self._test_delete_object(test_acc, url)
 
@@ -90,7 +90,7 @@ class APIV1DeleteTestCase(BaseAPIV1TestCase):
 
         """
         test_ema = self.create_dummy_ema()
-        test_ema.share_with(self.superuser)
+        test_ema.share_with_user(self.superuser)
         url = reverse("api:v1:ema", args=(str(test_ema.id),))
         self._test_delete_object(test_ema, url)
 
@@ -101,7 +101,7 @@ class APIV1DeleteTestCase(BaseAPIV1TestCase):
 
         """
         test_deduction = self.create_dummy_deduction()
-        test_deduction.intervention.share_with(self.superuser)
+        test_deduction.intervention.share_with_user(self.superuser)
         url = reverse("api:v1:deduction", args=(str(test_deduction.id),))
 
         response = self._run_delete_request(url)

api/tests/v1/get/test_api_get.py

@@ -36,7 +36,12 @@ class APIV1GetTestCase(BaseAPIV1TestCase):
         """
         response = self._run_get_request(url)
         content = json.loads(response.content)
-        geojson = content[str(obj.id)]
+        self.assertIn("rpp", content)
+        self.assertIn("p", content)
+        self.assertIn("next", content)
+        self.assertIn("results", content)
+        paginated_content = content["results"]
+        geojson = paginated_content[str(obj.id)]
         self.assertEqual(response.status_code, 200, msg=response.content)
         return geojson
 
@@ -59,7 +64,7 @@ class APIV1GetTestCase(BaseAPIV1TestCase):
         Returns:
 
         """
-        self.intervention.share_with(self.superuser)
+        self.intervention.share_with_user(self.superuser)
         url = reverse("api:v1:intervention", args=(str(self.intervention.id),))
         geojson = self._test_get_object(self.intervention, url)
         self._assert_geojson_format(geojson)
@@ -80,13 +85,33 @@ class APIV1GetTestCase(BaseAPIV1TestCase):
         except KeyError as e:
             self.fail(e)
 
+    def test_get_shared(self):
+        """ Tests api GET on shared info of the intervention
+
+        Returns:
+
+        """
+        self.intervention.share_with_user(self.superuser)
+        self.intervention.share_with_team(self.team)
+        url = reverse("api:v1:intervention-share", args=(str(self.intervention.id),))
+        response = self._run_get_request(url)
+        content = json.loads(response.content)
+        self.assertIn("users", content)
+        self.assertIn(self.superuser.username, content["users"])
+        self.assertEqual(1, len(content["users"]))
+        self.assertIn("teams", content)
+        self.assertEqual(1, len(content["teams"]))
+        for team in content["teams"]:
+            self.assertEqual(team["id"], str(self.team.id))
+            self.assertEqual(team["name"], self.team.name)
+
     def test_get_compensation(self):
         """ Tests api GET
 
         Returns:
 
         """
-        self.intervention.share_with(self.superuser)
+        self.intervention.share_with_user(self.superuser)
         self.compensation.intervention = self.intervention
         self.compensation.save()
 
@@ -97,6 +122,7 @@ class APIV1GetTestCase(BaseAPIV1TestCase):
             props = geojson["properties"]
             props["is_cef"]
             props["is_coherence_keeping"]
+            props["is_pik"]
             props["intervention"]
             props["intervention"]["id"]
             props["intervention"]["identifier"]
@@ -114,7 +140,7 @@ class APIV1GetTestCase(BaseAPIV1TestCase):
         Returns:
 
         """
-        self.eco_account.share_with(self.superuser)
+        self.eco_account.share_with_user(self.superuser)
 
         url = reverse("api:v1:ecoaccount", args=(str(self.eco_account.id),))
         geojson = self._test_get_object(self.eco_account, url)
@@ -143,7 +169,7 @@ class APIV1GetTestCase(BaseAPIV1TestCase):
         Returns:
 
         """
-        self.ema.share_with(self.superuser)
+        self.ema.share_with_user(self.superuser)
 
         url = reverse("api:v1:ema", args=(str(self.ema.id),))
         geojson = self._test_get_object(self.ema, url)
@@ -167,7 +193,7 @@ class APIV1GetTestCase(BaseAPIV1TestCase):
         Returns:
 
         """
-        self.deduction.intervention.share_with(self.superuser)
+        self.deduction.intervention.share_with_user(self.superuser)
 
         url = reverse("api:v1:deduction", args=(str(self.deduction.id),))
         _json = self._test_get_object(self.deduction, url)

api/tests/v1/share/test_api_sharing.py

@@ -4,7 +4,6 @@ from django.urls import reverse
 
 from konova.settings import DEFAULT_GROUP
 from konova.tests.test_views import BaseTestCase
-from konova.utils.user_checks import is_default_group_only
 
 
 class BaseAPIV1TestCase(BaseTestCase):
@@ -12,15 +11,17 @@ class BaseAPIV1TestCase(BaseTestCase):
     def setUpTestData(cls):
         super().setUpTestData()
 
-        cls.superuser.get_API_token()
-        cls.superuser.api_token.is_active = True
-        cls.superuser.api_token.save()
-        default_group = cls.groups.get(name=DEFAULT_GROUP)
-        cls.superuser.groups.add(default_group)
+    def setUp(self) -> None:
+        super().setUp()
+        self.superuser.get_API_token()
+        self.superuser.api_token.is_active = True
+        self.superuser.api_token.save()
+        default_group = self.groups.get(name=DEFAULT_GROUP)
+        self.superuser.groups.add(default_group)
 
-        cls.header_data = {
-            "HTTP_ksptoken": cls.superuser.api_token.token,
-            "HTTP_kspuser": cls.superuser.username,
+        self.header_data = {
+            "HTTP_ksptoken": self.superuser.api_token.token,
+            "HTTP_kspuser": self.superuser.username,
         }
 
 
@@ -136,7 +137,7 @@ class APIV1SharingTestCase(BaseAPIV1TestCase):
         # Give the user only default group rights
         default_group = self.groups.get(name=DEFAULT_GROUP)
         self.superuser.groups.set([default_group])
-        self.assertTrue(is_default_group_only(self.superuser))
+        self.assertTrue(self.superuser.is_default_group_only())
 
         # Add only him as shared_users an object
         self.intervention.users.set([self.superuser])

api/tests/v1/update/compensation_update_put_body.json

@@ -46,6 +46,7 @@
         "title": "TEST_compensation_CHANGED",
         "is_cef": true,
         "is_coherence_keeping": true,
+        "is_pik": true,
         "intervention": "CHANGE_BEFORE_RUN!!!",
         "before_states": [],
         "after_states": [],

api/tests/v1/update/deduction_update_put_body.json

@@ -1,5 +1,5 @@
 {
     "eco_account": "CHANGE_BEFORE_RUN!!!",
-    "surface": 523400.0,
+    "surface": 523400.50,
     "intervention": "CHANGE_BEFORE_RUN!!!"
 }

api/tests/v1/update/ecoaccount_update_put_body.json

@@ -45,10 +45,14 @@
     "properties": {
         "title": "TEST_account_CHANGED",
         "deductable_surface": "100000.0",
+        "is_pik": true,
         "responsible": {
             "conservation_office": null,
             "conservation_file_number": "123-TEST",
-            "handler": "TEST_HANDLER_CHANGED"
+            "handler": {
+                "type": null,
+                "detail": "TEST HANDLER CHANGED"
+            }
         },
         "legal": {
             "agreement_date": "2022-01-11"

api/tests/v1/update/ema_update_put_body.json

@@ -47,8 +47,12 @@
         "responsible": {
             "conservation_office": null,
             "conservation_file_number": "TEST_CHANGED",
-            "handler": "TEST_HANDLER_CHANGED"
+            "handler": {
+                "type": null,
+                "detail": "TEST_HANDLER_CHANGED"
+            }
         },
+        "is_pik": true,
         "before_states": [],
         "after_states": [],
         "actions": [],

api/tests/v1/update/intervention_share_update_put_body.json

@@ -0,0 +1,8 @@
+{
+    "users": [
+        "CHANGE_ME"
+    ],
+    "teams": [
+        "CHANGE_ME"
+    ]
+}

api/tests/v1/update/intervention_update_put_body.json

@@ -49,7 +49,10 @@
             "registration_file_number": "CHANGED",
             "conservation_office": null,
             "conservation_file_number": "CHANGED",
-            "handler": null
+            "handler": {
+                "type": null,
+                "detail": "TEST_HANDLER_CHANGED"
+            }
         },
         "legal": {
             "registration_date": "2022-02-01",

api/tests/v1/update/test_api_update.py

@@ -12,6 +12,7 @@ from django.contrib.gis import geos
 from django.urls import reverse
 
 from api.tests.v1.share.test_api_sharing import BaseAPIV1TestCase
+from konova.sub_settings.lanis_settings import DEFAULT_SRID_RLP
 
 
 class APIV1UpdateTestCase(BaseAPIV1TestCase):
@@ -52,7 +53,7 @@ class APIV1UpdateTestCase(BaseAPIV1TestCase):
         Returns:
 
         """
-        self.intervention.share_with(self.superuser)
+        self.intervention.share_with_user(self.superuser)
         modified_on = self.intervention.modified
         url = reverse("api:v1:intervention", args=(str(self.intervention.id),))
         json_file_path = "api/tests/v1/update/intervention_update_put_body.json"
@@ -63,6 +64,7 @@ class APIV1UpdateTestCase(BaseAPIV1TestCase):
 
         put_props = put_body["properties"]
         put_geom = geos.fromstr(json.dumps(put_body))
+        put_geom.transform(DEFAULT_SRID_RLP)
         self.assertEqual(put_geom, self.intervention.geometry.geom)
         self.assertEqual(put_props["title"], self.intervention.title)
         self.assertNotEqual(modified_on, self.intervention.modified)
@@ -79,7 +81,7 @@ class APIV1UpdateTestCase(BaseAPIV1TestCase):
         """
         self.compensation.intervention = self.intervention
         self.compensation.save()
-        self.intervention.share_with(self.superuser)
+        self.intervention.share_with_user(self.superuser)
 
         modified_on = self.compensation.modified
         url = reverse("api:v1:compensation", args=(str(self.compensation.id),))
@@ -92,11 +94,13 @@ class APIV1UpdateTestCase(BaseAPIV1TestCase):
 
         put_props = put_body["properties"]
         put_geom = geos.fromstr(json.dumps(put_body))
+        put_geom.transform(DEFAULT_SRID_RLP)
         self.assertEqual(put_geom, self.compensation.geometry.geom)
         self.assertEqual(put_props["title"], self.compensation.title)
         self.assertNotEqual(modified_on, self.compensation.modified)
         self.assertEqual(put_props["is_cef"], self.compensation.is_cef)
         self.assertEqual(put_props["is_coherence_keeping"], self.compensation.is_coherence_keeping)
+        self.assertEqual(put_props["is_pik"], self.compensation.is_pik)
         self.assertEqual(len(put_props["actions"]), self.compensation.actions.count())
         self.assertEqual(len(put_props["before_states"]), self.compensation.before_states.count())
         self.assertEqual(len(put_props["after_states"]), self.compensation.after_states.count())
@@ -108,7 +112,7 @@ class APIV1UpdateTestCase(BaseAPIV1TestCase):
         Returns:
 
         """
-        self.eco_account.share_with(self.superuser)
+        self.eco_account.share_with_user(self.superuser)
 
         modified_on = self.eco_account.modified
         url = reverse("api:v1:ecoaccount", args=(str(self.eco_account.id),))
@@ -120,13 +124,14 @@ class APIV1UpdateTestCase(BaseAPIV1TestCase):
 
         put_props = put_body["properties"]
         put_geom = geos.fromstr(json.dumps(put_body))
+        put_geom.transform(DEFAULT_SRID_RLP)
         self.assertEqual(put_geom, self.eco_account.geometry.geom)
         self.assertEqual(put_props["title"], self.eco_account.title)
         self.assertNotEqual(modified_on, self.eco_account.modified)
         self.assertEqual(put_props["deductable_surface"], str(self.eco_account.deductable_surface))
         self.assertEqual(put_props["responsible"]["conservation_office"], self.eco_account.responsible.conservation_office)
         self.assertEqual(put_props["responsible"]["conservation_file_number"], self.eco_account.responsible.conservation_file_number)
-        self.assertEqual(put_props["responsible"]["handler"], self.eco_account.responsible.handler)
+        self.assertEqual(put_props["responsible"]["handler"]["detail"], self.eco_account.responsible.handler.detail)
         self.assertEqual(put_props["legal"]["agreement_date"], str(self.eco_account.legal.registration_date))
         self.assertEqual(len(put_props["actions"]), self.eco_account.actions.count())
         self.assertEqual(len(put_props["before_states"]), self.eco_account.before_states.count())
@@ -139,7 +144,7 @@ class APIV1UpdateTestCase(BaseAPIV1TestCase):
         Returns:
 
         """
-        self.ema.share_with(self.superuser)
+        self.ema.share_with_user(self.superuser)
 
         modified_on = self.ema.modified
         url = reverse("api:v1:ema", args=(str(self.ema.id),))
@@ -151,12 +156,13 @@ class APIV1UpdateTestCase(BaseAPIV1TestCase):
 
         put_props = put_body["properties"]
         put_geom = geos.fromstr(json.dumps(put_body))
+        put_geom.transform(DEFAULT_SRID_RLP)
         self.assertEqual(put_geom, self.ema.geometry.geom)
         self.assertEqual(put_props["title"], self.ema.title)
         self.assertNotEqual(modified_on, self.ema.modified)
         self.assertEqual(put_props["responsible"]["conservation_office"], self.ema.responsible.conservation_office)
         self.assertEqual(put_props["responsible"]["conservation_file_number"], self.ema.responsible.conservation_file_number)
-        self.assertEqual(put_props["responsible"]["handler"], self.ema.responsible.handler)
+        self.assertEqual(put_props["responsible"]["handler"]["detail"], self.ema.responsible.handler.detail)
         self.assertEqual(len(put_props["actions"]), self.ema.actions.count())
         self.assertEqual(len(put_props["before_states"]), self.ema.before_states.count())
         self.assertEqual(len(put_props["after_states"]), self.ema.after_states.count())
@@ -168,8 +174,8 @@ class APIV1UpdateTestCase(BaseAPIV1TestCase):
         Returns:
 
         """
-        self.deduction.intervention.share_with(self.superuser)
-        self.deduction.account.share_with(self.superuser)
+        self.deduction.intervention.share_with_user(self.superuser)
+        self.deduction.account.share_with_user(self.superuser)
 
         url = reverse("api:v1:deduction", args=(str(self.deduction.id),))
         json_file_path = "api/tests/v1/update/deduction_update_put_body.json"
@@ -184,3 +190,24 @@ class APIV1UpdateTestCase(BaseAPIV1TestCase):
         self.assertEqual(put_body["intervention"], str(self.deduction.intervention.id))
         self.assertEqual(put_body["eco_account"], str(self.deduction.account.id))
         self.assertEqual(put_body["surface"], self.deduction.surface)
+
+    def test_update_share_intervention(self):
+        self.intervention.share_with_user(self.superuser)
+        url = reverse("api:v1:intervention-share", args=(str(self.intervention.id),))
+        json_file_path = "api/tests/v1/update/intervention_share_update_put_body.json"
+        with open(json_file_path) as json_file:
+            put_body = json.load(fp=json_file)
+            put_body["users"] = [self.user.username]
+            put_body["teams"] = [self.team.name]
+
+        self.assertFalse(self.intervention.is_shared_with(self.user))
+        self.assertEqual(0, self.intervention.shared_teams.count())
+
+        response = self._run_update_request(url, put_body)
+        self.assertEqual(response.status_code, 200, msg=response.content)
+        self.intervention.refresh_from_db()
+
+        self.assertEqual(1, self.intervention.shared_teams.count())
+        self.assertEqual(2, self.intervention.shared_users.count())
+        self.assertEqual(self.team.name, self.intervention.shared_teams.first().name)
+        self.assertTrue(self.intervention.is_shared_with(self.user))

api/utils/serializer/serializer.py

@@ -10,7 +10,10 @@ from abc import abstractmethod
 
 from django.contrib.gis import geos
 from django.contrib.gis.geos import GEOSGeometry
+from django.core.paginator import Paginator
+from django.db.models import Q
 
+from konova.sub_settings.lanis_settings import DEFAULT_SRID_RLP
 from konova.utils.message_templates import DATA_UNSHARED
 
 
@@ -19,6 +22,10 @@ class AbstractModelAPISerializer:
     lookup = None
     properties_data = None
 
+    rpp = None
+    page_number = None
+    paginator = None
+
     class Meta:
         abstract = True
 
@@ -26,8 +33,8 @@ class AbstractModelAPISerializer:
         self.lookup = {
             "id": None,  # must be set
             "deleted__isnull": True,
-            "users__in": [],  # must be set
         }
+        self.shared_lookup = Q()  # must be set, so user or team based share will be used properly
         super().__init__(*args, **kwargs)
 
     @abstractmethod
@@ -70,7 +77,11 @@ class AbstractModelAPISerializer:
         else:
             # Return certain object
             self.lookup["id"] = _id
-        self.lookup["users__in"] = [user]
+
+        self.shared_lookup = Q(
+            Q(users__in=[user]) |
+            Q(teams__in=list(user.shared_teams))
+        )
 
     def fetch_and_serialize(self):
         """ Serializes the model entry according to the given lookup data
@@ -80,9 +91,18 @@ class AbstractModelAPISerializer:
         Returns:
             serialized_data (dict)
         """
-        entries = self.model.objects.filter(**self.lookup)
+        entries = self.model.objects.filter(
+            **self.lookup
+        ).filter(
+            self.shared_lookup
+        ).order_by(
+            "id"
+        ).distinct()
+        self.paginator = Paginator(entries, self.rpp)
+        requested_entries = self.paginator.page(self.page_number)
+
         serialized_data = {}
-        for entry in entries:
+        for entry in requested_entries.object_list:
             serialized_data[str(entry.id)] = self._model_to_geo_json(entry)
         return serialized_data
 
@@ -125,8 +145,8 @@ class AbstractModelAPISerializer:
         if isinstance(geojson, dict):
             geojson = json.dumps(geojson)
         geometry = geos.fromstr(geojson)
-        if geometry.empty:
-            geometry = None
+        if geometry.srid != DEFAULT_SRID_RLP:
+            geometry.transform(DEFAULT_SRID_RLP)
         return geometry
 
     def _get_obj_from_db(self, id, user):

api/utils/serializer/v1/compensation.py

@@ -6,12 +6,13 @@ Created on: 24.01.22
 
 """
 from django.db import transaction
+from django.db.models import Q
 
 from api.utils.serializer.v1.serializer import AbstractModelAPISerializerV1, AbstractCompensationAPISerializerV1Mixin
 from compensation.models import Compensation
 from intervention.models import Intervention
 from konova.models import Geometry
-from konova.tasks import celery_update_parcels
+from konova.tasks import celery_update_parcels, celery_check_for_geometry_conflicts
 from konova.utils.message_templates import DATA_UNSHARED
 from user.models import UserActionLogEntry
 
@@ -21,8 +22,10 @@ class CompensationAPISerializerV1(AbstractModelAPISerializerV1, AbstractCompensa
 
     def prepare_lookup(self, id, user):
         super().prepare_lookup(id, user)
-        del self.lookup["users__in"]
-        self.lookup["intervention__users__in"] = [user]
+        self.shared_lookup = Q(
+            Q(intervention__users__in=[user]) |
+            Q(intervention__teams__in=user.shared_teams)
+        )
 
     def intervention_to_json(self, entry):
         return {
@@ -34,6 +37,7 @@ class CompensationAPISerializerV1(AbstractModelAPISerializerV1, AbstractCompensa
     def _extend_properties_data(self, entry):
         self.properties_data["is_cef"] = entry.is_cef
         self.properties_data["is_coherence_keeping"] = entry.is_coherence_keeping
+        self.properties_data["is_pik"] = entry.is_pik
         self.properties_data["intervention"] = self.intervention_to_json(entry.intervention)
         self.properties_data["before_states"] = self._compensation_state_to_json(entry.before_states.all())
         self.properties_data["after_states"] = self._compensation_state_to_json(entry.after_states.all())
@@ -63,6 +67,7 @@ class CompensationAPISerializerV1(AbstractModelAPISerializerV1, AbstractCompensa
         obj = Compensation()
         created = create_action
         obj.created = created
+        obj.modified = created
         obj.geometry = geometry
         return obj
 
@@ -113,6 +118,7 @@ class CompensationAPISerializerV1(AbstractModelAPISerializerV1, AbstractCompensa
             obj.title = properties["title"]
             obj.is_cef = properties["is_cef"]
             obj.is_coherence_keeping = properties["is_coherence_keeping"]
+            obj.is_pik = properties.get("is_pik", False)
             obj = self.set_intervention(obj, properties["intervention"], user)
 
             obj.geometry.save()
@@ -123,11 +129,12 @@ class CompensationAPISerializerV1(AbstractModelAPISerializerV1, AbstractCompensa
             obj = self._set_compensation_states(obj, properties["after_states"], obj.after_states)
             obj = self._set_deadlines(obj, properties["deadlines"])
 
-            obj.log.add(obj.created)
+        obj.log.add(obj.created)
 
-            celery_update_parcels.delay(obj.geometry.id)
+        celery_update_parcels.delay(obj.geometry.id)
+        celery_check_for_geometry_conflicts.delay(obj.geometry.id)
 
-            return obj.id
+        return obj.id
 
     def update_model_from_json(self, id, json_model, user):
         """ Updates an entry for the model based on the contents of json_model
@@ -149,6 +156,7 @@ class CompensationAPISerializerV1(AbstractModelAPISerializerV1, AbstractCompensa
             obj.title = properties["title"]
             obj.is_cef = properties["is_cef"]
             obj.is_coherence_keeping = properties["is_coherence_keeping"]
+            obj.is_pik = properties.get("is_pik", False)
             obj.modified = update_action
             obj.geometry.geom = self._create_geometry_from_json(json_model)
             obj.geometry.modified = update_action
@@ -162,8 +170,8 @@ class CompensationAPISerializerV1(AbstractModelAPISerializerV1, AbstractCompensa
             obj = self._set_compensation_states(obj, properties["after_states"], obj.after_states)
             obj = self._set_deadlines(obj, properties["deadlines"])
 
-            obj.log.add(update_action)
+        obj.log.add(update_action)
 
-            celery_update_parcels.delay(obj.geometry.id)
+        celery_update_parcels.delay(obj.geometry.id)
 
-            return obj.id
+        return obj.id

api/utils/serializer/v1/deduction.py

@@ -6,6 +6,7 @@ Created on: 28.01.22
 
 """
 from django.core.exceptions import ObjectDoesNotExist
+from django.db.models import Q
 
 from api.utils.serializer.v1.serializer import DeductableAPISerializerV1Mixin, AbstractModelAPISerializerV1
 from compensation.models import EcoAccountDeduction, EcoAccount
@@ -28,9 +29,11 @@ class DeductionAPISerializerV1(AbstractModelAPISerializerV1,
 
         """
         super().prepare_lookup(_id, user)
-        del self.lookup["users__in"]
         del self.lookup["deleted__isnull"]
-        self.lookup["intervention__users__in"] = [user]
+        self.shared_lookup = Q(
+            Q(intervention__users__in=[user]) |
+            Q(intervention__teams__in=user.shared_teams)
+        )
 
     def _model_to_geo_json(self, entry):
         """ Adds the basic data

api/utils/serializer/v1/ecoaccount.py

@@ -9,11 +9,11 @@ from django.db import transaction
 
 from api.utils.serializer.v1.serializer import AbstractModelAPISerializerV1, AbstractCompensationAPISerializerV1Mixin, \
     LegalAPISerializerV1Mixin, ResponsibilityAPISerializerV1Mixin, DeductableAPISerializerV1Mixin
-from codelist.settings import CODELIST_CONSERVATION_OFFICE_ID
+from codelist.settings import CODELIST_CONSERVATION_OFFICE_ID, CODELIST_HANDLER_ID
 from compensation.models import EcoAccount
-from intervention.models import Legal, Responsibility
+from intervention.models import Legal, Responsibility, Handler
 from konova.models import Geometry
-from konova.tasks import celery_update_parcels
+from konova.tasks import celery_update_parcels, celery_check_for_geometry_conflicts
 from user.models import UserActionLogEntry
 
 
@@ -25,6 +25,7 @@ class EcoAccountAPISerializerV1(AbstractModelAPISerializerV1,
     model = EcoAccount
 
     def _extend_properties_data(self, entry):
+        self.properties_data["is_pik"] = entry.is_pik
         self.properties_data["deductable_surface"] = entry.deductable_surface
         self.properties_data["deductable_surface_available"] = entry.deductable_surface - entry.get_deductions_surface()
         self.properties_data["responsible"] = self._responsible_to_json(entry.responsible)
@@ -44,7 +45,7 @@ class EcoAccountAPISerializerV1(AbstractModelAPISerializerV1,
         return {
             "conservation_office": self._konova_code_to_json(responsible.conservation_office),
             "conservation_file_number": responsible.conservation_file_number,
-            "handler": responsible.handler,
+            "handler": self._handler_to_json(responsible.handler),
         }
 
     def _set_responsibility(self, obj, responsibility_data: dict):
@@ -64,7 +65,11 @@ class EcoAccountAPISerializerV1(AbstractModelAPISerializerV1,
             CODELIST_CONSERVATION_OFFICE_ID,
         )
         obj.responsible.conservation_file_number = responsibility_data["conservation_file_number"]
-        obj.responsible.handler = responsibility_data["handler"]
+        obj.responsible.handler.type = self._konova_code_from_json(
+            responsibility_data["handler"]["type"],
+            CODELIST_HANDLER_ID,
+        )
+        obj.responsible.handler.detail = responsibility_data["handler"]["detail"]
         return obj
 
     def _set_legal(self, obj, legal_data):
@@ -92,10 +97,13 @@ class EcoAccountAPISerializerV1(AbstractModelAPISerializerV1,
 
         # Create linked objects
         obj = EcoAccount()
-        obj.responsible = Responsibility()
+        obj.responsible = Responsibility(
+            handler=Handler()
+        )
         obj.legal = Legal()
         created = create_action
         obj.created = created
+        obj.modified = created
         obj.geometry = geometry
         return obj
 
@@ -116,6 +124,7 @@ class EcoAccountAPISerializerV1(AbstractModelAPISerializerV1,
             properties = json_model["properties"]
             obj.identifier = obj.generate_new_identifier()
             obj.title = properties["title"]
+            obj.is_pik = properties.get("is_pik", False)
 
             try:
                 obj.deductable_surface = float(properties["deductable_surface"])
@@ -128,6 +137,7 @@ class EcoAccountAPISerializerV1(AbstractModelAPISerializerV1,
             obj = self._set_legal(obj, properties["legal"])
 
             obj.geometry.save()
+            obj.responsible.handler.save()
             obj.responsible.save()
             obj.legal.save()
             obj.save()
@@ -137,12 +147,13 @@ class EcoAccountAPISerializerV1(AbstractModelAPISerializerV1,
             obj = self._set_compensation_states(obj, properties["after_states"], obj.after_states)
             obj = self._set_deadlines(obj, properties["deadlines"])
 
-            obj.log.add(obj.created)
-            obj.users.add(user)
+        obj.log.add(obj.created)
+        obj.users.add(user)
 
-            celery_update_parcels.delay(obj.geometry.id)
+        celery_update_parcels.delay(obj.geometry.id)
+        celery_check_for_geometry_conflicts.delay(obj.geometry.id)
 
-            return obj.id
+        return obj.id
 
     def update_model_from_json(self, id, json_model, user):
         """ Updates an entry for the model based on the contents of json_model
@@ -162,6 +173,7 @@ class EcoAccountAPISerializerV1(AbstractModelAPISerializerV1,
             # Fill in data to objects
             properties = json_model["properties"]
             obj.title = properties["title"]
+            obj.is_pik = properties.get("is_pik", False)
             obj.deductable_surface = float(properties["deductable_surface"])
             obj.modified = update_action
             obj.geometry.geom = self._create_geometry_from_json(json_model)
@@ -170,6 +182,7 @@ class EcoAccountAPISerializerV1(AbstractModelAPISerializerV1,
             obj = self._set_legal(obj, properties["legal"])
 
             obj.geometry.save()
+            obj.responsible.handler.save()
             obj.responsible.save()
             obj.legal.save()
             obj.save()
@@ -179,8 +192,8 @@ class EcoAccountAPISerializerV1(AbstractModelAPISerializerV1,
             obj = self._set_compensation_states(obj, properties["after_states"], obj.after_states)
             obj = self._set_deadlines(obj, properties["deadlines"])
 
-            obj.log.add(update_action)
+        obj.log.add(update_action)
 
-            celery_update_parcels.delay(obj.geometry.id)
+        celery_update_parcels.delay(obj.geometry.id)
 
-            return obj.id
+        return obj.id

api/utils/serializer/v1/ema.py

@@ -9,11 +9,11 @@ from django.db import transaction
 
 from api.utils.serializer.v1.serializer import AbstractModelAPISerializerV1, AbstractCompensationAPISerializerV1Mixin, \
     ResponsibilityAPISerializerV1Mixin
-from codelist.settings import CODELIST_CONSERVATION_OFFICE_ID
+from codelist.settings import CODELIST_CONSERVATION_OFFICE_ID, CODELIST_HANDLER_ID
 from ema.models import Ema
-from intervention.models import Responsibility
+from intervention.models import Responsibility, Handler
 from konova.models import Geometry
-from konova.tasks import celery_update_parcels
+from konova.tasks import celery_update_parcels, celery_check_for_geometry_conflicts
 from user.models import UserActionLogEntry
 
 
@@ -21,6 +21,7 @@ class EmaAPISerializerV1(AbstractModelAPISerializerV1, AbstractCompensationAPISe
     model = Ema
 
     def _extend_properties_data(self, entry):
+        self.properties_data["is_pik"] = entry.is_pik
         self.properties_data["responsible"] = self._responsible_to_json(entry.responsible)
         self.properties_data["before_states"] = self._compensation_state_to_json(entry.before_states.all())
         self.properties_data["after_states"] = self._compensation_state_to_json(entry.after_states.all())
@@ -31,7 +32,7 @@ class EmaAPISerializerV1(AbstractModelAPISerializerV1, AbstractCompensationAPISe
         return {
             "conservation_office": self._konova_code_to_json(responsible.conservation_office),
             "conservation_file_number": responsible.conservation_file_number,
-            "handler": responsible.handler,
+            "handler": self._handler_to_json(responsible.handler),
         }
 
     def _set_responsibility(self, obj, responsibility_data: dict):
@@ -51,7 +52,11 @@ class EmaAPISerializerV1(AbstractModelAPISerializerV1, AbstractCompensationAPISe
             CODELIST_CONSERVATION_OFFICE_ID,
         )
         obj.responsible.conservation_file_number = responsibility_data["conservation_file_number"]
-        obj.responsible.handler = responsibility_data["handler"]
+        obj.responsible.handler.type = self._konova_code_from_json(
+            responsibility_data["handler"]["type"],
+            CODELIST_HANDLER_ID,
+        )
+        obj.responsible.handler.detail = responsibility_data["handler"]["detail"]
         return obj
 
     def _initialize_objects(self, json_model, user):
@@ -75,9 +80,12 @@ class EmaAPISerializerV1(AbstractModelAPISerializerV1, AbstractCompensationAPISe
 
         # Create linked objects
         obj = Ema()
-        obj.responsible = Responsibility()
+        obj.responsible = Responsibility(
+            handler=Handler()
+        )
         created = create_action
         obj.created = created
+        obj.modified = created
         obj.geometry = geometry
         return obj
 
@@ -98,9 +106,11 @@ class EmaAPISerializerV1(AbstractModelAPISerializerV1, AbstractCompensationAPISe
             properties = json_model["properties"]
             obj.identifier = obj.generate_new_identifier()
             obj.title = properties["title"]
+            obj.is_pik = properties.get("is_pik", False)
             obj = self._set_responsibility(obj, properties["responsible"])
 
             obj.geometry.save()
+            obj.responsible.handler.save()
             obj.responsible.save()
             obj.save()
 
@@ -109,12 +119,13 @@ class EmaAPISerializerV1(AbstractModelAPISerializerV1, AbstractCompensationAPISe
             obj = self._set_compensation_states(obj, properties["after_states"], obj.after_states)
             obj = self._set_deadlines(obj, properties["deadlines"])
 
-            obj.log.add(obj.created)
-            obj.users.add(user)
+        obj.log.add(obj.created)
+        obj.users.add(user)
 
-            celery_update_parcels.delay(obj.geometry.id)
+        celery_update_parcels.delay(obj.geometry.id)
+        celery_check_for_geometry_conflicts.delay(obj.geometry.id)
 
-            return obj.id
+        return obj.id
 
     def update_model_from_json(self, id, json_model, user):
         """ Updates an entry for the model based on the contents of json_model
@@ -134,12 +145,14 @@ class EmaAPISerializerV1(AbstractModelAPISerializerV1, AbstractCompensationAPISe
             # Fill in data to objects
             properties = json_model["properties"]
             obj.title = properties["title"]
+            obj.is_pik = properties.get("is_pik", False)
             obj.modified = update_action
             obj.geometry.geom = self._create_geometry_from_json(json_model)
             obj.geometry.modified = update_action
             obj = self._set_responsibility(obj, properties["responsible"])
 
             obj.geometry.save()
+            obj.responsible.handler.save()
             obj.responsible.save()
             obj.save()
 
@@ -148,8 +161,8 @@ class EmaAPISerializerV1(AbstractModelAPISerializerV1, AbstractCompensationAPISe
             obj = self._set_compensation_states(obj, properties["after_states"], obj.after_states)
             obj = self._set_deadlines(obj, properties["deadlines"])
 
-            obj.log.add(update_action)
+        obj.log.add(update_action)
 
-            celery_update_parcels.delay(obj.geometry.id)
+        celery_update_parcels.delay(obj.geometry.id)
 
-            return obj.id
+        return obj.id

api/utils/serializer/v1/intervention.py

@@ -11,9 +11,9 @@ from django.db.models import QuerySet
 from api.utils.serializer.v1.serializer import AbstractModelAPISerializerV1, \
     ResponsibilityAPISerializerV1Mixin, LegalAPISerializerV1Mixin, DeductableAPISerializerV1Mixin
 from compensation.models import Payment
-from intervention.models import Intervention, Responsibility, Legal
+from intervention.models import Intervention, Responsibility, Legal, Handler
 from konova.models import Geometry
-from konova.tasks import celery_update_parcels
+from konova.tasks import celery_update_parcels, celery_check_for_geometry_conflicts
 from user.models import UserActionLogEntry
 
 
@@ -69,11 +69,14 @@ class InterventionAPISerializerV1(AbstractModelAPISerializerV1,
 
         # Create linked objects
         obj = Intervention()
-        resp = Responsibility()
+        resp = Responsibility(
+            handler=Handler()
+        )
         legal = Legal()
         created = create_action
         obj.legal = legal
         obj.created = created
+        obj.modified = created
         obj.geometry = geometry
         obj.responsible = resp
         return obj
@@ -152,17 +155,19 @@ class InterventionAPISerializerV1(AbstractModelAPISerializerV1,
             self._set_responsibility(obj, properties["responsible"])
             self._set_legal(obj, properties["legal"])
 
+            obj.responsible.handler.save()
             obj.responsible.save()
             obj.geometry.save()
             obj.legal.save()
             obj.save()
 
-            obj.users.add(user)
-            obj.log.add(obj.created)
+        obj.users.add(user)
+        obj.log.add(obj.created)
 
-            celery_update_parcels.delay(obj.geometry.id)
+        celery_update_parcels.delay(obj.geometry.id)
+        celery_check_for_geometry_conflicts.delay(obj.geometry.id)
 
-            return obj.id
+        return obj.id
 
     def update_model_from_json(self, id, json_model, user):
         """ Updates an entry for the model based on the contents of json_model
@@ -188,13 +193,15 @@ class InterventionAPISerializerV1(AbstractModelAPISerializerV1,
             obj.geometry.geom = self._create_geometry_from_json(json_model)
             obj.geometry.modified = update_action
 
+            obj.responsible.handler.save()
             obj.responsible.save()
             obj.geometry.save()
             obj.legal.save()
             obj.save()
 
-            obj.mark_as_edited(user)
+        obj.mark_as_edited(user, edit_comment="API update")
+        obj.send_data_to_egon()
 
-            celery_update_parcels.delay(obj.geometry.id)
+        celery_update_parcels.delay(obj.geometry.id)
 
-            return obj.id
+        return obj.id

api/utils/serializer/v1/serializer.py

@@ -9,15 +9,17 @@ Created on: 24.01.22
 import json
 
 from django.contrib.gis.geos import MultiPolygon
+from django.core.exceptions import ObjectDoesNotExist
 from django.db.models import QuerySet
 
 from api.utils.serializer.serializer import AbstractModelAPISerializer
 from codelist.models import KonovaCode
 from codelist.settings import CODELIST_COMPENSATION_ACTION_ID, CODELIST_BIOTOPES_ID, CODELIST_PROCESS_TYPE_ID, \
     CODELIST_LAW_ID, CODELIST_REGISTRATION_OFFICE_ID, CODELIST_CONSERVATION_OFFICE_ID, \
-    CODELIST_COMPENSATION_ACTION_DETAIL_ID, CODELIST_BIOTOPES_EXTRA_CODES_ID
+    CODELIST_COMPENSATION_ACTION_DETAIL_ID, CODELIST_HANDLER_ID, \
+    CODELIST_BIOTOPES_EXTRA_CODES_FULL_ID
 from compensation.models import CompensationAction, UnitChoices, CompensationState
-from intervention.models import Responsibility, Legal
+from intervention.models import Responsibility, Legal, Handler
 from konova.models import Deadline, DeadlineType
 from konova.utils.message_templates import DATA_UNSHARED
 
@@ -60,7 +62,7 @@ class AbstractModelAPISerializerV1(AbstractModelAPISerializer):
         if konova_code is None:
             return None
         return {
-            "atom_id": konova_code.atom_id,
+            "id": konova_code.id,
             "long_name": konova_code.long_name,
             "short_name": konova_code.short_name,
         }
@@ -69,18 +71,25 @@ class AbstractModelAPISerializerV1(AbstractModelAPISerializer):
         """ Returns a konova code instance
 
         Args:
-            json_str (str): The value for the code (atom id)
+            json_str (str): The value for the code (id)
             code_list_identifier (str): From which konova code list this code is supposed to be from
 
         Returns:
 
         """
-        if json_str is None or len(json_str) == 0:
+        if json_str is None:
             return None
-        code = KonovaCode.objects.get(
-            atom_id=json_str,
-            code_lists__in=[code_list_identifier]
-        )
+        json_str = str(json_str)
+        if len(json_str) == 0:
+            return None
+        try:
+            code = KonovaCode.objects.get(
+                id=json_str,
+                code_lists__in=[code_list_identifier]
+            )
+        except ObjectDoesNotExist as e:
+            msg = f"{e.args[0]} ({json_str} not found in official list {code_list_identifier})"
+            raise ObjectDoesNotExist(msg)
         return code
 
     def _created_on_to_json(self, entry):
@@ -176,6 +185,12 @@ class ResponsibilityAPISerializerV1Mixin:
     class Meta:
         abstract = True
 
+    def _handler_to_json(self, handler: Handler):
+        return {
+            "type": self._konova_code_to_json(handler.type),
+            "detail": handler.detail
+        }
+
     def _responsible_to_json(self, responsible: Responsibility):
         """ Serializes Responsibility model into json
 
@@ -190,7 +205,7 @@ class ResponsibilityAPISerializerV1Mixin:
             "registration_file_number": responsible.registration_file_number,
             "conservation_office": self._konova_code_to_json(responsible.conservation_office),
             "conservation_file_number": responsible.conservation_file_number,
-            "handler": responsible.handler,
+            "handler": self._handler_to_json(responsible.handler),
         }
 
     def _set_responsibility(self, obj, responsibility_data: dict):
@@ -215,7 +230,11 @@ class ResponsibilityAPISerializerV1Mixin:
             CODELIST_CONSERVATION_OFFICE_ID,
         )
         obj.responsible.conservation_file_number = responsibility_data["conservation_file_number"]
-        obj.responsible.handler = responsibility_data["handler"]
+        obj.responsible.handler.type = self._konova_code_from_json(
+            responsibility_data["handler"]["type"],
+            CODELIST_HANDLER_ID,
+        )
+        obj.responsible.handler.detail = responsibility_data["handler"]["detail"]
         return obj
 
 
@@ -279,9 +298,12 @@ class AbstractCompensationAPISerializerV1Mixin:
         """
         deadlines = []
         for entry in deadline_data:
-            deadline_type = entry["type"]
-            date = entry["date"]
-            comment = entry["comment"]
+            try:
+                deadline_type = entry["type"]
+                date = entry["date"]
+                comment = entry["comment"]
+            except KeyError:
+                raise ValueError(f"Invalid deadline content. Content was {entry} but should follow the specification")
 
             # Check on validity
             if deadline_type not in DeadlineType:
@@ -323,11 +345,14 @@ class AbstractCompensationAPISerializerV1Mixin:
         """
         states = []
         for entry in states_data:
-            biotope_type = entry["biotope"]
-            biotope_details = [
-                self._konova_code_from_json(e, CODELIST_BIOTOPES_EXTRA_CODES_ID) for e in entry["biotope_details"]
-            ]
-            surface = float(entry["surface"])
+            try:
+                biotope_type = entry["biotope"]
+                biotope_details = [
+                    self._konova_code_from_json(e, CODELIST_BIOTOPES_EXTRA_CODES_FULL_ID) for e in entry["biotope_details"]
+                ]
+                surface = float(entry["surface"])
+            except KeyError:
+                raise ValueError(f"Invalid biotope content. Content was {entry} but should follow the specification ")
 
             # Check on validity
             if surface <= 0:
@@ -336,7 +361,7 @@ class AbstractCompensationAPISerializerV1Mixin:
             # If this exact data is already existing, we do not create it new. Instead put it's id in the list of
             # entries, we will use to set the new actions
             state = states_manager.filter(
-                biotope_type__atom_id=biotope_type,
+                biotope_type__id=biotope_type,
                 surface=surface,
             ).exclude(
                 id__in=states
@@ -367,13 +392,19 @@ class AbstractCompensationAPISerializerV1Mixin:
         """
         actions = []
         for entry in actions_data:
-            action = entry["action"]
-            action_details = [
-                self._konova_code_from_json(e, CODELIST_COMPENSATION_ACTION_DETAIL_ID) for e in entry["action_details"]
-            ]
-            amount = float(entry["amount"])
-            unit = entry["unit"]
-            comment = entry["comment"]
+            try:
+                action_types = [
+                    self._konova_code_from_json(e, CODELIST_COMPENSATION_ACTION_ID) for e in entry["action_types"]
+                ]
+                action_details = [
+                    self._konova_code_from_json(e, CODELIST_COMPENSATION_ACTION_DETAIL_ID) for e in entry["action_details"]
+                ]
+                amount = float(entry["amount"])
+                # Mapping of old "qm" into "m²"
+                unit = UnitChoices.m2.value if entry["unit"] == "qm" else entry["unit"]
+                comment = entry["comment"]
+            except KeyError:
+                raise ValueError(f"Invalid action content. Content was {entry} but should follow specification")
 
             # Check on validity
             if amount <= 0:
@@ -384,7 +415,7 @@ class AbstractCompensationAPISerializerV1Mixin:
             # If this exact data is already existing, we do not create it new. Instead put it's id in the list of
             # entries, we will use to set the new actions
             action_entry = obj.actions.filter(
-                action_type__atom_id=action,
+                action_type__in=action_types,
                 amount=amount,
                 unit=unit,
                 comment=comment,
@@ -396,13 +427,13 @@ class AbstractCompensationAPISerializerV1Mixin:
             else:
                 # Create and add id to list
                 action_entry = CompensationAction.objects.create(
-                    action_type=self._konova_code_from_json(action, CODELIST_COMPENSATION_ACTION_ID),
                     amount=amount,
                     unit=unit,
                     comment=comment,
                 )
                 actions.append(action_entry.id)
 
+            action_entry.action_type.set(action_types)
             action_entry.action_type_details.set(action_details)
         obj.actions.set(actions)
         return obj
@@ -438,7 +469,9 @@ class AbstractCompensationAPISerializerV1Mixin:
         """
         return [
             {
-                "action": self._konova_code_to_json(entry.action_type),
+                "action_types": [
+                    self._konova_code_to_json(action) for action in entry.action_type.all()
+                ],
                 "action_details": [
                     self._konova_code_to_json(detail) for detail in entry.action_type_details.all()
                 ],

api/views/v1/views.py

@@ -21,14 +21,8 @@ class AbstractAPIViewV1(AbstractAPIView):
     """ Holds general serialization functions for API v1
 
     """
-    serializer = None
 
     def __init__(self, *args, **kwargs):
-        self.lookup = {
-            "id": None,  # must be set in subclasses
-            "deleted__isnull": True,
-            "users__in": [],  # must be set in subclasses
-        }
         super().__init__(*args, **kwargs)
         self.serializer = self.serializer()
 
@@ -45,11 +39,17 @@ class AbstractAPIViewV1(AbstractAPIView):
             response (JsonResponse)
         """
         try:
+            self.rpp = int(request.GET.get("rpp", self.rpp))
+            self.page_number = int(request.GET.get("p", self.page_number))
+
+            self.serializer.rpp = self.rpp
+            self.serializer.page_number = self.page_number
+
             self.serializer.prepare_lookup(id, self.user)
             data = self.serializer.fetch_and_serialize()
         except Exception as e:
-            return self.return_error_response(e, 500)
-        return JsonResponse(data)
+            return self._return_error_response(e, 500)
+        return self._return_response(request, data)
 
     def post(self, request: HttpRequest):
         """ Handles the POST request
@@ -67,7 +67,7 @@ class AbstractAPIViewV1(AbstractAPIView):
             body = json.loads(body)
             created_id = self.serializer.create_model_from_json(body, self.user)
         except Exception as e:
-            return self.return_error_response(e, 500)
+            return self._return_error_response(e, 500)
         return JsonResponse({"id": created_id})
 
     def put(self, request: HttpRequest, id=None):
@@ -87,7 +87,7 @@ class AbstractAPIViewV1(AbstractAPIView):
             body = json.loads(body)
             updated_id = self.serializer.update_model_from_json(id, body, self.user)
         except Exception as e:
-            return self.return_error_response(e, 500)
+            return self._return_error_response(e, 500)
         return JsonResponse({"id": updated_id})
 
     def delete(self, request: HttpRequest, id=None):
@@ -104,7 +104,7 @@ class AbstractAPIViewV1(AbstractAPIView):
         try:
             success = self.serializer.delete_entry(id, self.user)
         except Exception as e:
-            return self.return_error_response(e, 500)
+            return self._return_error_response(e, 500)
         return JsonResponse(
             {
                 "success": success,

api/views/views.py

@@ -18,8 +18,7 @@ from compensation.models import EcoAccount
 from ema.models import Ema
 from intervention.models import Intervention
 from konova.utils.message_templates import DATA_UNSHARED
-from konova.utils.user_checks import is_default_group_only
-from user.models import User
+from user.models import User, Team
 
 
 class AbstractAPIView(View):
@@ -31,24 +30,43 @@ class AbstractAPIView(View):
 
     """
     user = None
+    serializer = None
+    rpp = 5  # Results per page default
+    page_number = 1  # Page number default
 
     class Meta:
         abstract = True
 
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.response_body_base = {
+            "rpp": None,
+            "p": None,
+            "next": None,
+            "results": None
+        }
+
     @csrf_exempt
     def dispatch(self, request, *args, **kwargs):
         try:
             # Fetch the proper user from the given request header token
             ksp_token = request.headers.get(KSP_TOKEN_HEADER_IDENTIFIER, None)
             ksp_user = request.headers.get(KSP_USER_HEADER_IDENTIFIER, None)
-            self.user = APIUserToken.get_user_from_token(ksp_token, ksp_user)
+            token_user = APIUserToken.get_user_from_token(ksp_token)
+
+            if ksp_user != token_user.username:
+                raise PermissionError(f"Invalid token for {ksp_user}")
+            else:
+                self.user = token_user
+
+            request.user = self.user
             if not self.user.is_default_user():
                 raise PermissionError("Default permissions required")
         except PermissionError as e:
-            return self.return_error_response(e, 403)
+            return self._return_error_response(e, 403)
         return super().dispatch(request, *args, **kwargs)
 
-    def return_error_response(self, error, status_code=500):
+    def _return_error_response(self, error, status_code=500):
         """ Returns an error as JsonReponse
 
         Args:
@@ -68,6 +86,31 @@ class AbstractAPIView(View):
             status=status_code
         )
 
+    def _return_response(self, request: HttpRequest, data):
+        """ Returns all important data into a response object
+
+        Args:
+            request (HttpRequest): The incoming request
+            data (dict): The serialized data
+
+        Returns:
+            response (JsonResponse): The response to be returned
+        """
+        response = self.response_body_base
+        next_page = self.page_number + 1
+        next_page = next_page if next_page in self.serializer.paginator.page_range else None
+        if next_page is not None:
+            next_url = request.build_absolute_uri(
+                request.path + f"?rpp={self.rpp}&p={next_page}"
+            )
+        else:
+            next_url = None
+        response["rpp"] = self.rpp
+        response["p"] = self.page_number
+        response["next"] = next_url
+        response["results"] = data
+        return JsonResponse(response)
+
 
 class InterventionCheckAPIView(AbstractAPIView):
 
@@ -82,14 +125,14 @@ class InterventionCheckAPIView(AbstractAPIView):
             response (JsonResponse)
         """
         if not self.user.is_zb_user():
-            return self.return_error_response("Permission not granted", 403)
+            return self._return_error_response("Permission not granted", 403)
         try:
             obj = Intervention.objects.get(
                 id=id,
                 users__in=[self.user]
             )
         except Exception as e:
-            return self.return_error_response(e)
+            return self._return_error_response(e)
 
         all_valid, check_details = self.run_quality_checks(obj)
 
@@ -160,13 +203,21 @@ class AbstractModelShareAPIView(AbstractAPIView):
         """
         try:
             users = self._get_shared_users_of_object(id)
+            teams = self._get_shared_teams_of_object(id)
         except Exception as e:
-            return self.return_error_response(e)
+            return self._return_error_response(e)
 
         data = {
             "users": [
                 user.username for user in users
-            ]
+            ],
+            "teams": [
+                {
+                    "id": team.id,
+                    "name": team.name,
+                }
+                for team in teams
+            ],
         }
 
         return JsonResponse(data)
@@ -185,7 +236,7 @@ class AbstractModelShareAPIView(AbstractAPIView):
         try:
             success = self._process_put_body(request.body, id)
         except Exception as e:
-            return self.return_error_response(e)
+            return self._return_error_response(e)
         data = {
             "success": success,
         }
@@ -220,6 +271,22 @@ class AbstractModelShareAPIView(AbstractAPIView):
         users = obj.shared_users
         return users
 
+    def _get_shared_teams_of_object(self, id) -> QuerySet:
+        """ Check permissions and get the teams
+
+        Args:
+            id (str): The object's id
+
+        Returns:
+            users (QuerySet)
+        """
+        obj = self.model.objects.get(
+            id=id
+        )
+        self._check_user_has_shared_access(obj)
+        teams = obj.shared_teams
+        return teams
+
     def _process_put_body(self, body: bytes, id: str):
         """ Reads the body data, performs validity checks and sets the new users
 
@@ -233,20 +300,27 @@ class AbstractModelShareAPIView(AbstractAPIView):
         obj = self.model.objects.get(id=id)
         self._check_user_has_shared_access(obj)
 
-        new_users = json.loads(body.decode("utf-8"))
-        new_users = new_users.get("users", [])
+        content = json.loads(body.decode("utf-8"))
+        new_users = content.get("users", [])
         if len(new_users) == 0:
             raise ValueError("Shared user list must not be empty!")
+        new_teams = content.get("teams", [])
 
         # Eliminate duplicates
         new_users = list(dict.fromkeys(new_users))
+        new_teams = list(dict.fromkeys(new_teams))
 
         # Make sure each of these names exist as a user
         new_users_objs = []
         for user in new_users:
             new_users_objs.append(User.objects.get(username=user))
 
-        if is_default_group_only(self.user):
+        # Make sure each of these names exist as a user
+        new_teams_objs = []
+        for team_name in new_teams:
+            new_teams_objs.append(Team.objects.get(name=team_name))
+
+        if self.user.is_default_group_only():
             # Default only users are not allowed to remove other users from having access. They can only add new ones!
             new_users_to_be_added = User.objects.filter(
                 username__in=new_users
@@ -254,7 +328,16 @@ class AbstractModelShareAPIView(AbstractAPIView):
                 id__in=obj.shared_users
             )
             new_users_objs = obj.shared_users.union(new_users_to_be_added)
-        obj.share_with_list(new_users_objs)
+
+            new_teams_to_be_added = Team.objects.filter(
+                name__in=new_teams
+            ).exclude(
+                id__in=obj.shared_teams
+            )
+            new_teams_objs = obj.shared_teams.union(new_teams_to_be_added)
+
+        obj.share_with_user_list(new_users_objs)
+        obj.share_with_team_list(new_teams_objs)
         return True
 
 

codelist/admin.py

@@ -33,6 +33,7 @@ class KonovaCodeAdmin(admin.ModelAdmin):
         "is_selectable",
         "is_leaf",
         "parent",
+        "found_in_codelists",
     ]
 
     search_fields = [
@@ -42,6 +43,12 @@ class KonovaCodeAdmin(admin.ModelAdmin):
         "short_name",
     ]
 
+    def found_in_codelists(self, obj):
+        codelists = KonovaCodeList.objects.filter(
+            codes__in=[obj]
+        ).values_list("id", flat=True)
+        codelists = "\n".join(str(x) for x in codelists)
+        return codelists
 
 #admin.site.register(KonovaCodeList, KonovaCodeListAdmin)
 admin.site.register(KonovaCode, KonovaCodeAdmin)

codelist/autocomplete/__init__.py

@@ -0,0 +1,7 @@
+"""
+Author: Michel Peltriaux
+Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany
+Contact: ksp-servicestelle@sgdnord.rlp.de
+Created on: 18.08.22
+
+"""

codelist/autocomplete/base.py

@@ -0,0 +1,74 @@
+"""
+Author: Michel Peltriaux
+Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany
+Contact: ksp-servicestelle@sgdnord.rlp.de
+Created on: 18.08.22
+
+"""
+from dal_select2.views import Select2GroupQuerySetView
+from django.db.models import Q
+
+from codelist.models import KonovaCode
+
+
+class KonovaCodeAutocomplete(Select2GroupQuerySetView):
+    """
+    Provides simple autocomplete functionality for codes
+
+    Parameter support:
+    * q: Search for a word inside long_name of a code
+    * c: Search inside a special codelist
+
+    """
+    paginate_by = 50
+
+    def order_by(self, qs):
+        """ Orders by a predefined value
+
+        Wrapped in a function to provide inheritance-based different orders
+
+        Args:
+            qs (QuerySet): The queryset to be ordered
+
+        Returns:
+            qs (QuerySet): The ordered queryset
+        """
+        return qs.order_by(
+            "long_name"
+        )
+
+    def get_queryset(self):
+        if self.request.user.is_anonymous:
+            return KonovaCode.objects.none()
+        qs = KonovaCode.objects.filter(
+            is_archived=False,
+            is_selectable=True,
+            is_leaf=True,
+        )
+        qs = self.order_by(qs)
+        if self.c:
+            qs = qs.filter(
+                code_lists__in=[self.c]
+            )
+        if self.q:
+            # Remove whitespaces from self.q and split input in all keywords (if multiple given)
+            q = dict.fromkeys(self.q.strip().split(" "))
+            # Create one filter looking up for all keys where all keywords can be found in the same result
+            _filter = Q()
+            for keyword in q:
+                q_or = Q()
+                q_or |= Q(long_name__icontains=keyword)
+                q_or |= Q(short_name__icontains=keyword)
+                q_or |= Q(parent__long_name__icontains=keyword)
+                q_or |= Q(parent__short_name__icontains=keyword)
+                q_or |= Q(parent__parent__long_name__icontains=keyword)
+                q_or |= Q(parent__parent__short_name__icontains=keyword)
+                _filter.add(q_or, Q.AND)
+            qs = qs.filter(_filter).distinct()
+        return qs
+
+    def get_result_label(self, result):
+        return f"{result.long_name}"
+
+    def get_selected_result_label(self, result):
+        return f"{result.__str__()}"

codelist/autocomplete/biotope.py

@@ -0,0 +1,114 @@
+"""
+Author: Michel Peltriaux
+Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany
+Contact: ksp-servicestelle@sgdnord.rlp.de
+Created on: 18.08.22
+
+"""
+import collections
+
+from django.core.exceptions import ImproperlyConfigured
+
+from codelist.settings import CODELIST_BIOTOPES_ID, \
+    CODELIST_BIOTOPES_EXTRA_CODES_FULL_ID
+from codelist.autocomplete.base import KonovaCodeAutocomplete
+from konova.utils.message_templates import UNGROUPED
+
+
+class BiotopeCodeAutocomplete(KonovaCodeAutocomplete):
+    """
+    Due to limitations of the django dal package, we need to subclass for each code list
+    """
+    group_by_related = "parent"
+    related_field_name = "long_name"
+
+    def __init__(self, *args, **kwargs):
+        self.c = CODELIST_BIOTOPES_ID
+        super().__init__(*args, **kwargs)
+
+    def order_by(self, qs):
+        """ Orders by a predefined value
+
+        Wrapped in a function to provide inheritance-based different orders
+
+        Args:
+            qs (QuerySet): The queryset to be ordered
+
+        Returns:
+            qs (QuerySet): The ordered queryset
+        """
+        return qs.order_by(
+            "short_name",
+        )
+
+    def get_result_label(self, result):
+        return f"{result.long_name} ({result.short_name})"
+
+    def get_results(self, context):
+        """Return the options grouped by a common related model.
+
+        Raises ImproperlyConfigured if self.group_by_name is not configured
+        """
+        if not self.group_by_related:
+            raise ImproperlyConfigured("Missing group_by_related.")
+
+        super_groups = collections.OrderedDict()
+
+        object_list = context['object_list']
+
+        for result in object_list:
+            group = result.parent if result.parent else None
+            group_name = f"{group.long_name} ({group.short_name})" if group else UNGROUPED
+            super_group = result.parent.parent if result.parent else None
+            super_group_name = f"{super_group.long_name} ({super_group.short_name})" if super_group else UNGROUPED
+            super_groups.setdefault(super_group_name, {})
+            super_groups[super_group_name].setdefault(group_name, [])
+            super_groups[super_group_name][group_name].append(result)
+
+        return [{
+            'id': None,
+            'text': super_group,
+            'children': [{
+                "id": None,
+                "text": group,
+                "children": [{
+                    'id': self.get_result_value(result),
+                    'text': self.get_result_label(result),
+                    'selected_text': self.get_selected_result_label(result),
+                } for result in results]
+            } for group, results in groups.items()]
+        } for super_group, groups in super_groups.items()]
+
+
+class BiotopeExtraCodeAutocomplete(KonovaCodeAutocomplete):
+    """
+    Due to limitations of the django dal package, we need to subclass for each code list
+    """
+    group_by_related = "parent"
+    related_field_name = "short_name"
+    paginate_by = 200
+
+    def __init__(self, *args, **kwargs):
+        self.c = CODELIST_BIOTOPES_EXTRA_CODES_FULL_ID
+        super().__init__(*args, **kwargs)
+
+    def order_by(self, qs):
+        """ Orders by a predefined value
+
+        Wrapped in a function to provide inheritance-based different orders
+
+        Args:
+            qs (QuerySet): The queryset to be ordered
+
+        Returns:
+            qs (QuerySet): The ordered queryset
+        """
+        return qs.order_by(
+            "short_name",
+        )
+
+    def get_result_label(self, result):
+        return f"{result.long_name} ({result.short_name})"
+
+    def get_selected_result_label(self, result):
+        return f"{result.parent.short_name} > {result.long_name} ({result.short_name})"

codelist/autocomplete/compensation_action.py

@@ -0,0 +1,45 @@
+"""
+Author: Michel Peltriaux
+Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany
+Contact: ksp-servicestelle@sgdnord.rlp.de
+Created on: 18.08.22
+
+"""
+from codelist.settings import CODELIST_COMPENSATION_ACTION_ID, CODELIST_COMPENSATION_ACTION_DETAIL_ID
+from codelist.autocomplete.base import KonovaCodeAutocomplete
+
+
+class CompensationActionCodeAutocomplete(KonovaCodeAutocomplete):
+    """
+    Due to limitations of the django dal package, we need to subclass for each code list
+    """
+    group_by_related = "parent"
+    related_field_name = "long_name"
+
+    def __init__(self, *args, **kwargs):
+        self.c = CODELIST_COMPENSATION_ACTION_ID
+        super().__init__(*args, **kwargs)
+
+    def order_by(self, qs):
+        return qs.order_by(
+            "parent__long_name"
+        )
+
+
+class CompensationActionDetailCodeAutocomplete(KonovaCodeAutocomplete):
+    """
+    Due to limitations of the django dal package, we need to subclass for each code list
+    """
+    group_by_related = "parent"
+    related_field_name = "long_name"
+    paginate_by = 200
+
+    def __init__(self, *args, **kwargs):
+        self.c = CODELIST_COMPENSATION_ACTION_DETAIL_ID
+        super().__init__(*args, **kwargs)
+
+    def order_by(self, qs):
+        return qs.order_by(
+            "long_name"
+        )
+

codelist/autocomplete/handler.py

@@ -0,0 +1,24 @@
+"""
+Author: Michel Peltriaux
+Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany
+Contact: ksp-servicestelle@sgdnord.rlp.de
+Created on: 18.08.22
+
+"""
+from codelist.settings import CODELIST_HANDLER_ID
+from codelist.autocomplete.base import KonovaCodeAutocomplete
+
+
+class HandlerCodeAutocomplete(KonovaCodeAutocomplete):
+    """
+    Due to limitations of the django dal package, we need to subclass for each code list
+    """
+    group_by_related = "parent"
+    related_field_name = "long_name"
+
+    def __init__(self, *args, **kwargs):
+        self.c = CODELIST_HANDLER_ID
+        super().__init__(*args, **kwargs)
+
+    def get_result_label(self, result):
+        return result.long_name

codelist/autocomplete/law.py

@@ -0,0 +1,24 @@
+"""
+Author: Michel Peltriaux
+Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany
+Contact: ksp-servicestelle@sgdnord.rlp.de
+Created on: 18.08.22
+
+"""
+from codelist.settings import CODELIST_LAW_ID
+from codelist.autocomplete.base import KonovaCodeAutocomplete
+
+
+class LawCodeAutocomplete(KonovaCodeAutocomplete):
+    """
+    Due to limitations of the django dal package, we need to subclass for each code list
+    """
+    group_by_related = "parent"
+    related_field_name = "long_name"
+
+    def __init__(self, *args, **kwargs):
+        self.c = CODELIST_LAW_ID
+        super().__init__(*args, **kwargs)
+
+    def get_result_label(self, result):
+        return f"{result.long_name} ({result.short_name})"

codelist/autocomplete/office.py

@@ -0,0 +1,41 @@
+"""
+Author: Michel Peltriaux
+Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany
+Contact: ksp-servicestelle@sgdnord.rlp.de
+Created on: 18.08.22
+
+"""
+from codelist.settings import CODELIST_CONSERVATION_OFFICE_ID, CODELIST_REGISTRATION_OFFICE_ID
+from codelist.autocomplete.base import KonovaCodeAutocomplete
+
+
+class RegistrationOfficeCodeAutocomplete(KonovaCodeAutocomplete):
+    """
+    Due to limitations of the django dal package, we need to subclass for each code list
+    """
+    group_by_related = "parent"
+    related_field_name = "long_name"
+
+    def __init__(self, *args, **kwargs):
+        self.c = CODELIST_REGISTRATION_OFFICE_ID
+        super().__init__(*args, **kwargs)
+
+    def order_by(self, qs):
+        return qs.order_by(
+            "parent__long_name"
+        )
+
+
+class ConservationOfficeCodeAutocomplete(KonovaCodeAutocomplete):
+    """
+    Due to limitations of the django dal package, we need to subclass for each code list
+    """
+    group_by_related = "parent"
+    related_field_name = "long_name"
+
+    def __init__(self, *args, **kwargs):
+        self.c = CODELIST_CONSERVATION_OFFICE_ID
+        super().__init__(*args, **kwargs)
+
+    def get_result_label(self, result):
+        return f"{result.long_name} ({result.short_name})"

codelist/autocomplete/process_type.py

@@ -0,0 +1,21 @@
+"""
+Author: Michel Peltriaux
+Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany
+Contact: ksp-servicestelle@sgdnord.rlp.de
+Created on: 18.08.22
+
+"""
+from codelist.autocomplete.base import KonovaCodeAutocomplete
+from codelist.settings import CODELIST_PROCESS_TYPE_ID
+
+
+class ProcessTypeCodeAutocomplete(KonovaCodeAutocomplete):
+    """
+    Due to limitations of the django dal package, we need to subclass for each code list
+    """
+    group_by_related = "parent"
+    related_field_name = "long_name"
+
+    def __init__(self, *args, **kwargs):
+        self.c = CODELIST_PROCESS_TYPE_ID
+        super().__init__(*args, **kwargs)

codelist/management/commands/sync_codelist.py

@@ -0,0 +1,165 @@
+"""
+Author: Michel Peltriaux
+Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany
+Contact: michel.peltriaux@sgdnord.rlp.de
+Created on: 31.05.22
+
+"""
+
+from django.db import transaction
+
+from codelist.models import KonovaCode
+from compensation.models import CompensationAction, CompensationState
+from intervention.models import Legal, Handler, Responsibility
+from konova.management.commands.setup import BaseKonovaCommand
+
+
+class Command(BaseKonovaCommand):
+    help = "Updates internal codelist by external API"
+
+    def handle(self, *args, **options):
+        try:
+            with transaction.atomic():
+                self.sync_codelist()
+        except KeyboardInterrupt:
+            self._break_line()
+            exit(-1)
+
+    def __get_newest_code(self, code):
+        code = KonovaCode.objects.filter(
+            atom_id=code.atom_id,
+            parent=code.parent,
+            code_lists__in=code.code_lists.all(),
+        ).order_by(
+            "-id"
+        ).first()
+        return code
+
+    def __migrate_compensation_action_codes(self):
+        all_actions = CompensationAction.objects.all()
+        used_codes = []
+        for action in all_actions:
+            stored_codes = action.action_type.all()
+            codes = []
+            for code in stored_codes:
+                codes.append(self.__get_newest_code(code))
+            action.action_type.set(codes)
+            used_codes += codes
+
+            stored_codes = action.action_type_details.all()
+            codes = []
+            for code in stored_codes:
+                codes.append(self.__get_newest_code(code))
+            action.action_type_details.set(codes)
+            used_codes += codes
+
+            action.save()
+        return used_codes
+
+    def __migrate_compensation_state_codes(self):
+        all_states = CompensationState.objects.all()
+        used_codes = []
+        for state in all_states:
+            code = state.biotope_type
+            if code is not None:
+                new_code = self.__get_newest_code(code)
+                state.biotope_type = new_code
+                used_codes.append(new_code)
+
+            stored_codes = state.biotope_type_details.all()
+            codes = []
+            for code in stored_codes:
+                codes.append(self.__get_newest_code(code))
+            state.biotope_type_details.set(codes)
+
+            used_codes += codes
+            state.save()
+        return used_codes
+
+    def __migrate_legal_codes(self):
+        all_legal = Legal.objects.all()
+        used_codes = []
+        for legal in all_legal:
+            code = legal.process_type
+            if code is not None:
+                new_code = self.__get_newest_code(code)
+                legal.process_type = new_code
+                used_codes.append(new_code)
+
+            stored_codes = legal.laws.all()
+            codes = []
+            for code in stored_codes:
+                codes.append(self.__get_newest_code(code))
+            legal.laws.set(codes)
+
+            used_codes += codes
+            legal.save()
+        return used_codes
+
+    def __migrate_handler_codes(apps):
+        all_handlers = Handler.objects.all()
+        used_codes = []
+        for handler in all_handlers:
+            code = handler.type
+            if code is None:
+                continue
+            new_code = apps.__get_newest_code(code)
+            handler.type = new_code
+            used_codes.append(new_code)
+            handler.save()
+        return used_codes
+
+    def __migrate_responsibility_codes(apps):
+        all_resps = Responsibility.objects.all()
+        used_codes = []
+        for responsibility in all_resps:
+            code = responsibility.registration_office
+            if code is not None:
+                new_code = apps.__get_newest_code(code)
+                responsibility.registration_office = new_code
+                used_codes.append(new_code)
+
+            code = responsibility.conservation_office
+            if code is not None:
+                new_code = apps.__get_newest_code(code)
+                responsibility.conservation_office = new_code
+                used_codes.append(new_code)
+
+            responsibility.save()
+        return used_codes
+
+    def sync_codelist(self):
+        """ Due to issues on the external codelist app there can be multiple entries of the same code
+        (atom_id, parent, list) but with different identifiers.
+
+        These issues have been resolved but already
+
+        Returns:
+
+        """
+        self._write_warning("Sync codes in usage and replace by newest entries...")
+        used_codes = []
+        used_codes += self.__migrate_compensation_action_codes()
+        used_codes += self.__migrate_compensation_state_codes()
+        used_codes += self.__migrate_legal_codes()
+        used_codes += self.__migrate_handler_codes()
+        used_codes += self.__migrate_responsibility_codes()
+        self._write_success(f"Synced {len(used_codes)} code usages!")
+
+        all_codes = KonovaCode.objects.all()
+        newest_code_ids = []
+        for code in all_codes:
+            newest_code = self.__get_newest_code(code)
+            newest_code_ids.append(newest_code.id)
+
+        code_ids_to_keep = set(newest_code_ids)
+        self._write_warning(f"Of {all_codes.count()} KonovaCodes there are {len(code_ids_to_keep)} to keep as newest versions...")
+
+        deletable_codes = KonovaCode.objects.all().exclude(
+            id__in=code_ids_to_keep
+        )
+        deletable_codes_count = deletable_codes.count()
+        self._write_warning(f"{deletable_codes_count} found which are obsolet...")
+        if deletable_codes_count > 0:
+            deletable_codes.delete()
+            self._write_success("Obsolete codes deleted!")

codelist/management/commands/update_codelist.py

@@ -6,15 +6,14 @@ Created on: 23.08.21
 
 """
 import requests
-from django.core.management import BaseCommand
 from xml.etree import ElementTree as etree
 
 from codelist.models import KonovaCode, KonovaCodeList
 from codelist.settings import CODELIST_INTERVENTION_HANDLER_ID, CODELIST_CONSERVATION_OFFICE_ID, \
-    CODELIST_REGISTRATION_OFFICE_ID, CODELIST_BIOTOPES_ID, CODELIST_LAW_ID, CODELIST_COMPENSATION_HANDLER_ID, \
+    CODELIST_REGISTRATION_OFFICE_ID, CODELIST_BIOTOPES_ID, CODELIST_LAW_ID, CODELIST_HANDLER_ID, \
     CODELIST_COMPENSATION_ACTION_ID, CODELIST_COMPENSATION_ACTION_CLASS_ID, CODELIST_COMPENSATION_ADDITIONAL_TYPE_ID, \
     CODELIST_BASE_URL, CODELIST_PROCESS_TYPE_ID, CODELIST_BIOTOPES_EXTRA_CODES_ID, \
-    CODELIST_COMPENSATION_ACTION_DETAIL_ID
+    CODELIST_COMPENSATION_ACTION_DETAIL_ID, CODELIST_BIOTOPES_EXTRA_CODES_FULL_ID
 from konova.management.commands.setup import BaseKonovaCommand
 from konova.settings import PROXIES
 
@@ -35,8 +34,9 @@ class Command(BaseKonovaCommand):
                 CODELIST_REGISTRATION_OFFICE_ID,
                 CODELIST_BIOTOPES_ID,
                 CODELIST_BIOTOPES_EXTRA_CODES_ID,
+                CODELIST_BIOTOPES_EXTRA_CODES_FULL_ID,
                 CODELIST_LAW_ID,
-                CODELIST_COMPENSATION_HANDLER_ID,
+                CODELIST_HANDLER_ID,
                 CODELIST_COMPENSATION_ACTION_ID,
                 CODELIST_COMPENSATION_ACTION_CLASS_ID,
                 CODELIST_COMPENSATION_ACTION_DETAIL_ID,
@@ -56,7 +56,7 @@ class Command(BaseKonovaCommand):
                 content = result.content.decode("utf-8")
                 root = etree.fromstring(content)
                 items = root.findall("item")
-                self._write_warning("Found {} codes. Process now...".format(len(items)))
+                self._write_warning("   Found {} codes. Process now...".format(len(items)))
 
                 code_list = KonovaCodeList.objects.get_or_create(
                     id=list_id,
@@ -75,7 +75,7 @@ class Command(BaseKonovaCommand):
         if items is None:
             return
         else:
-            self._write_warning(" --- Found {} subcodes. Process now...".format(len(items)))
+            self._write_warning("       --- Found {} subcodes. Process now...".format(len(items)))
             for element in items:
                 children = element.find("items")
                 _id = element.find("id").text

codelist/migrations/0001_initial.py

@@ -1,9 +1,13 @@
 # Generated by Django 3.1.3 on 2022-01-14 08:36
-
+from django.core.management import call_command
 from django.db import migrations, models
 import django.db.models.deletion
 
 
+def load_initial_codes(apps, schema_editor):
+    call_command('update_codelist')
+
+
 class Migration(migrations.Migration):
 
     initial = True
@@ -32,4 +36,5 @@ class Migration(migrations.Migration):
                 ('codes', models.ManyToManyField(blank=True, help_text='Codes for this list', related_name='code_lists', to='codelist.KonovaCode')),
             ],
         ),
+        migrations.RunPython(load_initial_codes),
     ]

codelist/migrations/0002_migrate_975_to_288.py

@@ -0,0 +1,60 @@
+# Generated by Django 5.0.7 on 2024-08-06 13:40
+
+from django.core.exceptions import ObjectDoesNotExist
+from django.db import migrations
+from django.db.models import Q
+
+from codelist.settings import CODELIST_BIOTOPES_EXTRA_CODES_FULL_ID, CODELIST_BIOTOPES_EXTRA_CODES_ID
+
+
+def migrate_975_to_288(apps, schema_editor):
+    KonovaCodeList = apps.get_model('codelist', 'KonovaCodeList')
+    CompensationState = apps.get_model('compensation', 'CompensationState')
+
+    try:
+        list_288 = KonovaCodeList.objects.get(
+            id=CODELIST_BIOTOPES_EXTRA_CODES_FULL_ID
+        ).codes.all()
+    except ObjectDoesNotExist:
+        raise AssertionError("KonovaCodeList 288 does not exist. Did you run 'update_codelist' before migrating?")
+
+    states_with_extra_code = CompensationState.objects.filter(
+        ~Q(biotope_type_details=None)
+    )
+
+    print(f"... Found {states_with_extra_code.count()} biotope state entries")
+    for state in states_with_extra_code:
+        extra_codes_975 = state.biotope_type_details.filter(
+            code_lists__in=[CODELIST_BIOTOPES_EXTRA_CODES_ID]
+        )
+        count_extra_codes_975 = extra_codes_975.count()
+        if count_extra_codes_975 > 0:
+            print(f"    --> Found {count_extra_codes_975} codes from list 975 in biotope entry {state.id}")
+        extra_codes_288 = []
+        for extra_code_975 in extra_codes_975:
+            atom_id = extra_code_975.atom_id
+            codes_from_288 = list_288.filter(
+                atom_id=atom_id,
+            )
+            extra_codes_288 += codes_from_288
+
+        state.biotope_type_details.set(extra_codes_288)
+    print("    --> Migrated to list 288 for all biotope entries")
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('codelist', '0001_initial'),
+        ('compensation', '0003_auto_20220202_0846'),
+    ]
+
+    # If migration of codelist is not necessary, this variable can shut down the logic whilst not disturbing the
+    # migration history
+    EXECUTE_CODELIST_MIGRATION = True
+
+    operations = []
+
+    if EXECUTE_CODELIST_MIGRATION:
+        operations.append(migrations.RunPython(migrate_975_to_288))
+

codelist/migrations/0003_alter_konovacode_long_name_and_more.py

@@ -0,0 +1,25 @@
+# Generated by Django 5.0.8 on 2024-08-26 16:47
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('codelist', '0002_migrate_975_to_288'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='konovacode',
+            name='long_name',
+            field=models.CharField(blank=True, default="", max_length=1000),
+            preserve_default=False,
+        ),
+        migrations.AlterField(
+            model_name='konovacode',
+            name='short_name',
+            field=models.CharField(blank=True, default="", help_text='Short version of long name', max_length=500),
+            preserve_default=False,
+        ),
+    ]

codelist/models.py

@@ -25,13 +25,11 @@ class KonovaCode(models.Model):
     )
     short_name = models.CharField(
         max_length=500,
-        null=True,
         blank=True,
         help_text="Short version of long name",
     )
     long_name = models.CharField(
         max_length=1000,
-        null=True,
         blank=True,
         help_text="",
     )
@@ -50,12 +48,28 @@ class KonovaCode(models.Model):
 
     def __str__(self, with_parent: bool = True):
         ret_val = ""
-        if self.parent and with_parent:
-            ret_val += self.parent.long_name + " > "
-        ret_val += self.long_name
-        if self.short_name and self.short_name != self.long_name:
-            # Only add short name, if we won't have stupid repition like 'thing a (thing a)' due to misused long-short names
-            ret_val += f" ({self.short_name})"
+
+        long_name = self.long_name
+        short_name = self.short_name
+
+        both_names_exist = long_name is not None and short_name is not None
+
+        if both_names_exist:
+            if with_parent and self.parent:
+                parent_short_name_exists = self.parent.short_name is not None
+                parent_long_name_exists = self.parent.long_name is not None
+                if parent_long_name_exists:
+                    ret_val += self.parent.long_name + " > "
+                elif parent_short_name_exists:
+                    ret_val += self.parent.short_name + " > "
+
+            ret_val += long_name
+
+            if short_name and short_name != long_name:
+                ret_val += f" ({short_name})"
+        else:
+            ret_val += str(long_name or short_name)
+
         return ret_val
 
     @property
@@ -65,6 +79,26 @@ class KonovaCode(models.Model):
             ret_val += ", " + self.parent.long_name
         return ret_val
 
+    def add_children(self, order_by: str = "long_name"):
+        """ Adds all children (resurcively until leaf) as .children to the KonovaCode
+
+        Returns:
+            code (KonovaCode): The manipulated KonovaCode instance
+        """
+        if self.is_leaf:
+            return self
+
+        children = KonovaCode.objects.filter(
+            parent=self,
+            is_archived=False,
+        ).order_by(
+            order_by
+        )
+        self.children = children
+        for child in children:
+            child.add_children(order_by)
+        return self
+
 
 class KonovaCodeList(models.Model):
     """

codelist/settings.py

@@ -13,12 +13,14 @@ CODELIST_BASE_URL = "https://codelisten.naturschutz.rlp.de/repository/referenzli
 CODELIST_INTERVENTION_HANDLER_ID = 903  # CLMassnahmeträger
 CODELIST_CONSERVATION_OFFICE_ID = 907  # CLNaturschutzbehörden
 CODELIST_REGISTRATION_OFFICE_ID = 1053  # CLZulassungsbehörden
-CODELIST_BIOTOPES_ID = 974  # CL_EIV_Biotoptypen
-CODELIST_BIOTOPES_EXTRA_CODES_ID = 975  # CLZusatzbezeichnung
+CODELIST_BIOTOPES_ID = 654  # CL_Biotoptypen
+CODELIST_AFTER_STATE_BIOTOPES_ID = 974  # CL-KSP_ZielBiotoptypen - USAGE HAS BEEN DROPPED IN 2022 IN FAVOR OF 654
+CODELIST_BIOTOPES_EXTRA_CODES_ID = 975  # CLZusatzbezeichnung - Subset of 288. Migration usage 975->288 in 08/2024
+CODELIST_BIOTOPES_EXTRA_CODES_FULL_ID = 288  # CLBiotoptypZusatzcode
 CODELIST_LAW_ID = 1048  # CLVerfahrensrecht
 CODELIST_PROCESS_TYPE_ID = 44382  # CLVerfahrenstyp
 
-CODELIST_COMPENSATION_HANDLER_ID = 1052  # CLEingreifer
+CODELIST_HANDLER_ID = 1052  # CLEingreifer
 CODELIST_COMPENSATION_ACTION_ID = 1026  # CLMassnahmedetail
 CODELIST_COMPENSATION_ACTION_DETAIL_ID = 1035  # CLZusatzmerkmal
 CODELIST_COMPENSATION_ACTION_CLASS_ID = 1034  # CLMassnahmeklasse

codelist/urls.py

@@ -7,8 +7,24 @@ Created on: 23.08.21
 """
 from django.urls import path
 
+from codelist.autocomplete.biotope import BiotopeCodeAutocomplete, BiotopeExtraCodeAutocomplete
+from codelist.autocomplete.compensation_action import CompensationActionDetailCodeAutocomplete, \
+    CompensationActionCodeAutocomplete
+from codelist.autocomplete.handler import HandlerCodeAutocomplete
+from codelist.autocomplete.law import LawCodeAutocomplete
+from codelist.autocomplete.office import ConservationOfficeCodeAutocomplete, RegistrationOfficeCodeAutocomplete
+from codelist.autocomplete.process_type import ProcessTypeCodeAutocomplete
 
 app_name = "codelist"
 urlpatterns = [
-
+    path("atcmplt/codes/biotope", BiotopeCodeAutocomplete.as_view(), name="biotope-autocomplete"),
+    path("atcmplt/codes/biotope/extra", BiotopeExtraCodeAutocomplete.as_view(),
+         name="biotope-extra-type-autocomplete"),
+    path("atcmplt/codes/law", LawCodeAutocomplete.as_view(), name="law-autocomplete"),
+    path("atcmplt/codes/reg-off", RegistrationOfficeCodeAutocomplete.as_view(), name="registration-office-autocomplete"),
+    path("atcmplt/codes/cons-off", ConservationOfficeCodeAutocomplete.as_view(), name="conservation-office-autocomplete"),
+    path("atcmplt/codes/handler", HandlerCodeAutocomplete.as_view(), name="handler-autocomplete"),
+    path("atcmplt/codes/comp/action", CompensationActionCodeAutocomplete.as_view(), name="compensation-action-autocomplete"),
+    path("atcmplt/codes/comp/action/detail", CompensationActionDetailCodeAutocomplete.as_view(), name="compensation-action-detail-autocomplete"),
+    path("atcmplt/codes/prc-type", ProcessTypeCodeAutocomplete.as_view(), name="process-type-autocomplete"),
 ]

compensation/admin.py

@@ -3,6 +3,8 @@ from django.contrib import admin
 from compensation.models import Compensation, CompensationAction, CompensationState, Payment, \
     EcoAccountDeduction, EcoAccount
 from konova.admin import BaseObjectAdmin, BaseResourceAdmin
+from konova.utils.message_templates import COMPENSATION_REMOVED_TEMPLATE
+from user.models import UserAction
 
 
 class AbstractCompensationAdmin(BaseObjectAdmin):
@@ -19,16 +21,30 @@ class AbstractCompensationAdmin(BaseObjectAdmin):
             "identifier",
             "title",
             "comment",
-            "after_states",
-            "before_states",
+            "list_after_states",
+            "list_before_states",
+            "geometry",
         ]
 
     def get_readonly_fields(self, request, obj=None):
         return super().get_readonly_fields(request, obj) + [
-            "after_states",
-            "before_states",
+            "list_after_states",
+            "list_before_states",
+            "geometry",
         ]
 
+    def list_after_states(self, obj):
+        states = obj.after_states.all()
+        states = [str(state) for state in states]
+        states = "\n".join(states)
+        return states
+
+    def list_before_states(self, obj):
+        states = obj.before_states.all()
+        states = [str(state) for state in states]
+        states = "\n".join(states)
+        return states
+
 
 class CompensationAdmin(AbstractCompensationAdmin):
     autocomplete_fields = [
@@ -39,9 +55,21 @@ class CompensationAdmin(AbstractCompensationAdmin):
         return super().get_fields(request, obj) + [
             "is_cef",
             "is_coherence_keeping",
+            "is_pik",
             "intervention",
         ]
 
+    def restore_deleted_data(self, request, queryset):
+        super().restore_deleted_data(request, queryset)
+
+        for entry in queryset:
+            # Remove delete log entry from related intervention log history
+            logs = entry.intervention.log.filter(
+                action=UserAction.EDITED,
+                comment=COMPENSATION_REMOVED_TEMPLATE.format(entry.identifier)
+            )
+            logs.delete()
+
 
 class EcoAccountAdmin(AbstractCompensationAdmin):
     list_display = [
@@ -53,13 +81,15 @@ class EcoAccountAdmin(AbstractCompensationAdmin):
     ]
 
     filter_horizontal = [
-        "users"
+        "users",
+        "teams",
     ]
 
     def get_fields(self, request, obj=None):
         return super().get_fields(request, obj) + [
             "deductable_surface",
-            "users"
+            "users",
+            "teams",
         ]
 
 
@@ -118,7 +148,7 @@ class CompensationActionAdmin(admin.ModelAdmin):
 
 admin.site.register(Compensation, CompensationAdmin)
 admin.site.register(EcoAccount, EcoAccountAdmin)
-admin.site.register(EcoAccountDeduction, EcoAccountDeductionAdmin)
+#admin.site.register(EcoAccountDeduction, EcoAccountDeductionAdmin)
 
 # For a more cleaner admin interface these rarely used admin views are not important for deployment
 #admin.site.register(Payment, PaymentAdmin)

compensation/autocomplete/__init__.py

@@ -0,0 +1,7 @@
+"""
+Author: Michel Peltriaux
+Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany
+Contact: ksp-servicestelle@sgdnord.rlp.de
+Created on: 18.08.22
+
+"""

compensation/autocomplete/eco_account.py

@@ -0,0 +1,40 @@
+"""
+Author: Michel Peltriaux
+Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany
+Contact: ksp-servicestelle@sgdnord.rlp.de
+Created on: 18.08.22
+
+"""
+from dal_select2.views import Select2QuerySetView
+from django.db.models import Q
+
+from compensation.models import EcoAccount
+
+
+class EcoAccountAutocomplete(Select2QuerySetView):
+    """ Autocomplete for ecoAccount entries
+
+    Only returns entries that are already recorded and not deleted
+
+    """
+    def get_queryset(self):
+        if self.request.user.is_anonymous:
+            return EcoAccount.objects.none()
+        qs = EcoAccount.objects.filter(
+            deleted=None,
+            recorded__isnull=False,
+        ).order_by(
+            "identifier"
+        )
+        if self.q:
+            qs = qs.filter(
+                Q(identifier__icontains=self.q) |
+                Q(title__icontains=self.q)
+            ).distinct()
+        return qs
+
+    def get_result_label(self, result):
+        return str(result)
+
+    def get_selected_result_label(self, result):
+        return str(result)

compensation/filters/__init__.py

@@ -0,0 +1,7 @@
+"""
+Author: Michel Peltriaux
+Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany
+Contact: ksp-servicestelle@sgdnord.rlp.de
+Created on: 18.08.22
+
+"""

compensation/filters/compensation.py

@@ -1,17 +1,14 @@
 """
 Author: Michel Peltriaux
 Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany
-Contact: michel.peltriaux@sgdnord.rlp.de
-Created on: 29.07.21
+Contact: ksp-servicestelle@sgdnord.rlp.de
+Created on: 18.08.22
 
 """
-import django_filters
-from django.utils.translation import gettext_lazy as _
-from django import forms
 from django.db.models import QuerySet, Q
 
-from konova.filters.mixins import ConservationOfficeTableFilterMixin
-from konova.filters.table_filters import QueryTableFilter, CheckboxTableFilter, SelectionTableFilter, AbstractTableFilter
+from konova.filters.table_filters import AbstractTableFilter, CheckboxTableFilter, QueryTableFilter, \
+    SelectionTableFilter
 
 
 class SelectionCompensationTableFilter(SelectionTableFilter):
@@ -58,9 +55,12 @@ class CheckboxCompensationTableFilter(CheckboxTableFilter):
 
         """
         if not value:
-            return queryset.filter(
-                intervention__users__in=[self.user],  # requesting user has access
-            )
+            user_teams = self.user.shared_teams
+            result = queryset.filter(
+                Q(intervention__users__in=[self.user]) |  # requesting user has access
+                Q(intervention__teams__in=user_teams)
+            ).distinct()
+            return result
         else:
             return queryset
 
@@ -113,89 +113,3 @@ class CompensationTableFilter(AbstractTableFilter):
         )
         # Overwrite final queryset as well
         self.qs = self.checkbox_filter.qs
-
-
-class CheckboxEcoAccountTableFilter(CheckboxTableFilter):
-    sr = django_filters.BooleanFilter(
-        method='filter_only_show_unrecorded',
-        label=_("Show only unrecorded"),
-        label_suffix=_(""),
-        widget=forms.CheckboxInput(
-            attrs={
-                "class": "form-check-input",
-            }
-        )
-    )
-
-    def filter_show_all(self, queryset, name, value) -> QuerySet:
-        """ Filters queryset depending on value of 'show_all' setting
-
-        Args:
-            queryset ():
-            name ():
-            value ():
-
-        Returns:
-
-        """
-        if not value:
-            return queryset.filter(
-                users__in=[self.user],  # requesting user has access
-            )
-        else:
-            return queryset
-
-    def filter_only_show_unrecorded(self, queryset, name, value) -> QuerySet:
-        """ Filters queryset depending on value of 'show_recorded' setting
-
-        Args:
-            queryset ():
-            name ():
-            value ():
-
-        Returns:
-
-        """
-        if value:
-            return queryset.filter(
-                recorded=None,
-            )
-        else:
-            return queryset
-
-
-class SelectionEcoAccountTableFilter(ConservationOfficeTableFilterMixin):
-    """ Special selection table filter for eco accounts
-
-    EcoAccounts only need a selection filter for conservation office
-
-    """
-    pass
-
-
-class EcoAccountTableFilter(AbstractTableFilter):
-    """ TableFilter for eco accounts
-
-    """
-    def __init__(self, user=None, *args, **kwargs):
-        super().__init__(*args, **kwargs)
-        self.user = user
-        qs = kwargs.get("queryset", None)
-        request_data = kwargs.get("data", None)
-
-        # Pipe the queryset through all needed filters
-        self.selection_filter = SelectionEcoAccountTableFilter(
-            data=request_data,
-            queryset=qs,
-        )
-        self.query_filter = QueryTableFilter(
-            data=request_data,
-            queryset=self.selection_filter.qs,
-        )
-        self.checkbox_filter = CheckboxEcoAccountTableFilter(
-            user=user,
-            data=request_data,
-            queryset=self.query_filter.qs,
-        )
-        # Overwrite the final queryset result
-        self.qs = self.checkbox_filter.qs

compensation/filters/eco_account.py

@@ -0,0 +1,82 @@
+"""
+Author: Michel Peltriaux
+Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany
+Contact: ksp-servicestelle@sgdnord.rlp.de
+Created on: 18.08.22
+
+"""
+from django import forms
+from django.db.models import QuerySet
+from django.utils.translation import gettext_lazy as _
+import django_filters
+
+from konova.filters.mixins.office import ConservationOfficeTableFilterMixin
+from konova.filters.table_filters import AbstractTableFilter, CheckboxTableFilter, QueryTableFilter
+
+
+class CheckboxEcoAccountTableFilter(CheckboxTableFilter):
+    sr = django_filters.BooleanFilter(
+        method='filter_only_show_unrecorded',
+        label=_("Show only unrecorded"),
+        label_suffix=_(""),
+        widget=forms.CheckboxInput(
+            attrs={
+                "class": "form-check-input",
+            }
+        )
+    )
+
+    def filter_only_show_unrecorded(self, queryset, name, value) -> QuerySet:
+        """ Filters queryset depending on value of 'show_recorded' setting
+
+        Args:
+            queryset ():
+            name ():
+            value ():
+
+        Returns:
+
+        """
+        if value:
+            return queryset.filter(
+                recorded=None,
+            )
+        else:
+            return queryset
+
+
+class SelectionEcoAccountTableFilter(ConservationOfficeTableFilterMixin):
+    """ Special selection table filter for eco accounts
+
+    EcoAccounts only need a selection filter for conservation office
+
+    """
+    pass
+
+
+class EcoAccountTableFilter(AbstractTableFilter):
+    """ TableFilter for eco accounts
+
+    """
+    def __init__(self, user=None, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.user = user
+        qs = kwargs.get("queryset", None)
+        request_data = kwargs.get("data", None)
+
+        # Pipe the queryset through all needed filters
+        self.selection_filter = SelectionEcoAccountTableFilter(
+            data=request_data,
+            queryset=qs,
+        )
+        self.query_filter = QueryTableFilter(
+            data=request_data,
+            queryset=self.selection_filter.qs,
+        )
+        self.checkbox_filter = CheckboxEcoAccountTableFilter(
+            user=user,
+            data=request_data,
+            queryset=self.query_filter.qs,
+        )
+        # Overwrite the final queryset result
+        self.qs = self.checkbox_filter.qs

compensation/forms/__init__.py

@@ -0,0 +1,7 @@
+"""
+Author: Michel Peltriaux
+Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany
+Contact: ksp-servicestelle@sgdnord.rlp.de
+Created on: 18.08.22
+
+"""

compensation/forms/compensation.py

@@ -0,0 +1,240 @@
+"""
+Author: Michel Peltriaux
+Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany
+Contact: ksp-servicestelle@sgdnord.rlp.de
+Created on: 18.08.22
+
+"""
+from dal import autocomplete
+from django import forms
+from django.db import transaction
+from django.urls import reverse, reverse_lazy
+from django.utils.translation import gettext_lazy as _
+
+from compensation.forms.mixins import CEFCompensationFormMixin, CoherenceCompensationFormMixin, PikCompensationFormMixin
+from compensation.models import Compensation
+from intervention.inputs import GenerateInput
+from intervention.models import Intervention
+from konova.forms import BaseForm, SimpleGeomForm
+from konova.utils.message_templates import COMPENSATION_ADDED_TEMPLATE, EDITED_GENERAL_DATA
+from user.models import UserActionLogEntry, User
+
+
+class AbstractCompensationForm(BaseForm):
+    """ Abstract form for compensations
+
+    Holds all important form fields, which are used in compensation and eco account forms
+
+    """
+    identifier = forms.CharField(
+        label=_("Identifier"),
+        label_suffix="",
+        max_length=255,
+        help_text=_("Generated automatically - not editable"),
+        widget=GenerateInput(
+            attrs={
+                "class": "form-control",
+                "url": None,  # Needs to be set in inheriting constructors
+                "readonly": True,
+            }
+        )
+    )
+    title = forms.CharField(
+        label=_("Title"),
+        label_suffix="",
+        help_text=_("An explanatory name"),
+        max_length=255,
+        widget=forms.TextInput(
+            attrs={
+                "placeholder": _("Compensation XY; Location ABC"),
+                "class": "form-control",
+            }
+        )
+    )
+    comment = forms.CharField(
+        label_suffix="",
+        label=_("Comment"),
+        required=False,
+        help_text=_("Additional comment"),
+        widget=forms.Textarea(
+            attrs={
+                "rows": 5,
+                "class": "form-control"
+            }
+        )
+    )
+
+    class Meta:
+        abstract = True
+
+
+class NewCompensationForm(AbstractCompensationForm,
+                          CEFCompensationFormMixin,
+                          CoherenceCompensationFormMixin,
+                          PikCompensationFormMixin):
+    """ Form for creating new compensations.
+
+    Can be initialized with an intervention id for preselecting the related intervention.
+        form = NewCompensationForm(request.POST or None, intervention_id=intervention_id)
+        ...
+    The intervention id will not be resolved into the intervention ORM object but instead will be used to initialize
+    the related form field.
+
+    """
+    intervention = forms.ModelChoiceField(
+        label=_("compensates intervention"),
+        label_suffix="",
+        help_text=_("Select the intervention for which this compensation compensates"),
+        queryset=Intervention.objects.filter(
+            deleted=None,
+        ),
+        widget=autocomplete.ModelSelect2(
+            url="intervention:autocomplete",
+            attrs={
+                "data-placeholder": _("Click for selection"),
+                "data-minimum-input-length": 3,
+            }
+        ),
+    )
+
+    # Define a field order for a nicer layout instead of running with the inheritance result
+    field_order = [
+        "identifier",
+        "title",
+        "intervention",
+        "is_pik",
+        "is_cef",
+        "is_coherence_keeping",
+        "comment",
+    ]
+
+    def __init__(self, *args, **kwargs):
+        intervention_id = kwargs.pop("intervention_id", None)
+        super().__init__(*args, **kwargs)
+        self.form_title = _("New compensation")
+
+        # If the compensation shall directly be initialized from an intervention, we need to fill in the intervention id
+        # and disable the form field.
+        # Furthermore the action_url needs to be set accordingly.
+        if intervention_id is not None:
+            self.initialize_form_field("intervention", intervention_id)
+            self.disable_form_field("intervention")
+            self.action_url = reverse("compensation:new", args=(intervention_id,))
+            self.cancel_redirect = reverse("intervention:detail", args=(intervention_id,))
+        else:
+            self.action_url = reverse("compensation:new")
+            self.cancel_redirect = reverse("compensation:index")
+
+        tmp = Compensation()
+        identifier = tmp.generate_new_identifier()
+        self.initialize_form_field("identifier", identifier)
+        self.fields["identifier"].widget.attrs["url"] = reverse_lazy("compensation:new-id")
+
+    def __create_comp(self, user):
+        """ Creates the compensation from form data
+
+        Args:
+            user (User): The performing user
+
+        Returns:
+            comp (Compensation): The compensation object
+        """
+        # Fetch data from cleaned POST values
+        identifier = self.cleaned_data.get("identifier", None)
+        title = self.cleaned_data.get("title", None)
+        intervention = self.cleaned_data.get("intervention", None)
+        is_cef = self.cleaned_data.get("is_cef", None)
+        is_coherence_keeping = self.cleaned_data.get("is_coherence_keeping", None)
+        is_pik = self.cleaned_data.get("is_pik", None)
+        comment = self.cleaned_data.get("comment", None)
+
+        # Create log entry
+        action = UserActionLogEntry.get_created_action(user)
+
+        # Finally create main object
+        comp = Compensation.objects.create(
+            identifier=identifier,
+            title=title,
+            intervention=intervention,
+            created=action,
+            modified=action,
+            is_cef=is_cef,
+            is_coherence_keeping=is_coherence_keeping,
+            is_pik=is_pik,
+            comment=comment,
+        )
+
+        # Add the log entry to the main objects log list
+        comp.log.add(action)
+        return comp, action
+
+    def save(self, user: User, geom_form: SimpleGeomForm):
+        with transaction.atomic():
+            comp, action = self.__create_comp(user)
+            comp.intervention.mark_as_edited(user, edit_comment=COMPENSATION_ADDED_TEMPLATE.format(comp.identifier))
+
+        # Process the geometry form
+        geometry = geom_form.save(action)
+        comp.geometry = geometry
+        comp.save()
+
+        return comp
+
+
+class EditCompensationForm(NewCompensationForm):
+    """ Form for editing compensations
+
+    """
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.form_title = _("Edit compensation")
+        self.action_url = reverse("compensation:edit", args=(self.instance.id,))
+        self.cancel_redirect = reverse("compensation:detail", args=(self.instance.id,))
+
+        # Initialize form data
+        form_data = {
+            "identifier": self.instance.identifier,
+            "title": self.instance.title,
+            "intervention": self.instance.intervention,
+            "is_cef": self.instance.is_cef,
+            "is_coherence_keeping": self.instance.is_coherence_keeping,
+            "is_pik": self.instance.is_pik,
+            "comment": self.instance.comment,
+        }
+        disabled_fields = []
+        self.load_initial_data(
+            form_data,
+            disabled_fields
+        )
+
+    def save(self, user: User, geom_form: SimpleGeomForm):
+        with transaction.atomic():
+            # Create log entry
+            action = UserActionLogEntry.get_edited_action(user)
+
+            # Fetch data from cleaned POST values
+            title = self.cleaned_data.get("title", None)
+            intervention = self.cleaned_data.get("intervention", None)
+            is_cef = self.cleaned_data.get("is_cef", None)
+            is_coherence_keeping = self.cleaned_data.get("is_coherence_keeping", None)
+            is_pik = self.cleaned_data.get("is_pik", None)
+            comment = self.cleaned_data.get("comment", None)
+
+            self.instance.title = title
+            self.instance.intervention = intervention
+            self.instance.is_cef = is_cef
+            self.instance.is_coherence_keeping = is_coherence_keeping
+            self.instance.comment = comment
+            self.instance.is_pik = is_pik
+            self.instance.modified = action
+            self.instance.save()
+
+            self.instance.log.add(action)
+            intervention.mark_as_edited(user, self.request, EDITED_GENERAL_DATA)
+
+        # Process the geometry form (NOT ATOMIC TRANSACTION DUE TO CELERY!)
+        geometry = geom_form.save(action)
+        self.instance.geometry = geometry
+        self.instance.save()
+
+        return self.instance

compensation/forms/eco_account.py

@@ -0,0 +1,249 @@
+"""
+Author: Michel Peltriaux
+Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany
+Contact: ksp-servicestelle@sgdnord.rlp.de
+Created on: 18.08.22
+
+"""
+from django import forms
+from django.db import transaction
+from django.urls import reverse, reverse_lazy
+from django.utils.translation import gettext_lazy as _
+from compensation.forms.compensation import AbstractCompensationForm
+from compensation.forms.mixins import CompensationResponsibleFormMixin, PikCompensationFormMixin
+from compensation.models import EcoAccount
+from intervention.models import Handler, Responsibility, Legal
+from konova.forms import SimpleGeomForm
+from konova.forms.modals import RemoveModalForm
+from konova.utils import validators
+from user.models import User, UserActionLogEntry
+
+
+class NewEcoAccountForm(AbstractCompensationForm, CompensationResponsibleFormMixin, PikCompensationFormMixin):
+    """ Form for creating eco accounts
+
+    Inherits from basic AbstractCompensationForm and further form fields from CompensationResponsibleFormMixin
+
+    """
+    surface = forms.DecimalField(
+        min_value=0.00,
+        decimal_places=2,
+        label=_("Available Surface"),
+        label_suffix="",
+        required=False,
+        help_text=_("The amount that can be used for deductions"),
+        widget=forms.NumberInput(
+            attrs={
+                "class": "form-control",
+                "placeholder": "0,00"
+            }
+        )
+    )
+    registration_date = forms.DateField(
+        label=_("Agreement date"),
+        label_suffix="",
+        help_text=_("When did the parties agree on this?"),
+        required=False,
+        validators=[validators.reasonable_date],
+        widget=forms.DateInput(
+            attrs={
+                "type": "date",
+                "class": "form-control",
+            },
+            format="%d.%m.%Y"
+        )
+    )
+
+    field_order = [
+        "identifier",
+        "title",
+        "conservation_office",
+        "registration_date",
+        "surface",
+        "conservation_file_number",
+        "is_pik",
+        "handler_type",
+        "handler_detail",
+        "comment",
+    ]
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.form_title = _("New Eco-Account")
+
+        self.action_url = reverse("compensation:acc:new")
+        self.cancel_redirect = reverse("compensation:acc:index")
+
+        tmp = EcoAccount()
+        identifier = tmp.generate_new_identifier()
+        self.initialize_form_field("identifier", identifier)
+        self.fields["identifier"].widget.attrs["url"] = reverse_lazy("compensation:acc:new-id")
+        self.fields["title"].widget.attrs["placeholder"] = _("Eco-Account XY; Location ABC")
+
+    def save(self, user: User, geom_form: SimpleGeomForm):
+        with transaction.atomic():
+            # Fetch data from cleaned POST values
+            identifier = self.cleaned_data.get("identifier", None)
+            title = self.cleaned_data.get("title", None)
+            registration_date = self.cleaned_data.get("registration_date", None)
+            handler_type = self.cleaned_data.get("handler_type", None)
+            handler_detail = self.cleaned_data.get("handler_detail", None)
+            surface = self.cleaned_data.get("surface", None)
+            conservation_office = self.cleaned_data.get("conservation_office", None)
+            conservation_file_number = self.cleaned_data.get("conservation_file_number", None)
+            is_pik = self.cleaned_data.get("is_pik", None)
+            comment = self.cleaned_data.get("comment", None)
+
+            # Create log entry
+            action = UserActionLogEntry.get_created_action(user)
+
+            handler = Handler.objects.create(
+                type=handler_type,
+                detail=handler_detail,
+            )
+
+            responsible = Responsibility.objects.create(
+                handler=handler,
+                conservation_file_number=conservation_file_number,
+                conservation_office=conservation_office,
+            )
+
+            legal = Legal.objects.create(
+                registration_date=registration_date
+            )
+
+            # Finally create main object
+            acc = EcoAccount.objects.create(
+                identifier=identifier,
+                title=title,
+                responsible=responsible,
+                deductable_surface=surface,
+                created=action,
+                modified=action,
+                comment=comment,
+                is_pik=is_pik,
+                legal=legal
+            )
+            acc.share_with_user(user)
+
+            # Add the log entry to the main objects log list
+            acc.log.add(action)
+
+        # Process the geometry form
+        geometry = geom_form.save(action)
+        acc.geometry = geometry
+        acc.save()
+        acc.update_deductable_rest()
+        return acc
+
+
+class EditEcoAccountForm(NewEcoAccountForm):
+    """ Form for editing eco accounts
+
+    """
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.form_title = _("Edit Eco-Account")
+
+        self.action_url = reverse("compensation:acc:edit", args=(self.instance.id,))
+        self.cancel_redirect = reverse("compensation:acc:detail", args=(self.instance.id,))
+
+        # Initialize form data
+        reg_date = self.instance.legal.registration_date
+        if reg_date is not None:
+            reg_date = reg_date.isoformat()
+
+        form_data = {
+            "identifier": self.instance.identifier,
+            "title": self.instance.title,
+            "surface": self.instance.deductable_surface,
+            "handler_type": self.instance.responsible.handler.type,
+            "handler_detail": self.instance.responsible.handler.detail,
+            "registration_date": reg_date,
+            "conservation_office": self.instance.responsible.conservation_office,
+            "conservation_file_number": self.instance.responsible.conservation_file_number,
+            "is_pik": self.instance.is_pik,
+            "comment": self.instance.comment,
+        }
+        disabled_fields = []
+        self.load_initial_data(
+            form_data,
+            disabled_fields
+        )
+
+    def is_valid(self):
+        valid = super().is_valid()
+
+        deductable_surface = self.cleaned_data.get("surface") or 0.0
+        deduction_surface_sum = self.instance.get_deductions_surface()
+        if deductable_surface < deduction_surface_sum:
+            self.add_error(
+                "surface",
+                _("{}m² have been deducted from this eco account so far. The given value of {} would be too low.").format(
+                    deduction_surface_sum,
+                    deductable_surface
+                )
+            )
+            valid &= False
+
+        return valid
+
+    def save(self, user: User, geom_form: SimpleGeomForm):
+        with transaction.atomic():
+            # Fetch data from cleaned POST values
+            title = self.cleaned_data.get("title", None)
+            registration_date = self.cleaned_data.get("registration_date", None)
+            handler_type = self.cleaned_data.get("handler_type", None)
+            handler_detail = self.cleaned_data.get("handler_detail", None)
+            surface = self.cleaned_data.get("surface", None)
+            conservation_office = self.cleaned_data.get("conservation_office", None)
+            conservation_file_number = self.cleaned_data.get("conservation_file_number", None)
+            comment = self.cleaned_data.get("comment", None)
+            is_pik = self.cleaned_data.get("is_pik", None)
+
+            # Create log entry
+            action = UserActionLogEntry.get_edited_action(user)
+
+            # Update responsible data
+            self.instance.responsible.handler.type = handler_type
+            self.instance.responsible.handler.detail = handler_detail
+            self.instance.responsible.handler.save()
+            self.instance.responsible.conservation_office = conservation_office
+            self.instance.responsible.conservation_file_number = conservation_file_number
+            self.instance.responsible.save()
+
+            # Update legal data
+            self.instance.legal.registration_date = registration_date
+            self.instance.legal.save()
+
+            # Update main oject data
+            self.instance.title = title
+            self.instance.deductable_surface = surface
+            self.instance.comment = comment
+            self.instance.is_pik = is_pik
+            self.instance.modified = action
+            self.instance.save()
+
+            # Add the log entry to the main objects log list
+            self.instance.log.add(action)
+
+        # Process the geometry form (NOT ATOMIC TRANSACTION DUE TO CELERY!)
+        geometry = geom_form.save(action)
+        self.instance.geometry = geometry
+        self.instance.save()
+        self.instance.update_deductable_rest()
+        return self.instance
+
+
+class RemoveEcoAccountModalForm(RemoveModalForm):
+
+    def is_valid(self):
+        super_valid = super().is_valid()
+        has_deductions = self.instance.deductions.exists()
+        if has_deductions:
+            self.add_error(
+                "confirm",
+                _("The account can not be removed, since there are still deductions.")
+            )
+        return super_valid and not has_deductions

compensation/forms/forms.py

@@ -1,467 +0,0 @@
-"""
-Author: Michel Peltriaux
-Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany
-Contact: michel.peltriaux@sgdnord.rlp.de
-Created on: 04.12.20
-
-"""
-from dal import autocomplete
-from user.models import User
-from django.db import transaction
-from django.urls import reverse_lazy, reverse
-from django.utils.translation import gettext_lazy as _
-from django import forms
-
-from codelist.models import KonovaCode
-from codelist.settings import CODELIST_CONSERVATION_OFFICE_ID
-from compensation.models import Compensation, EcoAccount
-from intervention.inputs import GenerateInput
-from intervention.models import Intervention, Responsibility, Legal
-from konova.forms import BaseForm, SimpleGeomForm
-from konova.utils.message_templates import EDITED_GENERAL_DATA
-from user.models import UserActionLogEntry
-
-
-class AbstractCompensationForm(BaseForm):
-    """ Abstract form for compensations
-
-    Holds all important form fields, which are used in compensation and eco account forms
-
-    """
-    identifier = forms.CharField(
-        label=_("Identifier"),
-        label_suffix="",
-        max_length=255,
-        help_text=_("Generated automatically"),
-        widget=GenerateInput(
-            attrs={
-                "class": "form-control",
-                "url": None,  # Needs to be set in inheriting constructors
-            }
-        )
-    )
-    title = forms.CharField(
-        label=_("Title"),
-        label_suffix="",
-        help_text=_("An explanatory name"),
-        max_length=255,
-        widget=forms.TextInput(
-            attrs={
-                "placeholder": _("Compensation XY; Location ABC"),
-                "class": "form-control",
-            }
-        )
-    )
-    comment = forms.CharField(
-        label_suffix="",
-        label=_("Comment"),
-        required=False,
-        help_text=_("Additional comment"),
-        widget=forms.Textarea(
-            attrs={
-                "rows": 5,
-                "class": "form-control"
-            }
-        )
-    )
-
-    class Meta:
-        abstract = True
-
-
-class CompensationResponsibleFormMixin(forms.Form):
-    """ Encapsulates form fields used in different compensation related models like EcoAccount or EMA
-
-    """
-    conservation_office = forms.ModelChoiceField(
-        label=_("Conservation office"),
-        label_suffix="",
-        help_text=_("Select the responsible office"),
-        queryset=KonovaCode.objects.filter(
-            is_archived=False,
-            is_leaf=True,
-            code_lists__in=[CODELIST_CONSERVATION_OFFICE_ID],
-        ),
-        widget=autocomplete.ModelSelect2(
-            url="codes-conservation-office-autocomplete",
-            attrs={
-                "data-placeholder": _("Click for selection")
-            }
-        ),
-    )
-    conservation_file_number = forms.CharField(
-        label=_("Conservation office file number"),
-        label_suffix="",
-        max_length=255,
-        required=False,
-        widget=forms.TextInput(
-            attrs={
-                "placeholder": _("ETS-123/ABC.456"),
-                "class": "form-control",
-            }
-        )
-    )
-    handler = forms.CharField(
-        label=_("Eco-account handler"),
-        label_suffix="",
-        max_length=255,
-        required=False,
-        help_text=_("Who handles the eco-account"),
-        widget=forms.TextInput(
-            attrs={
-                "placeholder": _("Company Mustermann"),
-                "class": "form-control",
-            }
-        )
-    )
-
-
-class CEFCompensationFormMixin(forms.Form):
-    """ A form mixin, providing CEF compensation field
-
-    """
-    is_cef = forms.BooleanField(
-        label_suffix="",
-        label=_("Is CEF"),
-        help_text=_("Optionally: Whether this compensation is a CEF compensation?"),
-        required=False,
-        widget=forms.CheckboxInput()
-    )
-
-
-class CoherenceCompensationFormMixin(forms.Form):
-    """ A form mixin, providing coherence compensation field
-
-    """
-    is_coherence_keeping = forms.BooleanField(
-        label_suffix="",
-        label=_("Is coherence keeping"),
-        help_text=_("Optionally: Whether this compensation is a coherence keeping compensation?"),
-        required=False,
-        widget=forms.CheckboxInput()
-    )
-
-
-class NewCompensationForm(AbstractCompensationForm, CEFCompensationFormMixin, CoherenceCompensationFormMixin):
-    """ Form for creating new compensations.
-
-    Can be initialized with an intervention id for preselecting the related intervention.
-        form = NewCompensationForm(request.POST or None, intervention_id=intervention_id)
-        ...
-    The intervention id will not be resolved into the intervention ORM object but instead will be used to initialize
-    the related form field.
-
-    """
-    intervention = forms.ModelChoiceField(
-        label=_("compensates intervention"),
-        label_suffix="",
-        help_text=_("Select the intervention for which this compensation compensates"),
-        queryset=Intervention.objects.filter(
-            deleted=None,
-        ),
-        widget=autocomplete.ModelSelect2(
-            url="interventions-autocomplete",
-            attrs={
-                "data-placeholder": _("Click for selection"),
-                "data-minimum-input-length": 3,
-            }
-        ),
-    )
-
-    # Define a field order for a nicer layout instead of running with the inheritance result
-    field_order = [
-        "identifier",
-        "title",
-        "intervention",
-        "is_cef",
-        "is_coherence_keeping",
-        "comment",
-    ]
-
-    def __init__(self, *args, **kwargs):
-        intervention_id = kwargs.pop("intervention_id", None)
-        super().__init__(*args, **kwargs)
-        self.form_title = _("New compensation")
-
-        # If the compensation shall directly be initialized from an intervention, we need to fill in the intervention id
-        # and disable the form field.
-        # Furthermore the action_url needs to be set accordingly.
-        if intervention_id is not None:
-            self.initialize_form_field("intervention", intervention_id)
-            self.disable_form_field("intervention")
-            self.action_url = reverse("compensation:new", args=(intervention_id,))
-            self.cancel_redirect = reverse("intervention:detail", args=(intervention_id,))
-        else:
-            self.action_url = reverse("compensation:new")
-            self.cancel_redirect = reverse("compensation:index")
-
-        tmp = Compensation()
-        identifier = tmp.generate_new_identifier()
-        self.initialize_form_field("identifier", identifier)
-        self.fields["identifier"].widget.attrs["url"] = reverse_lazy("compensation:new-id")
-
-    def save(self, user: User, geom_form: SimpleGeomForm):
-        with transaction.atomic():
-            # Fetch data from cleaned POST values
-            identifier = self.cleaned_data.get("identifier", None)
-            title = self.cleaned_data.get("title", None)
-            intervention = self.cleaned_data.get("intervention", None)
-            is_cef = self.cleaned_data.get("is_cef", None)
-            is_coherence_keeping = self.cleaned_data.get("is_coherence_keeping", None)
-            comment = self.cleaned_data.get("comment", None)
-
-            # Create log entry
-            action = UserActionLogEntry.get_created_action(user)
-            # Process the geometry form
-            geometry = geom_form.save(action)
-
-            # Finally create main object
-            comp = Compensation.objects.create(
-                identifier=identifier,
-                title=title,
-                intervention=intervention,
-                created=action,
-                is_cef=is_cef,
-                is_coherence_keeping=is_coherence_keeping,
-                geometry=geometry,
-                comment=comment,
-            )
-
-            # Add the log entry to the main objects log list
-            comp.log.add(action)
-        return comp
-
-
-class EditCompensationForm(NewCompensationForm):
-    """ Form for editing compensations
-
-    """
-    def __init__(self, *args, **kwargs):
-        super().__init__(*args, **kwargs)
-        self.form_title = _("Edit compensation")
-        self.action_url = reverse("compensation:edit", args=(self.instance.id,))
-        self.cancel_redirect = reverse("compensation:detail", args=(self.instance.id,))
-
-        # Initialize form data
-        form_data = {
-            "identifier": self.instance.identifier,
-            "title": self.instance.title,
-            "intervention": self.instance.intervention,
-            "is_cef": self.instance.is_cef,
-            "is_coherence_keeping": self.instance.is_coherence_keeping,
-            "comment": self.instance.comment,
-        }
-        disabled_fields = []
-        self.load_initial_data(
-            form_data,
-            disabled_fields
-        )
-
-    def save(self, user: User, geom_form: SimpleGeomForm):
-        with transaction.atomic():
-            # Fetch data from cleaned POST values
-            identifier = self.cleaned_data.get("identifier", None)
-            title = self.cleaned_data.get("title", None)
-            intervention = self.cleaned_data.get("intervention", None)
-            is_cef = self.cleaned_data.get("is_cef", None)
-            is_coherence_keeping = self.cleaned_data.get("is_coherence_keeping", None)
-            comment = self.cleaned_data.get("comment", None)
-
-            # Create log entry
-            action = UserActionLogEntry.get_edited_action(user)
-
-            # Process the geometry form
-            geometry = geom_form.save(action)
-
-            # Finally create main object
-            self.instance.identifier = identifier
-            self.instance.title = title
-            self.instance.intervention = intervention
-            self.instance.geometry = geometry
-            self.instance.is_cef = is_cef
-            self.instance.is_coherence_keeping = is_coherence_keeping
-            self.instance.comment = comment
-            self.instance.modified = action
-            self.instance.save()
-
-            self.instance.log.add(action)
-
-            intervention.mark_as_edited(user, self.request, EDITED_GENERAL_DATA)
-        return self.instance
-
-
-class NewEcoAccountForm(AbstractCompensationForm, CompensationResponsibleFormMixin):
-    """ Form for creating eco accounts
-
-    Inherits from basic AbstractCompensationForm and further form fields from CompensationResponsibleFormMixin
-
-    """
-    surface = forms.DecimalField(
-        min_value=0.00,
-        decimal_places=2,
-        label=_("Available Surface"),
-        label_suffix="",
-        required=False,
-        help_text=_("The amount that can be used for deductions"),
-        widget=forms.NumberInput(
-            attrs={
-                "class": "form-control",
-                "placeholder": "0,00"
-            }
-        )
-    )
-    registration_date = forms.DateField(
-        label=_("Agreement date"),
-        label_suffix="",
-        help_text=_("When did the parties agree on this?"),
-        required=False,
-        widget=forms.DateInput(
-            attrs={
-                "type": "date",
-                "class": "form-control",
-            },
-            format="%d.%m.%Y"
-        )
-    )
-
-    field_order = [
-        "identifier",
-        "title",
-        "conservation_office",
-        "registration_date",
-        "surface",
-        "conservation_file_number",
-        "handler",
-        "comment",
-    ]
-
-    def __init__(self, *args, **kwargs):
-        super().__init__(*args, **kwargs)
-        self.form_title = _("New Eco-Account")
-
-        self.action_url = reverse("compensation:acc-new")
-        self.cancel_redirect = reverse("compensation:acc-index")
-
-        tmp = EcoAccount()
-        identifier = tmp.generate_new_identifier()
-        self.initialize_form_field("identifier", identifier)
-        self.fields["identifier"].widget.attrs["url"] = reverse_lazy("compensation:acc-new-id")
-        self.fields["title"].widget.attrs["placeholder"] = _("Eco-Account XY; Location ABC")
-
-    def save(self, user: User, geom_form: SimpleGeomForm):
-        with transaction.atomic():
-            # Fetch data from cleaned POST values
-            identifier = self.cleaned_data.get("identifier", None)
-            title = self.cleaned_data.get("title", None)
-            registration_date = self.cleaned_data.get("registration_date", None)
-            handler = self.cleaned_data.get("handler", None)
-            surface = self.cleaned_data.get("surface", None)
-            conservation_office = self.cleaned_data.get("conservation_office", None)
-            conservation_file_number = self.cleaned_data.get("conservation_file_number", None)
-            comment = self.cleaned_data.get("comment", None)
-
-            # Create log entry
-            action = UserActionLogEntry.get_created_action(user)
-            # Process the geometry form
-            geometry = geom_form.save(action)
-
-            responsible = Responsibility.objects.create(
-                handler=handler,
-                conservation_file_number=conservation_file_number,
-                conservation_office=conservation_office,
-            )
-
-            legal = Legal.objects.create(
-                registration_date=registration_date
-            )
-
-            # Finally create main object
-            acc = EcoAccount.objects.create(
-                identifier=identifier,
-                title=title,
-                responsible=responsible,
-                deductable_surface=surface,
-                created=action,
-                geometry=geometry,
-                comment=comment,
-                legal=legal
-            )
-            acc.share_with(user)
-
-            # Add the log entry to the main objects log list
-            acc.log.add(action)
-        return acc
-
-
-class EditEcoAccountForm(NewEcoAccountForm):
-    """ Form for editing eco accounts
-
-    """
-
-    def __init__(self, *args, **kwargs):
-        super().__init__(*args, **kwargs)
-        self.form_title = _("Edit Eco-Account")
-
-        self.action_url = reverse("compensation:acc-edit", args=(self.instance.id,))
-        self.cancel_redirect = reverse("compensation:acc-detail", args=(self.instance.id,))
-
-        # Initialize form data
-        reg_date = self.instance.legal.registration_date
-        if reg_date is not None:
-            reg_date = reg_date.isoformat()
-        form_data = {
-            "identifier": self.instance.identifier,
-            "title": self.instance.title,
-            "surface": self.instance.deductable_surface,
-            "handler": self.instance.responsible.handler,
-            "registration_date": reg_date,
-            "conservation_office": self.instance.responsible.conservation_office,
-            "conservation_file_number": self.instance.responsible.conservation_file_number,
-            "comment": self.instance.comment,
-        }
-        disabled_fields = []
-        self.load_initial_data(
-            form_data,
-            disabled_fields
-        )
-
-    def save(self, user: User, geom_form: SimpleGeomForm):
-        with transaction.atomic():
-            # Fetch data from cleaned POST values
-            identifier = self.cleaned_data.get("identifier", None)
-            title = self.cleaned_data.get("title", None)
-            registration_date = self.cleaned_data.get("registration_date", None)
-            handler = self.cleaned_data.get("handler", None)
-            surface = self.cleaned_data.get("surface", None)
-            conservation_office = self.cleaned_data.get("conservation_office", None)
-            conservation_file_number = self.cleaned_data.get("conservation_file_number", None)
-            comment = self.cleaned_data.get("comment", None)
-
-            # Create log entry
-            action = UserActionLogEntry.get_edited_action(user)
-
-            # Process the geometry form
-            geometry = geom_form.save(action)
-
-            # Update responsible data
-            self.instance.responsible.handler = handler
-            self.instance.responsible.conservation_office = conservation_office
-            self.instance.responsible.conservation_file_number = conservation_file_number
-            self.instance.responsible.save()
-
-            # Update legal data
-            self.instance.legal.registration_date = registration_date
-            self.instance.legal.save()
-
-            # Update main oject data
-            self.instance.identifier = identifier
-            self.instance.title = title
-            self.instance.deductable_surface = surface
-            self.instance.geometry = geometry
-            self.instance.comment = comment
-            self.instance.modified = action
-            self.instance.save()
-
-            # Add the log entry to the main objects log list
-            self.instance.log.add(action)
-        return self.instance

compensation/forms/mixins.py

@@ -0,0 +1,117 @@
+"""
+Author: Michel Peltriaux
+Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany
+Contact: ksp-servicestelle@sgdnord.rlp.de
+Created on: 18.08.22
+
+"""
+from dal import autocomplete
+from django import forms
+from django.utils.translation import gettext_lazy as _
+
+from codelist.models import KonovaCode
+from codelist.settings import CODELIST_CONSERVATION_OFFICE_ID, CODELIST_HANDLER_ID
+
+
+class CompensationResponsibleFormMixin(forms.Form):
+    """ Encapsulates form fields used in different compensation related models like EcoAccount or EMA
+
+    """
+    conservation_office = forms.ModelChoiceField(
+        label=_("Conservation office"),
+        label_suffix="",
+        help_text=_("Select the responsible office"),
+        queryset=KonovaCode.objects.filter(
+            is_archived=False,
+            is_leaf=True,
+            code_lists__in=[CODELIST_CONSERVATION_OFFICE_ID],
+        ),
+        widget=autocomplete.ModelSelect2(
+            url="codelist:conservation-office-autocomplete",
+            attrs={
+                "data-placeholder": _("Click for selection")
+            }
+        ),
+    )
+    conservation_file_number = forms.CharField(
+        label=_("Conservation office file number"),
+        label_suffix="",
+        max_length=255,
+        required=False,
+        widget=forms.TextInput(
+            attrs={
+                "placeholder": _("ETS-123/ABC.456"),
+                "class": "form-control",
+            }
+        )
+    )
+
+    handler_type = forms.ModelChoiceField(
+        label=_("Eco-Account handler type"),
+        label_suffix="",
+        help_text=_("What type of handler is responsible for the ecoaccount?"),
+        required=False,
+        queryset=KonovaCode.objects.filter(
+            is_archived=False,
+            is_leaf=True,
+            code_lists__in=[CODELIST_HANDLER_ID],
+        ),
+        widget=autocomplete.ModelSelect2(
+            url="codelist:handler-autocomplete",
+            attrs={
+                "data-placeholder": _("Click for selection"),
+            }
+        ),
+    )
+    handler_detail = forms.CharField(
+        label=_("Eco-Account handler detail"),
+        label_suffix="",
+        max_length=255,
+        required=False,
+        help_text=_("Detail input on the handler"),
+        widget=forms.TextInput(
+            attrs={
+                "placeholder": _("Company Mustermann"),
+                "class": "form-control",
+            }
+        )
+    )
+
+
+class CEFCompensationFormMixin(forms.Form):
+    """ A form mixin, providing CEF compensation field
+
+    """
+    is_cef = forms.BooleanField(
+        label_suffix="",
+        label=_("Is CEF"),
+        help_text=_("Optionally: Whether this compensation is a CEF compensation?"),
+        required=False,
+        widget=forms.CheckboxInput()
+    )
+
+
+class CoherenceCompensationFormMixin(forms.Form):
+    """ A form mixin, providing coherence compensation field
+
+    """
+    is_coherence_keeping = forms.BooleanField(
+        label_suffix="",
+        label=_("Is coherence keeping"),
+        help_text=_("Optionally: Whether this compensation is a coherence keeping compensation?"),
+        required=False,
+        widget=forms.CheckboxInput()
+    )
+
+
+class PikCompensationFormMixin(forms.Form):
+    """ A form mixin, providing PIK compensation field
+
+    """
+    is_pik = forms.BooleanField(
+        label_suffix="",
+        label=_("Is PIK"),
+        help_text=_("Optionally: Whether this compensation is a compensation integrated in production?"),
+        required=False,
+        widget=forms.CheckboxInput()
+    )

compensation/forms/modalForms.py

@@ -1,377 +0,0 @@
-"""
-Author: Michel Peltriaux
-Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany
-Contact: michel.peltriaux@sgdnord.rlp.de
-Created on: 04.10.21
-
-"""
-from bootstrap_modal_forms.utils import is_ajax
-from dal import autocomplete
-from django import forms
-from django.contrib import messages
-from django.http import HttpRequest, HttpResponseRedirect
-from django.shortcuts import render
-from django.utils.translation import pgettext_lazy as _con, gettext_lazy as _
-
-from codelist.models import KonovaCode
-from codelist.settings import CODELIST_BIOTOPES_ID, CODELIST_COMPENSATION_ACTION_ID, CODELIST_BIOTOPES_EXTRA_CODES_ID, \
-    CODELIST_COMPENSATION_ACTION_DETAIL_ID
-from compensation.models import CompensationDocument, EcoAccountDocument
-from konova.contexts import BaseContext
-from konova.forms import BaseModalForm, NewDocumentForm
-from konova.models import DeadlineType
-from konova.utils.message_templates import FORM_INVALID, ADDED_COMPENSATION_STATE, ADDED_DEADLINE, \
-    ADDED_COMPENSATION_ACTION
-
-
-class NewPaymentForm(BaseModalForm):
-    """ Form handling payment related input
-
-    """
-    amount = forms.DecimalField(
-        min_value=0.00,
-        decimal_places=2,
-        label=_con("money", "Amount"),  # contextual translation
-        label_suffix=_(""),
-        help_text=_("in Euro"),
-        widget=forms.NumberInput(
-            attrs={
-                "class": "form-control",
-                "placeholder": "0,00",
-            }
-        )
-    )
-    due = forms.DateField(
-        label=_("Due on"),
-        label_suffix=_(""),
-        required=False,
-        help_text=_("Due on which date"),
-        widget=forms.DateInput(
-            attrs={
-                "type": "date",
-                "data-provide": "datepicker",
-                "class": "form-control",
-            },
-            format="%d.%m.%Y"
-        )
-    )
-    comment = forms.CharField(
-        max_length=200,
-        required=False,
-        label=_("Comment"),
-        label_suffix=_(""),
-        help_text=_("Additional comment, maximum {} letters").format(200),
-        widget=forms.Textarea(
-            attrs={
-                "rows": 5,
-                "class": "form-control"
-            }
-        )
-    )
-
-    def __init__(self, *args, **kwargs):
-        super().__init__(*args, **kwargs)
-        self.intervention = self.instance
-        self.form_title = _("Payment")
-        self.form_caption = _("Add a payment for intervention '{}'").format(self.intervention.title)
-
-    def is_valid(self):
-        """
-        Checks on form validity.
-
-        For this form we need to make sure that a date or a comment is set.
-        If both are missing, the user needs to enter at least an explanation why
-        there is no date to be entered.
-
-        Returns:
-            is_valid (bool): True if valid, False otherwise
-        """
-        super_valid = super().is_valid()
-        date = self.cleaned_data["due"]
-        comment = self.cleaned_data["comment"] or None
-        if not date and not comment:
-            # At least one needs to be set!
-            self.add_error(
-                "comment",
-                _("If there is no date you can enter, please explain why.")
-            )
-            return False
-        return super_valid
-
-    def save(self):
-        pay = self.instance.add_payment(self)
-        self.instance.mark_as_edited(self.user, self.request)
-        return pay
-
-
-class NewStateModalForm(BaseModalForm):
-    """ Form handling state related input
-
-    Compensation states refer to 'before' and 'after' states of a compensated surface. Basically it means:
-    What has been on this area before changes/compensations have been applied and what will be the result ('after')?
-
-    """
-    biotope_type = forms.ModelChoiceField(
-        label=_("Biotope Type"),
-        label_suffix="",
-        required=True,
-        help_text=_("Select the biotope type"),
-        queryset=KonovaCode.objects.filter(
-            is_archived=False,
-            is_leaf=True,
-            code_lists__in=[CODELIST_BIOTOPES_ID],
-        ),
-        widget=autocomplete.ModelSelect2(
-            url="codes-biotope-autocomplete",
-            attrs={
-                "data-placeholder": _("Biotope Type"),
-            }
-        ),
-    )
-    biotope_extra = forms.ModelMultipleChoiceField(
-        label=_("Biotope additional type"),
-        label_suffix="",
-        required=False,
-        help_text=_("Select an additional biotope type"),
-        queryset=KonovaCode.objects.filter(
-            is_archived=False,
-            is_leaf=True,
-            code_lists__in=[CODELIST_BIOTOPES_EXTRA_CODES_ID],
-        ),
-        widget=autocomplete.ModelSelect2Multiple(
-            url="codes-biotope-extra-type-autocomplete",
-            attrs={
-                "data-placeholder": _("Biotope additional type"),
-            }
-        ),
-    )
-    surface = forms.DecimalField(
-        min_value=0.00,
-        decimal_places=2,
-        label=_("Surface"),
-        label_suffix="",
-        required=True,
-        help_text=_("in m²"),
-        widget=forms.NumberInput(
-            attrs={
-                "class": "form-control",
-                "placeholder": "0,00"
-            }
-        )
-    )
-
-    def __init__(self, *args, **kwargs):
-        super().__init__(*args, **kwargs)
-        self.form_title = _("New state")
-        self.form_caption = _("Insert data for the new state")
-
-    def save(self, is_before_state: bool = False):
-        state = self.instance.add_state(self, is_before_state)
-        self.instance.mark_as_edited(self.user, self.request, ADDED_COMPENSATION_STATE)
-        return state
-
-    def process_request(self, request: HttpRequest, msg_success: str = _("Object removed"), msg_error: str = FORM_INVALID, redirect_url: str = None):
-        """ Generic processing of request
-
-        Wraps the request processing logic, so we don't need the same code everywhere a RemoveModalForm is being used
-
-        +++
-        The generic method from super class can not be used, since we need to do some request parameter check in here.
-        +++
-
-        Args:
-            request (HttpRequest): The incoming request
-            msg_success (str): The message in case of successful removing
-            msg_error (str): The message in case of an error
-
-        Returns:
-
-        """
-        redirect_url = redirect_url if redirect_url is not None else request.META.get("HTTP_REFERER", "home")
-        template = self.template
-        if request.method == "POST":
-            if self.is_valid():
-                # Modal forms send one POST for checking on data validity. This can be used to return possible errors
-                # on the form. A second POST (if no errors occured) is sent afterwards and needs to process the
-                # saving/commiting of the data to the database. is_ajax() performs this check. The first request is
-                # an ajax call, the second is a regular form POST.
-                if not is_ajax(request.META):
-                    is_before_state = bool(request.GET.get("before", False))
-                    self.save(is_before_state=is_before_state)
-                    messages.success(
-                        request,
-                        msg_success
-                    )
-                return HttpResponseRedirect(redirect_url)
-            else:
-                context = {
-                    "form": self,
-                }
-                context = BaseContext(request, context).context
-                return render(request, template, context)
-        elif request.method == "GET":
-            context = {
-                "form": self,
-            }
-            context = BaseContext(request, context).context
-            return render(request, template, context)
-        else:
-            raise NotImplementedError
-
-
-class NewDeadlineModalForm(BaseModalForm):
-    """ Form handling deadline related input
-
-    """
-    type = forms.ChoiceField(
-        label=_("Deadline Type"),
-        label_suffix="",
-        required=True,
-        help_text=_("Select the deadline type"),
-        choices=DeadlineType.choices,
-        widget=forms.Select(
-            attrs={
-                "class": "form-control"
-            }
-        )
-    )
-    date = forms.DateField(
-        label=_("Date"),
-        label_suffix="",
-        required=True,
-        help_text=_("Select date"),
-        widget=forms.DateInput(
-            attrs={
-                "type": "date",
-                "data-provide": "datepicker",
-                "class": "form-control",
-            },
-            format="%d.%m.%Y"
-        )
-    )
-    comment = forms.CharField(
-        required=False,
-        max_length=200,
-        label=_("Comment"),
-        label_suffix=_(""),
-        help_text=_("Additional comment, maximum {} letters").format(200),
-        widget=forms.Textarea(
-            attrs={
-                "cols": 30,
-                "rows": 5,
-                "class": "form-control",
-            }
-        )
-    )
-
-    def __init__(self, *args, **kwargs):
-        super().__init__(*args, **kwargs)
-        self.form_title = _("New deadline")
-        self.form_caption = _("Insert data for the new deadline")
-
-    def save(self):
-        deadline = self.instance.add_deadline(self)
-        self.instance.mark_as_edited(self.user, self.request, ADDED_DEADLINE)
-        return deadline
-
-
-class NewActionModalForm(BaseModalForm):
-    """ Form handling action related input
-
-    Compensation actions are the actions performed on the area, which shall be compensated. Actions will change the
-    surface of the area, the biotopes, and have an environmental impact. With actions the before-after states can change
-    (not in the process logic in Konova, but in the real world).
-
-    """
-    from compensation.models import UnitChoices
-    action_type = forms.ModelChoiceField(
-        label=_("Action Type"),
-        label_suffix="",
-        required=True,
-        help_text=_("Select the action type"),
-        queryset=KonovaCode.objects.filter(
-            is_archived=False,
-            is_leaf=True,
-            code_lists__in=[CODELIST_COMPENSATION_ACTION_ID],
-        ),
-        widget=autocomplete.ModelSelect2(
-            url="codes-compensation-action-autocomplete",
-            attrs={
-                "data-placeholder": _("Action"),
-            }
-        ),
-    )
-    action_type_details = forms.ModelMultipleChoiceField(
-        label=_("Action Type detail"),
-        label_suffix="",
-        required=False,
-        help_text=_("Select the action type detail"),
-        queryset=KonovaCode.objects.filter(
-            is_archived=False,
-            is_leaf=True,
-            code_lists__in=[CODELIST_COMPENSATION_ACTION_DETAIL_ID],
-        ),
-        widget=autocomplete.ModelSelect2Multiple(
-            url="codes-compensation-action-detail-autocomplete",
-            attrs={
-                "data-placeholder": _("Action Type detail"),
-            }
-        ),
-    )
-    unit = forms.ChoiceField(
-        label=_("Unit"),
-        label_suffix="",
-        required=True,
-        help_text=_("Select the unit"),
-        choices=UnitChoices.choices,
-        widget=forms.Select(
-            attrs={
-                "class": "form-control"
-            }
-        )
-    )
-    amount = forms.DecimalField(
-        label=_("Amount"),
-        label_suffix="",
-        required=True,
-        help_text=_("Insert the amount"),
-        decimal_places=2,
-        min_value=0.00,
-        widget=forms.NumberInput(
-            attrs={
-                "class": "form-control",
-                "placeholder": "0,00",
-            }
-        )
-    )
-    comment = forms.CharField(
-        required=False,
-        max_length=200,
-        label=_("Comment"),
-        label_suffix=_(""),
-        help_text=_("Additional comment, maximum {} letters").format(200),
-        widget=forms.Textarea(
-            attrs={
-                "rows": 5,
-                "class": "form-control",
-            }
-        )
-    )
-
-    def __init__(self, *args, **kwargs):
-        super().__init__(*args, **kwargs)
-        self.form_title = _("New action")
-        self.form_caption = _("Insert data for the new action")
-
-    def save(self):
-        action = self.instance.add_action(self)
-        self.instance.mark_as_edited(self.user, self.request, ADDED_COMPENSATION_ACTION)
-        return action
-
-
-class NewCompensationDocumentForm(NewDocumentForm):
-    document_model = CompensationDocument
-
-
-class NewEcoAccountDocumentForm(NewDocumentForm):
-    document_model = EcoAccountDocument

compensation/forms/modals/__init__.py

@@ -0,0 +1,7 @@
+"""
+Author: Michel Peltriaux
+Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany
+Contact: ksp-servicestelle@sgdnord.rlp.de
+Created on: 18.08.22
+
+"""

compensation/forms/modals/compensation_action.py

@@ -0,0 +1,155 @@
+"""
+Author: Michel Peltriaux
+Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany
+Contact: ksp-servicestelle@sgdnord.rlp.de
+Created on: 18.08.22
+
+"""
+from dal import autocomplete
+from django import forms
+from django.utils.translation import gettext_lazy as _
+
+from codelist.models import KonovaCode
+from codelist.settings import CODELIST_COMPENSATION_ACTION_ID, CODELIST_COMPENSATION_ACTION_DETAIL_ID
+from intervention.inputs import CompensationActionTreeCheckboxSelectMultiple
+from konova.forms.modals import BaseModalForm, RemoveModalForm
+from konova.utils.message_templates import COMPENSATION_ACTION_EDITED, ADDED_COMPENSATION_ACTION
+
+
+class NewCompensationActionModalForm(BaseModalForm):
+    """ Form handling action related input
+
+    Compensation actions are the actions performed on the area, which shall be compensated. Actions will change the
+    surface of the area, the biotopes, and have an environmental impact. With actions the before-after states can change
+    (not in the process logic in Konova, but in the real world).
+
+    """
+    from compensation.models import UnitChoices
+    action_type = forms.MultipleChoiceField(
+        label=_("Action Type"),
+        label_suffix="",
+        required=True,
+        help_text=_("An action can consist of multiple different action types. All the selected action types are expected to be performed according to the amount and unit below on this form."),
+        choices=[],
+        widget=CompensationActionTreeCheckboxSelectMultiple(),
+    )
+    action_type_details = forms.ModelMultipleChoiceField(
+        label=_("Action Type detail"),
+        label_suffix="",
+        required=False,
+        help_text=_("Select the action type detail"),
+        queryset=KonovaCode.objects.filter(
+            is_archived=False,
+            is_leaf=True,
+            code_lists__in=[CODELIST_COMPENSATION_ACTION_DETAIL_ID],
+        ),
+        widget=autocomplete.ModelSelect2Multiple(
+            url="codelist:compensation-action-detail-autocomplete",
+            attrs={
+                "data-placeholder": _("Action Type detail"),
+            }
+        ),
+    )
+    unit = forms.ChoiceField(
+        label=_("Unit"),
+        label_suffix="",
+        required=True,
+        help_text=_("Select the unit"),
+        choices=UnitChoices.choices,
+        widget=forms.Select(
+            attrs={
+                "class": "form-control"
+            }
+        )
+    )
+    amount = forms.DecimalField(
+        label=_("Amount"),
+        label_suffix="",
+        required=True,
+        help_text=_("Insert the amount"),
+        decimal_places=2,
+        min_value=0.00,
+        widget=forms.NumberInput(
+            attrs={
+                "class": "form-control",
+                "placeholder": "0,00",
+            }
+        )
+    )
+    comment = forms.CharField(
+        required=False,
+        label=_("Comment"),
+        label_suffix=_(""),
+        help_text=_("Additional comment"),
+        widget=forms.Textarea(
+            attrs={
+                "rows": 5,
+                "class": "form-control",
+            }
+        )
+    )
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.form_title = _("New action")
+        self.form_caption = _("Insert data for the new action")
+        choices = KonovaCode.objects.filter(
+            code_lists__in=[CODELIST_COMPENSATION_ACTION_ID],
+            is_archived=False,
+            is_leaf=True,
+        ).values_list("id", flat=True)
+        choices = [
+            (choice, choice)
+            for choice in choices
+        ]
+        self.fields["action_type"].choices = choices
+
+    def save(self):
+        action = self.instance.add_action(self)
+        self.instance.mark_as_edited(self.user, self.request, ADDED_COMPENSATION_ACTION)
+        return action
+
+
+class EditCompensationActionModalForm(NewCompensationActionModalForm):
+    action = None
+
+    def __init__(self, *args, **kwargs):
+        self.action = kwargs.pop("action", None)
+        super().__init__(*args, **kwargs)
+        self.form_title = _("Edit action")
+        form_data = {
+            "action_type": list(self.action.action_type.values_list("id", flat=True)),
+            "action_type_details": self.action.action_type_details.all(),
+            "amount": self.action.amount,
+            "unit": self.action.unit,
+            "comment": self.action.comment,
+        }
+        self.load_initial_data(form_data)
+
+    def save(self):
+        action = self.action
+        action.action_type.set(self.cleaned_data.get("action_type", []))
+        action.action_type_details.set(self.cleaned_data.get("action_type_details", []))
+        action.amount = self.cleaned_data.get("amount", None)
+        action.unit = self.cleaned_data.get("unit", None)
+        action.comment = self.cleaned_data.get("comment", None)
+        action.save()
+        self.instance.mark_as_edited(self.user, self.request, edit_comment=COMPENSATION_ACTION_EDITED)
+        return action
+
+
+class RemoveCompensationActionModalForm(RemoveModalForm):
+    """ Removing modal form for CompensationAction
+
+    Can be used for anything, where removing shall be confirmed by the user a second time.
+
+    """
+    action = None
+
+    def __init__(self, *args, **kwargs):
+        action = kwargs.pop("action", None)
+        self.action = action
+        super().__init__(*args, **kwargs)
+
+    def save(self):
+        self.instance.remove_action(self)

compensation/forms/modals/deadline.py

@@ -0,0 +1,110 @@
+"""
+Author: Michel Peltriaux
+Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany
+Contact: ksp-servicestelle@sgdnord.rlp.de
+Created on: 18.08.22
+
+"""
+from django import forms
+from django.utils.translation import gettext_lazy as _
+
+from konova.forms.modals import BaseModalForm
+from konova.models import DeadlineType
+from konova.utils import validators
+from konova.utils.message_templates import DEADLINE_EDITED
+
+
+class NewDeadlineModalForm(BaseModalForm):
+    """ Form handling deadline related input
+
+    """
+    type = forms.ChoiceField(
+        label=_("Deadline Type"),
+        label_suffix="",
+        required=True,
+        help_text=_("Select the deadline type"),
+        choices=DeadlineType.choices,
+        widget=forms.Select(
+            attrs={
+                "class": "form-control"
+            }
+        )
+    )
+    date = forms.DateField(
+        label=_("Date"),
+        label_suffix="",
+        required=True,
+        help_text=_("Select date"),
+        validators=[validators.reasonable_date],
+        widget=forms.DateInput(
+            attrs={
+                "type": "date",
+                "data-provide": "datepicker",
+                "class": "form-control",
+            },
+            format="%d.%m.%Y"
+        )
+    )
+    comment = forms.CharField(
+        required=False,
+        max_length=200,
+        label=_("Comment"),
+        label_suffix=_(""),
+        help_text=_("Additional comment, maximum {} letters").format(200),
+        widget=forms.Textarea(
+            attrs={
+                "cols": 30,
+                "rows": 5,
+                "class": "form-control",
+            }
+        )
+    )
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.form_title = _("New deadline")
+        self.form_caption = _("Insert data for the new deadline")
+
+    def is_valid(self):
+        valid = super().is_valid()
+        deadline_type = self.cleaned_data.get("type")
+        comment = self.cleaned_data.get("comment") or None
+
+        other_deadline_without_comment = deadline_type == DeadlineType.OTHER and comment is None
+
+        if other_deadline_without_comment:
+            self.add_error(
+                "comment",
+                _("Please explain this 'other' type of deadline.")
+            )
+            valid &= False
+
+        return valid
+
+    def save(self):
+        deadline = self.instance.add_deadline(self)
+        return deadline
+
+
+class EditDeadlineModalForm(NewDeadlineModalForm):
+    deadline = None
+
+    def __init__(self, *args, **kwargs):
+        self.deadline = kwargs.pop("deadline", None)
+        super().__init__(*args, **kwargs)
+        self.form_title = _("Edit deadline")
+        form_data = {
+            "type": self.deadline.type,
+            "date": str(self.deadline.date),
+            "comment": self.deadline.comment,
+        }
+        self.load_initial_data(form_data)
+
+    def save(self):
+        deadline = self.deadline
+        deadline.type = self.cleaned_data.get("type", None)
+        deadline.date = self.cleaned_data.get("date", None)
+        deadline.comment = self.cleaned_data.get("comment", None)
+        deadline.save()
+        self.instance.mark_as_edited(self.user, self.request, edit_comment=DEADLINE_EDITED)
+        return deadline

compensation/forms/modals/document.py

@@ -0,0 +1,17 @@
+"""
+Author: Michel Peltriaux
+Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany
+Contact: ksp-servicestelle@sgdnord.rlp.de
+Created on: 18.08.22
+
+"""
+from compensation.models import CompensationDocument, EcoAccountDocument
+from konova.forms.modals import NewDocumentModalForm
+
+
+class NewCompensationDocumentModalForm(NewDocumentModalForm):
+    document_model = CompensationDocument
+
+
+class NewEcoAccountDocumentModalForm(NewDocumentModalForm):
+    document_model = EcoAccountDocument

compensation/forms/modals/payment.py

@@ -0,0 +1,141 @@
+"""
+Author: Michel Peltriaux
+Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany
+Contact: ksp-servicestelle@sgdnord.rlp.de
+Created on: 18.08.22
+
+"""
+from django import forms
+from django.utils.translation import pgettext_lazy as _con, gettext_lazy as _
+
+from konova.forms.modals import RemoveModalForm, BaseModalForm
+from konova.utils import validators
+from konova.utils.message_templates import PAYMENT_EDITED
+
+
+class NewPaymentForm(BaseModalForm):
+    """ Form handling payment related input
+
+    """
+    amount = forms.DecimalField(
+        min_value=0.00,
+        decimal_places=2,
+        label=_con("money", "Amount"),  # contextual translation
+        label_suffix=_(""),
+        help_text=_("in Euro"),
+        widget=forms.NumberInput(
+            attrs={
+                "class": "form-control",
+                "placeholder": "0,00",
+            }
+        )
+    )
+    due = forms.DateField(
+        label=_("Due on"),
+        label_suffix=_(""),
+        required=False,
+        validators=[validators.reasonable_date],
+        help_text=_("Due on which date"),
+        widget=forms.DateInput(
+            attrs={
+                "type": "date",
+                "data-provide": "datepicker",
+                "class": "form-control",
+            },
+            format="%d.%m.%Y"
+        )
+    )
+    comment = forms.CharField(
+        max_length=200,
+        required=False,
+        label=_("Comment"),
+        label_suffix=_(""),
+        help_text=_("Additional comment, maximum {} letters").format(200),
+        widget=forms.Textarea(
+            attrs={
+                "rows": 5,
+                "class": "form-control"
+            }
+        )
+    )
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.intervention = self.instance
+        self.form_title = _("Payment")
+        self.form_caption = _("Add a payment for intervention '{}'").format(self.intervention.title)
+
+    def is_valid(self):
+        """
+        Checks on form validity.
+
+        For this form we need to make sure that a date or a comment is set.
+        If both are missing, the user needs to enter at least an explanation why
+        there is no date to be entered.
+
+        Returns:
+            is_valid (bool): True if valid, False otherwise
+        """
+        super_valid = super().is_valid()
+        if not super_valid:
+            return super_valid
+
+        date = self.cleaned_data.get("due", None)
+        comment = self.cleaned_data.get("comment", None)
+        if not date and not comment:
+            # At least one needs to be set!
+            self.add_error(
+                "comment",
+                _("If there is no date you can enter, please explain why.")
+            )
+            return False
+        return super_valid
+
+    def save(self):
+        pay = self.instance.add_payment(self)
+        return pay
+
+
+class EditPaymentModalForm(NewPaymentForm):
+    """ Form handling edit for Payment
+
+    """
+    payment = None
+
+    def __init__(self, *args, **kwargs):
+        self.payment = kwargs.pop("payment", None)
+        super().__init__(*args, **kwargs)
+        self.form_title = _("Edit payment")
+        form_date = {
+            "amount": self.payment.amount,
+            "due": str(self.payment.due_on),
+            "comment": self.payment.comment,
+        }
+        self.load_initial_data(form_date, disabled_fields=[])
+
+    def save(self):
+        payment = self.payment
+        payment.amount = self.cleaned_data.get("amount", None)
+        payment.due_on = self.cleaned_data.get("due", None)
+        payment.comment = self.cleaned_data.get("comment", None)
+        payment.save()
+        self.instance.mark_as_edited(self.user, self.request, edit_comment=PAYMENT_EDITED)
+        self.instance.send_data_to_egon()
+        return payment
+
+
+class RemovePaymentModalForm(RemoveModalForm):
+    """ Removing modal form for Payment
+
+    Can be used for anything, where removing shall be confirmed by the user a second time.
+
+    """
+    payment = None
+
+    def __init__(self, *args, **kwargs):
+        payment = kwargs.pop("payment", None)
+        self.payment = payment
+        super().__init__(*args, **kwargs)
+
+    def save(self):
+        self.instance.remove_payment(self)

compensation/forms/modals/state.py

@@ -0,0 +1,180 @@
+"""
+Author: Michel Peltriaux
+Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany
+Contact: ksp-servicestelle@sgdnord.rlp.de
+Created on: 18.08.22
+
+"""
+from bootstrap_modal_forms.mixins import is_ajax
+from dal import autocomplete
+from django import forms
+from django.contrib import messages
+from django.http import HttpResponseRedirect, HttpRequest
+from django.shortcuts import render
+from django.utils.translation import gettext_lazy as _
+
+from codelist.models import KonovaCode
+from codelist.settings import CODELIST_BIOTOPES_ID, \
+    CODELIST_BIOTOPES_EXTRA_CODES_FULL_ID
+from intervention.inputs import CompensationStateTreeRadioSelect
+from konova.contexts import BaseContext
+from konova.forms.modals import RemoveModalForm, BaseModalForm
+from konova.utils.message_templates import COMPENSATION_STATE_EDITED, FORM_INVALID, ADDED_COMPENSATION_STATE
+
+
+class NewCompensationStateModalForm(BaseModalForm):
+    """ Form handling state related input
+
+    Compensation states refer to 'before' and 'after' states of a compensated surface. Basically it means:
+    What has been on this area before changes/compensations have been applied and what will be the result ('after')?
+
+    """
+    biotope_type = forms.ChoiceField(
+        label=_("Biotope Type"),
+        label_suffix="",
+        required=True,
+        help_text=_("Select the biotope type"),
+        widget=CompensationStateTreeRadioSelect(),
+    )
+    biotope_extra = forms.ModelMultipleChoiceField(
+        label=_("Biotope additional type"),
+        label_suffix="",
+        required=False,
+        help_text=_("Select an additional biotope type"),
+        queryset=KonovaCode.objects.filter(
+            is_archived=False,
+            is_leaf=True,
+            code_lists__in=[CODELIST_BIOTOPES_EXTRA_CODES_FULL_ID],
+        ),
+        widget=autocomplete.ModelSelect2Multiple(
+            url="codelist:biotope-extra-type-autocomplete",
+            attrs={
+                "data-placeholder": _("Biotope additional type"),
+            }
+        ),
+    )
+    surface = forms.DecimalField(
+        min_value=0.00,
+        decimal_places=2,
+        label=_("Surface"),
+        label_suffix="",
+        required=True,
+        help_text=_("in m²"),
+        widget=forms.NumberInput(
+            attrs={
+                "class": "form-control",
+                "placeholder": "0,00"
+            }
+        )
+    )
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.form_title = _("New state")
+        self.form_caption = _("Insert data for the new state")
+        choices = KonovaCode.objects.filter(
+            code_lists__in=[CODELIST_BIOTOPES_ID],
+            is_archived=False,
+            is_leaf=True,
+        ).values_list("id", flat=True)
+        choices = [
+            (choice, choice)
+            for choice in choices
+        ]
+        self.fields["biotope_type"].choices = choices
+
+    def save(self, is_before_state: bool = False):
+        state = self.instance.add_state(self, is_before_state)
+        self.instance.mark_as_edited(self.user, self.request, ADDED_COMPENSATION_STATE)
+        return state
+
+    def process_request(self, request: HttpRequest, msg_success: str = _("Object removed"), msg_error: str = FORM_INVALID, redirect_url: str = None):
+        """ Generic processing of request
+
+        Wraps the request processing logic, so we don't need the same code everywhere a RemoveModalForm is being used
+
+        +++
+        The generic method from super class can not be used, since we need to do some request parameter check in here.
+        +++
+
+        Args:
+            request (HttpRequest): The incoming request
+            msg_success (str): The message in case of successful removing
+            msg_error (str): The message in case of an error
+
+        Returns:
+
+        """
+        redirect_url = redirect_url if redirect_url is not None else request.META.get("HTTP_REFERER", "home")
+        template = self.template
+        if request.method == "POST":
+            if self.is_valid():
+                # Modal forms send one POST for checking on data validity. This can be used to return possible errors
+                # on the form. A second POST (if no errors occured) is sent afterwards and needs to process the
+                # saving/commiting of the data to the database. is_ajax() performs this check. The first request is
+                # an ajax call, the second is a regular form POST.
+                if not is_ajax(request.META):
+                    is_before_state = bool(request.GET.get("before", False))
+                    self.save(is_before_state=is_before_state)
+                    messages.success(
+                        request,
+                        msg_success
+                    )
+                return HttpResponseRedirect(redirect_url)
+            else:
+                context = {
+                    "form": self,
+                }
+                context = BaseContext(request, context).context
+                return render(request, template, context)
+        elif request.method == "GET":
+            context = {
+                "form": self,
+            }
+            context = BaseContext(request, context).context
+            return render(request, template, context)
+        else:
+            raise NotImplementedError
+
+
+class EditCompensationStateModalForm(NewCompensationStateModalForm):
+    state = None
+
+    def __init__(self, *args, **kwargs):
+        self.state = kwargs.pop("state", None)
+        super().__init__(*args, **kwargs)
+        self.form_title = _("Edit state")
+        biotope_type_id = self.state.biotope_type.id if self.state.biotope_type else None
+        form_data = {
+            "biotope_type": biotope_type_id,
+            "biotope_extra": self.state.biotope_type_details.all(),
+            "surface": self.state.surface,
+        }
+        self.load_initial_data(form_data)
+
+    def save(self, is_before_state: bool = False):
+        state = self.state
+        biotope_type_id = self.cleaned_data.get("biotope_type", None)
+        state.biotope_type = KonovaCode.objects.get(id=biotope_type_id)
+        state.biotope_type_details.set(self.cleaned_data.get("biotope_extra", []))
+        state.surface = self.cleaned_data.get("surface", None)
+        state.save()
+        self.instance.mark_as_edited(self.user, self.request, edit_comment=COMPENSATION_STATE_EDITED)
+        return state
+
+
+class RemoveCompensationStateModalForm(RemoveModalForm):
+    """ Removing modal form for CompensationState
+
+    Can be used for anything, where removing shall be confirmed by the user a second time.
+
+    """
+    state = None
+
+    def __init__(self, *args, **kwargs):
+        state = kwargs.pop("state", None)
+        self.state = state
+        super().__init__(*args, **kwargs)
+
+    def save(self):
+        self.instance.remove_state(self)

compensation/managers.py

@@ -8,17 +8,6 @@ Created on: 14.10.21
 from django.db import models
 
 
-class CompensationActionManager(models.Manager):
-    """ Holds default db fetch setting for this model type
-
-    """
-    def get_queryset(self):
-        return super().get_queryset().select_related(
-            "action_type",
-            "action_type__parent"
-        )
-
-
 class CompensationStateManager(models.Manager):
     """ Holds default db fetch setting for this model type
 

compensation/migrations/0004_auto_20220210_1402.py

@@ -0,0 +1,42 @@
+# Generated by Django 3.1.3 on 2022-02-10 13:02
+
+from django.db import migrations, models
+
+
+def migrate_actions(apps, schema_editor):
+    CompensationAction = apps.get_model('compensation', 'CompensationAction')
+    actions = CompensationAction.objects.all()
+
+    for action in actions:
+        action_type = action.action_type or []
+        action.action_type_tmp.set([action_type])
+        action.save()
+
+        if not action.action_type_tmp.count() > 0:
+            raise ValueError("Migration of actions did not work! Stoped before data loss!")
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('codelist', '0001_initial'),
+        ('compensation', '0003_auto_20220202_0846'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='compensationaction',
+            name='action_type_tmp',
+            field=models.ManyToManyField(blank=True, limit_choices_to={'code_lists__in': [1026], 'is_archived': False, 'is_selectable': True}, related_name='_compensationaction_action_type_+', to='codelist.KonovaCode'),
+        ),
+        migrations.RunPython(migrate_actions),
+        migrations.RemoveField(
+            model_name='compensationaction',
+            name='action_type',
+        ),
+        migrations.RenameField(
+            model_name='compensationaction',
+            old_name='action_type_tmp',
+            new_name='action_type',
+        )
+    ]

compensation/migrations/0005_auto_20220218_0917.py

@@ -0,0 +1,46 @@
+# Generated by Django 3.1.3 on 2022-02-18 08:17
+
+from django.db import migrations, models, transaction
+import django.db.models.deletion
+
+from codelist.settings import CODELIST_BIOTOPES_ID, CODELIST_AFTER_STATE_BIOTOPES_ID
+
+
+def migrate_entries_974_to_654(apps, schema_editor):
+    CompensationState = apps.get_model("compensation", "CompensationState")
+    KonovaCode = apps.get_model("codelist", "KonovaCode")
+    all_states = CompensationState.objects.all()
+
+    with transaction.atomic():
+        for state in all_states:
+            code_from_654 = KonovaCode.objects.get(
+                short_name=state.biotope_type.short_name,
+                code_lists__in=[CODELIST_BIOTOPES_ID],
+                is_archived=False,
+                is_leaf=True,
+            )
+            state.biotope_type = code_from_654
+            state.save()
+
+    old_list_states = CompensationState.objects.filter(
+        biotope_type__code_lists__in=[CODELIST_AFTER_STATE_BIOTOPES_ID]
+    )
+    if old_list_states.count() > 0:
+        raise Exception("Still unmigrated values!")
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('codelist', '0001_initial'),
+        ('compensation', '0004_auto_20220210_1402'),
+    ]
+
+    operations = [
+        migrations.RunPython(migrate_entries_974_to_654),
+        migrations.AlterField(
+            model_name='compensationstate',
+            name='biotope_type',
+            field=models.ForeignKey(blank=True, limit_choices_to={'code_lists__in': [654], 'is_archived': False, 'is_selectable': True}, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='+', to='codelist.konovacode'),
+        ),
+    ]

compensation/migrations/0006_ecoaccount_teams.py

@@ -0,0 +1,19 @@
+# Generated by Django 3.1.3 on 2022-02-18 09:13
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('user', '0003_team'),
+        ('compensation', '0005_auto_20220218_0917'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='ecoaccount',
+            name='teams',
+            field=models.ManyToManyField(help_text='Teams having access (data shared with)', to='user.Team'),
+        ),
+    ]

compensation/migrations/0007_auto_20220531_1245.py

@@ -0,0 +1,23 @@
+# Generated by Django 3.1.3 on 2022-05-31 10:45
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('compensation', '0006_ecoaccount_teams'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='compensation',
+            name='is_pik',
+            field=models.BooleanField(blank=True, default=False, help_text="Flag if compensation is a 'Produktonsintegrierte Kompensation'", null=True),
+        ),
+        migrations.AddField(
+            model_name='ecoaccount',
+            name='is_pik',
+            field=models.BooleanField(blank=True, default=False, help_text="Flag if compensation is a 'Produktonsintegrierte Kompensation'", null=True),
+        ),
+    ]

compensation/migrations/0008_auto_20220815_0803.py

@@ -0,0 +1,24 @@
+# Generated by Django 3.1.3 on 2022-08-15 06:03
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('konova', '0014_resubmission'),
+        ('compensation', '0007_auto_20220531_1245'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='compensation',
+            name='resubmission',
+            field=models.ManyToManyField(blank=True, null=True, related_name='_compensation_resubmission_+', to='konova.Resubmission'),
+        ),
+        migrations.AddField(
+            model_name='ecoaccount',
+            name='resubmission',
+            field=models.ManyToManyField(blank=True, null=True, related_name='_ecoaccount_resubmission_+', to='konova.Resubmission'),
+        ),
+    ]

compensation/migrations/0009_auto_20220815_0803.py

@@ -0,0 +1,32 @@
+# Generated by Django 3.1.3 on 2022-08-15 06:03
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('konova', '0014_resubmission'),
+        ('compensation', '0008_auto_20220815_0803'),
+    ]
+
+    operations = [
+        migrations.RemoveField(
+            model_name='compensation',
+            name='resubmission',
+        ),
+        migrations.RemoveField(
+            model_name='ecoaccount',
+            name='resubmission',
+        ),
+        migrations.AddField(
+            model_name='compensation',
+            name='resubmissions',
+            field=models.ManyToManyField(blank=True, null=True, related_name='_compensation_resubmissions_+', to='konova.Resubmission'),
+        ),
+        migrations.AddField(
+            model_name='ecoaccount',
+            name='resubmissions',
+            field=models.ManyToManyField(blank=True, null=True, related_name='_ecoaccount_resubmissions_+', to='konova.Resubmission'),
+        ),
+    ]

compensation/migrations/0010_auto_20220815_1030.py

@@ -0,0 +1,24 @@
+# Generated by Django 3.1.3 on 2022-08-15 08:30
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('konova', '0014_resubmission'),
+        ('compensation', '0009_auto_20220815_0803'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='compensation',
+            name='resubmissions',
+            field=models.ManyToManyField(blank=True, related_name='_compensation_resubmissions_+', to='konova.Resubmission'),
+        ),
+        migrations.AlterField(
+            model_name='ecoaccount',
+            name='resubmissions',
+            field=models.ManyToManyField(blank=True, related_name='_ecoaccount_resubmissions_+', to='konova.Resubmission'),
+        ),
+    ]

compensation/migrations/0011_ecoaccount_deductable_rest.py

@@ -0,0 +1,36 @@
+# Generated by Django 3.1.3 on 2022-10-11 11:39
+
+from django.db import migrations, models
+from django.db.models import Sum
+
+
+def fill_deductable_rest(apps, schema_editor):
+    EcoAccount = apps.get_model("compensation", "EcoAccount")
+    accs = EcoAccount.objects.all()
+    for acc in accs:
+
+        deductions = acc.deductions.filter(
+            intervention__deleted=None,
+        )
+        deductions_surfaces = deductions.aggregate(Sum("surface"))["surface__sum"] or 0
+        available_surfaces = acc.deductable_surface or deductions_surfaces
+        rest = available_surfaces - deductions_surfaces
+
+        acc.deductable_rest = rest
+        acc.save()
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('compensation', '0010_auto_20220815_1030'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='ecoaccount',
+            name='deductable_rest',
+            field=models.FloatField(blank=True, default=0, help_text='Amount of deductable rest', null=True),
+        ),
+        migrations.RunPython(fill_deductable_rest)
+    ]

compensation/migrations/0012_auto_20221116_1322.py

@@ -0,0 +1,26 @@
+# Generated by Django 3.1.3 on 2022-11-16 12:22
+
+from django.conf import settings
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('user', '0006_auto_20220815_0759'),
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+        ('compensation', '0011_ecoaccount_deductable_rest'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='ecoaccount',
+            name='teams',
+            field=models.ManyToManyField(blank=True, help_text='Teams having access (data shared with)', to='user.Team'),
+        ),
+        migrations.AlterField(
+            model_name='ecoaccount',
+            name='users',
+            field=models.ManyToManyField(blank=True, help_text='Users having access (data shared with)', to=settings.AUTH_USER_MODEL),
+        ),
+    ]