Switch to githubb.com for actions loaded

Reviewed-on: SGD-Nord/konova#394

.gitea/workflows/demo.yaml

@@ -0,0 +1,19 @@
+name: Gitea Actions Demo
+run-name: ${{ gitea.actor }} is testing out Gitea Actions 🚀
+on: [push]
+
+jobs:
+  Explore-Gitea-Actions:
+    runs-on: ubuntu-latest
+    steps:
+      - run: echo "The job was automatically triggered by a ${{ gitea.event_name }} event."
+      - run: echo "This job is now running on a ${{ runner.os }} server hosted by Gitea!"
+      - run: echo "The name of your branch is ${{ gitea.ref }} and your repository is ${{ gitea.repository }}."
+      - name: Check out repository code
+        uses: https://github.com/actions/checkout@v3
+      - run: echo "The ${{ gitea.repository }} repository has been cloned to the runner."
+      - run: echo "The workflow is now ready to test your code on the runner."
+      - name: List files in the repository
+        run: |
+          ls ${{ gitea.workspace }}
+      - run: echo "This job's status is ${{ job.status }}."

.gitignore

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

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

@@ -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" class="w-25">{% trans 'Type' %}</th>
-                <th scope="col">{% fa5_icon 'bookmark' %} {% trans 'Recorded' %}</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")
+            evaluated_laws = []
-            intervention_laws_checked = self.queryset.filter(checked__isnull=False).values_list("legal__laws__id")
+            sum_num_checked = 0
-            intervention_laws_recorded = self.queryset.filter(recorded__isnull=False).values_list(
+            sum_num_recorded = 0
-                "legal__laws__id")
+            sum_num = 0
-            # Count how often which law id appears in the above list, return only the long_name of the law and the resulting
+            for law in laws:
-            # count (here 'num'). This is for keeping the db fetch as small as possible
+                num = self.queryset.filter(
-            # Compute the sum for total, checked and recorded
+                    legal__laws__atom_id=law.atom_id
-            self.evaluated_laws = laws.annotate(
+                ).count()
-                num=Count("id", filter=Q(id__in=intervention_laws_total)),
+                num_checked = self.queryset_checked.filter(
-                num_checked=Count("id", filter=Q(id__in=intervention_laws_checked)),
+                    legal__laws__atom_id=law.atom_id
-                num_recorded=Count("id", filter=Q(id__in=intervention_laws_recorded)),
+                ).count()
-            ).values_list("short_name", "long_name", "num_checked", "num_recorded", "num", named=True)
+                num_recorded = self.queryset_recorded.filter(
-            self.law_sum = self.evaluated_laws.aggregate(sum_num=Sum("num"))["sum_num"]
+                    legal__laws__atom_id=law.atom_id
-            self.law_sum_checked = self.evaluated_laws.aggregate(sum_num_checked=Sum("num_checked"))["sum_num_checked"]
+                ).count()
-            self.law_sum_recorded = self.evaluated_laws.aggregate(sum_num_recorded=Sum("num_recorded"))["sum_num_recorded"]
+                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__date__gte=date_from,
-                created__timestamp__lte=date_to,
+                created__timestamp__date__lte=date_to,
             )
             self.queryset_acc_recorded = self.queryset_acc.filter(
                 recorded__isnull=False,

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/models/token.py

@@ -14,7 +14,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 +25,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 +38,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")

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/get/test_api_get.py

@@ -122,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"]

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):
@@ -138,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_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):
@@ -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)
@@ -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())
@@ -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())
@@ -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())

api/utils/serializer/serializer.py

@@ -12,6 +12,7 @@ from django.contrib.gis import geos
 from django.contrib.gis.geos import GEOSGeometry
 from django.core.paginator import Paginator
 
+from konova.sub_settings.lanis_settings import DEFAULT_SRID_RLP
 from konova.utils.message_templates import DATA_UNSHARED
 
 
@@ -133,8 +134,8 @@ class AbstractModelAPISerializer:
         if isinstance(geojson, dict):
             geojson = json.dumps(geojson)
         geometry = geos.fromstr(geojson)
-        if geometry.empty:
+        if geometry.srid != DEFAULT_SRID_RLP:
-            geometry = None
+            geometry.transform(DEFAULT_SRID_RLP)
         return geometry
 
     def _get_obj_from_db(self, id, user):

api/utils/serializer/v1/compensation.py

@@ -11,7 +11,7 @@ from api.utils.serializer.v1.serializer import AbstractModelAPISerializerV1, Abs
 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
 
