Merge pull request 'master' (#253) from master into Docker

Reviewed-on: SGD-Nord/konova#253

analysis/utils/report.py

@@ -104,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,

api/utils/serializer/v1/compensation.py

@@ -64,6 +64,7 @@ class CompensationAPISerializerV1(AbstractModelAPISerializerV1, AbstractCompensa
         obj = Compensation()
         created = create_action
         obj.created = created
+        obj.modified = created
         obj.geometry = geometry
         return obj
 

api/utils/serializer/v1/ecoaccount.py

@@ -103,6 +103,7 @@ class EcoAccountAPISerializerV1(AbstractModelAPISerializerV1,
         obj.legal = Legal()
         created = create_action
         obj.created = created
+        obj.modified = created
         obj.geometry = geometry
         return obj
 

api/utils/serializer/v1/ema.py

@@ -85,6 +85,7 @@ class EmaAPISerializerV1(AbstractModelAPISerializerV1, AbstractCompensationAPISe
         )
         created = create_action
         obj.created = created
+        obj.modified = created
         obj.geometry = geometry
         return obj
 

api/utils/serializer/v1/intervention.py

@@ -76,6 +76,7 @@ class InterventionAPISerializerV1(AbstractModelAPISerializerV1,
         created = create_action
         obj.legal = legal
         obj.created = created
+        obj.modified = created
         obj.geometry = geometry
         obj.responsible = resp
         return obj

compensation/forms/compensation.py

@@ -156,6 +156,7 @@ class NewCompensationForm(AbstractCompensationForm,
             title=title,
             intervention=intervention,
             created=action,
+            modified=action,
             is_cef=is_cef,
             is_coherence_keeping=is_coherence_keeping,
             is_pik=is_pik,

compensation/forms/eco_account.py

@@ -117,6 +117,7 @@ class NewEcoAccountForm(AbstractCompensationForm, CompensationResponsibleFormMix
                 responsible=responsible,
                 deductable_surface=surface,
                 created=action,
+                modified=action,
                 comment=comment,
                 is_pik=is_pik,
                 legal=legal

compensation/templates/compensation/report/eco_account/report.html

@@ -16,10 +16,6 @@
                         <th scope="row">{% trans 'Conservation office' %}</th>
                         <td class="align-middle">{{obj.responsible.conservation_office.str_as_office|default_if_none:""}}</td>
                     </tr>
-                    <tr>
-                        <th scope="row">{% trans 'Conservation office file number' %}</th>
-                        <td class="align-middle">{{obj.responsible.conservation_file_number|default_if_none:""}}</td>
-                    </tr>
                     <tr>
                         <th scope="row">{% trans 'Is PIK' %}</th>
                         <td class="align-middle">

compensation/tests/compensation/test_workflow.py

@@ -71,6 +71,7 @@ class CompensationWorkflowTestCase(BaseWorkflowTestCase):
         self.assertEqual(new_compensation.title, test_title)
         self.assert_equal_geometries(new_compensation.geometry.geom, test_geom)
         self.assertEqual(new_compensation.log.count(), 1)
+        self.assertEqual(new_compensation.created, new_compensation.modified)
 
         # Expect logs to be set
         self.assertEqual(pre_creation_intervention_log_count + 1, self.intervention.log.count())

compensation/tests/ecoaccount/test_workflow.py

@@ -65,6 +65,7 @@ class EcoAccountWorkflowTestCase(BaseWorkflowTestCase):
         self.assertEqual(acc.deductable_rest, test_deductable_surface)
         self.assert_equal_geometries(acc.geometry.geom, test_geom)
         self.assertEqual(acc.log.count(), 1)
+        self.assertEqual(acc.created, acc.modified)
 
         # Expect logs to be set
         self.assertEqual(acc.log.count(), 1)

compensation/views/compensation/compensation.py

@@ -46,6 +46,8 @@ def index_view(request: HttpRequest):
     compensations = Compensation.objects.filter(
         deleted=None,  # only show those which are not deleted individually
         intervention__deleted=None,  # and don't show the ones whose intervention has been deleted
+    ).order_by(
+        "-modified__timestamp"
     )
     table = CompensationTable(
         request=request,

compensation/views/eco_account/eco_account.py

@@ -41,6 +41,8 @@ def index_view(request: HttpRequest):
     template = "generic_index.html"
     eco_accounts = EcoAccount.objects.filter(
         deleted=None,
+    ).order_by(
+        "-modified__timestamp"
     )
     table = EcoAccountTable(
         request=request,

ema/forms.py

@@ -81,6 +81,7 @@ class NewEmaForm(AbstractCompensationForm, CompensationResponsibleFormMixin, Pik
                 title=title,
                 responsible=responsible,
                 created=action,
+                modified=action,
                 comment=comment,
                 is_pik=is_pik,
             )

ema/templates/ema/report/report.html

@@ -16,10 +16,6 @@
                         <th scope="row">{% trans 'Conservation office' %}</th>
                         <td class="align-middle">{{obj.responsible.conservation_office.str_as_office|default_if_none:""}}</td>
                     </tr>
-                    <tr>
-                        <th scope="row">{% trans 'Conservation office file number' %}</th>
-                        <td class="align-middle">{{obj.responsible.conservation_file_number|default_if_none:""}}</td>
-                    </tr>
                     <tr>
                         <th scope="row">{% trans 'Is PIK' %}</th>
                         <td class="align-middle">

ema/tests/test_workflow.py

@@ -62,6 +62,7 @@ class EmaWorkflowTestCase(BaseWorkflowTestCase):
         self.assertEqual(ema.title, test_title)
         self.assert_equal_geometries(ema.geometry.geom, test_geom)
         self.assertEqual(ema.log.count(), 1)
+        self.assertEqual(ema.created, ema.modified)
 
         # Expect logs to be set
         self.assertEqual(ema.log.count(), 1)

ema/views/ema.py

@@ -39,6 +39,8 @@ def index_view(request: HttpRequest):
     template = "generic_index.html"
     emas = Ema.objects.filter(
         deleted=None,
+    ).order_by(
+        "-modified__timestamp"
     )
 
     table = EmaTable(

intervention/forms/intervention.py

@@ -270,6 +270,7 @@ class NewInterventionForm(BaseForm):
                 responsible=responsibility_data,
                 legal=legal_data,
                 created=action,
+                modified=action,
                 comment=comment,
             )
 

intervention/templates/intervention/report/report.html

@@ -29,18 +29,10 @@
                         <th scope="row">{% trans 'Registration office' %}</th>
                         <td class="align-middle">{{obj.responsible.registration_office.str_as_office|default_if_none:""}}</td>
                     </tr>
-                    <tr>
-                        <th scope="row">{% trans 'Registration office file number' %}</th>
-                        <td class="align-middle">{{obj.responsible.registration_file_number|default_if_none:""}}</td>
-                    </tr>
                     <tr>
                         <th scope="row">{% trans 'Conservation office' %}</th>
                         <td class="align-middle">{{obj.responsible.conservation_office.str_as_office|default_if_none:""}}</td>
                     </tr>
-                    <tr>
-                        <th scope="row">{% trans 'Conservation office file number' %}</th>
-                        <td class="align-middle">{{obj.responsible.conservation_file_number|default_if_none:""}}</td>
-                    </tr>
                     <tr>
                         <th scope="row">{% trans 'Compensations' %}</th>
                         <td class="align-middle">

intervention/tests/test_workflow.py

@@ -78,6 +78,7 @@ class InterventionWorkflowTestCase(BaseWorkflowTestCase):
             self.assertEqual(1, obj.log.count())
             self.assertEqual(obj.log.first().action, UserAction.CREATED)
             self.assertEqual(obj.log.first().user, self.superuser)
+            self.assertEqual(obj.created, obj.modified)
         except ObjectDoesNotExist:
             # Fail if there is no such object
             self.fail()

intervention/views/intervention.py

@@ -45,6 +45,8 @@ def index_view(request: HttpRequest):
         deleted=None,  # not deleted
     ).select_related(
         "legal"
+    ).order_by(
+        "-modified__timestamp"
     )
     table = InterventionTable(
         request=request,

konova/management/commands/generate_report.py

@@ -0,0 +1,137 @@
+"""
+Author: Michel Peltriaux
+Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany
+Contact: michel.peltriaux@sgdnord.rlp.de
+Created on: 26.10.22
+
+"""
+import zipfile
+from io import BytesIO
+
+from django.core.mail import EmailMessage
+from django.utils import timezone
+from django.utils.datetime_safe import datetime
+
+from analysis.utils.excel.excel import TempExcelFile
+from analysis.utils.report import TimespanReport
+from codelist.models import KonovaCode
+from codelist.settings import CODELIST_CONSERVATION_OFFICE_ID
+from konova.management.commands.setup import BaseKonovaCommand
+from konova.sub_settings.django_settings import DEFAULT_FROM_EMAIL, ADMINS
+
+
+class Command(BaseKonovaCommand):
+    help = "Generates reports for conservation offices"
+
+    __from_key = "from"
+    __to_key = "to"
+    __for_key = "for"
+
+    from_date = None
+    to_date = None
+    offices = None
+
+    def add_arguments(self, parser):
+        try:
+            parser.add_argument(f"--{self.__from_key}", type=str, nargs="+")
+            parser.add_argument(f"--{self.__to_key}", type=str, nargs="+")
+            parser.add_argument(f"--{self.__for_key}", type=str, nargs="*")
+        except ValueError as e:
+            self._write_error(f"Argument error: {e}")
+            exit(-1)
+
+    def handle(self, *args, **options):
+        self.__check_arguments(options)
+        in_memory_zipped_reports = self.generate_reports_in_memory_zipped()
+        self.send_mail_to_admins(in_memory_zipped_reports)
+
+    def generate_reports_in_memory_zipped(self):
+        """
+        Generates in-memory reports and zips into in-memory zip file.
+
+        Returns:
+
+        """
+        memory_zip = BytesIO()
+        with zipfile.ZipFile(memory_zip, "w", compression=zipfile.ZIP_DEFLATED) as zf:
+            for office in self.offices:
+                self._write_warning(f"  Process report for {office.long_name}...")
+                report = TimespanReport(office.id, self.from_date, self.to_date)
+                excel_file = TempExcelFile(report.excel_template_path, report.excel_map)
+                zf.writestr(zinfo_or_arcname=f"{office.long_name}_{self.from_date.date()}_{self.to_date.date()}.xlsx", data=excel_file.stream)
+        self._write_success(f"Reports generated for {self.offices.count()} offices and zipped.")
+        return memory_zip.getvalue()
+
+    def __check_arguments(self, options):
+        """
+        Checks given parameters for validity
+
+        Args:
+            options ():
+
+        Returns:
+
+        """
+        _from_value = options.get(self.__from_key, [None])[0]
+        _to_value = options.get(self.__to_key, [None])[0]
+        _for_value = options.get(self.__for_key, [])
+
+        # Check ISO dates
+        try:
+            _from_date = timezone.make_aware(datetime.fromisoformat(_from_value))
+            _to_date = timezone.make_aware(datetime.fromisoformat(_to_value))
+        except Exception as e:
+            self._write_warning(f"One of the dates is not in ISO format (YYYY-MM-DD). {e}")
+            exit(-1)
+
+        # Check conservation office IDs
+        _filter = {
+            "is_archived": False,
+            "is_leaf": True,
+            "code_lists__in": [CODELIST_CONSERVATION_OFFICE_ID],
+        }
+        offices = KonovaCode.objects.filter(**_filter)
+        if _for_value is not None and len(_for_value) != 0:
+            # Specifc offices requested
+            offices = offices.filter(short_name__in=_for_value)
+            all_requested_offices_exist = offices.count() == len(_for_value)
+            if not all_requested_offices_exist:
+                offices_short_name = set(offices.values_list("short_name", flat=True))
+                missing_ids = []
+                for val in _for_value:
+                    if val not in offices_short_name:
+                        missing_ids.append(val)
+                self._write_warning(
+                    f"Unknown offices: {missing_ids}"
+                )
+                exit(-1)
+
+        self.offices = offices
+        self.from_date = _from_date
+        self.to_date = _to_date
+
+    def send_mail_to_admins(self, attachment):
+        office_names = [office.long_name for office in self.offices]
+        admin_mails = [admin[1] for admin in ADMINS]
+
+        date_from_date = self.from_date.date()
+        date_to_date = self.to_date.date()
+
+        mail = EmailMessage(
+            subject="Konova reports generated",
+            body=f"Zipped reports attached from {date_from_date} to {date_to_date} for {office_names}.",
+            from_email=DEFAULT_FROM_EMAIL,
+            to=admin_mails,
+            attachments=[
+                (
+                    f"reports_{date_from_date}_{date_to_date}.zip",
+                    attachment,
+                    "application/zip"
+                )
+            ]
+        )
+        success = mail.send()
+        if success == 1:
+            self._write_success(f"Mails with zip as attachment sent to {admin_mails}.")
+        else:
+            self._write_error(f"Something went wrong during mail sending. Returned sending code was '{success}'")