@@ -34,6 +34,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 +64,7 @@ class CompensationAPISerializerV1(AbstractModelAPISerializerV1, AbstractCompensa
         obj = Compensation()
         created = create_action
         obj.created = created
+        obj.modified = created
         obj.geometry = geometry
         return obj
 
@@ -113,6 +115,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 +126,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 +153,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 +167,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/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.log.add(obj.created)
-            obj.users.add(user)
+        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.log.add(obj.created)
-            obj.users.add(user)
+        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.users.add(user)
-            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
@@ -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,16 @@ 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_BIOTOPES_EXTRA_CODES_ID, CODELIST_HANDLER_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 +61,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 +70,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(
+        json_str = str(json_str)
-            atom_id=json_str,
+        if len(json_str) == 0:
-            code_lists__in=[code_list_identifier]
+            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 +184,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 +204,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 +229,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 +297,12 @@ class AbstractCompensationAPISerializerV1Mixin:
         """
         deadlines = []
         for entry in deadline_data:
-            deadline_type = entry["type"]
+            try:
-            date = entry["date"]
+                deadline_type = entry["type"]
-            comment = entry["comment"]
+                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 +344,14 @@ class AbstractCompensationAPISerializerV1Mixin:
         """
         states = []
         for entry in states_data:
-            biotope_type = entry["biotope"]
+            try:
-            biotope_details = [
+                biotope_type = entry["biotope"]
-                self._konova_code_from_json(e, CODELIST_BIOTOPES_EXTRA_CODES_ID) for e in entry["biotope_details"]
+                biotope_details = [
-            ]
+                    self._konova_code_from_json(e, CODELIST_BIOTOPES_EXTRA_CODES_ID) for e in entry["biotope_details"]
-            surface = float(entry["surface"])
+                ]
+                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 +360,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,15 +391,19 @@ class AbstractCompensationAPISerializerV1Mixin:
         """
         actions = []
         for entry in actions_data:
-            action_types = [
+            try:
-                self._konova_code_from_json(e, CODELIST_COMPENSATION_ACTION_ID) for e in entry["action_types"]
+                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"]
+                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"]
+                amount = float(entry["amount"])
-            comment = entry["comment"]
+                # 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:

api/views/views.py

@@ -18,7 +18,6 @@ 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, Team
 
 
@@ -53,7 +52,13 @@ class AbstractAPIView(View):
             # 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")
@@ -315,7 +320,7 @@ class AbstractModelShareAPIView(AbstractAPIView):
         for team_name in new_teams:
             new_teams_objs.append(Team.objects.get(name=team_name))
 
-        if is_default_group_only(self.user):
+        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

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,110 @@
+"""
+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_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 = "long_name"
+    paginate_by = 200
+
+    def __init__(self, *args, **kwargs):
+        self.c = CODELIST_BIOTOPES_EXTRA_CODES_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(
+            "long_name",
+        )
+
+    def get_result_label(self, result):
+        return f"{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,12 +6,11 @@ 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
@@ -36,7 +35,7 @@ class Command(BaseKonovaCommand):
                 CODELIST_BIOTOPES_ID,
                 CODELIST_BIOTOPES_EXTRA_CODES_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,

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/models.py

@@ -50,7 +50,7 @@ class KonovaCode(models.Model):
 
     def __str__(self, with_parent: bool = True):
         ret_val = ""
-        if self.parent and with_parent:
+        if self.parent and self.parent.long_name 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:
@@ -65,24 +65,23 @@ class KonovaCode(models.Model):
             ret_val += ", " + self.parent.long_name
         return ret_val
 
-    def add_children(self):
+    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 None
+            return self
 
         children = KonovaCode.objects.filter(
-            code_lists__in=self.code_lists.all(),
             parent=self
         ).order_by(
-            "long_name"
+            order_by
         )
         self.children = children
         for child in children:
-            child.add_children()
+            child.add_children(order_by)
         return self
 
 

codelist/settings.py

@@ -14,12 +14,12 @@ CODELIST_INTERVENTION_HANDLER_ID = 903  # CLMassnahmeträger
 CODELIST_CONSERVATION_OFFICE_ID = 907  # CLNaturschutzbehörden
 CODELIST_REGISTRATION_OFFICE_ID = 1053  # CLZulassungsbehörden
 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_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
 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

@@ -21,16 +21,30 @@ class AbstractCompensationAdmin(BaseObjectAdmin):
             "identifier",
             "title",
             "comment",
-            "after_states",
+            "list_after_states",
-            "before_states",
+            "list_before_states",
+            "geometry",
         ]
 
     def get_readonly_fields(self, request, obj=None):
         return super().get_readonly_fields(request, obj) + [
-            "after_states",
+            "list_after_states",
-            "before_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 = [
@@ -41,6 +55,7 @@ class CompensationAdmin(AbstractCompensationAdmin):
         return super().get_fields(request, obj) + [
             "is_cef",
             "is_coherence_keeping",
+            "is_pik",
             "intervention",
         ]
 
@@ -66,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",
         ]
 
 
@@ -131,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
+Contact: ksp-servicestelle@sgdnord.rlp.de
-Created on: 29.07.21
+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 AbstractTableFilter, CheckboxTableFilter, QueryTableFilter, \
-from konova.filters.table_filters import QueryTableFilter, CheckboxTableFilter, SelectionTableFilter, AbstractTableFilter
+    SelectionTableFilter
 
 
 class SelectionCompensationTableFilter(SelectionTableFilter):
@@ -58,10 +55,12 @@ class CheckboxCompensationTableFilter(CheckboxTableFilter):
 
         """
         if not value:
-            return queryset.filter(
+            user_teams = self.user.shared_teams
+            result = queryset.filter(
                 Q(intervention__users__in=[self.user]) |  # requesting user has access
-                Q(intervention__teams__users__in=[self.user])
+                Q(intervention__teams__in=user_teams)
             ).distinct()
+            return result
         else:
             return queryset
 
@@ -114,71 +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_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,481 +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, COMPENSATION_ADDED_TEMPLATE
-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 __create_comp(self, user, geom_form) -> Compensation:
-        """ Creates the compensation from form data
-
-        Args:
-            user (User): The performing user
-            geom_form (SimpleGeomForm): The geometry form
-
-        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)
-        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
-
-    def save(self, user: User, geom_form: SimpleGeomForm):
-        with transaction.atomic():
-            comp = self.__create_comp(user, geom_form)
-            comp.intervention.mark_as_edited(user, edit_comment=COMPENSATION_ADDED_TEMPLATE.format(comp.identifier))
-        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(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,526 +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 intervention.inputs import CompensationActionTreeCheckboxSelectMultiple
-from konova.contexts import BaseContext
-from konova.forms import BaseModalForm, NewDocumentModalForm, RemoveModalForm
-from konova.models import DeadlineType
-from konova.utils.message_templates import FORM_INVALID, ADDED_COMPENSATION_STATE, \
-    ADDED_COMPENSATION_ACTION, PAYMENT_EDITED, COMPENSATION_STATE_EDITED, COMPENSATION_ACTION_EDITED, DEADLINE_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,
-        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)
-        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)
-        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)
-        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)
-
-
-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 EditCompensationStateModalForm(NewStateModalForm):
-    state = None
-
-    def __init__(self, *args, **kwargs):
-        self.state = kwargs.pop("state", None)
-        super().__init__(*args, **kwargs)
-        form_data = {
-            "biotope_type": self.state.biotope_type,
-            "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
-        state.biotope_type = self.cleaned_data.get("biotope_type", None)
-        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)
-
-
-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)
-
-
-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)
-        return deadline
-
-
-class EditDeadlineModalForm(NewDeadlineModalForm):
-    deadline = None
-
-    def __init__(self, *args, **kwargs):
-        self.deadline = kwargs.pop("deadline", None)
-        super().__init__(*args, **kwargs)
-        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
-
-
-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.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="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,
-        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(NewActionModalForm):
-    action = None
-
-    def __init__(self, *args, **kwargs):
-        self.action = kwargs.pop("action", None)
-        super().__init__(*args, **kwargs)
-        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 NewCompensationDocumentModalForm(NewDocumentModalForm):
-    document_model = CompensationDocument
-
-
-class NewEcoAccountDocumentModalForm(NewDocumentModalForm):
-    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,179 @@
+"""
+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_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_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/migrations/0005_auto_20220218_0917.py

@@ -3,7 +3,7 @@
 from django.db import migrations, models, transaction
 import django.db.models.deletion
 
-from codelist.settings import CODELIST_BIOTOPES_ID, CODELIST_AFTER_STATE_BIOTOPES__ID
+from codelist.settings import CODELIST_BIOTOPES_ID, CODELIST_AFTER_STATE_BIOTOPES_ID
 
 
 def migrate_entries_974_to_654(apps, schema_editor):
@@ -23,7 +23,7 @@ def migrate_entries_974_to_654(apps, schema_editor):
             state.save()
 
     old_list_states = CompensationState.objects.filter(
-        biotope_type__code_lists__in=[CODELIST_AFTER_STATE_BIOTOPES__ID]
+        biotope_type__code_lists__in=[CODELIST_AFTER_STATE_BIOTOPES_ID]
     )
     if old_list_states.count() > 0:
         raise Exception("Still unmigrated values!")

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),
+        ),
+    ]

compensation/migrations/0013_auto_20221117_0819.py

@@ -0,0 +1,35 @@
+# Generated by Django 3.1.3 on 2022-11-17 07:19
+
+from django.db import migrations
+
+from compensation.models import UnitChoices
+
+
+def harmonize_action_units(apps, schema_editor):
+    """
+    CompensationAction units (based on UnitChoices) can be mixed up at this point where
+        * qm represents m²  and
+        * m2 represents m²
+
+    We drop qm in support of m2
+
+    """
+    CompensationAction = apps.get_model("compensation", "CompensationAction")
+    actions = CompensationAction.objects.filter(
+        unit="qm"
+    )
+
+    for action in actions:
+        action.unit = UnitChoices.m2
+        action.save()
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('compensation', '0012_auto_20221116_1322'),
+    ]
+
+    operations = [
+        migrations.RunPython(harmonize_action_units),
+    ]

compensation/migrations/0014_auto_20221118_1620.py

@@ -0,0 +1,18 @@
+# Generated by Django 3.1.3 on 2022-11-18 15:20
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('compensation', '0013_auto_20221117_0819'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='compensationaction',
+            name='unit',
+            field=models.CharField(blank=True, choices=[('cm', 'cm'), ('m', 'm'), ('m2', 'm²'), ('m3', 'm³'), ('km', 'km'), ('ha', 'ha'), ('pcs', 'Pieces')], max_length=100, null=True),
+        ),
+    ]

compensation/migrations/0015_alter_compensation_after_states_and_more.py

@@ -0,0 +1,70 @@
+# Generated by Django 4.2.6 on 2023-11-30 11:56
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('codelist', '0001_initial'),
+        ('konova', '0014_resubmission'),
+        ('compensation', '0014_auto_20221118_1620'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='compensation',
+            name='after_states',
+            field=models.ManyToManyField(blank=True, help_text="Refers to 'Zielzustand Biotop'", related_name='+', to='compensation.compensationstate'),
+        ),
+        migrations.AlterField(
+            model_name='compensation',
+            name='before_states',
+            field=models.ManyToManyField(blank=True, help_text="Refers to 'Ausgangszustand Biotop'", related_name='+', to='compensation.compensationstate'),
+        ),
+        migrations.AlterField(
+            model_name='compensation',
+            name='deadlines',
+            field=models.ManyToManyField(blank=True, related_name='+', to='konova.deadline'),
+        ),
+        migrations.AlterField(
+            model_name='compensation',
+            name='resubmissions',
+            field=models.ManyToManyField(blank=True, related_name='+', to='konova.resubmission'),
+        ),
+        migrations.AlterField(
+            model_name='compensationaction',
+            name='action_type',
+            field=models.ManyToManyField(blank=True, limit_choices_to={'code_lists__in': [1026], 'is_archived': False, 'is_selectable': True}, related_name='+', to='codelist.konovacode'),
+        ),
+        migrations.AlterField(
+            model_name='compensationaction',
+            name='action_type_details',
+            field=models.ManyToManyField(blank=True, limit_choices_to={'code_lists__in': [1035], 'is_archived': False, 'is_selectable': True}, related_name='+', to='codelist.konovacode'),
+        ),
+        migrations.AlterField(
+            model_name='compensationstate',
+            name='biotope_type_details',
+            field=models.ManyToManyField(blank=True, limit_choices_to={'code_lists__in': [975], 'is_archived': False, 'is_selectable': True}, related_name='+', to='codelist.konovacode'),
+        ),
+        migrations.AlterField(
+            model_name='ecoaccount',
+            name='after_states',
+            field=models.ManyToManyField(blank=True, help_text="Refers to 'Zielzustand Biotop'", related_name='+', to='compensation.compensationstate'),
+        ),
+        migrations.AlterField(
+            model_name='ecoaccount',
+            name='before_states',
+            field=models.ManyToManyField(blank=True, help_text="Refers to 'Ausgangszustand Biotop'", related_name='+', to='compensation.compensationstate'),
+        ),
+        migrations.AlterField(
+            model_name='ecoaccount',
+            name='deadlines',
+            field=models.ManyToManyField(blank=True, related_name='+', to='konova.deadline'),
+        ),
+        migrations.AlterField(
+            model_name='ecoaccount',
+            name='resubmissions',
+            field=models.ManyToManyField(blank=True, related_name='+', to='konova.resubmission'),
+        ),
+    ]

compensation/models/action.py

@@ -19,8 +19,9 @@ class UnitChoices(models.TextChoices):
     """
     cm = "cm", _("cm")
     m = "m", _("m")
+    m2 = "m2", _("m²")
+    m3 = "m3", _("m³")
     km = "km", _("km")
-    qm = "qm", _("m²")
     ha = "ha", _("ha")
     st = "pcs", _("Pieces")  # pieces
 

compensation/models/compensation.py

@@ -8,25 +8,33 @@ Created on: 16.11.21
 import shutil
 
 from django.contrib import messages
+from django.urls import reverse
+
+from analysis.settings import LKOMPVZVO_PUBLISH_DATE
+from codelist.models import KonovaCode
+from compensation.settings import COMPENSATION_IDENTIFIER_TEMPLATE, COMPENSATION_IDENTIFIER_LENGTH, \
+    COMPENSATION_LANIS_LAYER_NAME_RECORDED, COMPENSATION_LANIS_LAYER_NAME_UNRECORDED, COMPENSATION_LANIS_LAYER_NAME_UNRECORDED_OLD_ENTRY
+from konova.sub_settings.django_settings import BASE_URL
 from user.models import User, Team
 from django.db import models, transaction
 from django.db.models import QuerySet, Sum
 from django.http import HttpRequest
-from django.utils.translation import gettext_lazy as _
 
 from compensation.managers import CompensationManager
 from compensation.models import CompensationState, CompensationAction
 from compensation.utils.quality import CompensationQualityChecker
 from konova.models import BaseObject, AbstractDocument, Deadline, generate_document_file_upload_path, \
-    GeoReferencedMixin
+    GeoReferencedMixin, DeadlineType, ResubmitableObjectMixin
-from konova.settings import DEFAULT_SRID_RLP, LANIS_LINK_TEMPLATE
 from konova.utils.message_templates import DATA_UNSHARED_EXPLANATION, COMPENSATION_REMOVED_TEMPLATE, \
-    DOCUMENT_REMOVED_TEMPLATE, COMPENSATION_EDITED_TEMPLATE, DEADLINE_REMOVED, ADDED_DEADLINE, \
+    DOCUMENT_REMOVED_TEMPLATE, DEADLINE_REMOVED, DEADLINE_ADDED, \
     COMPENSATION_ACTION_REMOVED, COMPENSATION_STATE_REMOVED, INTERVENTION_HAS_REVOCATIONS_TEMPLATE
 from user.models import UserActionLogEntry
 
 
-class AbstractCompensation(BaseObject, GeoReferencedMixin):
+class AbstractCompensation(BaseObject,
+                           GeoReferencedMixin,
+                           ResubmitableObjectMixin
+                           ):
     """
     Abstract compensation model which holds basic attributes, shared by subclasses like the regular Compensation,
     EMA or EcoAccount.
@@ -72,7 +80,7 @@ class AbstractCompensation(BaseObject, GeoReferencedMixin):
 
             self.save()
             self.deadlines.add(deadline)
-            self.mark_as_edited(user, edit_comment=ADDED_DEADLINE)
+            self.mark_as_edited(user, edit_comment=DEADLINE_ADDED)
             return deadline
 
     def remove_deadline(self, form):
@@ -142,8 +150,10 @@ class AbstractCompensation(BaseObject, GeoReferencedMixin):
         """
         form_data = form.cleaned_data
         with transaction.atomic():
+            biotope_type_id = form_data["biotope_type"]
+            code = KonovaCode.objects.get(id=biotope_type_id)
             state = CompensationState.objects.create(
-                biotope_type=form_data["biotope_type"],
+                biotope_type=code,
                 surface=form_data["surface"],
             )
             state_additional_types = form_data["biotope_extra"]
@@ -194,7 +204,9 @@ class AbstractCompensation(BaseObject, GeoReferencedMixin):
         Returns:
 
         """
-        return qs.aggregate(Sum("surface"))["surface__sum"] or 0
+        val = qs.aggregate(Sum("surface"))["surface__sum"] or 0
+        val = float('{:0.2f}'.format(val))
+        return val
 
     def quality_check(self) -> CompensationQualityChecker:
         """ Performs data quality check
@@ -222,6 +234,15 @@ class AbstractCompensation(BaseObject, GeoReferencedMixin):
         request = self.set_geometry_conflict_message(request)
         return request
 
+    def get_finished_deadlines(self):
+        """ Getter for FINISHED-deadlines
+
+        Returns:
+            queryset (QuerySet): The finished deadlines
+        """
+        return self.deadlines.filter(
+            type=DeadlineType.FINISHED
+        )
 
 class CEFMixin(models.Model):
     """ Provides CEF flag as Mixin
@@ -253,7 +274,22 @@ class CoherenceMixin(models.Model):
         abstract = True
 
 
-class Compensation(AbstractCompensation, CEFMixin, CoherenceMixin):
+class PikMixin(models.Model):
+    """ Provides PIK flag as Mixin
+
+    """
+    is_pik = models.BooleanField(
+        blank=True,
+        null=True,
+        default=False,
+        help_text="Flag if compensation is a 'Produktonsintegrierte Kompensation'"
+    )
+
+    class Meta:
+        abstract = True
+
+
+class Compensation(AbstractCompensation, CEFMixin, CoherenceMixin, PikMixin):
     """
     Regular compensation, linked to an intervention
     """
@@ -267,9 +303,18 @@ class Compensation(AbstractCompensation, CEFMixin, CoherenceMixin):
 
     objects = CompensationManager()
 
+    identifier_length = COMPENSATION_IDENTIFIER_LENGTH
+    identifier_template = COMPENSATION_IDENTIFIER_TEMPLATE
+
     def __str__(self):
         return "{}".format(self.identifier)
 
+    def get_detail_url(self):
+        return reverse("compensation:detail", args=(self.id,))
+
+    def get_detail_url_absolute(self):
+        return BASE_URL + self.get_detail_url()
+
     def save(self, *args, **kwargs):
         if self.identifier is None or len(self.identifier) == 0:
             # Create new identifier is none was given
@@ -299,6 +344,20 @@ class Compensation(AbstractCompensation, CEFMixin, CoherenceMixin):
         # Compensations inherit their shared state from the interventions
         return self.intervention.is_shared_with(user)
 
+    def is_only_shared_with(self, user: User):
+        """ Share check
+
+        Checks whether a given user is the only one having shared access to this entry
+
+        Args:
+            user (User): The user to be checked
+
+        Returns:
+
+        """
+        # Compensations inherit their shared state from the interventions
+        return self.intervention.is_only_shared_with(user)
+
     def share_with_user(self, user: User):
         """ Adds user to list of shared access users
 
@@ -350,7 +409,7 @@ class Compensation(AbstractCompensation, CEFMixin, CoherenceMixin):
         Returns:
             users (QuerySet)
         """
-        return self.intervention.users.all()
+        return self.intervention.shared_users
 
     @property
     def shared_teams(self) -> QuerySet:
@@ -359,7 +418,7 @@ class Compensation(AbstractCompensation, CEFMixin, CoherenceMixin):
         Returns:
             users (QuerySet)
         """
-        return self.intervention.teams.all()
+        return self.intervention.shared_teams
 
     def get_documents(self) -> QuerySet:
         """ Getter for all documents of a compensation
@@ -372,19 +431,18 @@ class Compensation(AbstractCompensation, CEFMixin, CoherenceMixin):
         )
         return docs
 
-    def mark_as_edited(self, user: User, request: HttpRequest = None, edit_comment: str = None, reset_recorded: bool = True):
+    def mark_as_edited(self, user: User, request: HttpRequest = None, edit_comment: str = None):
-        """ Performs internal logic for setting the recordedd/checked state of the related intervention
+        """ Performs internal logic for setting the checked state of the related intervention
 
         Args:
             user (User): The performing user
             request (HttpRequest): The performing request
             edit_comment (str): Additional comment for the log entry
-            reset_recorded (bool): Whether the record-state of the object should be reset
 
         Returns:
 
         """
-        self.intervention.unrecord(user, request)
+        self.intervention.set_unchecked()
         action = super().mark_as_edited(user, edit_comment=edit_comment)
         return action
 
@@ -418,6 +476,40 @@ class Compensation(AbstractCompensation, CEFMixin, CoherenceMixin):
         super().set_status_messages(request)
         return request
 
+    @property
+    def is_recorded(self):
+        """ Getter for record status as property
+
+        Since compensations inherit their record status from their intervention, the intervention's status is being
+        returned
+
+        Returns:
+
+        """
+        return self.intervention.is_recorded
+
+    def get_lanis_layer_name(self):
+        """ Getter for specific LANIS/WFS object layer
+
+        Returns:
+
+        """
+        retval = None
+        if self.is_recorded:
+            retval = COMPENSATION_LANIS_LAYER_NAME_RECORDED
+        else:
+            try:
+                is_old_entry = self.intervention.legal.binding_date < LKOMPVZVO_PUBLISH_DATE
+            except TypeError:
+                is_old_entry = False
+
+            if is_old_entry:
+                retval = COMPENSATION_LANIS_LAYER_NAME_UNRECORDED_OLD_ENTRY
+            else:
+                retval = COMPENSATION_LANIS_LAYER_NAME_UNRECORDED
+
+        return retval
+
 
 class CompensationDocument(AbstractDocument):
     """
@@ -452,8 +544,11 @@ class CompensationDocument(AbstractDocument):
             # The only file left for this compensation is the one which is currently processed and will be deleted
             # Make sure that the compensation folder itself is deleted as well, not only the file
             # Therefore take the folder path from the file path
-            folder_path = self.file.path.split("/")[:-1]
+            try:
-            folder_path = "/".join(folder_path)
+                folder_path = self.file.path.split("/")[:-1]
+                folder_path = "/".join(folder_path)
+            except ValueError:
+                folder_path = None
 
         if user:
             self.instance.mark_as_edited(user, edit_comment=DOCUMENT_REMOVED_TEMPLATE.format(self.title))

compensation/models/eco_account.py

@@ -9,22 +9,23 @@ import shutil
 
 from django.urls import reverse
 
+from compensation.settings import ECO_ACCOUNT_IDENTIFIER_TEMPLATE, ECO_ACCOUNT_IDENTIFIER_LENGTH, \
+    ECO_ACCOUNT_LANIS_LAYER_NAME_RECORDED, ECO_ACCOUNT_LANIS_LAYER_NAME_UNRECORDED
+from konova.sub_settings.django_settings import BASE_URL
 from konova.utils.message_templates import DEDUCTION_REMOVED, DOCUMENT_REMOVED_TEMPLATE
-from django.core.exceptions import ValidationError
 from django.core.validators import MinValueValidator
 from django.db import models
 from django.db.models import Sum, QuerySet
-from django.utils.translation import gettext_lazy as _
 
 from compensation.managers import EcoAccountManager, EcoAccountDeductionManager
-from compensation.models.compensation import AbstractCompensation
+from compensation.models.compensation import AbstractCompensation, PikMixin
 from compensation.utils.quality import EcoAccountQualityChecker
 from konova.models import ShareableObjectMixin, RecordableObjectMixin, AbstractDocument, BaseResource, \
     generate_document_file_upload_path
-from konova.settings import DEFAULT_SRID_RLP, LANIS_LINK_TEMPLATE
+from konova.tasks import celery_send_mail_deduction_changed, celery_send_mail_deduction_changed_team
 
 
-class EcoAccount(AbstractCompensation, ShareableObjectMixin, RecordableObjectMixin):
+class EcoAccount(AbstractCompensation, ShareableObjectMixin, RecordableObjectMixin, PikMixin):
     """
     An eco account is a kind of 'prepaid' compensation. It can be compared to an account that already has been filled
     with some kind of currency. From this account one is able to deduct currency for current projects.
@@ -35,6 +36,12 @@ class EcoAccount(AbstractCompensation, ShareableObjectMixin, RecordableObjectMix
         help_text="Amount of deductable surface - can be lower than the total surface due to deduction limitations",
         default=0,
     )
+    deductable_rest = models.FloatField(
+        blank=True,
+        null=True,
+        help_text="Amount of deductable rest",
+        default=0,
+    )
 
     legal = models.OneToOneField(
         "intervention.Legal",
@@ -46,22 +53,17 @@ class EcoAccount(AbstractCompensation, ShareableObjectMixin, RecordableObjectMix
 
     objects = EcoAccountManager()
 
+    identifier_length = ECO_ACCOUNT_IDENTIFIER_LENGTH
+    identifier_template = ECO_ACCOUNT_IDENTIFIER_TEMPLATE
+
     def __str__(self):
         return f"{self.identifier} ({self.title})"
 
-    def clean(self):
+    def get_detail_url(self):
-        # Deductable surface can not be larger than added states after surface
+        return reverse("compensation:acc:detail", args=(self.id,))
-        after_state_sum = self.get_state_after_surface_sum()
-        if self.deductable_surface > after_state_sum:
-            raise ValidationError(_("Deductable surface can not be larger than existing surfaces in after states"))
 
-        # Deductable surface can not be lower than amount of already deducted surfaces
+    def get_detail_url_absolute(self):
-        # User needs to contact deducting user in case of further problems
+        return BASE_URL + self.get_detail_url()
-        deducted_sum = self.get_deductions_surface()
-        if self.deductable_surface < deducted_sum:
-            raise ValidationError(
-                _("Deductable surface can not be smaller than the sum of already existing deductions. Please contact the responsible users for the deductions!")
-            )
 
     def save(self, *args, **kwargs):
         if self.identifier is None or len(self.identifier) == 0:
@@ -90,38 +92,30 @@ class EcoAccount(AbstractCompensation, ShareableObjectMixin, RecordableObjectMix
         Returns:
             sum_surface (float)
         """
-        return self.deductions.all().aggregate(Sum("surface"))["surface__sum"] or 0
+        val = self.deductions.all().aggregate(Sum("surface"))["surface__sum"] or 0
+        val = float('{:0.2f}'.format(val))
+        return val
 
-    def get_state_after_surface_sum(self) -> float:
+    def __calculate_deductable_rest(self):
-        """ Calculates the account's after state surface sum
-
-        Returns:
-            sum_surface (float)
-        """
-        return self.after_states.all().aggregate(Sum("surface"))["surface__sum"] or 0
-
-    def get_available_rest(self) -> (float, float):
         """ Calculates available rest surface of the eco account
 
         Args:
 
         Returns:
             ret_val_total (float): Total amount
-            ret_val_relative (float): Amount as percentage (0-100)
         """
-        deductions = self.deductions.filter(
+        deductions_surfaces = self.get_deductions_surface()
-            intervention__deleted=None,
-        )
-        deductions_surfaces = deductions.aggregate(Sum("surface"))["surface__sum"] or 0
-        available_surfaces = self.deductable_surface or deductions_surfaces ## no division by zero
-        ret_val_total = available_surfaces - deductions_surfaces
 
-        if available_surfaces > 0:
+        available_surface = self.deductable_surface
-            ret_val_relative = int((ret_val_total / available_surfaces) * 100)
+        if available_surface is None:
+            # Fallback!
+            available_surface = deductions_surfaces
         else:
-            ret_val_relative = 0
+            available_surface = float(available_surface)
 
-        return ret_val_total, ret_val_relative
+        ret_val = available_surface - deductions_surfaces
+
+        return ret_val
 
     def quality_check(self) -> EcoAccountQualityChecker:
         """ Quality check
@@ -160,8 +154,63 @@ class EcoAccount(AbstractCompensation, ShareableObjectMixin, RecordableObjectMix
         Returns:
 
         """
-        return reverse("compensation:acc:share", args=(self.id, self.access_token))
+        return reverse("compensation:acc:share-token", args=(self.id, self.access_token))
 
+    def send_notification_mail_on_deduction_change(self, data_change: dict):
+        """ Sends notification mails for changes on the deduction
+
+        Args:
+            data_change ():
+
+        Returns:
+
+        """
+        # Send mail
+        shared_users = self.shared_users.values_list("id", flat=True)
+        for user_id in shared_users:
+            celery_send_mail_deduction_changed.delay(self.id, self.get_app_object_tuple(), user_id, data_change)
+
+        # Send mail
+        shared_teams = self.shared_teams.values_list("id", flat=True)
+        for team_id in shared_teams:
+            celery_send_mail_deduction_changed_team.delay(self.id, self.get_app_object_tuple(), team_id, data_change)
+
+    def update_deductable_rest(self):
+        """
+        Updates deductable_rest, which holds the amount of rest surface for this account.
+
+        Returns:
+
+        """
+        self.deductable_rest = self.__calculate_deductable_rest()
+        self.save()
+
+    def get_deductable_rest_relative(self):
+        """
+        Returns deductable_rest relative to deductable_surface mapped to [0,100]
+
+        Returns:
+
+        """
+        try:
+            ret_val = int((self.deductable_rest / (self.deductable_surface or 0)) * 100)
+        except ZeroDivisionError:
+            ret_val = 0
+        return ret_val
+
+    def get_lanis_layer_name(self):
+        """ Getter for specific LANIS/WFS object layer
+
+        Returns:
+
+        """
+        retval = None
+        if self.is_recorded:
+            retval = ECO_ACCOUNT_LANIS_LAYER_NAME_RECORDED
+        else:
+            retval = ECO_ACCOUNT_LANIS_LAYER_NAME_UNRECORDED
+
+        return retval
 
 class EcoAccountDocument(AbstractDocument):
     """
@@ -196,8 +245,11 @@ class EcoAccountDocument(AbstractDocument):
             # The only file left for this eco account is the one which is currently processed and will be deleted
             # Make sure that the compensation folder itself is deleted as well, not only the file
             # Therefore take the folder path from the file path
-            folder_path = self.file.path.split("/")[:-1]
+            try:
-            folder_path = "/".join(folder_path)
+                folder_path = self.file.path.split("/")[:-1]
+                folder_path = "/".join(folder_path)
+            except ValueError:
+                folder_path = None
 
         if user:
             self.instance.mark_as_edited(user, edit_comment=DOCUMENT_REMOVED_TEMPLATE.format(self.title))
@@ -252,4 +304,9 @@ class EcoAccountDeduction(BaseResource):
         if user is not None:
             self.intervention.mark_as_edited(user, edit_comment=DEDUCTION_REMOVED)
             self.account.mark_as_edited(user, edit_comment=DEDUCTION_REMOVED)
-        super().delete(*args, **kwargs)
+        super().delete(*args, **kwargs)
+        self.account.update_deductable_rest()
+
+    def save(self, *args, **kwargs):
+        super().save(*args, **kwargs)
+        self.account.update_deductable_rest()

compensation/models/payment.py

@@ -10,8 +10,6 @@ from django.db import models
 
 from intervention.models import Intervention
 from konova.models import BaseResource
-from konova.utils.message_templates import PAYMENT_REMOVED
-from user.models import UserActionLogEntry
 
 
 class Payment(BaseResource):

compensation/models/state.py

@@ -12,7 +12,6 @@ from codelist.models import KonovaCode
 from codelist.settings import CODELIST_BIOTOPES_ID, CODELIST_BIOTOPES_EXTRA_CODES_ID
 from compensation.managers import CompensationStateManager
 from konova.models import UuidModel
-from konova.utils.message_templates import COMPENSATION_STATE_REMOVED
 
 
 class CompensationState(UuidModel):

compensation/settings.py

@@ -7,6 +7,11 @@ Created on: 18.12.20
 """
 COMPENSATION_IDENTIFIER_LENGTH = 6
 COMPENSATION_IDENTIFIER_TEMPLATE = "KOM-{}"
+COMPENSATION_LANIS_LAYER_NAME_RECORDED = "kom_recorded"
+COMPENSATION_LANIS_LAYER_NAME_UNRECORDED = "kom_unrecorded"
+COMPENSATION_LANIS_LAYER_NAME_UNRECORDED_OLD_ENTRY = "kom_unrecorded_old_entries"
 
 ECO_ACCOUNT_IDENTIFIER_LENGTH = 6
-ECO_ACCOUNT_IDENTIFIER_TEMPLATE = "OEK-{}"
+ECO_ACCOUNT_IDENTIFIER_TEMPLATE = "OEK-{}"
+ECO_ACCOUNT_LANIS_LAYER_NAME_RECORDED = "oek_recorded"
+ECO_ACCOUNT_LANIS_LAYER_NAME_UNRECORDED = "oek_unrecorded"

compensation/tables.py

@@ -1,351 +0,0 @@
-"""
-Author: Michel Peltriaux
-Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany
-Contact: michel.peltriaux@sgdnord.rlp.de
-Created on: 01.12.20
-
-"""
-from user.models import User
-from django.http import HttpRequest
-from django.template.loader import render_to_string
-from django.urls import reverse
-from django.utils.html import format_html
-from django.utils.timezone import localtime
-from django.utils.translation import gettext_lazy as _
-
-from compensation.filters import CompensationTableFilter, EcoAccountTableFilter
-from compensation.models import Compensation, EcoAccount
-from konova.sub_settings.django_settings import DEFAULT_DATE_TIME_FORMAT
-from konova.utils.tables import BaseTable, TableRenderMixin
-import django_tables2 as tables
-
-
-class CompensationTable(BaseTable, TableRenderMixin):
-    id = tables.Column(
-        verbose_name=_("Identifier"),
-        orderable=True,
-        accessor="identifier",
-    )
-    t = tables.Column(
-        verbose_name=_("Title"),
-        orderable=True,
-        accessor="title",
-    )
-    d = tables.Column(
-        verbose_name=_("Parcel gmrkng"),
-        orderable=True,
-        accessor="geometry",
-    )
-    c = tables.Column(
-        verbose_name=_("Checked"),
-        orderable=True,
-        empty_values=[],
-        accessor="intervention__checked",
-    )
-    r = tables.Column(
-        verbose_name=_("Recorded"),
-        orderable=True,
-        empty_values=[],
-        accessor="intervention__recorded",
-    )
-    e = tables.Column(
-        verbose_name=_("Editable"),
-        orderable=True,
-        empty_values=[],
-        accessor="intervention__users",
-    )
-    lm = tables.Column(
-        verbose_name=_("Last edit"),
-        orderable=True,
-        accessor="modified__timestamp",
-    )
-
-    class Meta(BaseTable.Meta):
-        template_name = "django_tables2/bootstrap4.html"
-
-    def __init__(self, request: HttpRequest, *args, **kwargs):
-        self.title = _("Compensations")
-        self.add_new_url = reverse("compensation:new")
-        qs = kwargs.get("queryset", None)
-        self.filter = CompensationTableFilter(
-            user=request.user,
-            data=request.GET,
-            queryset=qs,
-        )
-        kwargs["queryset"] = self.filter.qs
-        super().__init__(request, *args, **kwargs)
-
-    def render_id(self, value, record: Compensation):
-        """ Renders the id column for a compensation
-
-        Args:
-            value (str): The identifier value
-            record (Compensation): The compensation record
-
-        Returns:
-
-        """
-        context = {
-            "tooltip": _("Open {}").format(_("Intervention")),
-            "content": value,
-            "url": reverse("compensation:detail", args=(record.id,)),
-            "has_revocations": record.intervention.legal.revocations.exists()
-        }
-        html = render_to_string(
-            "table/revocation_warning_col.html",
-            context
-        )
-        return html
-
-    def render_c(self, value, record: Compensation):
-        """ Renders the checked column for a compensation
-
-        checked is set by the main object Intervention
-
-        Args:
-            value (str): The identifier value
-            record (Compensation): The compensation record
-
-        Returns:
-
-        """
-        html = ""
-        checked = value is not None
-        tooltip = _("Not checked yet")
-        if checked:
-            value = value.timestamp
-            value = localtime(value)
-            checked_on = value.strftime(DEFAULT_DATE_TIME_FORMAT)
-            tooltip = _("Checked on {} by {}").format(checked_on, record.intervention.checked.user)
-        html += self.render_checked_star(
-            tooltip=tooltip,
-            icn_filled=checked,
-        )
-        return format_html(html)
-
-    def render_d(self, value, record: Compensation):
-        """ Renders the parcel district column for a compensation
-
-        Args:
-            value (str): The geometry
-            record (Compensation): The compensation record
-
-        Returns:
-
-        """
-        parcels = value.get_underlying_parcels().values_list(
-            "gmrkng",
-            flat=True
-        ).distinct()
-        html = render_to_string(
-            "table/gmrkng_col.html",
-            {
-                "entries": parcels
-            }
-        )
-        return html
-
-    def render_r(self, value, record: Compensation):
-        """ Renders the registered column for a compensation
-
-        Args:
-            value (str): The identifier value
-            record (Compensation): The compensation record
-
-        Returns:
-
-        """
-        html = ""
-        recorded = value is not None
-        tooltip = _("Not recorded yet")
-        if recorded:
-            value = value.timestamp
-            value = localtime(value)
-            on = value.strftime(DEFAULT_DATE_TIME_FORMAT)
-            tooltip = _("Recorded on {} by {}").format(on, record.intervention.recorded.user)
-        html += self.render_bookmark(
-            tooltip=tooltip,
-            icn_filled=recorded,
-        )
-        return format_html(html)
-
-    def render_e(self, value, record: Compensation):
-        """ Renders the editable column for a compensation
-
-        Args:
-            value (str): The identifier value
-            record (Compensation): The compensation record
-
-        Returns:
-
-        """
-        if value is None:
-            value = User.objects.none()
-        has_access = value.filter(
-            id=self.user.id
-        ).exists()
-
-        html = self.render_icn(
-            tooltip=_("Full access granted") if has_access else _("Access not granted"),
-            icn_class="fas fa-edit rlp-r-inv" if has_access else "far fa-edit",
-        )
-        return format_html(html)
-
-
-class EcoAccountTable(BaseTable, TableRenderMixin):
-    id = tables.Column(
-        verbose_name=_("Identifier"),
-        orderable=True,
-        accessor="identifier",
-    )
-    t = tables.Column(
-        verbose_name=_("Title"),
-        orderable=True,
-        accessor="title",
-    )
-    d = tables.Column(
-        verbose_name=_("Parcel gmrkng"),
-        orderable=True,
-        accessor="geometry",
-    )
-    av = tables.Column(
-        verbose_name=_("Available"),
-        orderable=True,
-        empty_values=[],
-        attrs={
-            "th": {
-                "class": "w-20",
-            }
-        }
-    )
-    r = tables.Column(
-        verbose_name=_("Recorded"),
-        orderable=True,
-        empty_values=[],
-        accessor="recorded",
-    )
-    e = tables.Column(
-        verbose_name=_("Editable"),
-        orderable=True,
-        empty_values=[],
-        accessor="users",
-    )
-    lm = tables.Column(
-        verbose_name=_("Last edit"),
-        orderable=True,
-        accessor="modified__timestamp",
-    )
-
-    class Meta(BaseTable.Meta):
-        template_name = "django_tables2/bootstrap4.html"
-
-    def __init__(self,  request: HttpRequest, *args, **kwargs):
-        self.title = _("Eco Accounts")
-        self.add_new_url = reverse("compensation:acc:new")
-        qs = kwargs.get("queryset", None)
-        self.filter = EcoAccountTableFilter(
-            user=request.user,
-            data=request.GET,
-            queryset=qs,
-        )
-        kwargs["queryset"] = self.filter.qs
-        super().__init__(request, *args, **kwargs)
-
-    def render_id(self, value, record: EcoAccount):
-        """ Renders the id column for an eco account
-
-        Args:
-            value (str): The identifier value
-            record (EcoAccount): The eco account record
-
-        Returns:
-
-        """
-        html = ""
-        html += self.render_link(
-            tooltip=_("Open {}").format(_("Eco-account")),
-            href=reverse("compensation:acc:detail", args=(record.id,)),
-            txt=value,
-            new_tab=False,
-        )
-        return format_html(html)
-
-    def render_av(self, value, record: EcoAccount):
-        """ Renders the available column for an eco account
-
-        Args:
-            value (str): The identifier value
-            record (EcoAccount): The eco account record
-
-        Returns:
-
-        """
-        value_total, value_relative = record.get_available_rest()
-        html = render_to_string("konova/widgets/progressbar.html", {"value": value_relative})
-        return format_html(html)
-
-    def render_d(self, value, record: Compensation):
-        """ Renders the parcel district column for a compensation
-
-        Args:
-            value (str): The geometry
-            record (Compensation): The compensation record
-
-        Returns:
-
-        """
-        parcels = value.get_underlying_parcels().values_list(
-            "gmrkng",
-            flat=True
-        ).distinct()
-        html = render_to_string(
-            "table/gmrkng_col.html",
-            {
-                "entries": parcels
-            }
-        )
-        return html
-
-    def render_r(self, value, record: EcoAccount):
-        """ Renders the recorded column for an eco account
-
-        Args:
-            value (str): The identifier value
-            record (EcoAccount): The eco account record
-
-        Returns:
-
-        """
-        html = ""
-        checked = value is not None
-        tooltip = _("Not recorded yet. Can not be used for deductions, yet.")
-        if checked:
-            value = value.timestamp
-            value = localtime(value)
-            on = value.strftime(DEFAULT_DATE_TIME_FORMAT)
-            tooltip = _("Recorded on {} by {}").format(on, record.recorded.user)
-        html += self.render_bookmark(
-            tooltip=tooltip,
-            icn_filled=checked,
-        )
-        return format_html(html)
-
-    def render_e(self, value, record: EcoAccount):
-        """ Renders the editable column for an eco account
-
-        Args:
-            value (str): The identifier value
-            record (EcoAccount): The eco account record
-
-        Returns:
-
-        """
-        html = ""
-        # Do not use value in here, since value does use unprefetched 'users' manager, where record has already
-        # prefetched users data
-        has_access = self.user in record.users.all()
-        html += self.render_icn(
-            tooltip=_("Full access granted") if has_access else _("Access not granted"),
-            icn_class="fas fa-edit rlp-r-inv" if has_access else "far fa-edit",
-        )
-        return format_html(html)

compensation/tables/__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/tables/compensation.py

@@ -0,0 +1,150 @@
+"""
+Author: Michel Peltriaux
+Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany
+Contact: ksp-servicestelle@sgdnord.rlp.de
+Created on: 18.08.22
+
+"""
+from django.http import HttpRequest
+from django.template.loader import render_to_string
+from django.urls import reverse
+from django.utils.html import format_html
+from django.utils.translation import gettext_lazy as _
+
+from compensation.filters.compensation import CompensationTableFilter
+from compensation.models import Compensation
+from konova.utils.message_templates import DATA_IS_UNCHECKED, DATA_CHECKED_ON_TEMPLATE, DATA_CHECKED_PREVIOUSLY_TEMPLATE
+from konova.utils.tables import BaseTable, TableRenderMixin, TableOrderMixin
+import django_tables2 as tables
+
+
+class CompensationTable(BaseTable, TableRenderMixin, TableOrderMixin):
+    id = tables.Column(
+        verbose_name=_("Identifier"),
+        orderable=True,
+        accessor="identifier",
+    )
+    t = tables.Column(
+        verbose_name=_("Title"),
+        orderable=True,
+        accessor="title",
+    )
+    d = tables.Column(
+        verbose_name=_("Parcel gmrkng"),
+        orderable=False,
+        accessor="geometry",
+    )
+    c = tables.Column(
+        verbose_name=_("Checked"),
+        orderable=True,
+        empty_values=[],
+        accessor="intervention__checked",
+    )
+    r = tables.Column(
+        verbose_name=_("Recorded"),
+        orderable=True,
+        empty_values=[],
+        accessor="intervention__recorded",
+    )
+    e = tables.Column(
+        verbose_name=_("Editable"),
+        orderable=True,
+        empty_values=[],
+        accessor="intervention__users",
+    )
+    lm = tables.Column(
+        verbose_name=_("Last edit"),
+        orderable=True,
+        accessor="modified__timestamp",
+    )
+
+    class Meta(BaseTable.Meta):
+        template_name = "django_tables2/bootstrap4.html"
+
+    def __init__(self, request: HttpRequest, *args, **kwargs):
+        self.title = _("Compensations")
+        self.add_new_url = reverse("compensation:new")
+        qs = kwargs.get("queryset", None)
+        self.filter = CompensationTableFilter(
+            user=request.user,
+            data=request.GET,
+            queryset=qs,
+        )
+        kwargs["queryset"] = self.filter.qs
+        super().__init__(request, *args, **kwargs)
+
+    def render_id(self, value, record: Compensation):
+        """ Renders the id column for a compensation
+
+        Args:
+            value (str): The identifier value
+            record (Compensation): The compensation record
+
+        Returns:
+
+        """
+        context = {
+            "tooltip": _("Open {}").format(_("Intervention")),
+            "content": value,
+            "url": reverse("compensation:detail", args=(record.id,)),
+            "has_revocations": record.intervention.legal.revocations.exists()
+        }
+        html = render_to_string(
+            "table/revocation_warning_col.html",
+            context
+        )
+        return html
+
+    def render_c(self, value, record: Compensation):
+        """ Renders the checked column for a compensation
+
+        checked is set by the main object Intervention
+
+        Args:
+            value (str): The identifier value
+            record (Compensation): The compensation record
+
+        Returns:
+
+        """
+        html = ""
+        checked = value is not None
+        tooltip = DATA_IS_UNCHECKED
+        previously_checked = record.intervention.get_last_checked_action()
+        if checked:
+            checked_on = value.get_timestamp_str_formatted()
+            tooltip = DATA_CHECKED_ON_TEMPLATE.format(checked_on, record.intervention.checked.user)
+        html += self.render_checked_star(
+            tooltip=tooltip,
+            icn_filled=checked,
+        )
+        if previously_checked and not checked:
+            checked_on = previously_checked.get_timestamp_str_formatted()
+            tooltip = DATA_CHECKED_PREVIOUSLY_TEMPLATE.format(checked_on, previously_checked.user)
+            html += self.render_previously_checked_star(
+                tooltip=tooltip,
+            )
+        return format_html(html)
+
+    def render_r(self, value, record: Compensation):
+        """ Renders the registered column for a compensation
+
+        Args:
+            value (str): The identifier value
+            record (Compensation): The compensation record
+
+        Returns:
+
+        """
+        html = ""
+        recorded = value is not None
+        tooltip = _("Not recorded yet")
+        if recorded:
+            on = value.get_timestamp_str_formatted()
+            tooltip = _("Recorded on {} by {}").format(on, record.intervention.recorded.user)
+        html += self.render_bookmark(
+            tooltip=tooltip,
+            icn_filled=recorded,
+        )
+        return format_html(html)
+