From 1367fd2b5f7759980f920932154d1c59513a15d4 Mon Sep 17 00:00:00 2001 From: mpeltriaux Date: Thu, 18 Aug 2022 09:54:49 +0200 Subject: [PATCH 01/21] Compensation forms refactoring * splits compensation/forms.py and /modalForms.py into individual files inside new packages * general forms stay in new files in compensation/forms * modal forms stay in new files in compensation/forms/modals --- compensation/forms/__init__.py | 7 + compensation/forms/compensation.py | 238 ++++++++ compensation/forms/eco_account.py | 212 +++++++ compensation/forms/forms.py | 539 ------------------ compensation/forms/mixins.py | 117 ++++ compensation/forms/modalForms.py | 534 ----------------- compensation/forms/modals/__init__.py | 7 + .../forms/modals/compensation_action.py | 155 +++++ compensation/forms/modals/deadline.py | 92 +++ compensation/forms/modals/document.py | 17 + compensation/forms/modals/payment.py | 136 +++++ compensation/forms/modals/state.py | 179 ++++++ compensation/views/compensation.py | 16 +- compensation/views/eco_account.py | 15 +- compensation/views/payment.py | 3 +- ema/forms.py | 4 +- ema/views.py | 12 +- 17 files changed, 1188 insertions(+), 1095 deletions(-) create mode 100644 compensation/forms/__init__.py create mode 100644 compensation/forms/compensation.py create mode 100644 compensation/forms/eco_account.py delete mode 100644 compensation/forms/forms.py create mode 100644 compensation/forms/mixins.py delete mode 100644 compensation/forms/modalForms.py create mode 100644 compensation/forms/modals/__init__.py create mode 100644 compensation/forms/modals/compensation_action.py create mode 100644 compensation/forms/modals/deadline.py create mode 100644 compensation/forms/modals/document.py create mode 100644 compensation/forms/modals/payment.py create mode 100644 compensation/forms/modals/state.py diff --git a/compensation/forms/__init__.py b/compensation/forms/__init__.py new file mode 100644 index 00000000..ca978536 --- /dev/null +++ b/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 + +""" diff --git a/compensation/forms/compensation.py b/compensation/forms/compensation.py new file mode 100644 index 00000000..1672e161 --- /dev/null +++ b/compensation/forms/compensation.py @@ -0,0 +1,238 @@ +""" +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"), + 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 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="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_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, 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) + 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) + # 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, + is_pik=is_pik, + 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, + "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(): + # 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_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.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) + return self.instance \ No newline at end of file diff --git a/compensation/forms/eco_account.py b/compensation/forms/eco_account.py new file mode 100644 index 00000000..6bc12618 --- /dev/null +++ b/compensation/forms/eco_account.py @@ -0,0 +1,212 @@ +""" +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 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, + 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) + # Process the geometry form + geometry = geom_form.save(action) + + 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, + geometry=geometry, + 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) + 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 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) + 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) + + # Process the geometry form + geometry = geom_form.save(action) + + # 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.identifier = identifier + self.instance.title = title + self.instance.deductable_surface = surface + self.instance.geometry = geometry + 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) + return self.instance diff --git a/compensation/forms/forms.py b/compensation/forms/forms.py deleted file mode 100644 index 8f28c5ff..00000000 --- a/compensation/forms/forms.py +++ /dev/null @@ -1,539 +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, CODELIST_HANDLER_ID -from compensation.models import Compensation, EcoAccount -from intervention.inputs import GenerateInput -from intervention.models import Intervention, Responsibility, Legal, Handler -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_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="codes-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() - ) - - -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="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_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, 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) - 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) - # 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, - is_pik=is_pik, - 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, - "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(): - # 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_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.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) - return self.instance - - -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, - 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) - # Process the geometry form - geometry = geom_form.save(action) - - 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, - geometry=geometry, - 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) - 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 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) - 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) - - # Process the geometry form - geometry = geom_form.save(action) - - # 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.identifier = identifier - self.instance.title = title - self.instance.deductable_surface = surface - self.instance.geometry = geometry - 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) - return self.instance diff --git a/compensation/forms/mixins.py b/compensation/forms/mixins.py new file mode 100644 index 00000000..db174808 --- /dev/null +++ b/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="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_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="codes-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() + ) \ No newline at end of file diff --git a/compensation/forms/modalForms.py b/compensation/forms/modalForms.py deleted file mode 100644 index ef21aa3f..00000000 --- a/compensation/forms/modalForms.py +++ /dev/null @@ -1,534 +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, \ - CompensationStateTreeRadioSelect -from konova.contexts import BaseContext -from konova.forms.modals 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) - 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) - - -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.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="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") - 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(NewStateModalForm): - 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) - - -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) - 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 - - -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) - 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 NewCompensationDocumentModalForm(NewDocumentModalForm): - document_model = CompensationDocument - - -class NewEcoAccountDocumentModalForm(NewDocumentModalForm): - document_model = EcoAccountDocument \ No newline at end of file diff --git a/compensation/forms/modals/__init__.py b/compensation/forms/modals/__init__.py new file mode 100644 index 00000000..ca978536 --- /dev/null +++ b/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 + +""" diff --git a/compensation/forms/modals/compensation_action.py b/compensation/forms/modals/compensation_action.py new file mode 100644 index 00000000..cc0bae15 --- /dev/null +++ b/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="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(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) \ No newline at end of file diff --git a/compensation/forms/modals/deadline.py b/compensation/forms/modals/deadline.py new file mode 100644 index 00000000..330c83c8 --- /dev/null +++ b/compensation/forms/modals/deadline.py @@ -0,0 +1,92 @@ +""" +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.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"), + 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) + 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 diff --git a/compensation/forms/modals/document.py b/compensation/forms/modals/document.py new file mode 100644 index 00000000..83c2ff92 --- /dev/null +++ b/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 diff --git a/compensation/forms/modals/payment.py b/compensation/forms/modals/payment.py new file mode 100644 index 00000000..4383a576 --- /dev/null +++ b/compensation/forms/modals/payment.py @@ -0,0 +1,136 @@ +""" +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.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, + 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) + 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) diff --git a/compensation/forms/modals/state.py b/compensation/forms/modals/state.py new file mode 100644 index 00000000..485045ba --- /dev/null +++ b/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.utils 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="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") + 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) diff --git a/compensation/views/compensation.py b/compensation/views/compensation.py index db01a045..e12324ce 100644 --- a/compensation/views/compensation.py +++ b/compensation/views/compensation.py @@ -5,10 +5,12 @@ from django.http import HttpRequest, JsonResponse from django.shortcuts import render from django.utils.translation import gettext_lazy as _ -from compensation.forms.forms import NewCompensationForm, EditCompensationForm -from compensation.forms.modalForms import NewStateModalForm, NewDeadlineModalForm, NewActionModalForm, \ - NewCompensationDocumentModalForm, RemoveCompensationActionModalForm, RemoveCompensationStateModalForm, \ - EditCompensationStateModalForm, EditCompensationActionModalForm, EditDeadlineModalForm +from compensation.forms.compensation import NewCompensationForm, EditCompensationForm +from compensation.forms.modals.state import NewCompensationStateModalForm, RemoveCompensationStateModalForm, EditCompensationStateModalForm +from compensation.forms.modals.document import NewCompensationDocumentModalForm +from compensation.forms.modals.compensation_action import NewCompensationActionModalForm, \ + EditCompensationActionModalForm, RemoveCompensationActionModalForm +from compensation.forms.modals.deadline import NewDeadlineModalForm, EditDeadlineModalForm from compensation.models import Compensation, CompensationState, CompensationAction, CompensationDocument from compensation.tables import CompensationTable from intervention.models import Intervention @@ -21,7 +23,7 @@ from konova.models import Deadline from konova.sub_settings.context_settings import TAB_TITLE_IDENTIFIER from konova.utils.documents import get_document, remove_document from konova.utils.generators import generate_qr_code -from konova.utils.message_templates import FORM_INVALID, IDENTIFIER_REPLACED, DATA_UNSHARED_EXPLANATION, \ +from konova.utils.message_templates import FORM_INVALID, IDENTIFIER_REPLACED, \ CHECKED_RECORDED_RESET, COMPENSATION_ADDED_TEMPLATE, COMPENSATION_REMOVED_TEMPLATE, DOCUMENT_ADDED, \ COMPENSATION_STATE_REMOVED, COMPENSATION_STATE_ADDED, COMPENSATION_ACTION_REMOVED, COMPENSATION_ACTION_ADDED, \ DEADLINE_ADDED, DEADLINE_REMOVED, DOCUMENT_EDITED, COMPENSATION_STATE_EDITED, COMPENSATION_ACTION_EDITED, \ @@ -402,7 +404,7 @@ def state_new_view(request: HttpRequest, id: str): """ comp = get_object_or_404(Compensation, id=id) - form = NewStateModalForm(request.POST or None, instance=comp, request=request) + form = NewCompensationStateModalForm(request.POST or None, instance=comp, request=request) return form.process_request( request, msg_success=COMPENSATION_STATE_ADDED, @@ -424,7 +426,7 @@ def action_new_view(request: HttpRequest, id: str): """ comp = get_object_or_404(Compensation, id=id) - form = NewActionModalForm(request.POST or None, instance=comp, request=request) + form = NewCompensationActionModalForm(request.POST or None, instance=comp, request=request) return form.process_request( request, msg_success=COMPENSATION_ACTION_ADDED, diff --git a/compensation/views/eco_account.py b/compensation/views/eco_account.py index 2ebeb1f7..d600c23c 100644 --- a/compensation/views/eco_account.py +++ b/compensation/views/eco_account.py @@ -14,10 +14,13 @@ from django.core.exceptions import ObjectDoesNotExist from django.http import HttpRequest, Http404, JsonResponse from django.shortcuts import render, get_object_or_404, redirect -from compensation.forms.forms import NewEcoAccountForm, EditEcoAccountForm -from compensation.forms.modalForms import NewStateModalForm, NewActionModalForm, NewDeadlineModalForm, \ - NewEcoAccountDocumentModalForm, RemoveCompensationActionModalForm, RemoveCompensationStateModalForm, \ - EditCompensationStateModalForm, EditCompensationActionModalForm, EditDeadlineModalForm +from compensation.forms.eco_account import NewEcoAccountForm, EditEcoAccountForm +from compensation.forms.modals.compensation_action import NewCompensationActionModalForm, \ + RemoveCompensationActionModalForm, EditCompensationActionModalForm +from compensation.forms.modals.deadline import EditDeadlineModalForm, NewDeadlineModalForm +from compensation.forms.modals.document import NewEcoAccountDocumentModalForm +from compensation.forms.modals.state import NewCompensationStateModalForm, RemoveCompensationStateModalForm, \ + EditCompensationStateModalForm from compensation.models import EcoAccount, EcoAccountDocument, CompensationState, CompensationAction from compensation.tables import EcoAccountTable from intervention.forms.modalForms import NewDeductionModalForm, ShareModalForm, RemoveEcoAccountDeductionModalForm, \ @@ -401,7 +404,7 @@ def state_new_view(request: HttpRequest, id: str): """ acc = get_object_or_404(EcoAccount, id=id) - form = NewStateModalForm(request.POST or None, instance=acc, request=request) + form = NewCompensationStateModalForm(request.POST or None, instance=acc, request=request) return form.process_request( request, msg_success=COMPENSATION_STATE_ADDED, @@ -423,7 +426,7 @@ def action_new_view(request: HttpRequest, id: str): """ acc = get_object_or_404(EcoAccount, id=id) - form = NewActionModalForm(request.POST or None, instance=acc, request=request) + form = NewCompensationActionModalForm(request.POST or None, instance=acc, request=request) return form.process_request( request, msg_success=COMPENSATION_ACTION_ADDED, diff --git a/compensation/views/payment.py b/compensation/views/payment.py index 84fad5bc..29e89ac3 100644 --- a/compensation/views/payment.py +++ b/compensation/views/payment.py @@ -6,12 +6,11 @@ Created on: 09.08.21 """ from django.urls import reverse -from django.utils.translation import gettext_lazy as _ from django.contrib.auth.decorators import login_required from django.http import HttpRequest from django.shortcuts import get_object_or_404 -from compensation.forms.modalForms import NewPaymentForm, RemovePaymentModalForm, EditPaymentModalForm +from compensation.forms.modals.payment import NewPaymentForm, RemovePaymentModalForm, EditPaymentModalForm from compensation.models import Payment from intervention.models import Intervention from konova.decorators import default_group_required, shared_access_required diff --git a/ema/forms.py b/ema/forms.py index 93f23490..bbe09a88 100644 --- a/ema/forms.py +++ b/ema/forms.py @@ -10,8 +10,8 @@ from django.db import transaction from django.urls import reverse, reverse_lazy from django.utils.translation import gettext_lazy as _ -from compensation.forms.forms import AbstractCompensationForm, CompensationResponsibleFormMixin, \ - PikCompensationFormMixin +from compensation.forms.mixins import CompensationResponsibleFormMixin, PikCompensationFormMixin +from compensation.forms.compensation import AbstractCompensationForm from ema.models import Ema, EmaDocument from intervention.models import Responsibility, Handler from konova.forms import SimpleGeomForm diff --git a/ema/views.py b/ema/views.py index f07187aa..fea6d4bc 100644 --- a/ema/views.py +++ b/ema/views.py @@ -6,9 +6,11 @@ from django.shortcuts import render, get_object_or_404, redirect from django.urls import reverse from django.utils.translation import gettext_lazy as _ -from compensation.forms.modalForms import NewStateModalForm, NewActionModalForm, NewDeadlineModalForm, \ - RemoveCompensationActionModalForm, RemoveCompensationStateModalForm, EditCompensationStateModalForm, \ - EditCompensationActionModalForm, EditDeadlineModalForm +from compensation.forms.modals.compensation_action import NewCompensationActionModalForm, \ + EditCompensationActionModalForm, RemoveCompensationActionModalForm +from compensation.forms.modals.deadline import NewDeadlineModalForm, EditDeadlineModalForm +from compensation.forms.modals.state import NewCompensationStateModalForm, RemoveCompensationStateModalForm, \ + EditCompensationStateModalForm from compensation.models import CompensationAction, CompensationState from ema.forms import NewEmaForm, EditEmaForm, NewEmaDocumentModalForm from ema.tables import EmaTable @@ -303,7 +305,7 @@ def state_new_view(request: HttpRequest, id: str): """ ema = get_object_or_404(Ema, id=id) - form = NewStateModalForm(request.POST or None, instance=ema, request=request) + form = NewCompensationStateModalForm(request.POST or None, instance=ema, request=request) return form.process_request( request, msg_success=COMPENSATION_STATE_ADDED, @@ -325,7 +327,7 @@ def action_new_view(request: HttpRequest, id: str): """ ema = get_object_or_404(Ema, id=id) - form = NewActionModalForm(request.POST or None, instance=ema, request=request) + form = NewCompensationActionModalForm(request.POST or None, instance=ema, request=request) return form.process_request( request, msg_success=COMPENSATION_ACTION_ADDED, -- 2.45.2 From de8d79983d6e9962797fe6b211e3a066206b289c Mon Sep 17 00:00:00 2001 From: mpeltriaux Date: Thu, 18 Aug 2022 10:08:51 +0200 Subject: [PATCH 02/21] Intervention forms * refactors intervention/forms and ../modalForms into individual files in separated packages * forms.py has been renamed into intervention.py, now can be found as intervention/forms/intervention.py * modalForms.py has been split into individual files living in modals package, can be found as intervention/forms/modals/... --- codelist/models.py | 2 +- compensation/views/eco_account.py | 5 +- ema/views.py | 2 +- .../forms/{forms.py => intervention.py} | 0 intervention/forms/modalForms.py | 574 ------------------ intervention/forms/modals/__init__.py | 7 + intervention/forms/modals/check.py | 107 ++++ intervention/forms/modals/deduction.py | 252 ++++++++ intervention/forms/modals/document.py | 13 + intervention/forms/modals/revocation.py | 110 ++++ intervention/forms/modals/share.py | 136 +++++ intervention/views.py | 14 +- konova/forms/base_form.py | 4 +- 13 files changed, 641 insertions(+), 585 deletions(-) rename intervention/forms/{forms.py => intervention.py} (100%) delete mode 100644 intervention/forms/modalForms.py create mode 100644 intervention/forms/modals/__init__.py create mode 100644 intervention/forms/modals/check.py create mode 100644 intervention/forms/modals/deduction.py create mode 100644 intervention/forms/modals/document.py create mode 100644 intervention/forms/modals/revocation.py create mode 100644 intervention/forms/modals/share.py diff --git a/codelist/models.py b/codelist/models.py index 8e5de0c9..5d06172e 100644 --- a/codelist/models.py +++ b/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: diff --git a/compensation/views/eco_account.py b/compensation/views/eco_account.py index d600c23c..07796d14 100644 --- a/compensation/views/eco_account.py +++ b/compensation/views/eco_account.py @@ -23,8 +23,9 @@ from compensation.forms.modals.state import NewCompensationStateModalForm, Remov EditCompensationStateModalForm from compensation.models import EcoAccount, EcoAccountDocument, CompensationState, CompensationAction from compensation.tables import EcoAccountTable -from intervention.forms.modalForms import NewDeductionModalForm, ShareModalForm, RemoveEcoAccountDeductionModalForm, \ +from intervention.forms.modals.deduction import RemoveEcoAccountDeductionModalForm, NewEcoAccountDeductionModalForm, \ EditEcoAccountDeductionModalForm +from intervention.forms.modals.share import ShareModalForm from konova.contexts import BaseContext from konova.decorators import any_group_check, default_group_required, conservation_office_group_required, \ shared_access_required @@ -707,7 +708,7 @@ def new_deduction_view(request: HttpRequest, id: str): acc = get_object_or_404(EcoAccount, id=id) if not acc.recorded: raise Http404() - form = NewDeductionModalForm(request.POST or None, instance=acc, request=request) + form = NewEcoAccountDeductionModalForm(request.POST or None, instance=acc, request=request) return form.process_request( request, msg_success=DEDUCTION_ADDED, diff --git a/ema/views.py b/ema/views.py index fea6d4bc..2dd6e51f 100644 --- a/ema/views.py +++ b/ema/views.py @@ -14,7 +14,7 @@ from compensation.forms.modals.state import NewCompensationStateModalForm, Remov from compensation.models import CompensationAction, CompensationState from ema.forms import NewEmaForm, EditEmaForm, NewEmaDocumentModalForm from ema.tables import EmaTable -from intervention.forms.modalForms import ShareModalForm +from intervention.forms.modals.share import ShareModalForm from konova.contexts import BaseContext from konova.decorators import conservation_office_group_required, shared_access_required from ema.models import Ema, EmaDocument diff --git a/intervention/forms/forms.py b/intervention/forms/intervention.py similarity index 100% rename from intervention/forms/forms.py rename to intervention/forms/intervention.py diff --git a/intervention/forms/modalForms.py b/intervention/forms/modalForms.py deleted file mode 100644 index a977c1ce..00000000 --- a/intervention/forms/modalForms.py +++ /dev/null @@ -1,574 +0,0 @@ -""" -Author: Michel Peltriaux -Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany -Contact: michel.peltriaux@sgdnord.rlp.de -Created on: 27.09.21 - -""" -from dal import autocomplete -from django.core.exceptions import ObjectDoesNotExist - -from konova.utils.message_templates import DEDUCTION_ADDED, REVOCATION_ADDED, DEDUCTION_REMOVED, DEDUCTION_EDITED, \ - REVOCATION_EDITED, ENTRY_REMOVE_MISSING_PERMISSION -from user.models import User, Team -from user.models import UserActionLogEntry -from django.db import transaction -from django import forms -from django.utils.translation import gettext_lazy as _ - -from compensation.models import EcoAccount, EcoAccountDeduction -from intervention.inputs import TextToClipboardInput -from intervention.models import Intervention, InterventionDocument, RevocationDocument -from konova.forms.modals import BaseModalForm -from konova.forms.modals import NewDocumentModalForm, RemoveModalForm -from konova.utils.general import format_german_float -from konova.utils.user_checks import is_default_group_only - - -class ShareModalForm(BaseModalForm): - url = forms.CharField( - label=_("Share link"), - label_suffix="", - help_text=_("Send this link to users who you want to have writing access on the data"), - required=False, - widget=TextToClipboardInput( - attrs={ - "readonly": True, - "class": "form-control", - } - ) - ) - teams = forms.ModelMultipleChoiceField( - label=_("Add team to share with"), - label_suffix="", - help_text=_("Multiple selection possible - You can only select teams which do not already have access."), - required=False, - queryset=Team.objects.all(), - widget=autocomplete.ModelSelect2Multiple( - url="share-team-autocomplete", - attrs={ - "data-placeholder": _("Click for selection"), - "data-minimum-input-length": 3, - }, - ), - ) - users = forms.ModelMultipleChoiceField( - label=_("Add user to share with"), - label_suffix="", - help_text=_("Multiple selection possible - You can only select users which do not already have access. Enter the full username."), - required=False, - queryset=User.objects.all(), - widget=autocomplete.ModelSelect2Multiple( - url="share-user-autocomplete", - attrs={ - "data-placeholder": _("Click for selection"), - "data-minimum-input-length": 3, - }, - ), - ) - - def __init__(self, *args, **kwargs): - super().__init__(*args, **kwargs) - self.form_title = _("Share") - self.form_caption = _("Share settings for {}").format(self.instance.identifier) - self.template = "modal/modal_form.html" - - # Make sure an access_token is set - if self.instance.access_token is None: - self.instance.generate_access_token() - - self._init_fields() - - def _user_team_valid(self): - """ Checks whether users and teams have been removed by the user and if the user is allowed to do so or not - - Returns: - - """ - users = self.cleaned_data.get("users", User.objects.none()) - teams = self.cleaned_data.get("teams", Team.objects.none()) - - _is_valid = True - if is_default_group_only(self.user): - shared_users = self.instance.shared_users - shared_teams = self.instance.shared_teams - - shared_users_are_removed = not set(shared_users).issubset(users) - shared_teams_are_removed = not set(shared_teams).issubset(teams) - - if shared_users_are_removed: - self.add_error( - "users", - ENTRY_REMOVE_MISSING_PERMISSION - ) - _is_valid = False - if shared_teams_are_removed: - self.add_error( - "teams", - ENTRY_REMOVE_MISSING_PERMISSION - ) - _is_valid = False - return _is_valid - - def is_valid(self): - """ Extended validity check - - Returns: - - """ - super_valid = super().is_valid() - user_team_valid = self._user_team_valid() - _is_valid = super_valid and user_team_valid - return _is_valid - - def _init_fields(self): - """ Wraps initializing of fields - - Returns: - - """ - # Initialize share_link field - share_link = self.instance.get_share_link() - self.share_link = self.request.build_absolute_uri(share_link) - self.initialize_form_field( - "url", - self.share_link - ) - - form_data = { - "teams": self.instance.teams.all(), - "users": self.instance.users.all(), - } - self.load_initial_data(form_data) - - def save(self): - self.instance.update_shared_access(self) - - -class NewRevocationModalForm(BaseModalForm): - date = forms.DateField( - label=_("Date"), - label_suffix=_(""), - help_text=_("Date of revocation"), - widget=forms.DateInput( - attrs={ - "type": "date", - "data-provide": "datepicker", - "class": "form-control", - }, - format="%d.%m.%Y" - ) - ) - file = forms.FileField( - label=_("Document"), - label_suffix=_(""), - required=False, - help_text=_("Must be smaller than 15 Mb"), - widget=forms.FileInput( - attrs={ - "class": "form-control-file" - } - ) - ) - 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", - } - ) - ) - document_model = RevocationDocument - - def __init__(self, *args, **kwargs): - super().__init__(*args, **kwargs) - self.form_title = _("Add revocation") - self.form_caption = "" - self.form_attrs = { - "enctype": "multipart/form-data", # important for file upload - } - - def save(self): - revocation = self.instance.add_revocation(self) - self.instance.mark_as_edited(self.user, self.request, edit_comment=REVOCATION_ADDED) - return revocation - - -class EditRevocationModalForm(NewRevocationModalForm): - revocation = None - - def __init__(self, *args, **kwargs): - self.revocation = kwargs.pop("revocation", None) - super().__init__(*args, **kwargs) - self.form_title = _("Edit revocation") - try: - doc = self.revocation.document.file - except ObjectDoesNotExist: - doc = None - form_data = { - "date": str(self.revocation.date), - "file": doc, - "comment": self.revocation.comment, - } - self.load_initial_data(form_data) - - def save(self): - revocation = self.instance.edit_revocation(self) - self.instance.mark_as_edited(self.user, self.request, edit_comment=REVOCATION_EDITED) - return revocation - - -class RemoveRevocationModalForm(RemoveModalForm): - """ Removing modal form for Revocation - - Can be used for anything, where removing shall be confirmed by the user a second time. - - """ - revocation = None - - def __init__(self, *args, **kwargs): - revocation = kwargs.pop("revocation", None) - self.revocation = revocation - super().__init__(*args, **kwargs) - - def save(self): - self.instance.remove_revocation(self) - - -class CheckModalForm(BaseModalForm): - """ The modal form for running a check on interventions and their compensations - - """ - checked_intervention = forms.BooleanField( - label=_("Checked intervention data"), - label_suffix="", - widget=forms.CheckboxInput(), - required=True, - ) - checked_comps = forms.BooleanField( - label=_("Checked compensations data and payments"), - label_suffix="", - widget=forms.CheckboxInput(), - required=True - ) - valid = None - - def __init__(self, *args, **kwargs): - super().__init__(*args, **kwargs) - self.form_title = _("Run check") - self.form_caption = _("I, {} {}, confirm that all necessary control steps have been performed by myself.").format(self.user.first_name, self.user.last_name) - self.valid = False - - def _are_deductions_valid(self): - """ Performs validity checks on deductions and their eco-account - - Returns: - - """ - deductions = self.instance.deductions.all() - for deduction in deductions: - checker = deduction.account.quality_check() - for msg in checker.messages: - self.add_error( - "checked_comps", - f"{deduction.account.identifier}: {msg}" - ) - return checker.valid - return True - - def _are_comps_valid(self): - """ Performs validity checks on all types of compensations - - Types of compensations are - * regular Compensations - * deductions from EcoAccounts - - Returns: - - """ - comps = self.instance.compensations.filter( - deleted=None, - ) - comps_valid = True - for comp in comps: - checker = comp.quality_check() - for msg in checker.messages: - self.add_error( - "checked_comps", - f"{comp.identifier}: {msg}" - ) - comps_valid = checker.valid - deductions_valid = self._are_deductions_valid() - return deductions_valid and comps_valid - - def is_valid(self) -> bool: - """ Perform a validity check based on quality_check() logic - - Returns: - result (bool) - """ - super_valid = super().is_valid() - # Perform check - checker = self.instance.quality_check() - for msg in checker.messages: - self.add_error( - "checked_intervention", - msg - ) - all_comps_valid = self._are_comps_valid() - intervention_valid = checker.valid - - return super_valid and intervention_valid and all_comps_valid - - def save(self): - """ Saving logic - - Returns: - - """ - with transaction.atomic(): - self.instance.set_checked(self.user) - - -class NewDeductionModalForm(BaseModalForm): - """ Form for creating new deduction - - Can be used for Intervention view as well as for EcoAccount views. - - Parameter 'instance' can be an intervention, as well as an ecoAccount. - An instance check handles both workflows properly. - - """ - account = forms.ModelChoiceField( - label=_("Eco-account"), - label_suffix="", - help_text=_("Only recorded accounts can be selected for deductions"), - queryset=EcoAccount.objects.filter(deleted=None), - widget=autocomplete.ModelSelect2( - url="accounts-autocomplete", - attrs={ - "data-placeholder": _("Eco-account"), - "data-minimum-input-length": 3, - "readonly": True, - } - ), - ) - surface = forms.DecimalField( - min_value=0.00, - decimal_places=2, - label=_("Surface"), - label_suffix="", - help_text=_("in m²"), - widget=forms.NumberInput( - attrs={ - "class": "form-control", - "placeholder": "0,00", - } - ) - ) - intervention = forms.ModelChoiceField( - label=_("Intervention"), - label_suffix="", - help_text=_("Only shared interventions can be selected"), - queryset=Intervention.objects.filter(deleted=None), - widget=autocomplete.ModelSelect2( - url="interventions-autocomplete", - attrs={ - "data-placeholder": _("Intervention"), - "data-minimum-input-length": 3, - } - ), - ) - - def __init__(self, *args, **kwargs): - super().__init__(*args, **kwargs) - self.form_title = _("New Deduction") - self.form_caption = _("Enter the information for a new deduction from a chosen eco-account") - - # Check for Intervention or EcoAccount - if isinstance(self.instance, Intervention): - # Form has been called with a given intervention - self.initialize_form_field("intervention", self.instance) - self.disable_form_field("intervention") - elif isinstance(self.instance, EcoAccount): - # Form has been called with a given account --> make it initial in the form and read-only - self.initialize_form_field("account", self.instance) - self.disable_form_field("account") - else: - raise NotImplementedError - - def _get_available_surface(self, acc): - """ Calculates how much available surface is left on the account - - Args: - acc (EcoAccount): - - Returns: - - """ - # Calculate valid surface - deductable_surface = acc.deductable_surface - sum_surface_deductions = acc.get_deductions_surface() - rest_surface = deductable_surface - sum_surface_deductions - return rest_surface - - def is_valid(self): - """ Custom validity check - - Makes sure the deduction can not contain more surface than the account still provides - - Returns: - is_valid (bool) - """ - super_result = super().is_valid() - acc = self.cleaned_data["account"] - intervention = self.cleaned_data["intervention"] - objects_valid = True - - if not acc.recorded: - self.add_error( - "account", - _("Eco-account {} is not recorded yet. You can only deduct from recorded accounts.").format(acc.identifier) - ) - objects_valid = False - - if intervention.is_recorded: - self.add_error( - "intervention", - _("Intervention {} is currently recorded. To change any data on it, the entry must be unrecorded.").format(intervention.identifier) - ) - objects_valid = False - - rest_surface = self._get_available_surface(acc) - form_surface = float(self.cleaned_data["surface"]) - is_valid_surface = form_surface <= rest_surface - if not is_valid_surface: - self.add_error( - "surface", - _("The account {} has not enough surface for a deduction of {} m². There are only {} m² left").format( - acc.identifier, - format_german_float(form_surface), - format_german_float(rest_surface), - ), - ) - return is_valid_surface and objects_valid and super_result - - def __create_deduction(self): - """ Creates the deduction - - Returns: - - """ - with transaction.atomic(): - user_action_create = UserActionLogEntry.get_created_action(self.user) - deduction = EcoAccountDeduction.objects.create( - intervention=self.cleaned_data["intervention"], - account=self.cleaned_data["account"], - surface=self.cleaned_data["surface"], - created=user_action_create, - ) - return deduction - - def save(self): - deduction = self.__create_deduction() - self.cleaned_data["intervention"].mark_as_edited(self.user, edit_comment=DEDUCTION_ADDED) - self.cleaned_data["account"].mark_as_edited(self.user, edit_comment=DEDUCTION_ADDED) - return deduction - - -class EditEcoAccountDeductionModalForm(NewDeductionModalForm): - deduction = None - - def __init__(self, *args, **kwargs): - self.deduction = kwargs.pop("deduction", None) - super().__init__(*args, **kwargs) - self.form_title = _("Edit Deduction") - form_data = { - "account": self.deduction.account, - "intervention": self.deduction.intervention, - "surface": self.deduction.surface, - } - self.load_initial_data(form_data) - - def _get_available_surface(self, acc): - rest_surface = super()._get_available_surface(acc) - # Increase available surface by the currently deducted surface, so we can 'deduct' the same amount again or - # increase the surface only a little, which will still be valid. - # Example: 200 m² left, 500 m² deducted. Entering 700 m² would fail if we would not add the 500 m² to the available - # surface again. - rest_surface += self.deduction.surface - return rest_surface - - def save(self): - deduction = self.deduction - form_account = self.cleaned_data.get("account", None) - form_intervention = self.cleaned_data.get("intervention", None) - old_account = deduction.account - old_intervention = deduction.intervention - old_surface = deduction.surface - - # If account or intervention has been changed, we put that change in the logs just as if the deduction has - # been removed for this entry. Act as if the deduction is newly created for the new entries - if old_account != form_account: - old_account.mark_as_edited(self.user, self.request, edit_comment=DEDUCTION_REMOVED) - form_account.mark_as_edited(self.user, self.request, edit_comment=DEDUCTION_ADDED) - else: - old_account.mark_as_edited(self.user, self.request, edit_comment=DEDUCTION_EDITED) - - if old_intervention != form_intervention: - old_intervention.mark_as_edited(self.user, self.request, edit_comment=DEDUCTION_REMOVED) - form_intervention.mark_as_edited(self.user, self.request, edit_comment=DEDUCTION_ADDED) - else: - old_intervention.mark_as_edited(self.user, self.request, edit_comment=DEDUCTION_EDITED) - - deduction.account = form_account - deduction.intervention = self.cleaned_data.get("intervention", None) - deduction.surface = self.cleaned_data.get("surface", None) - deduction.save() - - data_changes = { - "surface": { - "old": old_surface, - "new": deduction.surface, - }, - "intervention": { - "old": old_intervention.identifier, - "new": deduction.intervention.identifier, - }, - "account": { - "old": old_account.identifier, - "new": deduction.account.identifier, - } - } - old_account.send_notification_mail_on_deduction_change(data_changes) - return deduction - - -class RemoveEcoAccountDeductionModalForm(RemoveModalForm): - """ Removing modal form for EcoAccountDeduction - - Can be used for anything, where removing shall be confirmed by the user a second time. - - """ - deduction = None - - def __init__(self, *args, **kwargs): - deduction = kwargs.pop("deduction", None) - self.deduction = deduction - super().__init__(*args, **kwargs) - - def save(self): - with transaction.atomic(): - self.deduction.intervention.mark_as_edited(self.user, edit_comment=DEDUCTION_REMOVED) - self.deduction.account.mark_as_edited(self.user, edit_comment=DEDUCTION_REMOVED) - self.deduction.delete() - - -class NewInterventionDocumentModalForm(NewDocumentModalForm): - document_model = InterventionDocument diff --git a/intervention/forms/modals/__init__.py b/intervention/forms/modals/__init__.py new file mode 100644 index 00000000..ca978536 --- /dev/null +++ b/intervention/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 + +""" diff --git a/intervention/forms/modals/check.py b/intervention/forms/modals/check.py new file mode 100644 index 00000000..8e2a551e --- /dev/null +++ b/intervention/forms/modals/check.py @@ -0,0 +1,107 @@ +""" +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.utils.translation import gettext_lazy as _ + +from konova.forms.modals import BaseModalForm + + +class CheckModalForm(BaseModalForm): + """ The modal form for running a check on interventions and their compensations + + """ + checked_intervention = forms.BooleanField( + label=_("Checked intervention data"), + label_suffix="", + widget=forms.CheckboxInput(), + required=True, + ) + checked_comps = forms.BooleanField( + label=_("Checked compensations data and payments"), + label_suffix="", + widget=forms.CheckboxInput(), + required=True + ) + valid = None + + def __init__(self, *args, **kwargs): + super().__init__(*args, **kwargs) + self.form_title = _("Run check") + self.form_caption = _("I, {} {}, confirm that all necessary control steps have been performed by myself.").format(self.user.first_name, self.user.last_name) + self.valid = False + + def _are_deductions_valid(self): + """ Performs validity checks on deductions and their eco-account + + Returns: + + """ + deductions = self.instance.deductions.all() + for deduction in deductions: + checker = deduction.account.quality_check() + for msg in checker.messages: + self.add_error( + "checked_comps", + f"{deduction.account.identifier}: {msg}" + ) + return checker.valid + return True + + def _are_comps_valid(self): + """ Performs validity checks on all types of compensations + + Types of compensations are + * regular Compensations + * deductions from EcoAccounts + + Returns: + + """ + comps = self.instance.compensations.filter( + deleted=None, + ) + comps_valid = True + for comp in comps: + checker = comp.quality_check() + for msg in checker.messages: + self.add_error( + "checked_comps", + f"{comp.identifier}: {msg}" + ) + comps_valid = checker.valid + deductions_valid = self._are_deductions_valid() + return deductions_valid and comps_valid + + def is_valid(self) -> bool: + """ Perform a validity check based on quality_check() logic + + Returns: + result (bool) + """ + super_valid = super().is_valid() + # Perform check + checker = self.instance.quality_check() + for msg in checker.messages: + self.add_error( + "checked_intervention", + msg + ) + all_comps_valid = self._are_comps_valid() + intervention_valid = checker.valid + + return super_valid and intervention_valid and all_comps_valid + + def save(self): + """ Saving logic + + Returns: + + """ + with transaction.atomic(): + self.instance.set_checked(self.user) diff --git a/intervention/forms/modals/deduction.py b/intervention/forms/modals/deduction.py new file mode 100644 index 00000000..2e182146 --- /dev/null +++ b/intervention/forms/modals/deduction.py @@ -0,0 +1,252 @@ +""" +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.utils.translation import gettext_lazy as _ + +from compensation.models import EcoAccount, EcoAccountDeduction +from intervention.models import Intervention +from konova.forms.modals import BaseModalForm, RemoveModalForm +from konova.utils.general import format_german_float +from konova.utils.message_templates import DEDUCTION_ADDED, DEDUCTION_REMOVED, DEDUCTION_EDITED +from user.models import UserActionLogEntry + + +class NewEcoAccountDeductionModalForm(BaseModalForm): + """ Form for creating new deduction + + Can be used for Intervention view as well as for EcoAccount views. + + Parameter 'instance' can be an intervention, as well as an ecoAccount. + An instance check handles both workflows properly. + + """ + account = forms.ModelChoiceField( + label=_("Eco-account"), + label_suffix="", + help_text=_("Only recorded accounts can be selected for deductions"), + queryset=EcoAccount.objects.filter(deleted=None), + widget=autocomplete.ModelSelect2( + url="accounts-autocomplete", + attrs={ + "data-placeholder": _("Eco-account"), + "data-minimum-input-length": 3, + "readonly": True, + } + ), + ) + surface = forms.DecimalField( + min_value=0.00, + decimal_places=2, + label=_("Surface"), + label_suffix="", + help_text=_("in m²"), + widget=forms.NumberInput( + attrs={ + "class": "form-control", + "placeholder": "0,00", + } + ) + ) + intervention = forms.ModelChoiceField( + label=_("Intervention"), + label_suffix="", + help_text=_("Only shared interventions can be selected"), + queryset=Intervention.objects.filter(deleted=None), + widget=autocomplete.ModelSelect2( + url="interventions-autocomplete", + attrs={ + "data-placeholder": _("Intervention"), + "data-minimum-input-length": 3, + } + ), + ) + + def __init__(self, *args, **kwargs): + super().__init__(*args, **kwargs) + self.form_title = _("New Deduction") + self.form_caption = _("Enter the information for a new deduction from a chosen eco-account") + + # Check for Intervention or EcoAccount + if isinstance(self.instance, Intervention): + # Form has been called with a given intervention + self.initialize_form_field("intervention", self.instance) + self.disable_form_field("intervention") + elif isinstance(self.instance, EcoAccount): + # Form has been called with a given account --> make it initial in the form and read-only + self.initialize_form_field("account", self.instance) + self.disable_form_field("account") + else: + raise NotImplementedError + + def _get_available_surface(self, acc): + """ Calculates how much available surface is left on the account + + Args: + acc (EcoAccount): + + Returns: + + """ + # Calculate valid surface + deductable_surface = acc.deductable_surface + sum_surface_deductions = acc.get_deductions_surface() + rest_surface = deductable_surface - sum_surface_deductions + return rest_surface + + def is_valid(self): + """ Custom validity check + + Makes sure the deduction can not contain more surface than the account still provides + + Returns: + is_valid (bool) + """ + super_result = super().is_valid() + acc = self.cleaned_data["account"] + intervention = self.cleaned_data["intervention"] + objects_valid = True + + if not acc.recorded: + self.add_error( + "account", + _("Eco-account {} is not recorded yet. You can only deduct from recorded accounts.").format(acc.identifier) + ) + objects_valid = False + + if intervention.is_recorded: + self.add_error( + "intervention", + _("Intervention {} is currently recorded. To change any data on it, the entry must be unrecorded.").format(intervention.identifier) + ) + objects_valid = False + + rest_surface = self._get_available_surface(acc) + form_surface = float(self.cleaned_data["surface"]) + is_valid_surface = form_surface <= rest_surface + if not is_valid_surface: + self.add_error( + "surface", + _("The account {} has not enough surface for a deduction of {} m². There are only {} m² left").format( + acc.identifier, + format_german_float(form_surface), + format_german_float(rest_surface), + ), + ) + return is_valid_surface and objects_valid and super_result + + def __create_deduction(self): + """ Creates the deduction + + Returns: + + """ + with transaction.atomic(): + user_action_create = UserActionLogEntry.get_created_action(self.user) + deduction = EcoAccountDeduction.objects.create( + intervention=self.cleaned_data["intervention"], + account=self.cleaned_data["account"], + surface=self.cleaned_data["surface"], + created=user_action_create, + ) + return deduction + + def save(self): + deduction = self.__create_deduction() + self.cleaned_data["intervention"].mark_as_edited(self.user, edit_comment=DEDUCTION_ADDED) + self.cleaned_data["account"].mark_as_edited(self.user, edit_comment=DEDUCTION_ADDED) + return deduction + + +class EditEcoAccountDeductionModalForm(NewEcoAccountDeductionModalForm): + deduction = None + + def __init__(self, *args, **kwargs): + self.deduction = kwargs.pop("deduction", None) + super().__init__(*args, **kwargs) + self.form_title = _("Edit Deduction") + form_data = { + "account": self.deduction.account, + "intervention": self.deduction.intervention, + "surface": self.deduction.surface, + } + self.load_initial_data(form_data) + + def _get_available_surface(self, acc): + rest_surface = super()._get_available_surface(acc) + # Increase available surface by the currently deducted surface, so we can 'deduct' the same amount again or + # increase the surface only a little, which will still be valid. + # Example: 200 m² left, 500 m² deducted. Entering 700 m² would fail if we would not add the 500 m² to the available + # surface again. + rest_surface += self.deduction.surface + return rest_surface + + def save(self): + deduction = self.deduction + form_account = self.cleaned_data.get("account", None) + form_intervention = self.cleaned_data.get("intervention", None) + old_account = deduction.account + old_intervention = deduction.intervention + old_surface = deduction.surface + + # If account or intervention has been changed, we put that change in the logs just as if the deduction has + # been removed for this entry. Act as if the deduction is newly created for the new entries + if old_account != form_account: + old_account.mark_as_edited(self.user, self.request, edit_comment=DEDUCTION_REMOVED) + form_account.mark_as_edited(self.user, self.request, edit_comment=DEDUCTION_ADDED) + else: + old_account.mark_as_edited(self.user, self.request, edit_comment=DEDUCTION_EDITED) + + if old_intervention != form_intervention: + old_intervention.mark_as_edited(self.user, self.request, edit_comment=DEDUCTION_REMOVED) + form_intervention.mark_as_edited(self.user, self.request, edit_comment=DEDUCTION_ADDED) + else: + old_intervention.mark_as_edited(self.user, self.request, edit_comment=DEDUCTION_EDITED) + + deduction.account = form_account + deduction.intervention = self.cleaned_data.get("intervention", None) + deduction.surface = self.cleaned_data.get("surface", None) + deduction.save() + + data_changes = { + "surface": { + "old": old_surface, + "new": deduction.surface, + }, + "intervention": { + "old": old_intervention.identifier, + "new": deduction.intervention.identifier, + }, + "account": { + "old": old_account.identifier, + "new": deduction.account.identifier, + } + } + old_account.send_notification_mail_on_deduction_change(data_changes) + return deduction + + +class RemoveEcoAccountDeductionModalForm(RemoveModalForm): + """ Removing modal form for EcoAccountDeduction + + Can be used for anything, where removing shall be confirmed by the user a second time. + + """ + deduction = None + + def __init__(self, *args, **kwargs): + deduction = kwargs.pop("deduction", None) + self.deduction = deduction + super().__init__(*args, **kwargs) + + def save(self): + with transaction.atomic(): + self.deduction.intervention.mark_as_edited(self.user, edit_comment=DEDUCTION_REMOVED) + self.deduction.account.mark_as_edited(self.user, edit_comment=DEDUCTION_REMOVED) + self.deduction.delete() \ No newline at end of file diff --git a/intervention/forms/modals/document.py b/intervention/forms/modals/document.py new file mode 100644 index 00000000..212f3f02 --- /dev/null +++ b/intervention/forms/modals/document.py @@ -0,0 +1,13 @@ +""" +Author: Michel Peltriaux +Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany +Contact: ksp-servicestelle@sgdnord.rlp.de +Created on: 18.08.22 + +""" +from intervention.models import InterventionDocument +from konova.forms.modals import NewDocumentModalForm + + +class NewInterventionDocumentModalForm(NewDocumentModalForm): + document_model = InterventionDocument \ No newline at end of file diff --git a/intervention/forms/modals/revocation.py b/intervention/forms/modals/revocation.py new file mode 100644 index 00000000..b738efe6 --- /dev/null +++ b/intervention/forms/modals/revocation.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.core.exceptions import ObjectDoesNotExist +from django.utils.translation import gettext_lazy as _ + +from intervention.models import RevocationDocument +from konova.forms.modals import BaseModalForm, RemoveModalForm +from konova.utils.message_templates import REVOCATION_ADDED, REVOCATION_EDITED + + +class NewRevocationModalForm(BaseModalForm): + date = forms.DateField( + label=_("Date"), + label_suffix=_(""), + help_text=_("Date of revocation"), + widget=forms.DateInput( + attrs={ + "type": "date", + "data-provide": "datepicker", + "class": "form-control", + }, + format="%d.%m.%Y" + ) + ) + file = forms.FileField( + label=_("Document"), + label_suffix=_(""), + required=False, + help_text=_("Must be smaller than 15 Mb"), + widget=forms.FileInput( + attrs={ + "class": "form-control-file" + } + ) + ) + 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", + } + ) + ) + document_model = RevocationDocument + + def __init__(self, *args, **kwargs): + super().__init__(*args, **kwargs) + self.form_title = _("Add revocation") + self.form_caption = "" + self.form_attrs = { + "enctype": "multipart/form-data", # important for file upload + } + + def save(self): + revocation = self.instance.add_revocation(self) + self.instance.mark_as_edited(self.user, self.request, edit_comment=REVOCATION_ADDED) + return revocation + + +class EditRevocationModalForm(NewRevocationModalForm): + revocation = None + + def __init__(self, *args, **kwargs): + self.revocation = kwargs.pop("revocation", None) + super().__init__(*args, **kwargs) + self.form_title = _("Edit revocation") + try: + doc = self.revocation.document.file + except ObjectDoesNotExist: + doc = None + form_data = { + "date": str(self.revocation.date), + "file": doc, + "comment": self.revocation.comment, + } + self.load_initial_data(form_data) + + def save(self): + revocation = self.instance.edit_revocation(self) + self.instance.mark_as_edited(self.user, self.request, edit_comment=REVOCATION_EDITED) + return revocation + + +class RemoveRevocationModalForm(RemoveModalForm): + """ Removing modal form for Revocation + + Can be used for anything, where removing shall be confirmed by the user a second time. + + """ + revocation = None + + def __init__(self, *args, **kwargs): + revocation = kwargs.pop("revocation", None) + self.revocation = revocation + super().__init__(*args, **kwargs) + + def save(self): + self.instance.remove_revocation(self) diff --git a/intervention/forms/modals/share.py b/intervention/forms/modals/share.py new file mode 100644 index 00000000..39c9d142 --- /dev/null +++ b/intervention/forms/modals/share.py @@ -0,0 +1,136 @@ +""" +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 intervention.inputs import TextToClipboardInput +from konova.forms.modals import BaseModalForm +from konova.utils.message_templates import ENTRY_REMOVE_MISSING_PERMISSION +from konova.utils.user_checks import is_default_group_only +from user.models import Team, User + + +class ShareModalForm(BaseModalForm): + url = forms.CharField( + label=_("Share link"), + label_suffix="", + help_text=_("Send this link to users who you want to have writing access on the data"), + required=False, + widget=TextToClipboardInput( + attrs={ + "readonly": True, + "class": "form-control", + } + ) + ) + teams = forms.ModelMultipleChoiceField( + label=_("Add team to share with"), + label_suffix="", + help_text=_("Multiple selection possible - You can only select teams which do not already have access."), + required=False, + queryset=Team.objects.all(), + widget=autocomplete.ModelSelect2Multiple( + url="share-team-autocomplete", + attrs={ + "data-placeholder": _("Click for selection"), + "data-minimum-input-length": 3, + }, + ), + ) + users = forms.ModelMultipleChoiceField( + label=_("Add user to share with"), + label_suffix="", + help_text=_("Multiple selection possible - You can only select users which do not already have access. Enter the full username."), + required=False, + queryset=User.objects.all(), + widget=autocomplete.ModelSelect2Multiple( + url="share-user-autocomplete", + attrs={ + "data-placeholder": _("Click for selection"), + "data-minimum-input-length": 3, + }, + ), + ) + + def __init__(self, *args, **kwargs): + super().__init__(*args, **kwargs) + self.form_title = _("Share") + self.form_caption = _("Share settings for {}").format(self.instance.identifier) + self.template = "modal/modal_form.html" + + # Make sure an access_token is set + if self.instance.access_token is None: + self.instance.generate_access_token() + + self._init_fields() + + def _user_team_valid(self): + """ Checks whether users and teams have been removed by the user and if the user is allowed to do so or not + + Returns: + + """ + users = self.cleaned_data.get("users", User.objects.none()) + teams = self.cleaned_data.get("teams", Team.objects.none()) + + _is_valid = True + if is_default_group_only(self.user): + shared_users = self.instance.shared_users + shared_teams = self.instance.shared_teams + + shared_users_are_removed = not set(shared_users).issubset(users) + shared_teams_are_removed = not set(shared_teams).issubset(teams) + + if shared_users_are_removed: + self.add_error( + "users", + ENTRY_REMOVE_MISSING_PERMISSION + ) + _is_valid = False + if shared_teams_are_removed: + self.add_error( + "teams", + ENTRY_REMOVE_MISSING_PERMISSION + ) + _is_valid = False + return _is_valid + + def is_valid(self): + """ Extended validity check + + Returns: + + """ + super_valid = super().is_valid() + user_team_valid = self._user_team_valid() + _is_valid = super_valid and user_team_valid + return _is_valid + + def _init_fields(self): + """ Wraps initializing of fields + + Returns: + + """ + # Initialize share_link field + share_link = self.instance.get_share_link() + self.share_link = self.request.build_absolute_uri(share_link) + self.initialize_form_field( + "url", + self.share_link + ) + + form_data = { + "teams": self.instance.teams.all(), + "users": self.instance.users.all(), + } + self.load_initial_data(form_data) + + def save(self): + self.instance.update_shared_access(self) diff --git a/intervention/views.py b/intervention/views.py index 6a9304e9..e622488f 100644 --- a/intervention/views.py +++ b/intervention/views.py @@ -4,10 +4,14 @@ from django.utils.translation import gettext_lazy as _ from django.http import HttpRequest, JsonResponse, Http404 from django.shortcuts import render -from intervention.forms.forms import NewInterventionForm, EditInterventionForm -from intervention.forms.modalForms import ShareModalForm, NewRevocationModalForm, \ - CheckModalForm, NewDeductionModalForm, NewInterventionDocumentModalForm, RemoveEcoAccountDeductionModalForm, \ - RemoveRevocationModalForm, EditEcoAccountDeductionModalForm, EditRevocationModalForm +from intervention.forms.intervention import NewInterventionForm, EditInterventionForm +from intervention.forms.modals.check import CheckModalForm +from intervention.forms.modals.deduction import NewEcoAccountDeductionModalForm, RemoveEcoAccountDeductionModalForm, \ + EditEcoAccountDeductionModalForm +from intervention.forms.modals.document import NewInterventionDocumentModalForm +from intervention.forms.modals.revocation import EditRevocationModalForm, RemoveRevocationModalForm, \ + NewRevocationModalForm +from intervention.forms.modals.share import ShareModalForm from intervention.models import Intervention, Revocation, InterventionDocument, RevocationDocument from intervention.tables import InterventionTable from konova.contexts import BaseContext @@ -583,7 +587,7 @@ def new_deduction_view(request: HttpRequest, id: str): """ intervention = get_object_or_404(Intervention, id=id) - form = NewDeductionModalForm(request.POST or None, instance=intervention, request=request) + form = NewEcoAccountDeductionModalForm(request.POST or None, instance=intervention, request=request) return form.process_request( request, msg_success=DEDUCTION_ADDED, diff --git a/konova/forms/base_form.py b/konova/forms/base_form.py index 065fba17..fb69999c 100644 --- a/konova/forms/base_form.py +++ b/konova/forms/base_form.py @@ -134,7 +134,7 @@ class BaseForm(forms.Form): Returns: """ - from intervention.forms.modalForms import NewDeductionModalForm, EditEcoAccountDeductionModalForm, \ + from intervention.forms.modals.deduction import NewEcoAccountDeductionModalForm, EditEcoAccountDeductionModalForm, \ RemoveEcoAccountDeductionModalForm from konova.forms.modals.resubmission_form import ResubmissionModalForm is_none = self.instance is None @@ -142,7 +142,7 @@ class BaseForm(forms.Form): is_deduction_form_from_account = isinstance( self, ( - NewDeductionModalForm, + NewEcoAccountDeductionModalForm, ResubmissionModalForm, EditEcoAccountDeductionModalForm, RemoveEcoAccountDeductionModalForm, -- 2.45.2 From 05c1bf677c99edb0963e360874ec048e7a150342 Mon Sep 17 00:00:00 2001 From: mpeltriaux Date: Thu, 18 Aug 2022 10:17:09 +0200 Subject: [PATCH 03/21] User forms * refactors user/forms.py by splitting into modals package and regular forms * regular forms can now be found at user/forms/user.py and user/forms/team.py * modal forms can now be found at user/forms/modals/... --- user/forms/__init__.py | 7 + user/forms/modals/__init__.py | 7 + user/{forms.py => forms/modals/team.py} | 200 +----------------------- user/forms/modals/user.py | 62 ++++++++ user/forms/team.py | 54 +++++++ user/forms/user.py | 113 +++++++++++++ user/views.py | 6 +- 7 files changed, 251 insertions(+), 198 deletions(-) create mode 100644 user/forms/__init__.py create mode 100644 user/forms/modals/__init__.py rename user/{forms.py => forms/modals/team.py} (52%) create mode 100644 user/forms/modals/user.py create mode 100644 user/forms/team.py create mode 100644 user/forms/user.py diff --git a/user/forms/__init__.py b/user/forms/__init__.py new file mode 100644 index 00000000..ca978536 --- /dev/null +++ b/user/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 + +""" diff --git a/user/forms/modals/__init__.py b/user/forms/modals/__init__.py new file mode 100644 index 00000000..ca978536 --- /dev/null +++ b/user/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 + +""" diff --git a/user/forms.py b/user/forms/modals/team.py similarity index 52% rename from user/forms.py rename to user/forms/modals/team.py index 0649eaf3..d63a2306 100644 --- a/user/forms.py +++ b/user/forms/modals/team.py @@ -1,166 +1,17 @@ """ Author: Michel Peltriaux Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany -Contact: michel.peltriaux@sgdnord.rlp.de -Created on: 08.07.21 +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.urls import reverse from django.utils.translation import gettext_lazy as _ - -from api.models import APIUserToken -from intervention.inputs import GenerateInput -from user.models import User, UserNotification, Team - from konova.forms.modals import BaseModalForm, RemoveModalForm -from konova.forms import BaseForm - - -class UserNotificationForm(BaseForm): - """ Form for changing the notification settings of a user - - """ - notifications = forms.MultipleChoiceField( - label_suffix="", - label=_("Notifications"), - required=False, # allow total disabling of all notifications - help_text=_("Select the situations when you want to receive a notification"), - widget=forms.CheckboxSelectMultiple( - attrs={ - "class": "list-unstyled", - } - ), - choices=[] - ) - - def __init__(self, user: User, *args, **kwargs): - super().__init__(*args, **kwargs) - self.user = user - self.form_title = _("Edit notifications") - self.form_caption = _("") - self.action_url = reverse("user:notifications") - self.cancel_redirect = reverse("user:index") - - # Insert all notifications into form field by creating choices as tuples - notifications = UserNotification.objects.filter( - is_active=True, - ) - choices = [] - for n in notifications: - choices.append( - (n.id, _(n.name)) - ) - self.fields["notifications"].choices = choices - - users_current_notifications = self.user.notifications.all() - users_current_notifications = [str(n.id) for n in users_current_notifications] - self.fields["notifications"].initial = users_current_notifications - - def save(self): - """ Stores the changes in the user konova_extension - - Returns: - - """ - selected_notification_ids = self.cleaned_data.get("notifications", []) - notifications = UserNotification.objects.filter( - id__in=selected_notification_ids, - ) - self.user.notifications.set(notifications) - - -class UserContactForm(BaseModalForm): - name = forms.CharField( - label=_("Username"), - label_suffix="", - required=False, - widget=forms.TextInput( - attrs={ - "readonly": True, - "class": "form-control", - } - ), - ) - person_name = forms.CharField( - label=_("Person name"), - label_suffix="", - required=False, - widget=forms.TextInput( - attrs={ - "readonly": True, - "class": "form-control", - } - ), - ) - mail = forms.EmailField( - label=_("E-Mail"), - label_suffix="", - required=False, - widget=forms.TextInput( - attrs={ - "readonly": True, - "class": "form-control", - } - ), - ) - - def __init__(self, *args, **kwargs): - super().__init__(*args, **kwargs) - self.render_submit = False - self.form_title = _("User contact data") - self.form_caption = "" - - self.initialize_form_field("name", self.instance.username) - self.initialize_form_field("person_name", "{} {}".format(self.instance.first_name, self.instance.last_name)) - self.initialize_form_field("mail", self.instance.email) - - -class UserAPITokenForm(BaseForm): - token = forms.CharField( - label=_("Token"), - label_suffix="", - max_length=255, - required=True, - help_text=_("Generated automatically"), - widget=GenerateInput( - attrs={ - "class": "form-control", - "url": reverse_lazy("api:generate-new-token"), - } - ) - ) - - def __init__(self, *args, **kwargs): - super().__init__(*args, **kwargs) - self.form_title = _("Create new token") - self.form_caption = _("A new token needs to be validated by an administrator!") - - self.action_url = reverse("user:api-token") - self.cancel_redirect = reverse("user:index") - - # Make direct token editing by user impossible. Instead set the proper url for generating a new token - self.initialize_form_field("token", None) - self.fields["token"].widget.attrs["readonly"] = True - - def save(self): - """ Saves the form data - - Returns: - api_token (APIUserToken) - """ - user = self.instance - new_token = self.cleaned_data["token"] - if user.api_token is not None: - user.api_token.delete() - new_token = APIUserToken.objects.create( - token=new_token - ) - user.api_token = new_token - user.save() - return new_token +from user.models import User, Team class NewTeamModalForm(BaseModalForm): @@ -347,46 +198,3 @@ class LeaveTeamModalForm(RemoveModalForm): def save(self): self.instance.remove_user(self.user) - - -class TeamDataForm(BaseModalForm): - name = forms.CharField( - label_suffix="", - label=_("Team name"), - max_length=500, - required=False, - widget=forms.TextInput( - attrs={ - "placeholder": _("Team name"), - "class": "form-control", - } - ) - ) - description = forms.CharField( - label_suffix="", - required=False, - label=_("Description"), - widget=forms.Textarea( - attrs={ - "rows": 5, - "class": "form-control" - } - ) - ) - - def __init__(self, *args, **kwargs): - super().__init__(*args, **kwargs) - self.form_title = _("Team") - self.form_caption = "" - self.render_submit = False - form_data = { - "name": self.instance.name, - "description": self.instance.description, - } - self.load_initial_data( - form_data, - [ - "name", - "description" - ] - ) \ No newline at end of file diff --git a/user/forms/modals/user.py b/user/forms/modals/user.py new file mode 100644 index 00000000..d5631050 --- /dev/null +++ b/user/forms/modals/user.py @@ -0,0 +1,62 @@ +""" +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 + + +class UserContactForm(BaseModalForm): + def save(self): + # Readonly form. No saving needed + pass + + name = forms.CharField( + label=_("Username"), + label_suffix="", + required=False, + widget=forms.TextInput( + attrs={ + "readonly": True, + "class": "form-control", + } + ), + ) + person_name = forms.CharField( + label=_("Person name"), + label_suffix="", + required=False, + widget=forms.TextInput( + attrs={ + "readonly": True, + "class": "form-control", + } + ), + ) + mail = forms.EmailField( + label=_("E-Mail"), + label_suffix="", + required=False, + widget=forms.TextInput( + attrs={ + "readonly": True, + "class": "form-control", + } + ), + ) + + def __init__(self, *args, **kwargs): + super().__init__(*args, **kwargs) + self.render_submit = False + self.form_title = _("User contact data") + self.form_caption = "" + + self.initialize_form_field("name", self.instance.username) + self.initialize_form_field("person_name", "{} {}".format(self.instance.first_name, self.instance.last_name)) + self.initialize_form_field("mail", self.instance.email) + diff --git a/user/forms/team.py b/user/forms/team.py new file mode 100644 index 00000000..dab89842 --- /dev/null +++ b/user/forms/team.py @@ -0,0 +1,54 @@ +""" +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 + + +class TeamDataForm(BaseModalForm): + name = forms.CharField( + label_suffix="", + label=_("Team name"), + max_length=500, + required=False, + widget=forms.TextInput( + attrs={ + "placeholder": _("Team name"), + "class": "form-control", + } + ) + ) + description = forms.CharField( + label_suffix="", + required=False, + label=_("Description"), + widget=forms.Textarea( + attrs={ + "rows": 5, + "class": "form-control" + } + ) + ) + + def __init__(self, *args, **kwargs): + super().__init__(*args, **kwargs) + self.form_title = _("Team") + self.form_caption = "" + self.render_submit = False + form_data = { + "name": self.instance.name, + "description": self.instance.description, + } + self.load_initial_data( + form_data, + [ + "name", + "description" + ] + ) \ No newline at end of file diff --git a/user/forms/user.py b/user/forms/user.py new file mode 100644 index 00000000..99afc372 --- /dev/null +++ b/user/forms/user.py @@ -0,0 +1,113 @@ +""" +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.urls import reverse, reverse_lazy +from django.utils.translation import gettext_lazy as _ + +from api.models import APIUserToken +from intervention.inputs import GenerateInput +from konova.forms import BaseForm +from user.models import User, UserNotification + + +class UserNotificationForm(BaseForm): + """ Form for changing the notification settings of a user + + """ + notifications = forms.MultipleChoiceField( + label_suffix="", + label=_("Notifications"), + required=False, # allow total disabling of all notifications + help_text=_("Select the situations when you want to receive a notification"), + widget=forms.CheckboxSelectMultiple( + attrs={ + "class": "list-unstyled", + } + ), + choices=[] + ) + + def __init__(self, user: User, *args, **kwargs): + super().__init__(*args, **kwargs) + self.user = user + self.form_title = _("Edit notifications") + self.form_caption = _("") + self.action_url = reverse("user:notifications") + self.cancel_redirect = reverse("user:index") + + # Insert all notifications into form field by creating choices as tuples + notifications = UserNotification.objects.filter( + is_active=True, + ) + choices = [] + for n in notifications: + choices.append( + (n.id, _(n.name)) + ) + self.fields["notifications"].choices = choices + + users_current_notifications = self.user.notifications.all() + users_current_notifications = [str(n.id) for n in users_current_notifications] + self.fields["notifications"].initial = users_current_notifications + + def save(self): + """ Stores the changes in the user konova_extension + + Returns: + + """ + selected_notification_ids = self.cleaned_data.get("notifications", []) + notifications = UserNotification.objects.filter( + id__in=selected_notification_ids, + ) + self.user.notifications.set(notifications) + + +class UserAPITokenForm(BaseForm): + token = forms.CharField( + label=_("Token"), + label_suffix="", + max_length=255, + required=True, + help_text=_("Generated automatically"), + widget=GenerateInput( + attrs={ + "class": "form-control", + "url": reverse_lazy("api:generate-new-token"), + } + ) + ) + + def __init__(self, *args, **kwargs): + super().__init__(*args, **kwargs) + self.form_title = _("Create new token") + self.form_caption = _("A new token needs to be validated by an administrator!") + + self.action_url = reverse("user:api-token") + self.cancel_redirect = reverse("user:index") + + # Make direct token editing by user impossible. Instead set the proper url for generating a new token + self.initialize_form_field("token", None) + self.fields["token"].widget.attrs["readonly"] = True + + def save(self): + """ Saves the form data + + Returns: + api_token (APIUserToken) + """ + user = self.instance + new_token = self.cleaned_data["token"] + if user.api_token is not None: + user.api_token.delete() + new_token = APIUserToken.objects.create( + token=new_token + ) + user.api_token = new_token + user.save() + return new_token \ No newline at end of file diff --git a/user/views.py b/user/views.py index 2c5b86a1..7e2d21e6 100644 --- a/user/views.py +++ b/user/views.py @@ -5,6 +5,10 @@ from django.urls import reverse from konova.sub_settings.context_settings import TAB_TITLE_IDENTIFIER from konova.utils.mailer import Mailer from konova.utils.message_templates import FORM_INVALID +from user.forms.modals.team import NewTeamModalForm, EditTeamModalForm, RemoveTeamModalForm, LeaveTeamModalForm +from user.forms.modals.user import UserContactForm +from user.forms.team import TeamDataForm +from user.forms.user import UserNotificationForm, UserAPITokenForm from user.models import User, Team from django.http import HttpRequest, Http404 from django.shortcuts import render, redirect, get_object_or_404 @@ -12,8 +16,6 @@ from django.utils.translation import gettext_lazy as _ from konova.contexts import BaseContext from konova.decorators import any_group_check, default_group_required -from user.forms import UserNotificationForm, UserContactForm, UserAPITokenForm, NewTeamModalForm, EditTeamModalForm, \ - RemoveTeamModalForm, TeamDataForm, LeaveTeamModalForm @login_required -- 2.45.2 From ca6770ec54af6c50f461df87234d3c6c30de16ef Mon Sep 17 00:00:00 2001 From: mpeltriaux Date: Thu, 18 Aug 2022 10:24:11 +0200 Subject: [PATCH 04/21] Tables refactoring * splits compensation tables.py into individual files for compensation table and eco account table --- compensation/tables/__init__.py | 7 + .../{tables.py => tables/compensation.py} | 167 +---------------- compensation/tables/eco_account.py | 174 ++++++++++++++++++ compensation/views/compensation.py | 2 +- compensation/views/eco_account.py | 2 +- 5 files changed, 188 insertions(+), 164 deletions(-) create mode 100644 compensation/tables/__init__.py rename compensation/{tables.py => tables/compensation.py} (54%) create mode 100644 compensation/tables/eco_account.py diff --git a/compensation/tables/__init__.py b/compensation/tables/__init__.py new file mode 100644 index 00000000..ca978536 --- /dev/null +++ b/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 + +""" diff --git a/compensation/tables.py b/compensation/tables/compensation.py similarity index 54% rename from compensation/tables.py rename to compensation/tables/compensation.py index 1373f2cd..92fe1840 100644 --- a/compensation/tables.py +++ b/compensation/tables/compensation.py @@ -1,19 +1,19 @@ """ Author: Michel Peltriaux Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany -Contact: michel.peltriaux@sgdnord.rlp.de -Created on: 01.12.20 +Contact: ksp-servicestelle@sgdnord.rlp.de +Created on: 18.08.22 """ -from konova.utils.message_templates import DATA_IS_UNCHECKED, DATA_CHECKED_ON_TEMPLATE, DATA_CHECKED_PREVIOUSLY_TEMPLATE 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 import CompensationTableFilter, EcoAccountTableFilter -from compensation.models import Compensation, EcoAccount +from compensation.filters 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 import django_tables2 as tables @@ -187,160 +187,3 @@ class CompensationTable(BaseTable, TableRenderMixin): 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( - "parcel_group__name", - 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: - on = value.get_timestamp_str_formatted() - 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 = record.is_shared_with(self.user) - 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) diff --git a/compensation/tables/eco_account.py b/compensation/tables/eco_account.py new file mode 100644 index 00000000..0cf4a4ef --- /dev/null +++ b/compensation/tables/eco_account.py @@ -0,0 +1,174 @@ +""" +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 import EcoAccountTableFilter +from compensation.models import EcoAccount +from konova.utils.tables import TableRenderMixin, BaseTable + +import django_tables2 as tables + +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): + """ 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( + "parcel_group__name", + 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: + on = value.get_timestamp_str_formatted() + 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 = record.is_shared_with(self.user) + 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) diff --git a/compensation/views/compensation.py b/compensation/views/compensation.py index e12324ce..c1bec047 100644 --- a/compensation/views/compensation.py +++ b/compensation/views/compensation.py @@ -12,7 +12,7 @@ from compensation.forms.modals.compensation_action import NewCompensationActionM EditCompensationActionModalForm, RemoveCompensationActionModalForm from compensation.forms.modals.deadline import NewDeadlineModalForm, EditDeadlineModalForm from compensation.models import Compensation, CompensationState, CompensationAction, CompensationDocument -from compensation.tables import CompensationTable +from compensation.tables.compensation import CompensationTable from intervention.models import Intervention from konova.contexts import BaseContext from konova.decorators import * diff --git a/compensation/views/eco_account.py b/compensation/views/eco_account.py index 07796d14..51aa925d 100644 --- a/compensation/views/eco_account.py +++ b/compensation/views/eco_account.py @@ -22,7 +22,7 @@ from compensation.forms.modals.document import NewEcoAccountDocumentModalForm from compensation.forms.modals.state import NewCompensationStateModalForm, RemoveCompensationStateModalForm, \ EditCompensationStateModalForm from compensation.models import EcoAccount, EcoAccountDocument, CompensationState, CompensationAction -from compensation.tables import EcoAccountTable +from compensation.tables.eco_account import EcoAccountTable from intervention.forms.modals.deduction import RemoveEcoAccountDeductionModalForm, NewEcoAccountDeductionModalForm, \ EditEcoAccountDeductionModalForm from intervention.forms.modals.share import ShareModalForm -- 2.45.2 From c07933a9bf181f33aa608ed00de649f9ea68e9d7 Mon Sep 17 00:00:00 2001 From: mpeltriaux Date: Thu, 18 Aug 2022 10:45:15 +0200 Subject: [PATCH 05/21] Konova filter mixins * refactors konova/mixins.py into individual files in konova/mixins/... --- compensation/filters.py | 2 +- konova/filters/mixins.py | 414 ------------------------- konova/filters/mixins/__init__.py | 7 + konova/filters/mixins/file_number.py | 33 ++ konova/filters/mixins/geo_reference.py | 209 +++++++++++++ konova/filters/mixins/keyword.py | 41 +++ konova/filters/mixins/office.py | 77 +++++ konova/filters/mixins/record.py | 51 +++ konova/filters/mixins/share.py | 57 ++++ konova/filters/table_filters.py | 9 +- 10 files changed, 482 insertions(+), 418 deletions(-) delete mode 100644 konova/filters/mixins.py create mode 100644 konova/filters/mixins/__init__.py create mode 100644 konova/filters/mixins/file_number.py create mode 100644 konova/filters/mixins/geo_reference.py create mode 100644 konova/filters/mixins/keyword.py create mode 100644 konova/filters/mixins/office.py create mode 100644 konova/filters/mixins/record.py create mode 100644 konova/filters/mixins/share.py diff --git a/compensation/filters.py b/compensation/filters.py index c9bf9b70..186a7214 100644 --- a/compensation/filters.py +++ b/compensation/filters.py @@ -10,7 +10,7 @@ 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.mixins.office import ConservationOfficeTableFilterMixin from konova.filters.table_filters import QueryTableFilter, CheckboxTableFilter, SelectionTableFilter, AbstractTableFilter diff --git a/konova/filters/mixins.py b/konova/filters/mixins.py deleted file mode 100644 index cfd9cc4c..00000000 --- a/konova/filters/mixins.py +++ /dev/null @@ -1,414 +0,0 @@ -""" -Author: Michel Peltriaux -Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany -Contact: michel.peltriaux@sgdnord.rlp.de -Created on: 12.01.22 - -""" -import django_filters -from django import forms -from django.db.models import QuerySet, Q -from django.utils.translation import gettext_lazy as _ -from dal_select2.widgets import ModelSelect2 - -from codelist.models import KonovaCode -from codelist.settings import CODELIST_CONSERVATION_OFFICE_ID, CODELIST_REGISTRATION_OFFICE_ID -from intervention.inputs import DummyFilterInput -from konova.models import Parcel, District - - -class KeywordTableFilterMixin(django_filters.FilterSet): - q = django_filters.Filter( - method='filter_by_keyword', - # Since we use a custom search bar in the template, we need to 'render' this filter - # as 'anonymous' HiddenInput (no id, no name). This way our custom search bar's id and name won't be - # overwritten with these id and name (which would be equal) - # This way we can use the simple filter method mapping for a parameter without using a predefined widget! - widget=DummyFilterInput(), - ) - - class Meta: - abstract = True - - def filter_by_keyword(self, queryset, name, value) -> QuerySet: - """ Filters queryset depending on value of search bar input - - Args: - queryset (): - name (): - value (): - - Returns: - - """ - value = value.strip() - # build filter expression - q = Q(title__icontains=value) | Q(identifier__icontains=value) - return queryset.filter(q) - - -class FileNumberTableFilterMixin(django_filters.FilterSet): - rf = django_filters.CharFilter( - method="filter_file_number", - label=_(""), - label_suffix=_(""), - widget=forms.TextInput( - attrs={ - "placeholder": _("File number"), - "title": _("Search for file number"), - "class": "form-control", - } - ), - ) - - def filter_file_number(self, queryset, name, value) -> QuerySet: - queryset = queryset.filter( - Q(responsible__registration_file_number__icontains=value) | - Q(responsible__conservation_file_number__icontains=value) - ) - return queryset - - -class GeoReferencedTableFilterMixin(django_filters.FilterSet): - """ A mixin for AbstractTableFilter - - Specialized on filtering GeoReferenced model types - - """ - # Parcel gmrkng - di = django_filters.CharFilter( - method="filter_district", - label=_(""), - label_suffix=_(""), - widget=forms.TextInput( - attrs={ - "placeholder": _("District"), - "title": _("Search for district"), - "class": "form-control", - } - ), - ) - # Parcel gmrkng - pg = django_filters.CharFilter( - method="filter_gmrkng", - label=_(""), - label_suffix=_(""), - widget=forms.TextInput( - attrs={ - "placeholder": _("Parcel gmrkng"), - "title": _("Search for parcel gmrkng"), - "class": "form-control", - } - ), - ) - # Parcel - p = django_filters.CharFilter( - method="filter_parcel", - label=_(""), - label_suffix=_(""), - widget=forms.TextInput( - attrs={ - "placeholder": _("Parcel"), - "title": _("Search for parcel"), - "class": "form-control", - } - ), - ) - # Parcel counter - pc = django_filters.CharFilter( - method="filter_parcel_counter", - label=_(""), - label_suffix=_(""), - widget=forms.TextInput( - attrs={ - "placeholder": _("Parcel counter"), - "title": _("Search for parcel counter"), - "class": "form-control", - } - ), - ) - - # Parcel counter - pn = django_filters.CharFilter( - method="filter_parcel_number", - label=_(""), - label_suffix=_(""), - widget=forms.TextInput( - attrs={ - "placeholder": _("Parcel number"), - "title": _("Search for parcel number"), - "class": "form-control", - } - ), - ) - - class Meta: - abstract = True - - def _filter_parcel_reference(self, queryset, filter_q) -> QuerySet: - """ Filters the parcel entries by a given filter_q - - Args: - queryset (QuerySet): The queryset - filter_q (Q): The Q-style filter expression - - Returns: - - """ - matching_parcels = Parcel.objects.filter( - filter_q - ) - - related_geoms = matching_parcels.values( - "geometries" - ).distinct() - queryset = queryset.filter( - geometry__id__in=related_geoms - ) - return queryset - - def filter_district(self, queryset, name, value) -> QuerySet: - """ Filters queryset depending on value for 'Gemarkung' - - Args: - queryset (): - name (): - value (): - - Returns: - - """ - matching_districts = District.objects.filter( - Q(name__icontains=value) | - Q(key__icontains=value) - ).distinct() - matching_parcels = Parcel.objects.filter( - district__in=matching_districts - ) - related_geoms = matching_parcels.values( - "geometries" - ).distinct() - queryset = queryset.filter( - geometry__id__in=related_geoms - ) - return queryset - - def filter_gmrkng(self, queryset, name, value) -> QuerySet: - """ Filters queryset depending on value for 'Gemarkung' - - Args: - queryset (): - name (): - value (): - - Returns: - - """ - queryset = self._filter_parcel_reference( - queryset, - Q(parcel_group__name__icontains=value) | Q(parcel_group__key__icontains=value), - ) - return queryset - - def filter_parcel(self, queryset, name, value) -> QuerySet: - """ Filters queryset depending on value for 'Parcel' - - Args: - queryset (): - name (): - value (): - - Returns: - - """ - value = value.replace("-", "") - queryset = self._filter_parcel_reference( - queryset, - Q(flr=value), - ) - return queryset - - def filter_parcel_counter(self, queryset, name, value) -> QuerySet: - """ Filters queryset depending on value for 'Parcel' - - Args: - queryset (): - name (): - value (): - - Returns: - - """ - value = value.replace("-", "") - queryset = self._filter_parcel_reference( - queryset, - Q(flrstck_zhlr=value) - ) - return queryset - - def filter_parcel_number(self, queryset, name, value) -> QuerySet: - """ Filters queryset depending on value for 'Parcel' - - Args: - queryset (): - name (): - value (): - - Returns: - - """ - value = value.replace("-", "") - queryset = self._filter_parcel_reference( - queryset, - Q(flrstck_nnr=value), - ) - return queryset - - -class ShareableTableFilterMixin(django_filters.FilterSet): - """ A mixin for AbstractTableFilter - - Specialized on filtering shareable model types - - """ - sa = django_filters.BooleanFilter( - method='filter_show_all', - label=_("Show unshared"), - label_suffix=_(""), - widget=forms.CheckboxInput( - attrs={ - "class": "form-check-input", - } - ) - ) - - class Meta: - abstract = True - - def __init__(self, *args, **kwargs): - self.user = kwargs.pop("user", None) - if self.user is None: - raise AttributeError("User must be set for further filtering!") - super().__init__(*args, **kwargs) - - def filter_show_all(self, queryset, name, value) -> QuerySet: - """ Filters queryset depending on value of 'show_all' setting - - Args: - queryset (): - name (): - value (): - - Returns: - - """ - if not value: - return queryset.filter( - Q(users__in=[self.user]) | # requesting user has access - Q(teams__in=self.user.shared_teams) - ).distinct() - else: - return queryset - - -class RecordableTableFilterMixin(django_filters.FilterSet): - """ A mixin for AbstractTableFilter - - Specialized on filtering recordable model types - - """ - sr = django_filters.BooleanFilter( - method='filter_show_recorded', - label=_("Show recorded"), - label_suffix=_(""), - widget=forms.CheckboxInput( - attrs={ - "class": "form-check-input", - } - ) - ) - - class Meta: - abstract = True - - def filter_show_recorded(self, queryset, name, value) -> QuerySet: - """ Filters queryset depending on value of 'show_recorded' setting - - Args: - queryset (): - name (): - value (): - - Returns: - - """ - if not value: - return queryset.filter( - recorded=None, - ) - else: - return queryset - - -class RegistrationOfficeTableFilterMixin(django_filters.FilterSet): - """ A mixin for AbstractTableFilter - - Specialized on filtering for related registration offices - - """ - ro = django_filters.ModelChoiceFilter( - method="filter_reg_office", - label=_(""), - label_suffix=_(""), - queryset=KonovaCode.objects.filter( - is_archived=False, - is_leaf=True, - code_lists__in=[CODELIST_REGISTRATION_OFFICE_ID], - ), - widget=ModelSelect2( - url="codes-registration-office-autocomplete", - attrs={ - "data-placeholder": _("Registration office"), - "title": _("Search for registration office"), - "class": "", - } - ), - ) - - def filter_reg_office(self, queryset, name, value): - qs = queryset.filter( - responsible__registration_office=value - ) - return qs - - -class ConservationOfficeTableFilterMixin(django_filters.FilterSet): - """ A mixin for AbstractTableFilter - - Specialized on filtering for related conservation offices - - """ - co = django_filters.ModelChoiceFilter( - method="filter_cons_office", - label=_(""), - label_suffix=_(""), - queryset=KonovaCode.objects.filter( - is_archived=False, - is_leaf=True, - code_lists__in=[CODELIST_CONSERVATION_OFFICE_ID], - ), - widget=ModelSelect2( - url="codes-conservation-office-autocomplete", - attrs={ - "data-placeholder": _("Conservation office"), - "title": _("Search for conservation office"), - "class": "", - } - ), - ) - - def filter_cons_office(self, queryset, name, value): - qs = queryset.filter( - responsible__conservation_office=value - ) - return qs diff --git a/konova/filters/mixins/__init__.py b/konova/filters/mixins/__init__.py new file mode 100644 index 00000000..ca978536 --- /dev/null +++ b/konova/filters/mixins/__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 + +""" diff --git a/konova/filters/mixins/file_number.py b/konova/filters/mixins/file_number.py new file mode 100644 index 00000000..fa14b93b --- /dev/null +++ b/konova/filters/mixins/file_number.py @@ -0,0 +1,33 @@ +""" +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, Q +from django.utils.translation import gettext_lazy as _ +import django_filters + + +class FileNumberTableFilterMixin(django_filters.FilterSet): + rf = django_filters.CharFilter( + method="filter_file_number", + label=_(""), + label_suffix=_(""), + widget=forms.TextInput( + attrs={ + "placeholder": _("File number"), + "title": _("Search for file number"), + "class": "form-control", + } + ), + ) + + def filter_file_number(self, queryset, name, value) -> QuerySet: + queryset = queryset.filter( + Q(responsible__registration_file_number__icontains=value) | + Q(responsible__conservation_file_number__icontains=value) + ) + return queryset diff --git a/konova/filters/mixins/geo_reference.py b/konova/filters/mixins/geo_reference.py new file mode 100644 index 00000000..eacf5c5b --- /dev/null +++ b/konova/filters/mixins/geo_reference.py @@ -0,0 +1,209 @@ +""" +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, Q +from django.utils.translation import gettext_lazy as _ +import django_filters + +from konova.models import Parcel, District + + +class GeoReferencedTableFilterMixin(django_filters.FilterSet): + """ A mixin for AbstractTableFilter + + Specialized on filtering GeoReferenced model types + + """ + # Parcel gmrkng + di = django_filters.CharFilter( + method="filter_district", + label=_(""), + label_suffix=_(""), + widget=forms.TextInput( + attrs={ + "placeholder": _("District"), + "title": _("Search for district"), + "class": "form-control", + } + ), + ) + # Parcel gmrkng + pg = django_filters.CharFilter( + method="filter_gmrkng", + label=_(""), + label_suffix=_(""), + widget=forms.TextInput( + attrs={ + "placeholder": _("Parcel gmrkng"), + "title": _("Search for parcel gmrkng"), + "class": "form-control", + } + ), + ) + # Parcel + p = django_filters.CharFilter( + method="filter_parcel", + label=_(""), + label_suffix=_(""), + widget=forms.TextInput( + attrs={ + "placeholder": _("Parcel"), + "title": _("Search for parcel"), + "class": "form-control", + } + ), + ) + # Parcel counter + pc = django_filters.CharFilter( + method="filter_parcel_counter", + label=_(""), + label_suffix=_(""), + widget=forms.TextInput( + attrs={ + "placeholder": _("Parcel counter"), + "title": _("Search for parcel counter"), + "class": "form-control", + } + ), + ) + + # Parcel counter + pn = django_filters.CharFilter( + method="filter_parcel_number", + label=_(""), + label_suffix=_(""), + widget=forms.TextInput( + attrs={ + "placeholder": _("Parcel number"), + "title": _("Search for parcel number"), + "class": "form-control", + } + ), + ) + + class Meta: + abstract = True + + def _filter_parcel_reference(self, queryset, filter_q) -> QuerySet: + """ Filters the parcel entries by a given filter_q + + Args: + queryset (QuerySet): The queryset + filter_q (Q): The Q-style filter expression + + Returns: + + """ + matching_parcels = Parcel.objects.filter( + filter_q + ) + + related_geoms = matching_parcels.values( + "geometries" + ).distinct() + queryset = queryset.filter( + geometry__id__in=related_geoms + ) + return queryset + + def filter_district(self, queryset, name, value) -> QuerySet: + """ Filters queryset depending on value for 'Gemarkung' + + Args: + queryset (): + name (): + value (): + + Returns: + + """ + matching_districts = District.objects.filter( + Q(name__icontains=value) | + Q(key__icontains=value) + ).distinct() + matching_parcels = Parcel.objects.filter( + district__in=matching_districts + ) + related_geoms = matching_parcels.values( + "geometries" + ).distinct() + queryset = queryset.filter( + geometry__id__in=related_geoms + ) + return queryset + + def filter_gmrkng(self, queryset, name, value) -> QuerySet: + """ Filters queryset depending on value for 'Gemarkung' + + Args: + queryset (): + name (): + value (): + + Returns: + + """ + queryset = self._filter_parcel_reference( + queryset, + Q(parcel_group__name__icontains=value) | Q(parcel_group__key__icontains=value), + ) + return queryset + + def filter_parcel(self, queryset, name, value) -> QuerySet: + """ Filters queryset depending on value for 'Parcel' + + Args: + queryset (): + name (): + value (): + + Returns: + + """ + value = value.replace("-", "") + queryset = self._filter_parcel_reference( + queryset, + Q(flr=value), + ) + return queryset + + def filter_parcel_counter(self, queryset, name, value) -> QuerySet: + """ Filters queryset depending on value for 'Parcel' + + Args: + queryset (): + name (): + value (): + + Returns: + + """ + value = value.replace("-", "") + queryset = self._filter_parcel_reference( + queryset, + Q(flrstck_zhlr=value) + ) + return queryset + + def filter_parcel_number(self, queryset, name, value) -> QuerySet: + """ Filters queryset depending on value for 'Parcel' + + Args: + queryset (): + name (): + value (): + + Returns: + + """ + value = value.replace("-", "") + queryset = self._filter_parcel_reference( + queryset, + Q(flrstck_nnr=value), + ) + return queryset diff --git a/konova/filters/mixins/keyword.py b/konova/filters/mixins/keyword.py new file mode 100644 index 00000000..212599c8 --- /dev/null +++ b/konova/filters/mixins/keyword.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 + +""" +import django_filters +from django.db.models import QuerySet, Q + +from intervention.inputs import DummyFilterInput + + +class KeywordTableFilterMixin(django_filters.FilterSet): + q = django_filters.Filter( + method='filter_by_keyword', + # Since we use a custom search bar in the template, we need to 'render' this filter + # as 'anonymous' HiddenInput (no id, no name). This way our custom search bar's id and name won't be + # overwritten with these id and name (which would be equal) + # This way we can use the simple filter method mapping for a parameter without using a predefined widget! + widget=DummyFilterInput(), + ) + + class Meta: + abstract = True + + def filter_by_keyword(self, queryset, name, value) -> QuerySet: + """ Filters queryset depending on value of search bar input + + Args: + queryset (): + name (): + value (): + + Returns: + + """ + value = value.strip() + # build filter expression + q = Q(title__icontains=value) | Q(identifier__icontains=value) + return queryset.filter(q) diff --git a/konova/filters/mixins/office.py b/konova/filters/mixins/office.py new file mode 100644 index 00000000..856ff6f3 --- /dev/null +++ b/konova/filters/mixins/office.py @@ -0,0 +1,77 @@ +""" +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.widgets import ModelSelect2 +from django.utils.translation import gettext_lazy as _ +import django_filters + +from codelist.models import KonovaCode +from codelist.settings import CODELIST_CONSERVATION_OFFICE_ID, CODELIST_REGISTRATION_OFFICE_ID + + +class ConservationOfficeTableFilterMixin(django_filters.FilterSet): + """ A mixin for AbstractTableFilter + + Specialized on filtering for related conservation offices + + """ + co = django_filters.ModelChoiceFilter( + method="filter_cons_office", + label=_(""), + label_suffix=_(""), + queryset=KonovaCode.objects.filter( + is_archived=False, + is_leaf=True, + code_lists__in=[CODELIST_CONSERVATION_OFFICE_ID], + ), + widget=ModelSelect2( + url="codes-conservation-office-autocomplete", + attrs={ + "data-placeholder": _("Conservation office"), + "title": _("Search for conservation office"), + "class": "", + } + ), + ) + + def filter_cons_office(self, queryset, name, value): + qs = queryset.filter( + responsible__conservation_office=value + ) + return qs + + +class RegistrationOfficeTableFilterMixin(django_filters.FilterSet): + """ A mixin for AbstractTableFilter + + Specialized on filtering for related registration offices + + """ + ro = django_filters.ModelChoiceFilter( + method="filter_reg_office", + label=_(""), + label_suffix=_(""), + queryset=KonovaCode.objects.filter( + is_archived=False, + is_leaf=True, + code_lists__in=[CODELIST_REGISTRATION_OFFICE_ID], + ), + widget=ModelSelect2( + url="codes-registration-office-autocomplete", + attrs={ + "data-placeholder": _("Registration office"), + "title": _("Search for registration office"), + "class": "", + } + ), + ) + + def filter_reg_office(self, queryset, name, value): + qs = queryset.filter( + responsible__registration_office=value + ) + return qs diff --git a/konova/filters/mixins/record.py b/konova/filters/mixins/record.py new file mode 100644 index 00000000..45476078 --- /dev/null +++ b/konova/filters/mixins/record.py @@ -0,0 +1,51 @@ +""" +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 + + +class RecordableTableFilterMixin(django_filters.FilterSet): + """ A mixin for AbstractTableFilter + + Specialized on filtering recordable model types + + """ + sr = django_filters.BooleanFilter( + method='filter_show_recorded', + label=_("Show recorded"), + label_suffix=_(""), + widget=forms.CheckboxInput( + attrs={ + "class": "form-check-input", + } + ) + ) + + class Meta: + abstract = True + + def filter_show_recorded(self, queryset, name, value) -> QuerySet: + """ Filters queryset depending on value of 'show_recorded' setting + + Args: + queryset (): + name (): + value (): + + Returns: + + """ + if not value: + return queryset.filter( + recorded=None, + ) + else: + return queryset + diff --git a/konova/filters/mixins/share.py b/konova/filters/mixins/share.py new file mode 100644 index 00000000..562263c6 --- /dev/null +++ b/konova/filters/mixins/share.py @@ -0,0 +1,57 @@ +""" +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 Q, QuerySet +from django.utils.translation import gettext_lazy as _ +import django_filters + + +class ShareableTableFilterMixin(django_filters.FilterSet): + """ A mixin for AbstractTableFilter + + Specialized on filtering shareable model types + + """ + sa = django_filters.BooleanFilter( + method='filter_show_all', + label=_("Show unshared"), + label_suffix=_(""), + widget=forms.CheckboxInput( + attrs={ + "class": "form-check-input", + } + ) + ) + + class Meta: + abstract = True + + def __init__(self, *args, **kwargs): + self.user = kwargs.pop("user", None) + if self.user is None: + raise AttributeError("User must be set for further filtering!") + super().__init__(*args, **kwargs) + + def filter_show_all(self, queryset, name, value) -> QuerySet: + """ Filters queryset depending on value of 'show_all' setting + + Args: + queryset (): + name (): + value (): + + Returns: + + """ + if not value: + return queryset.filter( + Q(users__in=[self.user]) | # requesting user has access + Q(teams__in=self.user.shared_teams) + ).distinct() + else: + return queryset \ No newline at end of file diff --git a/konova/filters/table_filters.py b/konova/filters/table_filters.py index 8dca6d5f..5b8a4cc1 100644 --- a/konova/filters/table_filters.py +++ b/konova/filters/table_filters.py @@ -7,9 +7,12 @@ Created on: 12.01.22 """ import django_filters -from konova.filters.mixins import RegistrationOfficeTableFilterMixin, ConservationOfficeTableFilterMixin, \ - KeywordTableFilterMixin, FileNumberTableFilterMixin, GeoReferencedTableFilterMixin, ShareableTableFilterMixin, \ - RecordableTableFilterMixin +from konova.filters.mixins.file_number import FileNumberTableFilterMixin +from konova.filters.mixins.geo_reference import GeoReferencedTableFilterMixin +from konova.filters.mixins.keyword import KeywordTableFilterMixin +from konova.filters.mixins.office import ConservationOfficeTableFilterMixin, RegistrationOfficeTableFilterMixin +from konova.filters.mixins.record import RecordableTableFilterMixin +from konova.filters.mixins.share import ShareableTableFilterMixin class AbstractTableFilter(django_filters.FilterSet): -- 2.45.2 From 87b1da8fdd867e7c49828c014fb7110e571ee1de Mon Sep 17 00:00:00 2001 From: mpeltriaux Date: Thu, 18 Aug 2022 11:25:06 +0200 Subject: [PATCH 06/21] Autocomplete refactoring * refactors konova/autocompletes.py by splitting into individual files and moving them to fitting apps * autocomplete files now live in APPNAME/autocomplete/... --- analysis/forms.py | 2 +- codelist/autocomplete/__init__.py | 7 + codelist/autocomplete/base.py | 74 ++++ codelist/autocomplete/biotope.py | 110 +++++ codelist/autocomplete/compensation_action.py | 45 ++ codelist/autocomplete/handler.py | 24 ++ codelist/autocomplete/law.py | 24 ++ codelist/autocomplete/office.py | 41 ++ codelist/autocomplete/process_type.py | 21 + codelist/urls.py | 18 +- compensation/autocomplete/__init__.py | 7 + compensation/autocomplete/eco_account.py | 34 ++ compensation/forms/compensation.py | 2 +- compensation/forms/mixins.py | 4 +- .../forms/modals/compensation_action.py | 2 +- compensation/forms/modals/state.py | 2 +- compensation/urls/eco_account.py | 4 + intervention/autocomplete/__init__.py | 7 + intervention/autocomplete/intervention.py | 36 ++ intervention/forms/intervention.py | 10 +- intervention/forms/modals/deduction.py | 4 +- intervention/forms/modals/share.py | 4 +- intervention/urls.py | 4 + konova/autocompletes.py | 401 ------------------ konova/filters/mixins/office.py | 4 +- konova/tests/test_autocompletes.py | 28 +- konova/tests/test_views.py | 18 +- konova/urls.py | 21 - user/autocomplete/__init__.py | 7 + user/autocomplete/share.py | 52 +++ user/autocomplete/team.py | 34 ++ user/forms/modals/team.py | 4 +- user/urls.py | 6 + 33 files changed, 596 insertions(+), 465 deletions(-) create mode 100644 codelist/autocomplete/__init__.py create mode 100644 codelist/autocomplete/base.py create mode 100644 codelist/autocomplete/biotope.py create mode 100644 codelist/autocomplete/compensation_action.py create mode 100644 codelist/autocomplete/handler.py create mode 100644 codelist/autocomplete/law.py create mode 100644 codelist/autocomplete/office.py create mode 100644 codelist/autocomplete/process_type.py create mode 100644 compensation/autocomplete/__init__.py create mode 100644 compensation/autocomplete/eco_account.py create mode 100644 intervention/autocomplete/__init__.py create mode 100644 intervention/autocomplete/intervention.py delete mode 100644 konova/autocompletes.py create mode 100644 user/autocomplete/__init__.py create mode 100644 user/autocomplete/share.py create mode 100644 user/autocomplete/team.py diff --git a/analysis/forms.py b/analysis/forms.py index 68e217af..c9a7995a 100644 --- a/analysis/forms.py +++ b/analysis/forms.py @@ -55,7 +55,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") } diff --git a/codelist/autocomplete/__init__.py b/codelist/autocomplete/__init__.py new file mode 100644 index 00000000..ca978536 --- /dev/null +++ b/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 + +""" diff --git a/codelist/autocomplete/base.py b/codelist/autocomplete/base.py new file mode 100644 index 00000000..7e7a8e4a --- /dev/null +++ b/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__()}" diff --git a/codelist/autocomplete/biotope.py b/codelist/autocomplete/biotope.py new file mode 100644 index 00000000..5e56b7f3 --- /dev/null +++ b/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})" diff --git a/codelist/autocomplete/compensation_action.py b/codelist/autocomplete/compensation_action.py new file mode 100644 index 00000000..47a652cd --- /dev/null +++ b/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" + ) + diff --git a/codelist/autocomplete/handler.py b/codelist/autocomplete/handler.py new file mode 100644 index 00000000..480d3315 --- /dev/null +++ b/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 diff --git a/codelist/autocomplete/law.py b/codelist/autocomplete/law.py new file mode 100644 index 00000000..cf3f4b54 --- /dev/null +++ b/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})" diff --git a/codelist/autocomplete/office.py b/codelist/autocomplete/office.py new file mode 100644 index 00000000..46ddbea0 --- /dev/null +++ b/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})" diff --git a/codelist/autocomplete/process_type.py b/codelist/autocomplete/process_type.py new file mode 100644 index 00000000..3f487e41 --- /dev/null +++ b/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) diff --git a/codelist/urls.py b/codelist/urls.py index 7d2dbba2..bd230f91 100644 --- a/codelist/urls.py +++ b/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"), ] \ No newline at end of file diff --git a/compensation/autocomplete/__init__.py b/compensation/autocomplete/__init__.py new file mode 100644 index 00000000..ca978536 --- /dev/null +++ b/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 + +""" diff --git a/compensation/autocomplete/eco_account.py b/compensation/autocomplete/eco_account.py new file mode 100644 index 00000000..d1ea90f4 --- /dev/null +++ b/compensation/autocomplete/eco_account.py @@ -0,0 +1,34 @@ +""" +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 diff --git a/compensation/forms/compensation.py b/compensation/forms/compensation.py index 1672e161..c5186793 100644 --- a/compensation/forms/compensation.py +++ b/compensation/forms/compensation.py @@ -88,7 +88,7 @@ class NewCompensationForm(AbstractCompensationForm, deleted=None, ), widget=autocomplete.ModelSelect2( - url="interventions-autocomplete", + url="intervention:autocomplete", attrs={ "data-placeholder": _("Click for selection"), "data-minimum-input-length": 3, diff --git a/compensation/forms/mixins.py b/compensation/forms/mixins.py index db174808..7cb7eb25 100644 --- a/compensation/forms/mixins.py +++ b/compensation/forms/mixins.py @@ -27,7 +27,7 @@ class CompensationResponsibleFormMixin(forms.Form): 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") } @@ -57,7 +57,7 @@ class CompensationResponsibleFormMixin(forms.Form): code_lists__in=[CODELIST_HANDLER_ID], ), widget=autocomplete.ModelSelect2( - url="codes-handler-autocomplete", + url="codelist:handler-autocomplete", attrs={ "data-placeholder": _("Click for selection"), } diff --git a/compensation/forms/modals/compensation_action.py b/compensation/forms/modals/compensation_action.py index cc0bae15..6cd7279f 100644 --- a/compensation/forms/modals/compensation_action.py +++ b/compensation/forms/modals/compensation_action.py @@ -44,7 +44,7 @@ class NewCompensationActionModalForm(BaseModalForm): code_lists__in=[CODELIST_COMPENSATION_ACTION_DETAIL_ID], ), widget=autocomplete.ModelSelect2Multiple( - url="codes-compensation-action-detail-autocomplete", + url="codelist:compensation-action-detail-autocomplete", attrs={ "data-placeholder": _("Action Type detail"), } diff --git a/compensation/forms/modals/state.py b/compensation/forms/modals/state.py index 485045ba..f0c42213 100644 --- a/compensation/forms/modals/state.py +++ b/compensation/forms/modals/state.py @@ -46,7 +46,7 @@ class NewCompensationStateModalForm(BaseModalForm): code_lists__in=[CODELIST_BIOTOPES_EXTRA_CODES_ID], ), widget=autocomplete.ModelSelect2Multiple( - url="codes-biotope-extra-type-autocomplete", + url="codelist:biotope-extra-type-autocomplete", attrs={ "data-placeholder": _("Biotope additional type"), } diff --git a/compensation/urls/eco_account.py b/compensation/urls/eco_account.py index 5a84e8ca..c57540e5 100644 --- a/compensation/urls/eco_account.py +++ b/compensation/urls/eco_account.py @@ -6,6 +6,8 @@ Created on: 24.08.21 """ from django.urls import path + +from compensation.autocomplete.eco_account import EcoAccountAutocomplete from compensation.views.eco_account import * app_name = "acc" @@ -47,4 +49,6 @@ urlpatterns = [ path('/deduction//edit', deduction_edit_view, name='edit-deduction'), path('/deduct/new', new_deduction_view, name='new-deduction'), + # Autocomplete + path("atcmplt/eco-accounts", EcoAccountAutocomplete.as_view(), name="autocomplete"), ] \ No newline at end of file diff --git a/intervention/autocomplete/__init__.py b/intervention/autocomplete/__init__.py new file mode 100644 index 00000000..ca978536 --- /dev/null +++ b/intervention/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 + +""" diff --git a/intervention/autocomplete/intervention.py b/intervention/autocomplete/intervention.py new file mode 100644 index 00000000..961c9660 --- /dev/null +++ b/intervention/autocomplete/intervention.py @@ -0,0 +1,36 @@ +""" +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 intervention.models import Intervention + + +class InterventionAutocomplete(Select2QuerySetView): + """ Autocomplete for intervention entries + + Only returns entries that are accessible for the requesting user + + """ + def get_queryset(self): + user = self.request.user + if user.is_anonymous: + return Intervention.objects.none() + qs = Intervention.objects.filter( + Q(deleted=None) & + Q(users__in=[user]) | + Q(teams__in=user.teams.all()) + ).order_by( + "identifier" + ).distinct() + if self.q: + qs = qs.filter( + Q(identifier__icontains=self.q) | + Q(title__icontains=self.q) + ).distinct() + return qs diff --git a/intervention/forms/intervention.py b/intervention/forms/intervention.py index 15b02fd7..c62b3faa 100644 --- a/intervention/forms/intervention.py +++ b/intervention/forms/intervention.py @@ -60,7 +60,7 @@ class NewInterventionForm(BaseForm): code_lists__in=[CODELIST_PROCESS_TYPE_ID], ), widget=autocomplete.ModelSelect2( - url="codes-process-type-autocomplete", + url="codelist:process-type-autocomplete", attrs={ "data-placeholder": _("Click for selection"), } @@ -77,7 +77,7 @@ class NewInterventionForm(BaseForm): code_lists__in=[CODELIST_LAW_ID], ), widget=autocomplete.ModelSelect2Multiple( - url="codes-law-autocomplete", + url="codelist:law-autocomplete", attrs={ "data-placeholder": _("Click for selection"), } @@ -93,7 +93,7 @@ class NewInterventionForm(BaseForm): code_lists__in=[CODELIST_REGISTRATION_OFFICE_ID], ), widget=autocomplete.ModelSelect2( - url="codes-registration-office-autocomplete", + url="codelist:registration-office-autocomplete", attrs={ "data-placeholder": _("Click for selection"), } @@ -109,7 +109,7 @@ class NewInterventionForm(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"), } @@ -150,7 +150,7 @@ class NewInterventionForm(BaseForm): code_lists__in=[CODELIST_HANDLER_ID], ), widget=autocomplete.ModelSelect2( - url="codes-handler-autocomplete", + url="codelist:handler-autocomplete", attrs={ "data-placeholder": _("Click for selection"), } diff --git a/intervention/forms/modals/deduction.py b/intervention/forms/modals/deduction.py index 2e182146..130ef2f8 100644 --- a/intervention/forms/modals/deduction.py +++ b/intervention/forms/modals/deduction.py @@ -33,7 +33,7 @@ class NewEcoAccountDeductionModalForm(BaseModalForm): help_text=_("Only recorded accounts can be selected for deductions"), queryset=EcoAccount.objects.filter(deleted=None), widget=autocomplete.ModelSelect2( - url="accounts-autocomplete", + url="compensation:acc:autocomplete", attrs={ "data-placeholder": _("Eco-account"), "data-minimum-input-length": 3, @@ -60,7 +60,7 @@ class NewEcoAccountDeductionModalForm(BaseModalForm): help_text=_("Only shared interventions can be selected"), queryset=Intervention.objects.filter(deleted=None), widget=autocomplete.ModelSelect2( - url="interventions-autocomplete", + url="intervention:autocomplete", attrs={ "data-placeholder": _("Intervention"), "data-minimum-input-length": 3, diff --git a/intervention/forms/modals/share.py b/intervention/forms/modals/share.py index 39c9d142..35c662d5 100644 --- a/intervention/forms/modals/share.py +++ b/intervention/forms/modals/share.py @@ -36,7 +36,7 @@ class ShareModalForm(BaseModalForm): required=False, queryset=Team.objects.all(), widget=autocomplete.ModelSelect2Multiple( - url="share-team-autocomplete", + url="user:share-team-autocomplete", attrs={ "data-placeholder": _("Click for selection"), "data-minimum-input-length": 3, @@ -50,7 +50,7 @@ class ShareModalForm(BaseModalForm): required=False, queryset=User.objects.all(), widget=autocomplete.ModelSelect2Multiple( - url="share-user-autocomplete", + url="user:share-user-autocomplete", attrs={ "data-placeholder": _("Click for selection"), "data-minimum-input-length": 3, diff --git a/intervention/urls.py b/intervention/urls.py index c7c43837..b3cc7038 100644 --- a/intervention/urls.py +++ b/intervention/urls.py @@ -7,6 +7,7 @@ Created on: 30.11.20 """ from django.urls import path +from intervention.autocomplete.intervention import InterventionAutocomplete from intervention.views import index_view, new_view, detail_view, edit_view, remove_view, new_document_view, share_view, \ create_share_view, remove_revocation_view, new_revocation_view, check_view, log_view, new_deduction_view, \ record_view, remove_document_view, get_document_view, get_revocation_view, new_id_view, report_view, \ @@ -48,4 +49,7 @@ urlpatterns = [ path('/revocation//edit', edit_revocation_view, name='edit-revocation'), path('/revocation//remove', remove_revocation_view, name='remove-revocation'), path('revocation/', get_revocation_view, name='get-doc-revocation'), + + # Autocomplete + path("atcmplt/interventions", InterventionAutocomplete.as_view(), name="autocomplete"), ] \ No newline at end of file diff --git a/konova/autocompletes.py b/konova/autocompletes.py deleted file mode 100644 index fbd92f75..00000000 --- a/konova/autocompletes.py +++ /dev/null @@ -1,401 +0,0 @@ -""" -Author: Michel Peltriaux -Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany -Contact: michel.peltriaux@sgdnord.rlp.de -Created on: 07.12.20 - -""" -import collections - -from dal_select2.views import Select2QuerySetView, Select2GroupQuerySetView -from django.core.exceptions import ImproperlyConfigured - -from konova.utils.message_templates import UNGROUPED -from user.models import User, Team -from django.db.models import Q - -from codelist.models import KonovaCode -from codelist.settings import CODELIST_COMPENSATION_ACTION_ID, CODELIST_BIOTOPES_ID, CODELIST_LAW_ID, \ - CODELIST_REGISTRATION_OFFICE_ID, CODELIST_CONSERVATION_OFFICE_ID, CODELIST_PROCESS_TYPE_ID, \ - CODELIST_BIOTOPES_EXTRA_CODES_ID, CODELIST_COMPENSATION_ACTION_DETAIL_ID, CODELIST_HANDLER_ID -from compensation.models import EcoAccount -from intervention.models import Intervention - - -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 - - -class InterventionAutocomplete(Select2QuerySetView): - """ Autocomplete for intervention entries - - Only returns entries that are accessible for the requesting user - - """ - def get_queryset(self): - user = self.request.user - if user.is_anonymous: - return Intervention.objects.none() - qs = Intervention.objects.filter( - Q(deleted=None) & - Q(users__in=[user]) | - Q(teams__in=user.teams.all()) - ).order_by( - "identifier" - ).distinct() - if self.q: - qs = qs.filter( - Q(identifier__icontains=self.q) | - Q(title__icontains=self.q) - ).distinct() - return qs - - -class ShareUserAutocomplete(Select2QuerySetView): - """ Autocomplete for share with single users - - - """ - def get_queryset(self): - if self.request.user.is_anonymous: - return User.objects.none() - qs = User.objects.all() - if self.q: - # Due to privacy concerns only a full username match will return the proper user entry - qs = qs.filter( - Q(username=self.q) | - Q(email=self.q) - ).distinct() - qs = qs.order_by("username") - return qs - - -class ShareTeamAutocomplete(Select2QuerySetView): - """ Autocomplete for share with teams - - """ - def get_queryset(self): - if self.request.user.is_anonymous: - return Team.objects.none() - qs = Team.objects.filter( - deleted__isnull=True - ) - if self.q: - # Due to privacy concerns only a full username match will return the proper user entry - qs = qs.filter( - name__icontains=self.q - ) - qs = qs.order_by( - "name" - ) - return qs - - -class TeamAdminAutocomplete(Select2QuerySetView): - """ Autocomplete for share with teams - - """ - def get_queryset(self): - if self.request.user.is_anonymous: - return User.objects.none() - qs = User.objects.filter( - id__in=self.forwarded.get("members", []) - ).exclude( - id__in=self.forwarded.get("admins", []) - ) - if self.q: - # Due to privacy concerns only a full username match will return the proper user entry - qs = qs.filter( - name__icontains=self.q - ) - qs = qs.order_by( - "username" - ) - return qs - - -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__()}" - - -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" - ) - - -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})" - - -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})" - - -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) - - -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})" - - -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 diff --git a/konova/filters/mixins/office.py b/konova/filters/mixins/office.py index 856ff6f3..3ca540f9 100644 --- a/konova/filters/mixins/office.py +++ b/konova/filters/mixins/office.py @@ -29,7 +29,7 @@ class ConservationOfficeTableFilterMixin(django_filters.FilterSet): code_lists__in=[CODELIST_CONSERVATION_OFFICE_ID], ), widget=ModelSelect2( - url="codes-conservation-office-autocomplete", + url="codelist:conservation-office-autocomplete", attrs={ "data-placeholder": _("Conservation office"), "title": _("Search for conservation office"), @@ -61,7 +61,7 @@ class RegistrationOfficeTableFilterMixin(django_filters.FilterSet): code_lists__in=[CODELIST_REGISTRATION_OFFICE_ID], ), widget=ModelSelect2( - url="codes-registration-office-autocomplete", + url="codelist:registration-office-autocomplete", attrs={ "data-placeholder": _("Registration office"), "title": _("Search for registration office"), diff --git a/konova/tests/test_autocompletes.py b/konova/tests/test_autocompletes.py index 1533d572..c763fb62 100644 --- a/konova/tests/test_autocompletes.py +++ b/konova/tests/test_autocompletes.py @@ -21,7 +21,7 @@ class AutocompleteTestCase(BaseTestCase): def test_user_autocomplete(self): self.client.login(username=self.superuser.username, password=self.superuser_pw) - user_autocomplete_url = reverse("share-user-autocomplete") + user_autocomplete_url = reverse("user:share-user-autocomplete") username = self.user.username # Provide the full name --> success @@ -60,19 +60,19 @@ class AutocompleteTestCase(BaseTestCase): def test_all_autocompletes(self): tests = [ - "accounts-autocomplete", - "interventions-autocomplete", - "codes-compensation-action-autocomplete", - "codes-compensation-action-detail-autocomplete", - "codes-biotope-autocomplete", - "codes-biotope-extra-type-autocomplete", - "codes-law-autocomplete", - "codes-process-type-autocomplete", - "codes-registration-office-autocomplete", - "codes-conservation-office-autocomplete", - "share-user-autocomplete", - "share-team-autocomplete", - "team-admin-autocomplete", + "compensation:acc:autocomplete", + "intervention:autocomplete", + "codelist:compensation-action-autocomplete", + "codelist:compensation-action-detail-autocomplete", + "codelist:biotope-autocomplete", + "codelist:biotope-extra-type-autocomplete", + "codelist:law-autocomplete", + "codelist:process-type-autocomplete", + "codelist:registration-office-autocomplete", + "codelist:conservation-office-autocomplete", + "user:share-user-autocomplete", + "user:share-team-autocomplete", + "user:team-admin-autocomplete", ] for test in tests: self.client.login(username=self.superuser.username, password=self.superuser_pw) diff --git a/konova/tests/test_views.py b/konova/tests/test_views.py index c6006190..32ab5986 100644 --- a/konova/tests/test_views.py +++ b/konova/tests/test_views.py @@ -590,15 +590,15 @@ class AutocompleteTestCase(BaseViewTestCase): @classmethod def setUpTestData(cls) -> None: super().setUpTestData() - cls.atcmplt_accs = reverse("accounts-autocomplete") - cls.atcmplt_interventions = reverse("interventions-autocomplete") - cls.atcmplt_code_comp_action = reverse("codes-compensation-action-autocomplete") - cls.atcmplt_code_comp_biotope = reverse("codes-biotope-autocomplete") - cls.atcmplt_code_comp_law = reverse("codes-law-autocomplete") - cls.atcmplt_code_comp_process = reverse("codes-process-type-autocomplete") - cls.atcmplt_code_comp_reg_off = reverse("codes-registration-office-autocomplete") - cls.atcmplt_code_comp_cons_off = reverse("codes-conservation-office-autocomplete") - cls.atcmplt_code_share_user = reverse("share-user-autocomplete") + cls.atcmplt_accs = reverse("compensation:acc:autocomplete") + cls.atcmplt_interventions = reverse("intervention:autocomplete") + cls.atcmplt_code_comp_action = reverse("codelist:compensation-action-autocomplete") + cls.atcmplt_code_comp_biotope = reverse("codelist:biotope-autocomplete") + cls.atcmplt_code_comp_law = reverse("codelist:law-autocomplete") + cls.atcmplt_code_comp_process = reverse("codelist:process-type-autocomplete") + cls.atcmplt_code_comp_reg_off = reverse("codelist:registration-office-autocomplete") + cls.atcmplt_code_comp_cons_off = reverse("codelist:conservation-office-autocomplete") + cls.atcmplt_code_share_user = reverse("user:share-user-autocomplete") def _test_views_anonymous_user(self): # ATTENTION: As of the current state of django-autocomplete-light, there is no way to check on authenticated diff --git a/konova/urls.py b/konova/urls.py index e0126832..1909091e 100644 --- a/konova/urls.py +++ b/konova/urls.py @@ -17,11 +17,6 @@ import debug_toolbar from django.contrib import admin from django.urls import path, include -from konova.autocompletes import EcoAccountAutocomplete, \ - InterventionAutocomplete, CompensationActionCodeAutocomplete, BiotopeCodeAutocomplete, LawCodeAutocomplete, \ - RegistrationOfficeCodeAutocomplete, ConservationOfficeCodeAutocomplete, ProcessTypeCodeAutocomplete, \ - ShareUserAutocomplete, BiotopeExtraCodeAutocomplete, CompensationActionDetailCodeAutocomplete, \ - ShareTeamAutocomplete, HandlerCodeAutocomplete, TeamAdminAutocomplete from konova.settings import SSO_SERVER, SSO_PUBLIC_KEY, SSO_PRIVATE_KEY, DEBUG from konova.sso.sso import KonovaSSOClient from konova.views import logout_view, home_view, get_geom_parcels, get_geom_parcels_content, map_client_proxy_view @@ -43,22 +38,6 @@ urlpatterns = [ path('geom//parcels/', get_geom_parcels, name="geometry-parcels"), path('geom//parcels/', get_geom_parcels_content, name="geometry-parcels-content"), path('client/proxy', map_client_proxy_view, name="map-client-proxy"), - - # Autocomplete paths for all apps - path("atcmplt/eco-accounts", EcoAccountAutocomplete.as_view(), name="accounts-autocomplete"), - path("atcmplt/interventions", InterventionAutocomplete.as_view(), name="interventions-autocomplete"), - path("atcmplt/codes/comp/action", CompensationActionCodeAutocomplete.as_view(), name="codes-compensation-action-autocomplete"), - path("atcmplt/codes/comp/action/detail", CompensationActionDetailCodeAutocomplete.as_view(), name="codes-compensation-action-detail-autocomplete"), - path("atcmplt/codes/biotope", BiotopeCodeAutocomplete.as_view(), name="codes-biotope-autocomplete"), - path("atcmplt/codes/biotope/extra", BiotopeExtraCodeAutocomplete.as_view(), name="codes-biotope-extra-type-autocomplete"), - path("atcmplt/codes/law", LawCodeAutocomplete.as_view(), name="codes-law-autocomplete"), - path("atcmplt/codes/prc-type", ProcessTypeCodeAutocomplete.as_view(), name="codes-process-type-autocomplete"), - path("atcmplt/codes/reg-off", RegistrationOfficeCodeAutocomplete.as_view(), name="codes-registration-office-autocomplete"), - path("atcmplt/codes/cons-off", ConservationOfficeCodeAutocomplete.as_view(), name="codes-conservation-office-autocomplete"), - path("atcmplt/codes/handler", HandlerCodeAutocomplete.as_view(), name="codes-handler-autocomplete"), - path("atcmplt/share/u", ShareUserAutocomplete.as_view(), name="share-user-autocomplete"), - path("atcmplt/share/t", ShareTeamAutocomplete.as_view(), name="share-team-autocomplete"), - path("atcmplt/team/admin", TeamAdminAutocomplete.as_view(), name="team-admin-autocomplete"), ] if DEBUG: diff --git a/user/autocomplete/__init__.py b/user/autocomplete/__init__.py new file mode 100644 index 00000000..ca978536 --- /dev/null +++ b/user/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 + +""" diff --git a/user/autocomplete/share.py b/user/autocomplete/share.py new file mode 100644 index 00000000..de634111 --- /dev/null +++ b/user/autocomplete/share.py @@ -0,0 +1,52 @@ +""" +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 user.models import User, Team + + +class ShareUserAutocomplete(Select2QuerySetView): + """ Autocomplete for share with single users + + + """ + def get_queryset(self): + if self.request.user.is_anonymous: + return User.objects.none() + qs = User.objects.all() + if self.q: + # Due to privacy concerns only a full username match will return the proper user entry + qs = qs.filter( + Q(username=self.q) | + Q(email=self.q) + ).distinct() + qs = qs.order_by("username") + return qs + + +class ShareTeamAutocomplete(Select2QuerySetView): + """ Autocomplete for share with teams + + """ + def get_queryset(self): + if self.request.user.is_anonymous: + return Team.objects.none() + qs = Team.objects.filter( + deleted__isnull=True + ) + if self.q: + # Due to privacy concerns only a full username match will return the proper user entry + qs = qs.filter( + name__icontains=self.q + ) + qs = qs.order_by( + "name" + ) + return qs + diff --git a/user/autocomplete/team.py b/user/autocomplete/team.py new file mode 100644 index 00000000..377c693e --- /dev/null +++ b/user/autocomplete/team.py @@ -0,0 +1,34 @@ +""" +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 user.models import User + + +class TeamAdminAutocomplete(Select2QuerySetView): + """ Autocomplete for share with teams + + """ + def get_queryset(self): + if self.request.user.is_anonymous: + return User.objects.none() + qs = User.objects.filter( + id__in=self.forwarded.get("members", []) + ).exclude( + id__in=self.forwarded.get("admins", []) + ) + if self.q: + # Due to privacy concerns only a full username match will return the proper user entry + qs = qs.filter( + name__icontains=self.q + ) + qs = qs.order_by( + "username" + ) + return qs + diff --git a/user/forms/modals/team.py b/user/forms/modals/team.py index d63a2306..b9f3b55b 100644 --- a/user/forms/modals/team.py +++ b/user/forms/modals/team.py @@ -43,7 +43,7 @@ class NewTeamModalForm(BaseModalForm): required=True, queryset=User.objects.all(), widget=autocomplete.ModelSelect2Multiple( - url="share-user-autocomplete", + url="user:share-user-autocomplete", attrs={ "data-placeholder": _("Click for selection"), "data-minimum-input-length": 3, @@ -103,7 +103,7 @@ class EditTeamModalForm(NewTeamModalForm): required=True, queryset=User.objects.all(), widget=autocomplete.ModelSelect2Multiple( - url="team-admin-autocomplete", + url="user:team-admin-autocomplete", forward=[ "members", "admins", diff --git a/user/urls.py b/user/urls.py index f1fb4e8f..ed975488 100644 --- a/user/urls.py +++ b/user/urls.py @@ -7,6 +7,8 @@ Created on: 08.07.21 """ from django.urls import path +from user.autocomplete.share import ShareUserAutocomplete, ShareTeamAutocomplete +from user.autocomplete.team import TeamAdminAutocomplete from user.views import * app_name = "user" @@ -22,4 +24,8 @@ urlpatterns = [ path("team//remove", remove_team_view, name="team-remove"), path("team//leave", leave_team_view, name="team-leave"), + # Autocomplete urls + path("atcmplt/share/u", ShareUserAutocomplete.as_view(), name="share-user-autocomplete"), + path("atcmplt/share/t", ShareTeamAutocomplete.as_view(), name="share-team-autocomplete"), + path("atcmplt/team/admin", TeamAdminAutocomplete.as_view(), name="team-admin-autocomplete"), ] \ No newline at end of file -- 2.45.2 From 75777d65c6d30777d4340f01f35ab5c22b36eaf4 Mon Sep 17 00:00:00 2001 From: mpeltriaux Date: Thu, 18 Aug 2022 13:19:04 +0200 Subject: [PATCH 07/21] Filters refactoring * splits filters.py of compensation and ema app into separate files in new /filters module * optimizes entry search for multi keyword input --- compensation/filters/__init__.py | 7 ++ .../{filters.py => filters/compensation.py} | 79 +----------------- compensation/filters/eco_account.py | 82 +++++++++++++++++++ compensation/tables/compensation.py | 2 +- compensation/tables/eco_account.py | 3 +- ema/filters.py | 2 +- konova/filters/mixins/keyword.py | 5 +- 7 files changed, 101 insertions(+), 79 deletions(-) create mode 100644 compensation/filters/__init__.py rename compensation/{filters.py => filters/compensation.py} (59%) create mode 100644 compensation/filters/eco_account.py diff --git a/compensation/filters/__init__.py b/compensation/filters/__init__.py new file mode 100644 index 00000000..ca978536 --- /dev/null +++ b/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 + +""" diff --git a/compensation/filters.py b/compensation/filters/compensation.py similarity index 59% rename from compensation/filters.py rename to compensation/filters/compensation.py index 186a7214..aa1c967b 100644 --- a/compensation/filters.py +++ b/compensation/filters/compensation.py @@ -1,17 +1,14 @@ """ Author: Michel Peltriaux Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany -Contact: michel.peltriaux@sgdnord.rlp.de -Created on: 29.07.21 +Contact: ksp-servicestelle@sgdnord.rlp.de +Created on: 18.08.22 """ -import django_filters -from django.utils.translation import gettext_lazy as _ -from django import forms from django.db.models import QuerySet, Q -from konova.filters.mixins.office import ConservationOfficeTableFilterMixin -from konova.filters.table_filters import QueryTableFilter, CheckboxTableFilter, SelectionTableFilter, AbstractTableFilter +from konova.filters.table_filters import AbstractTableFilter, CheckboxTableFilter, QueryTableFilter, \ + SelectionTableFilter class SelectionCompensationTableFilter(SelectionTableFilter): @@ -114,71 +111,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 diff --git a/compensation/filters/eco_account.py b/compensation/filters/eco_account.py new file mode 100644 index 00000000..b71e38d8 --- /dev/null +++ b/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 diff --git a/compensation/tables/compensation.py b/compensation/tables/compensation.py index 92fe1840..032ab67e 100644 --- a/compensation/tables/compensation.py +++ b/compensation/tables/compensation.py @@ -11,7 +11,7 @@ from django.urls import reverse from django.utils.html import format_html from django.utils.translation import gettext_lazy as _ -from compensation.filters import CompensationTableFilter +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 diff --git a/compensation/tables/eco_account.py b/compensation/tables/eco_account.py index 0cf4a4ef..17b8ecaa 100644 --- a/compensation/tables/eco_account.py +++ b/compensation/tables/eco_account.py @@ -11,12 +11,13 @@ from django.urls import reverse from django.utils.html import format_html from django.utils.translation import gettext_lazy as _ -from compensation.filters import EcoAccountTableFilter +from compensation.filters.eco_account import EcoAccountTableFilter from compensation.models import EcoAccount from konova.utils.tables import TableRenderMixin, BaseTable import django_tables2 as tables + class EcoAccountTable(BaseTable, TableRenderMixin): id = tables.Column( verbose_name=_("Identifier"), diff --git a/ema/filters.py b/ema/filters.py index 70b93da0..b976a4c9 100644 --- a/ema/filters.py +++ b/ema/filters.py @@ -5,7 +5,7 @@ Contact: michel.peltriaux@sgdnord.rlp.de Created on: 19.08.21 """ -from compensation.filters import EcoAccountTableFilter +from compensation.filters.eco_account import EcoAccountTableFilter class EmaTableFilter(EcoAccountTableFilter): diff --git a/konova/filters/mixins/keyword.py b/konova/filters/mixins/keyword.py index 212599c8..19bca65f 100644 --- a/konova/filters/mixins/keyword.py +++ b/konova/filters/mixins/keyword.py @@ -36,6 +36,9 @@ class KeywordTableFilterMixin(django_filters.FilterSet): """ value = value.strip() + value = value.split(" ") # build filter expression - q = Q(title__icontains=value) | Q(identifier__icontains=value) + q = Q() + for val in value: + q &= Q(title__icontains=val) | Q(identifier__icontains=val) return queryset.filter(q) -- 2.45.2 From 55a69d45c310ebe6b4d3c4fb02e8491009dbf8ac Mon Sep 17 00:00:00 2001 From: mpeltriaux Date: Fri, 19 Aug 2022 07:34:09 +0200 Subject: [PATCH 08/21] Intervention views * splits intervention/views.py (+700 lines) into separate files in new module * view files can now be found in /intervention/views/... --- intervention/urls.py | 19 +- intervention/views.py | 756 ----------------------------- intervention/views/__init__.py | 7 + intervention/views/check.py | 39 ++ intervention/views/compensation.py | 45 ++ intervention/views/deduction.py | 97 ++++ intervention/views/document.py | 112 +++++ intervention/views/intervention.py | 251 ++++++++++ intervention/views/log.py | 41 ++ intervention/views/record.py | 39 ++ intervention/views/report.py | 73 +++ intervention/views/resubmission.py | 39 ++ intervention/views/revocation.py | 117 +++++ intervention/views/share.py | 78 +++ 14 files changed, 951 insertions(+), 762 deletions(-) delete mode 100644 intervention/views.py create mode 100644 intervention/views/__init__.py create mode 100644 intervention/views/check.py create mode 100644 intervention/views/compensation.py create mode 100644 intervention/views/deduction.py create mode 100644 intervention/views/document.py create mode 100644 intervention/views/intervention.py create mode 100644 intervention/views/log.py create mode 100644 intervention/views/record.py create mode 100644 intervention/views/report.py create mode 100644 intervention/views/resubmission.py create mode 100644 intervention/views/revocation.py create mode 100644 intervention/views/share.py diff --git a/intervention/urls.py b/intervention/urls.py index b3cc7038..2d0dfdb5 100644 --- a/intervention/urls.py +++ b/intervention/urls.py @@ -8,11 +8,18 @@ Created on: 30.11.20 from django.urls import path from intervention.autocomplete.intervention import InterventionAutocomplete -from intervention.views import index_view, new_view, detail_view, edit_view, remove_view, new_document_view, share_view, \ - create_share_view, remove_revocation_view, new_revocation_view, check_view, log_view, new_deduction_view, \ - record_view, remove_document_view, get_document_view, get_revocation_view, new_id_view, report_view, \ - remove_deduction_view, remove_compensation_view, edit_deduction_view, edit_revocation_view, edit_document_view, \ - create_resubmission_view +from intervention.views.check import check_view +from intervention.views.compensation import remove_compensation_view +from intervention.views.deduction import new_deduction_view, edit_deduction_view, remove_deduction_view +from intervention.views.document import new_document_view, get_document_view, remove_document_view, edit_document_view +from intervention.views.intervention import index_view, new_view, new_id_view, detail_view, edit_view, remove_view +from intervention.views.log import log_view +from intervention.views.record import record_view +from intervention.views.report import report_view +from intervention.views.resubmission import create_resubmission_view +from intervention.views.revocation import new_revocation_view, edit_revocation_view, remove_revocation_view, \ + get_revocation_view +from intervention.views.share import share_view, create_share_view app_name = "intervention" urlpatterns = [ @@ -52,4 +59,4 @@ urlpatterns = [ # Autocomplete path("atcmplt/interventions", InterventionAutocomplete.as_view(), name="autocomplete"), -] \ No newline at end of file +] diff --git a/intervention/views.py b/intervention/views.py deleted file mode 100644 index e622488f..00000000 --- a/intervention/views.py +++ /dev/null @@ -1,756 +0,0 @@ -from django.contrib.auth.decorators import login_required -from django.core.exceptions import ObjectDoesNotExist -from django.utils.translation import gettext_lazy as _ -from django.http import HttpRequest, JsonResponse, Http404 -from django.shortcuts import render - -from intervention.forms.intervention import NewInterventionForm, EditInterventionForm -from intervention.forms.modals.check import CheckModalForm -from intervention.forms.modals.deduction import NewEcoAccountDeductionModalForm, RemoveEcoAccountDeductionModalForm, \ - EditEcoAccountDeductionModalForm -from intervention.forms.modals.document import NewInterventionDocumentModalForm -from intervention.forms.modals.revocation import EditRevocationModalForm, RemoveRevocationModalForm, \ - NewRevocationModalForm -from intervention.forms.modals.share import ShareModalForm -from intervention.models import Intervention, Revocation, InterventionDocument, RevocationDocument -from intervention.tables import InterventionTable -from konova.contexts import BaseContext -from konova.decorators import * -from konova.forms import SimpleGeomForm -from konova.forms.modals import RemoveModalForm, RecordModalForm, EditDocumentModalForm, ResubmissionModalForm -from konova.sub_settings.context_settings import TAB_TITLE_IDENTIFIER -from konova.utils.documents import remove_document, get_document -from konova.utils.generators import generate_qr_code -from konova.utils.message_templates import INTERVENTION_INVALID, FORM_INVALID, IDENTIFIER_REPLACED, \ - CHECKED_RECORDED_RESET, DEDUCTION_REMOVED, DEDUCTION_ADDED, REVOCATION_ADDED, REVOCATION_REMOVED, \ - COMPENSATION_REMOVED_TEMPLATE, DOCUMENT_ADDED, DEDUCTION_EDITED, REVOCATION_EDITED, DOCUMENT_EDITED, \ - RECORDED_BLOCKS_EDIT, DATA_CHECKED_PREVIOUSLY_TEMPLATE -from konova.utils.user_checks import in_group - - -@login_required -@any_group_check -def index_view(request: HttpRequest): - """ - Renders the index view for Interventions - - Args: - request (HttpRequest): The incoming request - - Returns: - A rendered view - """ - template = "generic_index.html" - - # Filtering by user access is performed in table filter inside of InterventionTableFilter class - interventions = Intervention.objects.filter( - deleted=None, # not deleted - ).select_related( - "legal" - ) - table = InterventionTable( - request=request, - queryset=interventions - ) - context = { - "table": table, - TAB_TITLE_IDENTIFIER: _("Interventions - Overview"), - } - context = BaseContext(request, context).context - return render(request, template, context) - - -@login_required -@default_group_required -def new_view(request: HttpRequest): - """ - Renders a view for a new intervention creation - - Args: - request (HttpRequest): The incoming request - - Returns: - - """ - template = "intervention/form/view.html" - data_form = NewInterventionForm(request.POST or None) - geom_form = SimpleGeomForm(request.POST or None, read_only=False) - if request.method == "POST": - if data_form.is_valid() and geom_form.is_valid(): - generated_identifier = data_form.cleaned_data.get("identifier", None) - intervention = data_form.save(request.user, geom_form) - if generated_identifier != intervention.identifier: - messages.info( - request, - IDENTIFIER_REPLACED.format( - generated_identifier, - intervention.identifier - ) - ) - messages.success(request, _("Intervention {} added").format(intervention.identifier)) - return redirect("intervention:detail", id=intervention.id) - else: - messages.error(request, FORM_INVALID, extra_tags="danger",) - else: - # For clarification: nothing in this case - pass - context = { - "form": data_form, - "geom_form": geom_form, - TAB_TITLE_IDENTIFIER: _("New intervention"), - } - context = BaseContext(request, context).context - return render(request, template, context) - - -@login_required -@default_group_required -def new_id_view(request: HttpRequest): - """ JSON endpoint - - Provides fetching of free identifiers for e.g. AJAX calls - - """ - tmp_intervention = Intervention() - identifier = tmp_intervention.generate_new_identifier() - while Intervention.objects.filter(identifier=identifier).exists(): - identifier = tmp_intervention.generate_new_identifier() - return JsonResponse( - data={ - "gen_data": identifier - } - ) - - -@login_required -@default_group_required -@shared_access_required(Intervention, "id") -def new_document_view(request: HttpRequest, id: str): - """ Renders a form for uploading new documents - - Args: - request (HttpRequest): The incoming request - id (str): The intervention's id to which the new document will be related - Returns: - - """ - intervention = get_object_or_404(Intervention, id=id) - form = NewInterventionDocumentModalForm(request.POST or None, request.FILES or None, instance=intervention, request=request) - return form.process_request( - request, - msg_success=DOCUMENT_ADDED, - redirect_url=reverse("intervention:detail", args=(id,)) + "#related_data" - ) - - -@login_required -@default_group_required -def get_revocation_view(request: HttpRequest, doc_id: str): - """ Returns the revocation document as downloadable file - - Wraps the generic document fetcher function from konova.utils. - - Args: - request (HttpRequest): The incoming request - doc_id (str): The document id - - Returns: - - """ - doc = get_object_or_404(RevocationDocument, id=doc_id) - # File download only possible if related instance is shared with user - if not doc.instance.legal.intervention.users.filter(id=request.user.id): - messages.info( - request, - DATA_UNSHARED - ) - return redirect("intervention:detail", id=doc.instance.id) - return get_document(doc) - -@login_required -@default_group_required -@shared_access_required(Intervention, "id") -def get_document_view(request: HttpRequest, id: str, doc_id: str): - """ Returns the document as downloadable file - - Wraps the generic document fetcher function from konova.utils. - - Args: - request (HttpRequest): The incoming request - id (str): The intervention id - doc_id (str): The document id - - Returns: - - """ - intervention = get_object_or_404(Intervention, id=id) - doc = get_object_or_404(InterventionDocument, id=doc_id) - return get_document(doc) - - -@login_required -@default_group_required -@shared_access_required(Intervention, "id") -def remove_document_view(request: HttpRequest, id: str, doc_id: str): - """ Removes the document from the database and file system - - Wraps the generic functionality from konova.utils. - - Args: - request (HttpRequest): The incoming request - id (str): The intervention id - doc_id (str): The document id - - Returns: - - """ - intervention = get_object_or_404(Intervention, id=id) - doc = get_object_or_404(InterventionDocument, id=doc_id) - return remove_document( - request, - doc - ) - - -@login_required -@default_group_required -@shared_access_required(Intervention, "id") -def edit_document_view(request: HttpRequest, id: str, doc_id: str): - """ Removes the document from the database and file system - - Wraps the generic functionality from konova.utils. - - Args: - request (HttpRequest): The incoming request - id (str): The intervention id - doc_id (str): The document id - - Returns: - - """ - intervention = get_object_or_404(Intervention, id=id) - doc = get_object_or_404(InterventionDocument, id=doc_id) - form = EditDocumentModalForm(request.POST or None, request.FILES or None, instance=intervention, document=doc, request=request) - return form.process_request( - request, - DOCUMENT_EDITED, - redirect_url=reverse("intervention:detail", args=(intervention.id,)) + "#related_data" - ) - - -@login_required -@any_group_check -def detail_view(request: HttpRequest, id: str): - """ Renders a detail view for viewing an intervention's data - - Args: - request (HttpRequest): The incoming request - id (str): The intervention's id - - Returns: - - """ - template = "intervention/detail/view.html" - - # Fetch data, filter out deleted related data - intervention = get_object_or_404( - Intervention.objects.select_related( - "geometry", - "legal", - "responsible", - ), - id=id - ) - compensations = intervention.compensations.filter( - deleted=None, - ) - _user = request.user - is_data_shared = intervention.is_shared_with(user=_user) - - geom_form = SimpleGeomForm( - instance=intervention, - ) - last_checked = intervention.get_last_checked_action() - last_checked_tooltip = "" - if last_checked: - last_checked_tooltip = DATA_CHECKED_PREVIOUSLY_TEMPLATE.format(last_checked.get_timestamp_str_formatted(), last_checked.user) - - context = { - "obj": intervention, - "last_checked": last_checked, - "last_checked_tooltip": last_checked_tooltip, - "compensations": compensations, - "has_access": is_data_shared, - "geom_form": geom_form, - "is_default_member": in_group(_user, DEFAULT_GROUP), - "is_zb_member": in_group(_user, ZB_GROUP), - "is_ets_member": in_group(_user, ETS_GROUP), - "LANIS_LINK": intervention.get_LANIS_link(), - TAB_TITLE_IDENTIFIER: f"{intervention.identifier} - {intervention.title}", - } - - request = intervention.set_status_messages(request) - - context = BaseContext(request, context).context - return render(request, template, context) - - -@login_required -@default_group_required -@shared_access_required(Intervention, "id") -def edit_view(request: HttpRequest, id: str): - """ - Renders a view for editing interventions - - Args: - request (HttpRequest): The incoming request - - Returns: - - """ - template = "intervention/form/view.html" - # Get object from db - intervention = get_object_or_404(Intervention, id=id) - if intervention.is_recorded: - messages.info( - request, - RECORDED_BLOCKS_EDIT - ) - return redirect("intervention:detail", id=id) - - # Create forms, initialize with values from db/from POST request - data_form = EditInterventionForm(request.POST or None, instance=intervention) - geom_form = SimpleGeomForm(request.POST or None, read_only=False, instance=intervention) - if request.method == "POST": - if data_form.is_valid() and geom_form.is_valid(): - # The data form takes the geom form for processing, as well as the performing user - # Save the current state of recorded|checked to inform the user in case of a status reset due to editing - i_rec = intervention.recorded is not None - i_check = intervention.checked is not None - intervention = data_form.save(request.user, geom_form) - messages.success(request, _("Intervention {} edited").format(intervention.identifier)) - if i_check or i_rec: - messages.info(request, CHECKED_RECORDED_RESET) - return redirect("intervention:detail", id=intervention.id) - else: - messages.error(request, FORM_INVALID, extra_tags="danger",) - else: - # For clarification: nothing in this case - pass - context = { - "form": data_form, - "geom_form": geom_form, - TAB_TITLE_IDENTIFIER: _("Edit {}").format(intervention.identifier), - } - context = BaseContext(request, context).context - return render(request, template, context) - - -@login_required -@default_group_required -@shared_access_required(Intervention, "id") -def remove_view(request: HttpRequest, id: str): - """ Renders a remove view for this intervention - - Args: - request (HttpRequest): The incoming request - id (str): The uuid id as string - - Returns: - - """ - obj = Intervention.objects.get(id=id) - identifier = obj.identifier - form = RemoveModalForm(request.POST or None, instance=obj, request=request) - return form.process_request( - request, - _("{} removed").format(identifier), - redirect_url=reverse("intervention:index") - ) - - -@login_required -@default_group_required -@shared_access_required(Intervention, "id") -def edit_revocation_view(request: HttpRequest, id: str, revocation_id: str): - """ Renders a edit view for a revocation - - Args: - request (HttpRequest): The incoming request - id (str): The intervention's id as string - revocation_id (str): The revocation's id as string - - Returns: - - """ - intervention = get_object_or_404(Intervention, id=id) - revocation = get_object_or_404(Revocation, id=revocation_id) - - form = EditRevocationModalForm(request.POST or None, request.FILES or None, instance=intervention, revocation=revocation, request=request) - return form.process_request( - request, - REVOCATION_EDITED, - redirect_url=reverse("intervention:detail", args=(intervention.id,)) + "#related_data" - ) - - -@login_required -@default_group_required -@shared_access_required(Intervention, "id") -def remove_revocation_view(request: HttpRequest, id: str, revocation_id: str): - """ Renders a remove view for a revocation - - Args: - request (HttpRequest): The incoming request - id (str): The intervention's id as string - revocation_id (str): The revocation's id as string - - Returns: - - """ - intervention = get_object_or_404(Intervention, id=id) - revocation = get_object_or_404(Revocation, id=revocation_id) - - form = RemoveRevocationModalForm(request.POST or None, instance=intervention, revocation=revocation, request=request) - return form.process_request( - request, - REVOCATION_REMOVED, - redirect_url=reverse("intervention:detail", args=(intervention.id,)) + "#related_data" - ) - - -@login_required -def share_view(request: HttpRequest, id: str, token: str): - """ Performs sharing of an intervention - - If token given in url is not valid, the user will be redirected to the dashboard - - Args: - request (HttpRequest): The incoming request - id (str): Intervention's id - token (str): Access token for intervention - - Returns: - - """ - user = request.user - intervention = get_object_or_404(Intervention, id=id) - # Check tokens - if intervention.access_token == token: - # Send different messages in case user has already been added to list of sharing users - if intervention.is_shared_with(user): - messages.info( - request, - _("{} has already been shared with you").format(intervention.identifier) - ) - else: - messages.success( - request, - _("{} has been shared with you").format(intervention.identifier) - ) - intervention.share_with_user(user) - return redirect("intervention:detail", id=id) - else: - messages.error( - request, - _("Share link invalid"), - extra_tags="danger", - ) - return redirect("home") - - -@login_required -@default_group_required -@shared_access_required(Intervention, "id") -def create_share_view(request: HttpRequest, id: str): - """ Renders sharing form for an intervention - - Args: - request (HttpRequest): The incoming request - id (str): Intervention's id - - Returns: - - """ - intervention = get_object_or_404(Intervention, id=id) - form = ShareModalForm(request.POST or None, instance=intervention, request=request) - return form.process_request( - request, - msg_success=_("Share settings updated") - ) - - -@login_required -@default_group_required -@shared_access_required(Intervention, "id") -def create_resubmission_view(request: HttpRequest, id: str): - """ Renders resubmission form for an intervention - - Args: - request (HttpRequest): The incoming request - id (str): Intervention's id - - Returns: - - """ - intervention = get_object_or_404(Intervention, id=id) - form = ResubmissionModalForm(request.POST or None, instance=intervention, request=request) - form.action_url = reverse("intervention:resubmission-create", args=(id,)) - return form.process_request( - request, - msg_success=_("Resubmission set"), - redirect_url=reverse("intervention:detail", args=(id,)) - ) - - -@login_required -@registration_office_group_required -@shared_access_required(Intervention, "id") -def check_view(request: HttpRequest, id: str): - """ Renders check form for an intervention - - Args: - request (HttpRequest): The incoming request - id (str): Intervention's id - - Returns: - - """ - intervention = get_object_or_404(Intervention, id=id) - form = CheckModalForm(request.POST or None, instance=intervention, request=request) - return form.process_request( - request, - msg_success=_("Check performed"), - msg_error=INTERVENTION_INVALID - ) - - -@login_required -@default_group_required -@shared_access_required(Intervention, "id") -def new_revocation_view(request: HttpRequest, id: str): - """ Renders sharing form for an intervention - - Args: - request (HttpRequest): The incoming request - id (str): Intervention's id - - Returns: - - """ - intervention = get_object_or_404(Intervention, id=id) - form = NewRevocationModalForm(request.POST or None, request.FILES or None, instance=intervention, request=request) - return form.process_request( - request, - msg_success=REVOCATION_ADDED, - redirect_url=reverse("intervention:detail", args=(id,)) + "#related_data" - ) - - -@login_required -@default_group_required -@shared_access_required(Intervention, "id") -def log_view(request: HttpRequest, id: str): - """ Renders a log view using modal - - Args: - request (HttpRequest): The incoming request - id (str): The compensation's id - - Returns: - - """ - intervention = get_object_or_404(Intervention, id=id) - template = "modal/modal_generic.html" - body_template = "log.html" - - context = { - "modal_body_template": body_template, - "log": intervention.log.all(), - "modal_title": _("Log"), - } - context = BaseContext(request, context).context - return render(request, template, context) - - -@login_required -@default_group_required -@shared_access_required(Intervention, "id") -def new_deduction_view(request: HttpRequest, id: str): - """ Renders a modal form view for creating deductions - - Args: - request (HttpRequest): The incoming request - id (str): The intervention's id which shall benefit from this deduction - - Returns: - - """ - intervention = get_object_or_404(Intervention, id=id) - form = NewEcoAccountDeductionModalForm(request.POST or None, instance=intervention, request=request) - return form.process_request( - request, - msg_success=DEDUCTION_ADDED, - redirect_url=reverse("intervention:detail", args=(id,)) + "#related_data", - ) - - -@login_required -@default_group_required -@shared_access_required(Intervention, "id") -def remove_deduction_view(request: HttpRequest, id: str, deduction_id: str): - """ Renders a modal view for removing deductions - - Args: - request (HttpRequest): The incoming request - id (str): The intervention's id - deduction_id (str): The deduction's id - - Returns: - - """ - intervention = get_object_or_404(Intervention, id=id) - try: - eco_deduction = intervention.deductions.get(id=deduction_id) - except ObjectDoesNotExist: - raise Http404("Unknown deduction") - - form = RemoveEcoAccountDeductionModalForm(request.POST or None, instance=intervention, deduction=eco_deduction, request=request) - return form.process_request( - request=request, - msg_success=DEDUCTION_REMOVED, - redirect_url=reverse("intervention:detail", args=(id,)) + "#related_data" - ) - - -@login_required -@default_group_required -@shared_access_required(Intervention, "id") -def edit_deduction_view(request: HttpRequest, id: str, deduction_id: str): - """ Renders a modal view for removing deductions - - Args: - request (HttpRequest): The incoming request - id (str): The intervention's id - deduction_id (str): The deduction's id - - Returns: - - """ - intervention = get_object_or_404(Intervention, id=id) - try: - eco_deduction = intervention.deductions.get(id=deduction_id) - except ObjectDoesNotExist: - raise Http404("Unknown deduction") - - form = EditEcoAccountDeductionModalForm(request.POST or None, instance=intervention, deduction=eco_deduction, request=request) - return form.process_request( - request=request, - msg_success=DEDUCTION_EDITED, - redirect_url=reverse("intervention:detail", args=(id,)) + "#related_data" - ) - - -@login_required -@conservation_office_group_required -@shared_access_required(Intervention, "id") -def record_view(request: HttpRequest, id: str): - """ Renders a modal form for recording an intervention - - Args: - request (HttpRequest): The incoming request - id (str): The intervention's id - - Returns: - - """ - intervention = get_object_or_404(Intervention, id=id) - form = RecordModalForm(request.POST or None, instance=intervention, request=request) - msg_succ = _("{} unrecorded") if intervention.recorded else _("{} recorded") - msg_succ = msg_succ.format(intervention.identifier) - return form.process_request( - request, - msg_succ, - msg_error=_("There are errors on this intervention:") - ) - - -def remove_compensation_view(request:HttpRequest, id: str, comp_id: str): - """ Renders a modal view for removing the compensation - - Args: - request (HttpRequest): The incoming request - id (str): The compensation's id - - Returns: - - """ - intervention = get_object_or_404(Intervention, id=id) - try: - comp = intervention.compensations.get( - id=comp_id - ) - except ObjectDoesNotExist: - raise Http404("Unknown compensation") - form = RemoveModalForm(request.POST or None, instance=comp, request=request) - return form.process_request( - request=request, - msg_success=COMPENSATION_REMOVED_TEMPLATE.format(comp.identifier), - redirect_url=reverse("intervention:detail", args=(id,)) + "#related_data", - ) - - -def report_view(request:HttpRequest, id: str): - """ Renders the public report view - - Args: - request (HttpRequest): The incoming request - id (str): The id of the intervention - - Returns: - - """ - template = "intervention/report/report.html" - intervention = get_object_or_404(Intervention, id=id) - - tab_title = _("Report {}").format(intervention.identifier) - # If intervention is not recorded (yet or currently) we need to render another template without any data - if not intervention.is_ready_for_publish(): - template = "report/unavailable.html" - context = { - TAB_TITLE_IDENTIFIER: tab_title, - } - context = BaseContext(request, context).context - return render(request, template, context) - - # Prepare data for map viewer - geom_form = SimpleGeomForm( - instance=intervention - ) - parcels = intervention.get_underlying_parcels() - - distinct_deductions = intervention.deductions.all().distinct( - "account" - ) - qrcode_url = request.build_absolute_uri(reverse("intervention:report", args=(id,))) - qrcode_img = generate_qr_code(qrcode_url, 10) - qrcode_lanis_url = intervention.get_LANIS_link() - qrcode_img_lanis = generate_qr_code(qrcode_lanis_url, 7) - - context = { - "obj": intervention, - "deductions": distinct_deductions, - "qrcode": { - "img": qrcode_img, - "url": qrcode_url, - }, - "qrcode_lanis": { - "img": qrcode_img_lanis, - "url": qrcode_lanis_url, - }, - "geom_form": geom_form, - "parcels": parcels, - TAB_TITLE_IDENTIFIER: tab_title, - } - context = BaseContext(request, context).context - return render(request, template, context) diff --git a/intervention/views/__init__.py b/intervention/views/__init__.py new file mode 100644 index 00000000..3a996e1f --- /dev/null +++ b/intervention/views/__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: 19.08.22 + +""" diff --git a/intervention/views/check.py b/intervention/views/check.py new file mode 100644 index 00000000..1fae75bb --- /dev/null +++ b/intervention/views/check.py @@ -0,0 +1,39 @@ +""" +Author: Michel Peltriaux +Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany +Contact: ksp-servicestelle@sgdnord.rlp.de +Created on: 19.08.22 + +""" +from django.contrib.auth.decorators import login_required +from django.http import HttpRequest +from django.shortcuts import get_object_or_404 +from django.utils.translation import gettext_lazy as _ + +from intervention.forms.modals.check import CheckModalForm +from intervention.models import Intervention +from konova.decorators import registration_office_group_required, shared_access_required +from konova.utils.message_templates import INTERVENTION_INVALID + + +@login_required +@registration_office_group_required +@shared_access_required(Intervention, "id") +def check_view(request: HttpRequest, id: str): + """ Renders check form for an intervention + + Args: + request (HttpRequest): The incoming request + id (str): Intervention's id + + Returns: + + """ + intervention = get_object_or_404(Intervention, id=id) + form = CheckModalForm(request.POST or None, instance=intervention, request=request) + return form.process_request( + request, + msg_success=_("Check performed"), + msg_error=INTERVENTION_INVALID + ) + diff --git a/intervention/views/compensation.py b/intervention/views/compensation.py new file mode 100644 index 00000000..94e8dfd5 --- /dev/null +++ b/intervention/views/compensation.py @@ -0,0 +1,45 @@ +""" +Author: Michel Peltriaux +Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany +Contact: ksp-servicestelle@sgdnord.rlp.de +Created on: 19.08.22 + +""" +from django.contrib.auth.decorators import login_required +from django.core.exceptions import ObjectDoesNotExist +from django.http import HttpRequest, Http404 +from django.shortcuts import get_object_or_404 +from django.urls import reverse + +from intervention.models import Intervention +from konova.decorators import shared_access_required +from konova.forms.modals import RemoveModalForm +from konova.utils.message_templates import COMPENSATION_REMOVED_TEMPLATE + + +@login_required +@shared_access_required(Intervention, "id") +def remove_compensation_view(request: HttpRequest, id: str, comp_id: str): + """ Renders a modal view for removing the compensation + + Args: + request (HttpRequest): The incoming request + id (str): The compensation's id + + Returns: + + """ + intervention = get_object_or_404(Intervention, id=id) + try: + comp = intervention.compensations.get( + id=comp_id + ) + except ObjectDoesNotExist: + raise Http404("Unknown compensation") + form = RemoveModalForm(request.POST or None, instance=comp, request=request) + return form.process_request( + request=request, + msg_success=COMPENSATION_REMOVED_TEMPLATE.format(comp.identifier), + redirect_url=reverse("intervention:detail", args=(id,)) + "#related_data", + ) + diff --git a/intervention/views/deduction.py b/intervention/views/deduction.py new file mode 100644 index 00000000..2fb841c1 --- /dev/null +++ b/intervention/views/deduction.py @@ -0,0 +1,97 @@ +""" +Author: Michel Peltriaux +Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany +Contact: ksp-servicestelle@sgdnord.rlp.de +Created on: 19.08.22 + +""" +from django.contrib.auth.decorators import login_required +from django.core.exceptions import ObjectDoesNotExist +from django.http import HttpRequest, Http404 +from django.shortcuts import get_object_or_404 +from django.urls import reverse + +from intervention.forms.modals.deduction import NewEcoAccountDeductionModalForm, RemoveEcoAccountDeductionModalForm, \ + EditEcoAccountDeductionModalForm +from intervention.models import Intervention +from konova.decorators import default_group_required, shared_access_required +from konova.utils.message_templates import DEDUCTION_ADDED, DEDUCTION_REMOVED, DEDUCTION_EDITED + + +@login_required +@default_group_required +@shared_access_required(Intervention, "id") +def new_deduction_view(request: HttpRequest, id: str): + """ Renders a modal form view for creating deductions + + Args: + request (HttpRequest): The incoming request + id (str): The intervention's id which shall benefit from this deduction + + Returns: + + """ + intervention = get_object_or_404(Intervention, id=id) + form = NewEcoAccountDeductionModalForm(request.POST or None, instance=intervention, request=request) + return form.process_request( + request, + msg_success=DEDUCTION_ADDED, + redirect_url=reverse("intervention:detail", args=(id,)) + "#related_data", + ) + + +@login_required +@default_group_required +@shared_access_required(Intervention, "id") +def remove_deduction_view(request: HttpRequest, id: str, deduction_id: str): + """ Renders a modal view for removing deductions + + Args: + request (HttpRequest): The incoming request + id (str): The intervention's id + deduction_id (str): The deduction's id + + Returns: + + """ + intervention = get_object_or_404(Intervention, id=id) + try: + eco_deduction = intervention.deductions.get(id=deduction_id) + except ObjectDoesNotExist: + raise Http404("Unknown deduction") + + form = RemoveEcoAccountDeductionModalForm(request.POST or None, instance=intervention, deduction=eco_deduction, request=request) + return form.process_request( + request=request, + msg_success=DEDUCTION_REMOVED, + redirect_url=reverse("intervention:detail", args=(id,)) + "#related_data" + ) + + +@login_required +@default_group_required +@shared_access_required(Intervention, "id") +def edit_deduction_view(request: HttpRequest, id: str, deduction_id: str): + """ Renders a modal view for removing deductions + + Args: + request (HttpRequest): The incoming request + id (str): The intervention's id + deduction_id (str): The deduction's id + + Returns: + + """ + intervention = get_object_or_404(Intervention, id=id) + try: + eco_deduction = intervention.deductions.get(id=deduction_id) + except ObjectDoesNotExist: + raise Http404("Unknown deduction") + + form = EditEcoAccountDeductionModalForm(request.POST or None, instance=intervention, deduction=eco_deduction, request=request) + return form.process_request( + request=request, + msg_success=DEDUCTION_EDITED, + redirect_url=reverse("intervention:detail", args=(id,)) + "#related_data" + ) + diff --git a/intervention/views/document.py b/intervention/views/document.py new file mode 100644 index 00000000..be43fbd5 --- /dev/null +++ b/intervention/views/document.py @@ -0,0 +1,112 @@ +""" +Author: Michel Peltriaux +Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany +Contact: ksp-servicestelle@sgdnord.rlp.de +Created on: 19.08.22 + +""" +from django.contrib.auth.decorators import login_required +from django.http import HttpRequest +from django.shortcuts import get_object_or_404 +from django.urls import reverse +from django.utils.translation import gettext_lazy as _ + +from intervention.forms.modals.document import NewInterventionDocumentModalForm +from intervention.models import Intervention, InterventionDocument +from konova.decorators import default_group_required, shared_access_required +from konova.forms.modals import EditDocumentModalForm +from konova.utils.documents import get_document, remove_document +from konova.utils.message_templates import DOCUMENT_ADDED, DOCUMENT_EDITED + + +@login_required +@default_group_required +@shared_access_required(Intervention, "id") +def new_document_view(request: HttpRequest, id: str): + """ Renders a form for uploading new documents + + Args: + request (HttpRequest): The incoming request + id (str): The intervention's id to which the new document will be related + Returns: + + """ + intervention = get_object_or_404(Intervention, id=id) + form = NewInterventionDocumentModalForm(request.POST or None, request.FILES or None, instance=intervention, request=request) + return form.process_request( + request, + msg_success=DOCUMENT_ADDED, + redirect_url=reverse("intervention:detail", args=(id,)) + "#related_data" + ) + + +@login_required +@default_group_required +@shared_access_required(Intervention, "id") +def get_document_view(request: HttpRequest, id: str, doc_id: str): + """ Returns the document as downloadable file + + Wraps the generic document fetcher function from konova.utils. + + Args: + request (HttpRequest): The incoming request + id (str): The intervention id + doc_id (str): The document id + + Returns: + + """ + intervention = get_object_or_404(Intervention, id=id) + doc = get_object_or_404(InterventionDocument, id=doc_id) + return get_document(doc) + + +@login_required +@default_group_required +@shared_access_required(Intervention, "id") +def remove_document_view(request: HttpRequest, id: str, doc_id: str): + """ Removes the document from the database and file system + + Wraps the generic functionality from konova.utils. + + Args: + request (HttpRequest): The incoming request + id (str): The intervention id + doc_id (str): The document id + + Returns: + + """ + intervention = get_object_or_404(Intervention, id=id) + doc = get_object_or_404(InterventionDocument, id=doc_id) + return remove_document( + request, + doc + ) + + +@login_required +@default_group_required +@shared_access_required(Intervention, "id") +def edit_document_view(request: HttpRequest, id: str, doc_id: str): + """ Removes the document from the database and file system + + Wraps the generic functionality from konova.utils. + + Args: + request (HttpRequest): The incoming request + id (str): The intervention id + doc_id (str): The document id + + Returns: + + """ + intervention = get_object_or_404(Intervention, id=id) + doc = get_object_or_404(InterventionDocument, id=doc_id) + form = EditDocumentModalForm(request.POST or None, request.FILES or None, instance=intervention, document=doc, request=request) + return form.process_request( + request, + DOCUMENT_EDITED, + redirect_url=reverse("intervention:detail", args=(intervention.id,)) + "#related_data" + ) + diff --git a/intervention/views/intervention.py b/intervention/views/intervention.py new file mode 100644 index 00000000..bf33bfb9 --- /dev/null +++ b/intervention/views/intervention.py @@ -0,0 +1,251 @@ +""" +Author: Michel Peltriaux +Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany +Contact: ksp-servicestelle@sgdnord.rlp.de +Created on: 19.08.22 + +""" +from django.contrib import messages +from django.contrib.auth.decorators import login_required +from django.http import JsonResponse, HttpRequest +from django.shortcuts import get_object_or_404, render, redirect +from django.urls import reverse +from django.utils.translation import gettext_lazy as _ + +from intervention.forms.intervention import EditInterventionForm, NewInterventionForm +from intervention.models import Intervention +from intervention.tables import InterventionTable +from konova.contexts import BaseContext +from konova.decorators import default_group_required, shared_access_required, any_group_check +from konova.forms import SimpleGeomForm +from konova.forms.modals import RemoveModalForm +from konova.settings import DEFAULT_GROUP, ZB_GROUP, ETS_GROUP +from konova.sub_settings.context_settings import TAB_TITLE_IDENTIFIER +from konova.utils.message_templates import DATA_CHECKED_PREVIOUSLY_TEMPLATE, RECORDED_BLOCKS_EDIT, \ + CHECKED_RECORDED_RESET, FORM_INVALID, IDENTIFIER_REPLACED +from konova.utils.user_checks import in_group + + +@login_required +@any_group_check +def index_view(request: HttpRequest): + """ + Renders the index view for Interventions + + Args: + request (HttpRequest): The incoming request + + Returns: + A rendered view + """ + template = "generic_index.html" + + # Filtering by user access is performed in table filter inside of InterventionTableFilter class + interventions = Intervention.objects.filter( + deleted=None, # not deleted + ).select_related( + "legal" + ) + table = InterventionTable( + request=request, + queryset=interventions + ) + context = { + "table": table, + TAB_TITLE_IDENTIFIER: _("Interventions - Overview"), + } + context = BaseContext(request, context).context + return render(request, template, context) + + +@login_required +@default_group_required +def new_view(request: HttpRequest): + """ + Renders a view for a new intervention creation + + Args: + request (HttpRequest): The incoming request + + Returns: + + """ + template = "intervention/form/view.html" + data_form = NewInterventionForm(request.POST or None) + geom_form = SimpleGeomForm(request.POST or None, read_only=False) + if request.method == "POST": + if data_form.is_valid() and geom_form.is_valid(): + generated_identifier = data_form.cleaned_data.get("identifier", None) + intervention = data_form.save(request.user, geom_form) + if generated_identifier != intervention.identifier: + messages.info( + request, + IDENTIFIER_REPLACED.format( + generated_identifier, + intervention.identifier + ) + ) + messages.success(request, _("Intervention {} added").format(intervention.identifier)) + return redirect("intervention:detail", id=intervention.id) + else: + messages.error(request, FORM_INVALID, extra_tags="danger",) + else: + # For clarification: nothing in this case + pass + context = { + "form": data_form, + "geom_form": geom_form, + TAB_TITLE_IDENTIFIER: _("New intervention"), + } + context = BaseContext(request, context).context + return render(request, template, context) + + +@login_required +@default_group_required +def new_id_view(request: HttpRequest): + """ JSON endpoint + + Provides fetching of free identifiers for e.g. AJAX calls + + """ + tmp_intervention = Intervention() + identifier = tmp_intervention.generate_new_identifier() + while Intervention.objects.filter(identifier=identifier).exists(): + identifier = tmp_intervention.generate_new_identifier() + return JsonResponse( + data={ + "gen_data": identifier + } + ) + + +@login_required +@any_group_check +def detail_view(request: HttpRequest, id: str): + """ Renders a detail view for viewing an intervention's data + + Args: + request (HttpRequest): The incoming request + id (str): The intervention's id + + Returns: + + """ + template = "intervention/detail/view.html" + + # Fetch data, filter out deleted related data + intervention = get_object_or_404( + Intervention.objects.select_related( + "geometry", + "legal", + "responsible", + ), + id=id + ) + compensations = intervention.compensations.filter( + deleted=None, + ) + _user = request.user + is_data_shared = intervention.is_shared_with(user=_user) + + geom_form = SimpleGeomForm( + instance=intervention, + ) + last_checked = intervention.get_last_checked_action() + last_checked_tooltip = "" + if last_checked: + last_checked_tooltip = DATA_CHECKED_PREVIOUSLY_TEMPLATE.format(last_checked.get_timestamp_str_formatted(), last_checked.user) + + context = { + "obj": intervention, + "last_checked": last_checked, + "last_checked_tooltip": last_checked_tooltip, + "compensations": compensations, + "has_access": is_data_shared, + "geom_form": geom_form, + "is_default_member": in_group(_user, DEFAULT_GROUP), + "is_zb_member": in_group(_user, ZB_GROUP), + "is_ets_member": in_group(_user, ETS_GROUP), + "LANIS_LINK": intervention.get_LANIS_link(), + TAB_TITLE_IDENTIFIER: f"{intervention.identifier} - {intervention.title}", + } + + request = intervention.set_status_messages(request) + + context = BaseContext(request, context).context + return render(request, template, context) + + +@login_required +@default_group_required +@shared_access_required(Intervention, "id") +def edit_view(request: HttpRequest, id: str): + """ + Renders a view for editing interventions + + Args: + request (HttpRequest): The incoming request + + Returns: + + """ + template = "intervention/form/view.html" + # Get object from db + intervention = get_object_or_404(Intervention, id=id) + if intervention.is_recorded: + messages.info( + request, + RECORDED_BLOCKS_EDIT + ) + return redirect("intervention:detail", id=id) + + # Create forms, initialize with values from db/from POST request + data_form = EditInterventionForm(request.POST or None, instance=intervention) + geom_form = SimpleGeomForm(request.POST or None, read_only=False, instance=intervention) + if request.method == "POST": + if data_form.is_valid() and geom_form.is_valid(): + # The data form takes the geom form for processing, as well as the performing user + # Save the current state of recorded|checked to inform the user in case of a status reset due to editing + i_rec = intervention.recorded is not None + i_check = intervention.checked is not None + intervention = data_form.save(request.user, geom_form) + messages.success(request, _("Intervention {} edited").format(intervention.identifier)) + if i_check or i_rec: + messages.info(request, CHECKED_RECORDED_RESET) + return redirect("intervention:detail", id=intervention.id) + else: + messages.error(request, FORM_INVALID, extra_tags="danger",) + else: + # For clarification: nothing in this case + pass + context = { + "form": data_form, + "geom_form": geom_form, + TAB_TITLE_IDENTIFIER: _("Edit {}").format(intervention.identifier), + } + context = BaseContext(request, context).context + return render(request, template, context) + + +@login_required +@default_group_required +@shared_access_required(Intervention, "id") +def remove_view(request: HttpRequest, id: str): + """ Renders a remove view for this intervention + + Args: + request (HttpRequest): The incoming request + id (str): The uuid id as string + + Returns: + + """ + obj = Intervention.objects.get(id=id) + identifier = obj.identifier + form = RemoveModalForm(request.POST or None, instance=obj, request=request) + return form.process_request( + request, + _("{} removed").format(identifier), + redirect_url=reverse("intervention:index") + ) diff --git a/intervention/views/log.py b/intervention/views/log.py new file mode 100644 index 00000000..fcb69197 --- /dev/null +++ b/intervention/views/log.py @@ -0,0 +1,41 @@ +""" +Author: Michel Peltriaux +Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany +Contact: ksp-servicestelle@sgdnord.rlp.de +Created on: 19.08.22 + +""" +from django.contrib.auth.decorators import login_required +from django.http import HttpRequest +from django.shortcuts import get_object_or_404, render +from django.utils.translation import gettext_lazy as _ + +from intervention.models import Intervention +from konova.contexts import BaseContext +from konova.decorators import shared_access_required, default_group_required + + +@login_required +@default_group_required +@shared_access_required(Intervention, "id") +def log_view(request: HttpRequest, id: str): + """ Renders a log view using modal + + Args: + request (HttpRequest): The incoming request + id (str): The compensation's id + + Returns: + + """ + intervention = get_object_or_404(Intervention, id=id) + template = "modal/modal_generic.html" + body_template = "log.html" + + context = { + "modal_body_template": body_template, + "log": intervention.log.all(), + "modal_title": _("Log"), + } + context = BaseContext(request, context).context + return render(request, template, context) diff --git a/intervention/views/record.py b/intervention/views/record.py new file mode 100644 index 00000000..c5709b22 --- /dev/null +++ b/intervention/views/record.py @@ -0,0 +1,39 @@ +""" +Author: Michel Peltriaux +Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany +Contact: ksp-servicestelle@sgdnord.rlp.de +Created on: 19.08.22 + +""" +from django.contrib.auth.decorators import login_required +from django.http import HttpRequest +from django.shortcuts import get_object_or_404 +from django.utils.translation import gettext_lazy as _ + +from intervention.models import Intervention +from konova.decorators import conservation_office_group_required, shared_access_required +from konova.forms.modals import RecordModalForm + + +@login_required +@conservation_office_group_required +@shared_access_required(Intervention, "id") +def record_view(request: HttpRequest, id: str): + """ Renders a modal form for recording an intervention + + Args: + request (HttpRequest): The incoming request + id (str): The intervention's id + + Returns: + + """ + intervention = get_object_or_404(Intervention, id=id) + form = RecordModalForm(request.POST or None, instance=intervention, request=request) + msg_succ = _("{} unrecorded") if intervention.recorded else _("{} recorded") + msg_succ = msg_succ.format(intervention.identifier) + return form.process_request( + request, + msg_succ, + msg_error=_("There are errors on this intervention:") + ) diff --git a/intervention/views/report.py b/intervention/views/report.py new file mode 100644 index 00000000..fa4798d0 --- /dev/null +++ b/intervention/views/report.py @@ -0,0 +1,73 @@ +""" +Author: Michel Peltriaux +Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany +Contact: ksp-servicestelle@sgdnord.rlp.de +Created on: 19.08.22 + +""" +from django.http import HttpRequest +from django.shortcuts import get_object_or_404, render +from django.urls import reverse +from django.utils.translation import gettext_lazy as _ + +from intervention.models import Intervention +from konova.contexts import BaseContext +from konova.forms import SimpleGeomForm +from konova.sub_settings.context_settings import TAB_TITLE_IDENTIFIER +from konova.utils.generators import generate_qr_code + + +def report_view(request:HttpRequest, id: str): + """ Renders the public report view + + Args: + request (HttpRequest): The incoming request + id (str): The id of the intervention + + Returns: + + """ + template = "intervention/report/report.html" + intervention = get_object_or_404(Intervention, id=id) + + tab_title = _("Report {}").format(intervention.identifier) + # If intervention is not recorded (yet or currently) we need to render another template without any data + if not intervention.is_ready_for_publish(): + template = "report/unavailable.html" + context = { + TAB_TITLE_IDENTIFIER: tab_title, + } + context = BaseContext(request, context).context + return render(request, template, context) + + # Prepare data for map viewer + geom_form = SimpleGeomForm( + instance=intervention + ) + parcels = intervention.get_underlying_parcels() + + distinct_deductions = intervention.deductions.all().distinct( + "account" + ) + qrcode_url = request.build_absolute_uri(reverse("intervention:report", args=(id,))) + qrcode_img = generate_qr_code(qrcode_url, 10) + qrcode_lanis_url = intervention.get_LANIS_link() + qrcode_img_lanis = generate_qr_code(qrcode_lanis_url, 7) + + context = { + "obj": intervention, + "deductions": distinct_deductions, + "qrcode": { + "img": qrcode_img, + "url": qrcode_url, + }, + "qrcode_lanis": { + "img": qrcode_img_lanis, + "url": qrcode_lanis_url, + }, + "geom_form": geom_form, + "parcels": parcels, + TAB_TITLE_IDENTIFIER: tab_title, + } + context = BaseContext(request, context).context + return render(request, template, context) diff --git a/intervention/views/resubmission.py b/intervention/views/resubmission.py new file mode 100644 index 00000000..34a618c2 --- /dev/null +++ b/intervention/views/resubmission.py @@ -0,0 +1,39 @@ +""" +Author: Michel Peltriaux +Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany +Contact: ksp-servicestelle@sgdnord.rlp.de +Created on: 19.08.22 + +""" +from django.contrib.auth.decorators import login_required +from django.http import HttpRequest +from django.shortcuts import get_object_or_404 +from django.urls import reverse +from django.utils.translation import gettext_lazy as _ + +from intervention.models import Intervention +from konova.decorators import default_group_required, shared_access_required +from konova.forms.modals import ResubmissionModalForm + + +@login_required +@default_group_required +@shared_access_required(Intervention, "id") +def create_resubmission_view(request: HttpRequest, id: str): + """ Renders resubmission form for an intervention + + Args: + request (HttpRequest): The incoming request + id (str): Intervention's id + + Returns: + + """ + intervention = get_object_or_404(Intervention, id=id) + form = ResubmissionModalForm(request.POST or None, instance=intervention, request=request) + form.action_url = reverse("intervention:resubmission-create", args=(id,)) + return form.process_request( + request, + msg_success=_("Resubmission set"), + redirect_url=reverse("intervention:detail", args=(id,)) + ) diff --git a/intervention/views/revocation.py b/intervention/views/revocation.py new file mode 100644 index 00000000..6c6c70b7 --- /dev/null +++ b/intervention/views/revocation.py @@ -0,0 +1,117 @@ +""" +Author: Michel Peltriaux +Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany +Contact: ksp-servicestelle@sgdnord.rlp.de +Created on: 19.08.22 + +""" +from django.contrib import messages +from django.contrib.auth.decorators import login_required +from django.http import HttpRequest +from django.shortcuts import get_object_or_404, redirect +from django.urls import reverse + +from intervention.forms.modals.revocation import NewRevocationModalForm, EditRevocationModalForm, \ + RemoveRevocationModalForm +from intervention.models import Intervention, RevocationDocument, Revocation +from konova.decorators import default_group_required, shared_access_required +from konova.utils.documents import get_document +from konova.utils.message_templates import REVOCATION_ADDED, DATA_UNSHARED, REVOCATION_EDITED, REVOCATION_REMOVED + + +@login_required +@default_group_required +@shared_access_required(Intervention, "id") +def new_revocation_view(request: HttpRequest, id: str): + """ Renders sharing form for an intervention + + Args: + request (HttpRequest): The incoming request + id (str): Intervention's id + + Returns: + + """ + intervention = get_object_or_404(Intervention, id=id) + form = NewRevocationModalForm(request.POST or None, request.FILES or None, instance=intervention, request=request) + return form.process_request( + request, + msg_success=REVOCATION_ADDED, + redirect_url=reverse("intervention:detail", args=(id,)) + "#related_data" + ) + + +@login_required +@default_group_required +def get_revocation_view(request: HttpRequest, doc_id: str): + """ Returns the revocation document as downloadable file + + Wraps the generic document fetcher function from konova.utils. + + Args: + request (HttpRequest): The incoming request + doc_id (str): The document id + + Returns: + + """ + doc = get_object_or_404(RevocationDocument, id=doc_id) + # File download only possible if related instance is shared with user + if not doc.instance.legal.intervention.users.filter(id=request.user.id): + messages.info( + request, + DATA_UNSHARED + ) + return redirect("intervention:detail", id=doc.instance.id) + return get_document(doc) + + +@login_required +@default_group_required +@shared_access_required(Intervention, "id") +def edit_revocation_view(request: HttpRequest, id: str, revocation_id: str): + """ Renders a edit view for a revocation + + Args: + request (HttpRequest): The incoming request + id (str): The intervention's id as string + revocation_id (str): The revocation's id as string + + Returns: + + """ + intervention = get_object_or_404(Intervention, id=id) + revocation = get_object_or_404(Revocation, id=revocation_id) + + form = EditRevocationModalForm(request.POST or None, request.FILES or None, instance=intervention, revocation=revocation, request=request) + return form.process_request( + request, + REVOCATION_EDITED, + redirect_url=reverse("intervention:detail", args=(intervention.id,)) + "#related_data" + ) + + +@login_required +@default_group_required +@shared_access_required(Intervention, "id") +def remove_revocation_view(request: HttpRequest, id: str, revocation_id: str): + """ Renders a remove view for a revocation + + Args: + request (HttpRequest): The incoming request + id (str): The intervention's id as string + revocation_id (str): The revocation's id as string + + Returns: + + """ + intervention = get_object_or_404(Intervention, id=id) + revocation = get_object_or_404(Revocation, id=revocation_id) + + form = RemoveRevocationModalForm(request.POST or None, instance=intervention, revocation=revocation, request=request) + return form.process_request( + request, + REVOCATION_REMOVED, + redirect_url=reverse("intervention:detail", args=(intervention.id,)) + "#related_data" + ) + diff --git a/intervention/views/share.py b/intervention/views/share.py new file mode 100644 index 00000000..ba9cdd3a --- /dev/null +++ b/intervention/views/share.py @@ -0,0 +1,78 @@ +""" +Author: Michel Peltriaux +Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany +Contact: ksp-servicestelle@sgdnord.rlp.de +Created on: 19.08.22 + +""" +from django.contrib import messages +from django.contrib.auth.decorators import login_required +from django.http import HttpRequest +from django.shortcuts import get_object_or_404, redirect +from django.utils.translation import gettext_lazy as _ + +from intervention.forms.modals.share import ShareModalForm +from intervention.models import Intervention +from konova.decorators import default_group_required, shared_access_required + + +@login_required +def share_view(request: HttpRequest, id: str, token: str): + """ Performs sharing of an intervention + + If token given in url is not valid, the user will be redirected to the dashboard + + Args: + request (HttpRequest): The incoming request + id (str): Intervention's id + token (str): Access token for intervention + + Returns: + + """ + user = request.user + intervention = get_object_or_404(Intervention, id=id) + # Check tokens + if intervention.access_token == token: + # Send different messages in case user has already been added to list of sharing users + if intervention.is_shared_with(user): + messages.info( + request, + _("{} has already been shared with you").format(intervention.identifier) + ) + else: + messages.success( + request, + _("{} has been shared with you").format(intervention.identifier) + ) + intervention.share_with_user(user) + return redirect("intervention:detail", id=id) + else: + messages.error( + request, + _("Share link invalid"), + extra_tags="danger", + ) + return redirect("home") + + +@login_required +@default_group_required +@shared_access_required(Intervention, "id") +def create_share_view(request: HttpRequest, id: str): + """ Renders sharing form for an intervention + + Args: + request (HttpRequest): The incoming request + id (str): Intervention's id + + Returns: + + """ + intervention = get_object_or_404(Intervention, id=id) + form = ShareModalForm(request.POST or None, instance=intervention, request=request) + return form.process_request( + request, + msg_success=_("Share settings updated") + ) + -- 2.45.2 From 79840550cb07134454071e6da2665bb5e77dd3fc Mon Sep 17 00:00:00 2001 From: mpeltriaux Date: Fri, 19 Aug 2022 07:51:49 +0200 Subject: [PATCH 09/21] EMA views * splits ema/views.py (+700 lines) into separate files in new module * view files can now be found in /ema/views/... --- ema/urls.py | 12 +- ema/views.py | 739 -------------------------------------- ema/views/__init__.py | 7 + ema/views/action.py | 89 +++++ ema/views/deadline.py | 90 +++++ ema/views/document.py | 111 ++++++ ema/views/ema.py | 237 ++++++++++++ ema/views/log.py | 41 +++ ema/views/record.py | 37 ++ ema/views/report.py | 79 ++++ ema/views/resubmission.py | 39 ++ ema/views/share.py | 77 ++++ ema/views/state.py | 90 +++++ 13 files changed, 908 insertions(+), 740 deletions(-) delete mode 100644 ema/views.py create mode 100644 ema/views/__init__.py create mode 100644 ema/views/action.py create mode 100644 ema/views/deadline.py create mode 100644 ema/views/document.py create mode 100644 ema/views/ema.py create mode 100644 ema/views/log.py create mode 100644 ema/views/record.py create mode 100644 ema/views/report.py create mode 100644 ema/views/resubmission.py create mode 100644 ema/views/share.py create mode 100644 ema/views/state.py diff --git a/ema/urls.py b/ema/urls.py index 63073d6e..92877271 100644 --- a/ema/urls.py +++ b/ema/urls.py @@ -6,7 +6,17 @@ Created on: 19.08.21 """ from django.urls import path -from ema.views import * + +from ema.views.action import action_new_view, action_edit_view, action_remove_view +from ema.views.deadline import deadline_new_view, deadline_edit_view, deadline_remove_view +from ema.views.document import document_new_view, get_document_view, remove_document_view, edit_document_view +from ema.views.ema import index_view, new_view, new_id_view, detail_view, edit_view, remove_view +from ema.views.log import log_view +from ema.views.record import record_view +from ema.views.report import report_view +from ema.views.resubmission import create_resubmission_view +from ema.views.share import share_view, create_share_view +from ema.views.state import state_new_view, state_remove_view, state_edit_view app_name = "ema" urlpatterns = [ diff --git a/ema/views.py b/ema/views.py deleted file mode 100644 index 2dd6e51f..00000000 --- a/ema/views.py +++ /dev/null @@ -1,739 +0,0 @@ -from django.contrib import messages -from django.contrib.auth.decorators import login_required -from django.db.models import Sum -from django.http import HttpRequest, JsonResponse -from django.shortcuts import render, get_object_or_404, redirect -from django.urls import reverse -from django.utils.translation import gettext_lazy as _ - -from compensation.forms.modals.compensation_action import NewCompensationActionModalForm, \ - EditCompensationActionModalForm, RemoveCompensationActionModalForm -from compensation.forms.modals.deadline import NewDeadlineModalForm, EditDeadlineModalForm -from compensation.forms.modals.state import NewCompensationStateModalForm, RemoveCompensationStateModalForm, \ - EditCompensationStateModalForm -from compensation.models import CompensationAction, CompensationState -from ema.forms import NewEmaForm, EditEmaForm, NewEmaDocumentModalForm -from ema.tables import EmaTable -from intervention.forms.modals.share import ShareModalForm -from konova.contexts import BaseContext -from konova.decorators import conservation_office_group_required, shared_access_required -from ema.models import Ema, EmaDocument -from konova.forms.modals import RemoveModalForm, RecordModalForm, RemoveDeadlineModalForm, \ - EditDocumentModalForm, ResubmissionModalForm -from konova.forms import SimpleGeomForm -from konova.models import Deadline -from konova.settings import DEFAULT_GROUP, ZB_GROUP, ETS_GROUP -from konova.sub_settings.context_settings import TAB_TITLE_IDENTIFIER -from konova.utils.documents import get_document, remove_document -from konova.utils.generators import generate_qr_code -from konova.utils.message_templates import IDENTIFIER_REPLACED, FORM_INVALID, DATA_UNSHARED, DATA_UNSHARED_EXPLANATION, \ - DOCUMENT_ADDED, COMPENSATION_STATE_REMOVED, COMPENSATION_STATE_ADDED, COMPENSATION_ACTION_REMOVED, \ - COMPENSATION_ACTION_ADDED, DEADLINE_ADDED, DEADLINE_REMOVED, DOCUMENT_EDITED, COMPENSATION_STATE_EDITED, \ - COMPENSATION_ACTION_EDITED, DEADLINE_EDITED, RECORDED_BLOCKS_EDIT -from konova.utils.user_checks import in_group - - -@login_required -def index_view(request: HttpRequest): - """ Renders the index view for EMAs - - Args: - request (HttpRequest): The incoming request - - Returns: - - """ - template = "generic_index.html" - emas = Ema.objects.filter( - deleted=None, - ).order_by( - "-modified" - ) - table = EmaTable( - request, - queryset=emas - ) - context = { - "table": table, - TAB_TITLE_IDENTIFIER: _("EMAs - Overview"), - } - context = BaseContext(request, context).context - return render(request, template, context) - - -@login_required -@conservation_office_group_required -def new_view(request: HttpRequest): - """ - Renders a view for a new eco account creation - - Args: - request (HttpRequest): The incoming request - - Returns: - - """ - template = "ema/form/view.html" - data_form = NewEmaForm(request.POST or None) - geom_form = SimpleGeomForm(request.POST or None, read_only=False) - if request.method == "POST": - if data_form.is_valid() and geom_form.is_valid(): - generated_identifier = data_form.cleaned_data.get("identifier", None) - ema = data_form.save(request.user, geom_form) - if generated_identifier != ema.identifier: - messages.info( - request, - IDENTIFIER_REPLACED.format( - generated_identifier, - ema.identifier - ) - ) - messages.success(request, _("EMA {} added").format(ema.identifier)) - return redirect("ema:detail", id=ema.id) - else: - messages.error(request, FORM_INVALID, extra_tags="danger",) - else: - # For clarification: nothing in this case - pass - context = { - "form": data_form, - "geom_form": geom_form, - TAB_TITLE_IDENTIFIER: _("New EMA"), - } - context = BaseContext(request, context).context - return render(request, template, context) - - -@login_required -@conservation_office_group_required -def new_id_view(request: HttpRequest): - """ JSON endpoint - - Provides fetching of free identifiers for e.g. AJAX calls - - """ - tmp = Ema() - identifier = tmp.generate_new_identifier() - while Ema.objects.filter(identifier=identifier).exists(): - identifier = tmp.generate_new_identifier() - return JsonResponse( - data={ - "gen_data": identifier - } - ) - - -@login_required -def detail_view(request: HttpRequest, id: str): - """ Renders the detail view of an EMA - - Args: - request (HttpRequest): The incoming request - id (str): The EMA id - - Returns: - - """ - template = "ema/detail/view.html" - ema = get_object_or_404(Ema, id=id, deleted=None) - - geom_form = SimpleGeomForm(instance=ema) - parcels = ema.get_underlying_parcels() - _user = request.user - is_data_shared = ema.is_shared_with(_user) - - # Order states according to surface - before_states = ema.before_states.all().order_by("-surface") - after_states = ema.after_states.all().order_by("-surface") - - # Precalculate logical errors between before- and after-states - # Sum() returns None in case of no states, so we catch that and replace it with 0 for easier handling - sum_before_states = before_states.aggregate(Sum("surface"))["surface__sum"] or 0 - sum_after_states = after_states.aggregate(Sum("surface"))["surface__sum"] or 0 - diff_states = abs(sum_before_states - sum_after_states) - - ema.set_status_messages(request) - - context = { - "obj": ema, - "geom_form": geom_form, - "parcels": parcels, - "has_access": is_data_shared, - "before_states": before_states, - "after_states": after_states, - "sum_before_states": sum_before_states, - "sum_after_states": sum_after_states, - "diff_states": diff_states, - "is_default_member": in_group(_user, DEFAULT_GROUP), - "is_zb_member": in_group(_user, ZB_GROUP), - "is_ets_member": in_group(_user, ETS_GROUP), - "LANIS_LINK": ema.get_LANIS_link(), - TAB_TITLE_IDENTIFIER: f"{ema.identifier} - {ema.title}", - "has_finished_deadlines": ema.get_finished_deadlines().exists(), - } - context = BaseContext(request, context).context - return render(request, template, context) - - -@login_required -@conservation_office_group_required -@shared_access_required(Ema, "id") -def log_view(request: HttpRequest, id: str): - """ Renders a log view using modal - - Args: - request (HttpRequest): The incoming request - id (str): The EMA's id - - Returns: - - """ - ema = get_object_or_404(Ema, id=id) - template = "modal/modal_generic.html" - body_template = "log.html" - - context = { - "modal_body_template": body_template, - "log": ema.log.all(), - "modal_title": _("Log"), - } - context = BaseContext(request, context).context - return render(request, template, context) - - -@login_required -@conservation_office_group_required -@shared_access_required(Ema, "id") -def edit_view(request: HttpRequest, id: str): - """ - Renders a view for editing compensations - - Args: - request (HttpRequest): The incoming request - - Returns: - - """ - template = "compensation/form/view.html" - # Get object from db - ema = get_object_or_404(Ema, id=id) - if ema.is_recorded: - messages.info( - request, - RECORDED_BLOCKS_EDIT - ) - return redirect("ema:detail", id=id) - - # Create forms, initialize with values from db/from POST request - data_form = EditEmaForm(request.POST or None, instance=ema) - geom_form = SimpleGeomForm(request.POST or None, read_only=False, instance=ema) - if request.method == "POST": - if data_form.is_valid() and geom_form.is_valid(): - # The data form takes the geom form for processing, as well as the performing user - ema = data_form.save(request.user, geom_form) - messages.success(request, _("EMA {} edited").format(ema.identifier)) - return redirect("ema:detail", id=ema.id) - else: - messages.error(request, FORM_INVALID, extra_tags="danger",) - else: - # For clarification: nothing in this case - pass - context = { - "form": data_form, - "geom_form": geom_form, - TAB_TITLE_IDENTIFIER: _("Edit {}").format(ema.identifier), - } - context = BaseContext(request, context).context - return render(request, template, context) - - -@login_required -@conservation_office_group_required -@shared_access_required(Ema, "id") -def remove_view(request: HttpRequest, id: str): - """ Renders a modal view for removing the EMA - - Args: - request (HttpRequest): The incoming request - id (str): The EMA's id - - Returns: - - """ - ema = get_object_or_404(Ema, id=id) - form = RemoveModalForm(request.POST or None, instance=ema, request=request) - return form.process_request( - request=request, - msg_success=_("EMA removed"), - redirect_url=reverse("ema:index"), - ) - - -@login_required -@conservation_office_group_required -@shared_access_required(Ema, "id") -def record_view(request: HttpRequest, id: str): - """ Renders a modal view for recording the EMA - - Args: - request (HttpRequest): The incoming request - id (str): The EMA's id - - Returns: - - """ - ema = get_object_or_404(Ema, id=id) - msg_succ = _("{} unrecorded") if ema.recorded else _("{} recorded") - form = RecordModalForm(request.POST or None, instance=ema, request=request) - return form.process_request( - request=request, - msg_success=msg_succ.format("EMA"), - ) - - -@login_required -@conservation_office_group_required -@shared_access_required(Ema, "id") -def state_new_view(request: HttpRequest, id: str): - """ Renders a form for adding new states for an EMA - - Args: - request (HttpRequest): The incoming request - id (str): The EMA's id to which the new state will be related - - Returns: - - """ - ema = get_object_or_404(Ema, id=id) - form = NewCompensationStateModalForm(request.POST or None, instance=ema, request=request) - return form.process_request( - request, - msg_success=COMPENSATION_STATE_ADDED, - redirect_url=reverse("ema:detail", args=(id,)) + "#related_data" - ) - - -@login_required -@conservation_office_group_required -@shared_access_required(Ema, "id") -def action_new_view(request: HttpRequest, id: str): - """ Renders a form for adding new actions for an EMA - - Args: - request (HttpRequest): The incoming request - id (str): The EMA's id to which the new state will be related - - Returns: - - """ - ema = get_object_or_404(Ema, id=id) - form = NewCompensationActionModalForm(request.POST or None, instance=ema, request=request) - return form.process_request( - request, - msg_success=COMPENSATION_ACTION_ADDED, - redirect_url=reverse("ema:detail", args=(id,)) + "#related_data" - ) - - -@login_required -@conservation_office_group_required -@shared_access_required(Ema, "id") -def action_edit_view(request: HttpRequest, id: str, action_id: str): - """ Renders a form for editing an actions for an EMA - - Args: - request (HttpRequest): The incoming request - id (str): The EMA's id - action_id (str): The action id - - Returns: - - """ - ema = get_object_or_404(Ema, id=id) - action = get_object_or_404(CompensationAction, id=action_id) - form = EditCompensationActionModalForm(request.POST or None, instance=ema, action=action, request=request) - return form.process_request( - request, - msg_success=COMPENSATION_ACTION_EDITED, - redirect_url=reverse("ema:detail", args=(id,)) + "#related_data" - ) - - -@login_required -@conservation_office_group_required -@shared_access_required(Ema, "id") -def deadline_new_view(request: HttpRequest, id: str): - """ Renders a form for adding new states for an EMA - - Args: - request (HttpRequest): The incoming request - id (str): The EMA's id to which the new state will be related - - Returns: - - """ - ema = get_object_or_404(Ema, id=id) - form = NewDeadlineModalForm(request.POST or None, instance=ema, request=request) - return form.process_request( - request, - msg_success=DEADLINE_ADDED, - redirect_url=reverse("ema:detail", args=(id,)) + "#related_data" - ) - - -@login_required -@conservation_office_group_required -@shared_access_required(Ema, "id") -def document_new_view(request: HttpRequest, id: str): - """ Renders a form for uploading new documents - - Args: - request (HttpRequest): The incoming request - id (str): The EMA's id to which the new document will be related - Returns: - - """ - ema = get_object_or_404(Ema, id=id) - form = NewEmaDocumentModalForm(request.POST or None, request.FILES or None, instance=ema, request=request) - return form.process_request( - request, - msg_success=DOCUMENT_ADDED, - redirect_url=reverse("ema:detail", args=(id,)) + "#related_data" - ) - - -@login_required -@conservation_office_group_required -@shared_access_required(Ema, "id") -def get_document_view(request: HttpRequest, id: str, doc_id: str): - """ Returns the document as downloadable file - - Wraps the generic document fetcher function from konova.utils. - - Args: - request (HttpRequest): The incoming request - id (str): The EMA id - doc_id (str): The document id - - Returns: - - """ - ema = get_object_or_404(Ema, id=id) - doc = get_object_or_404(EmaDocument, id=doc_id) - return get_document(doc) - - -@login_required -@conservation_office_group_required -@shared_access_required(Ema, "id") -def edit_document_view(request: HttpRequest, id: str, doc_id: str): - """ Removes the document from the database and file system - - Wraps the generic functionality from konova.utils. - - Args: - request (HttpRequest): The incoming request - id (str): The EMA id - doc_id (str): The document id - - Returns: - - """ - ema = get_object_or_404(Ema, id=id) - doc = get_object_or_404(EmaDocument, id=doc_id) - form = EditDocumentModalForm(request.POST or None, request.FILES or None, instance=ema, document=doc, request=request) - return form.process_request( - request, - DOCUMENT_EDITED, - reverse("ema:detail", args=(id,)) + "#related_data" - ) - - -@login_required -@conservation_office_group_required -@shared_access_required(Ema, "id") -def remove_document_view(request: HttpRequest, id:str, doc_id: str): - """ Removes the document from the database and file system - - Wraps the generic functionality from konova.utils. - - Args: - request (HttpRequest): The incoming request - id (str): The EMA id - doc_id (str): The document id - - Returns: - - """ - ema = get_object_or_404(Ema, id=id) - doc = get_object_or_404(EmaDocument, id=doc_id) - return remove_document( - request, - doc - ) - - -@login_required -@conservation_office_group_required -@shared_access_required(Ema, "id") -def state_remove_view(request: HttpRequest, id: str, state_id: str): - """ Renders a form for removing an EMA state - - Args: - request (HttpRequest): The incoming request - id (str): The ema id - state_id (str): The state's id - - Returns: - - """ - ema = get_object_or_404(Ema, id=id) - state = get_object_or_404(CompensationState, id=state_id) - form = RemoveCompensationStateModalForm(request.POST or None, instance=ema, state=state, request=request) - return form.process_request( - request, - msg_success=COMPENSATION_STATE_REMOVED, - redirect_url=reverse("ema:detail", args=(id,)) + "#related_data" - ) - - -@login_required -@conservation_office_group_required -@shared_access_required(Ema, "id") -def state_edit_view(request: HttpRequest, id: str, state_id: str): - """ Renders a form for editing an EMA state - - Args: - request (HttpRequest): The incoming request - id (str): The ema id - state_id (str): The state's id - - Returns: - - """ - ema = get_object_or_404(Ema, id=id) - state = get_object_or_404(CompensationState, id=state_id) - form = EditCompensationStateModalForm(request.POST or None, instance=ema, state=state, request=request) - return form.process_request( - request, - msg_success=COMPENSATION_STATE_EDITED, - redirect_url=reverse("ema:detail", args=(id,)) + "#related_data" - ) - - -@login_required -@conservation_office_group_required -@shared_access_required(Ema, "id") -def action_remove_view(request: HttpRequest, id: str, action_id: str): - """ Renders a form for removing an EMA action - - Args: - request (HttpRequest): The incoming request - id (str): The ema id - id (str): The action's id - - Returns: - - """ - ema = get_object_or_404(Ema, id=id) - action = get_object_or_404(CompensationAction, id=action_id) - form = RemoveCompensationActionModalForm(request.POST or None, instance=ema, action=action, request=request) - return form.process_request( - request, - msg_success=COMPENSATION_ACTION_REMOVED, - redirect_url=reverse("ema:detail", args=(id,)) + "#related_data" - ) - - -def report_view(request:HttpRequest, id: str): - """ Renders the public report view - - Args: - request (HttpRequest): The incoming request - id (str): The id of the intervention - - Returns: - - """ - # Reuse the compensation report template since EMAs are structurally identical - template = "ema/report/report.html" - ema = get_object_or_404(Ema, id=id) - - tab_title = _("Report {}").format(ema.identifier) - # If intervention is not recorded (yet or currently) we need to render another template without any data - if not ema.is_ready_for_publish(): - template = "report/unavailable.html" - context = { - TAB_TITLE_IDENTIFIER: tab_title, - } - context = BaseContext(request, context).context - return render(request, template, context) - - # Prepare data for map viewer - geom_form = SimpleGeomForm( - instance=ema, - ) - parcels = ema.get_underlying_parcels() - - qrcode_url = request.build_absolute_uri(reverse("ema:report", args=(id,))) - qrcode_img = generate_qr_code(qrcode_url, 10) - qrcode_lanis_url = ema.get_LANIS_link() - qrcode_img_lanis = generate_qr_code(qrcode_lanis_url, 7) - - # Order states by surface - before_states = ema.before_states.all().order_by("-surface").prefetch_related("biotope_type") - after_states = ema.after_states.all().order_by("-surface").prefetch_related("biotope_type") - actions = ema.actions.all().prefetch_related("action_type") - - context = { - "obj": ema, - "qrcode": { - "img": qrcode_img, - "url": qrcode_url - }, - "qrcode_lanis": { - "img": qrcode_img_lanis, - "url": qrcode_lanis_url - }, - "has_access": False, # disables action buttons during rendering - "before_states": before_states, - "after_states": after_states, - "geom_form": geom_form, - "parcels": parcels, - "actions": actions, - TAB_TITLE_IDENTIFIER: tab_title, - } - context = BaseContext(request, context).context - return render(request, template, context) - - -@login_required -def share_view(request: HttpRequest, id: str, token: str): - """ Performs sharing of an ema - - If token given in url is not valid, the user will be redirected to the dashboard - - Args: - request (HttpRequest): The incoming request - id (str): EMA's id - token (str): Access token for EMA - - Returns: - - """ - user = request.user - obj = get_object_or_404(Ema, id=id) - # Check tokens - if obj.access_token == token: - # Send different messages in case user has already been added to list of sharing users - if obj.is_shared_with(user): - messages.info( - request, - _("{} has already been shared with you").format(obj.identifier) - ) - else: - messages.success( - request, - _("{} has been shared with you").format(obj.identifier) - ) - obj.share_with_user(user) - return redirect("ema:detail", id=id) - else: - messages.error( - request, - _("Share link invalid"), - extra_tags="danger", - ) - return redirect("home") - - -@login_required -@conservation_office_group_required -@shared_access_required(Ema, "id") -def create_share_view(request: HttpRequest, id: str): - """ Renders sharing form for an Ema - - Args: - request (HttpRequest): The incoming request - id (str): Ema's id - - Returns: - - """ - obj = get_object_or_404(Ema, id=id) - form = ShareModalForm(request.POST or None, instance=obj, request=request) - return form.process_request( - request, - msg_success=_("Share settings updated") - ) - - -@login_required -@conservation_office_group_required -@shared_access_required(Ema, "id") -def deadline_edit_view(request: HttpRequest, id: str, deadline_id: str): - """ Renders a form for editing deadlines from a compensation - - Args: - request (HttpRequest): The incoming request - id (str): The compensation's id - deadline_id (str): The deadline's id - - Returns: - - """ - ema = get_object_or_404(Ema, id=id) - deadline = get_object_or_404(Deadline, id=deadline_id) - form = EditDeadlineModalForm(request.POST or None, instance=ema, deadline=deadline, request=request) - return form.process_request( - request, - msg_success=DEADLINE_EDITED, - redirect_url=reverse("ema:detail", args=(id,)) + "#related_data" - ) - - -@login_required -@conservation_office_group_required -@shared_access_required(Ema, "id") -def deadline_remove_view(request: HttpRequest, id: str, deadline_id: str): - """ Renders a form for removing deadlines from a compensation - - Args: - request (HttpRequest): The incoming request - id (str): The compensation's id - deadline_id (str): The deadline's id - - Returns: - - """ - ema = get_object_or_404(Ema, id=id) - deadline = get_object_or_404(Deadline, id=deadline_id) - form = RemoveDeadlineModalForm(request.POST or None, instance=ema, deadline=deadline, request=request) - return form.process_request( - request, - msg_success=DEADLINE_REMOVED, - redirect_url=reverse("ema:detail", args=(id,)) + "#related_data" - ) - - -@login_required -@conservation_office_group_required -@shared_access_required(Ema, "id") -def create_resubmission_view(request: HttpRequest, id: str): - """ Renders resubmission form for an EMA - - Args: - request (HttpRequest): The incoming request - id (str): EMA's id - - Returns: - - """ - ema = get_object_or_404(Ema, id=id) - form = ResubmissionModalForm(request.POST or None, instance=ema, request=request) - form.action_url = reverse("ema:resubmission-create", args=(id,)) - return form.process_request( - request, - msg_success=_("Resubmission set"), - redirect_url=reverse("ema:detail", args=(id,)) - ) diff --git a/ema/views/__init__.py b/ema/views/__init__.py new file mode 100644 index 00000000..3a996e1f --- /dev/null +++ b/ema/views/__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: 19.08.22 + +""" diff --git a/ema/views/action.py b/ema/views/action.py new file mode 100644 index 00000000..bd13646c --- /dev/null +++ b/ema/views/action.py @@ -0,0 +1,89 @@ +""" +Author: Michel Peltriaux +Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany +Contact: ksp-servicestelle@sgdnord.rlp.de +Created on: 19.08.22 + +""" +from django.contrib.auth.decorators import login_required +from django.http import HttpRequest +from django.shortcuts import get_object_or_404 +from django.urls import reverse + +from compensation.forms.modals.compensation_action import RemoveCompensationActionModalForm, \ + EditCompensationActionModalForm, NewCompensationActionModalForm +from compensation.models import CompensationAction +from ema.models import Ema +from konova.decorators import shared_access_required, conservation_office_group_required +from konova.utils.message_templates import COMPENSATION_ACTION_REMOVED, COMPENSATION_ACTION_EDITED, \ + COMPENSATION_ACTION_ADDED + + +@login_required +@conservation_office_group_required +@shared_access_required(Ema, "id") +def action_new_view(request: HttpRequest, id: str): + """ Renders a form for adding new actions for an EMA + + Args: + request (HttpRequest): The incoming request + id (str): The EMA's id to which the new state will be related + + Returns: + + """ + ema = get_object_or_404(Ema, id=id) + form = NewCompensationActionModalForm(request.POST or None, instance=ema, request=request) + return form.process_request( + request, + msg_success=COMPENSATION_ACTION_ADDED, + redirect_url=reverse("ema:detail", args=(id,)) + "#related_data" + ) + + +@login_required +@conservation_office_group_required +@shared_access_required(Ema, "id") +def action_edit_view(request: HttpRequest, id: str, action_id: str): + """ Renders a form for editing an actions for an EMA + + Args: + request (HttpRequest): The incoming request + id (str): The EMA's id + action_id (str): The action id + + Returns: + + """ + ema = get_object_or_404(Ema, id=id) + action = get_object_or_404(CompensationAction, id=action_id) + form = EditCompensationActionModalForm(request.POST or None, instance=ema, action=action, request=request) + return form.process_request( + request, + msg_success=COMPENSATION_ACTION_EDITED, + redirect_url=reverse("ema:detail", args=(id,)) + "#related_data" + ) + + +@login_required +@conservation_office_group_required +@shared_access_required(Ema, "id") +def action_remove_view(request: HttpRequest, id: str, action_id: str): + """ Renders a form for removing an EMA action + + Args: + request (HttpRequest): The incoming request + id (str): The ema id + id (str): The action's id + + Returns: + + """ + ema = get_object_or_404(Ema, id=id) + action = get_object_or_404(CompensationAction, id=action_id) + form = RemoveCompensationActionModalForm(request.POST or None, instance=ema, action=action, request=request) + return form.process_request( + request, + msg_success=COMPENSATION_ACTION_REMOVED, + redirect_url=reverse("ema:detail", args=(id,)) + "#related_data" + ) diff --git a/ema/views/deadline.py b/ema/views/deadline.py new file mode 100644 index 00000000..223ceeb0 --- /dev/null +++ b/ema/views/deadline.py @@ -0,0 +1,90 @@ +""" +Author: Michel Peltriaux +Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany +Contact: ksp-servicestelle@sgdnord.rlp.de +Created on: 19.08.22 + +""" +from django.contrib.auth.decorators import login_required +from django.http import HttpRequest +from django.shortcuts import get_object_or_404 +from django.urls import reverse + +from compensation.forms.modals.deadline import EditDeadlineModalForm, NewDeadlineModalForm +from ema.models import Ema +from konova.decorators import shared_access_required, conservation_office_group_required +from konova.forms.modals import RemoveDeadlineModalForm +from konova.models import Deadline +from konova.utils.message_templates import DEADLINE_REMOVED, DEADLINE_EDITED, DEADLINE_ADDED + + +@login_required +@conservation_office_group_required +@shared_access_required(Ema, "id") +def deadline_new_view(request: HttpRequest, id: str): + """ Renders a form for adding new states for an EMA + + Args: + request (HttpRequest): The incoming request + id (str): The EMA's id to which the new state will be related + + Returns: + + """ + ema = get_object_or_404(Ema, id=id) + form = NewDeadlineModalForm(request.POST or None, instance=ema, request=request) + return form.process_request( + request, + msg_success=DEADLINE_ADDED, + redirect_url=reverse("ema:detail", args=(id,)) + "#related_data" + ) + + +@login_required +@conservation_office_group_required +@shared_access_required(Ema, "id") +def deadline_edit_view(request: HttpRequest, id: str, deadline_id: str): + """ Renders a form for editing deadlines from a compensation + + Args: + request (HttpRequest): The incoming request + id (str): The compensation's id + deadline_id (str): The deadline's id + + Returns: + + """ + ema = get_object_or_404(Ema, id=id) + deadline = get_object_or_404(Deadline, id=deadline_id) + form = EditDeadlineModalForm(request.POST or None, instance=ema, deadline=deadline, request=request) + return form.process_request( + request, + msg_success=DEADLINE_EDITED, + redirect_url=reverse("ema:detail", args=(id,)) + "#related_data" + ) + + +@login_required +@conservation_office_group_required +@shared_access_required(Ema, "id") +def deadline_remove_view(request: HttpRequest, id: str, deadline_id: str): + """ Renders a form for removing deadlines from a compensation + + Args: + request (HttpRequest): The incoming request + id (str): The compensation's id + deadline_id (str): The deadline's id + + Returns: + + """ + ema = get_object_or_404(Ema, id=id) + deadline = get_object_or_404(Deadline, id=deadline_id) + form = RemoveDeadlineModalForm(request.POST or None, instance=ema, deadline=deadline, request=request) + return form.process_request( + request, + msg_success=DEADLINE_REMOVED, + redirect_url=reverse("ema:detail", args=(id,)) + "#related_data" + ) + + diff --git a/ema/views/document.py b/ema/views/document.py new file mode 100644 index 00000000..faacb5bc --- /dev/null +++ b/ema/views/document.py @@ -0,0 +1,111 @@ +""" +Author: Michel Peltriaux +Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany +Contact: ksp-servicestelle@sgdnord.rlp.de +Created on: 19.08.22 + +""" +from django.contrib.auth.decorators import login_required +from django.http import HttpRequest +from django.shortcuts import get_object_or_404 +from django.urls import reverse + +from ema.forms import NewEmaDocumentModalForm +from ema.models import Ema, EmaDocument +from konova.decorators import shared_access_required, conservation_office_group_required +from konova.forms.modals import EditDocumentModalForm +from konova.utils.documents import get_document, remove_document +from konova.utils.message_templates import DOCUMENT_ADDED, DOCUMENT_EDITED + + +@login_required +@conservation_office_group_required +@shared_access_required(Ema, "id") +def document_new_view(request: HttpRequest, id: str): + """ Renders a form for uploading new documents + + Args: + request (HttpRequest): The incoming request + id (str): The EMA's id to which the new document will be related + Returns: + + """ + ema = get_object_or_404(Ema, id=id) + form = NewEmaDocumentModalForm(request.POST or None, request.FILES or None, instance=ema, request=request) + return form.process_request( + request, + msg_success=DOCUMENT_ADDED, + redirect_url=reverse("ema:detail", args=(id,)) + "#related_data" + ) + + +@login_required +@conservation_office_group_required +@shared_access_required(Ema, "id") +def get_document_view(request: HttpRequest, id: str, doc_id: str): + """ Returns the document as downloadable file + + Wraps the generic document fetcher function from konova.utils. + + Args: + request (HttpRequest): The incoming request + id (str): The EMA id + doc_id (str): The document id + + Returns: + + """ + ema = get_object_or_404(Ema, id=id) + doc = get_object_or_404(EmaDocument, id=doc_id) + return get_document(doc) + + +@login_required +@conservation_office_group_required +@shared_access_required(Ema, "id") +def edit_document_view(request: HttpRequest, id: str, doc_id: str): + """ Removes the document from the database and file system + + Wraps the generic functionality from konova.utils. + + Args: + request (HttpRequest): The incoming request + id (str): The EMA id + doc_id (str): The document id + + Returns: + + """ + ema = get_object_or_404(Ema, id=id) + doc = get_object_or_404(EmaDocument, id=doc_id) + form = EditDocumentModalForm(request.POST or None, request.FILES or None, instance=ema, document=doc, request=request) + return form.process_request( + request, + DOCUMENT_EDITED, + reverse("ema:detail", args=(id,)) + "#related_data" + ) + + +@login_required +@conservation_office_group_required +@shared_access_required(Ema, "id") +def remove_document_view(request: HttpRequest, id:str, doc_id: str): + """ Removes the document from the database and file system + + Wraps the generic functionality from konova.utils. + + Args: + request (HttpRequest): The incoming request + id (str): The EMA id + doc_id (str): The document id + + Returns: + + """ + ema = get_object_or_404(Ema, id=id) + doc = get_object_or_404(EmaDocument, id=doc_id) + return remove_document( + request, + doc + ) + diff --git a/ema/views/ema.py b/ema/views/ema.py new file mode 100644 index 00000000..f2b4d3b8 --- /dev/null +++ b/ema/views/ema.py @@ -0,0 +1,237 @@ +""" +Author: Michel Peltriaux +Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany +Contact: ksp-servicestelle@sgdnord.rlp.de +Created on: 19.08.22 + +""" +from django.contrib import messages +from django.contrib.auth.decorators import login_required +from django.db.models import Sum +from django.http import HttpRequest, JsonResponse +from django.shortcuts import get_object_or_404, redirect, render +from django.urls import reverse +from django.utils.translation import gettext_lazy as _ + +from ema.forms import NewEmaForm, EditEmaForm +from ema.models import Ema +from ema.tables import EmaTable +from konova.contexts import BaseContext +from konova.decorators import shared_access_required, conservation_office_group_required +from konova.forms import SimpleGeomForm +from konova.forms.modals import RemoveModalForm +from konova.settings import DEFAULT_GROUP, ZB_GROUP, ETS_GROUP +from konova.sub_settings.context_settings import TAB_TITLE_IDENTIFIER +from konova.utils.message_templates import RECORDED_BLOCKS_EDIT, IDENTIFIER_REPLACED, FORM_INVALID +from konova.utils.user_checks import in_group + + +@login_required +def index_view(request: HttpRequest): + """ Renders the index view for EMAs + + Args: + request (HttpRequest): The incoming request + + Returns: + + """ + template = "generic_index.html" + emas = Ema.objects.filter( + deleted=None, + ).order_by( + "-modified" + ) + table = EmaTable( + request, + queryset=emas + ) + context = { + "table": table, + TAB_TITLE_IDENTIFIER: _("EMAs - Overview"), + } + context = BaseContext(request, context).context + return render(request, template, context) + + +@login_required +@conservation_office_group_required +def new_view(request: HttpRequest): + """ + Renders a view for a new eco account creation + + Args: + request (HttpRequest): The incoming request + + Returns: + + """ + template = "ema/form/view.html" + data_form = NewEmaForm(request.POST or None) + geom_form = SimpleGeomForm(request.POST or None, read_only=False) + if request.method == "POST": + if data_form.is_valid() and geom_form.is_valid(): + generated_identifier = data_form.cleaned_data.get("identifier", None) + ema = data_form.save(request.user, geom_form) + if generated_identifier != ema.identifier: + messages.info( + request, + IDENTIFIER_REPLACED.format( + generated_identifier, + ema.identifier + ) + ) + messages.success(request, _("EMA {} added").format(ema.identifier)) + return redirect("ema:detail", id=ema.id) + else: + messages.error(request, FORM_INVALID, extra_tags="danger",) + else: + # For clarification: nothing in this case + pass + context = { + "form": data_form, + "geom_form": geom_form, + TAB_TITLE_IDENTIFIER: _("New EMA"), + } + context = BaseContext(request, context).context + return render(request, template, context) + + +@login_required +@conservation_office_group_required +def new_id_view(request: HttpRequest): + """ JSON endpoint + + Provides fetching of free identifiers for e.g. AJAX calls + + """ + tmp = Ema() + identifier = tmp.generate_new_identifier() + while Ema.objects.filter(identifier=identifier).exists(): + identifier = tmp.generate_new_identifier() + return JsonResponse( + data={ + "gen_data": identifier + } + ) + + +@login_required +def detail_view(request: HttpRequest, id: str): + """ Renders the detail view of an EMA + + Args: + request (HttpRequest): The incoming request + id (str): The EMA id + + Returns: + + """ + template = "ema/detail/view.html" + ema = get_object_or_404(Ema, id=id, deleted=None) + + geom_form = SimpleGeomForm(instance=ema) + parcels = ema.get_underlying_parcels() + _user = request.user + is_data_shared = ema.is_shared_with(_user) + + # Order states according to surface + before_states = ema.before_states.all().order_by("-surface") + after_states = ema.after_states.all().order_by("-surface") + + # Precalculate logical errors between before- and after-states + # Sum() returns None in case of no states, so we catch that and replace it with 0 for easier handling + sum_before_states = before_states.aggregate(Sum("surface"))["surface__sum"] or 0 + sum_after_states = after_states.aggregate(Sum("surface"))["surface__sum"] or 0 + diff_states = abs(sum_before_states - sum_after_states) + + ema.set_status_messages(request) + + context = { + "obj": ema, + "geom_form": geom_form, + "parcels": parcels, + "has_access": is_data_shared, + "before_states": before_states, + "after_states": after_states, + "sum_before_states": sum_before_states, + "sum_after_states": sum_after_states, + "diff_states": diff_states, + "is_default_member": in_group(_user, DEFAULT_GROUP), + "is_zb_member": in_group(_user, ZB_GROUP), + "is_ets_member": in_group(_user, ETS_GROUP), + "LANIS_LINK": ema.get_LANIS_link(), + TAB_TITLE_IDENTIFIER: f"{ema.identifier} - {ema.title}", + "has_finished_deadlines": ema.get_finished_deadlines().exists(), + } + context = BaseContext(request, context).context + return render(request, template, context) + + +@login_required +@conservation_office_group_required +@shared_access_required(Ema, "id") +def edit_view(request: HttpRequest, id: str): + """ + Renders a view for editing compensations + + Args: + request (HttpRequest): The incoming request + + Returns: + + """ + template = "compensation/form/view.html" + # Get object from db + ema = get_object_or_404(Ema, id=id) + if ema.is_recorded: + messages.info( + request, + RECORDED_BLOCKS_EDIT + ) + return redirect("ema:detail", id=id) + + # Create forms, initialize with values from db/from POST request + data_form = EditEmaForm(request.POST or None, instance=ema) + geom_form = SimpleGeomForm(request.POST or None, read_only=False, instance=ema) + if request.method == "POST": + if data_form.is_valid() and geom_form.is_valid(): + # The data form takes the geom form for processing, as well as the performing user + ema = data_form.save(request.user, geom_form) + messages.success(request, _("EMA {} edited").format(ema.identifier)) + return redirect("ema:detail", id=ema.id) + else: + messages.error(request, FORM_INVALID, extra_tags="danger",) + else: + # For clarification: nothing in this case + pass + context = { + "form": data_form, + "geom_form": geom_form, + TAB_TITLE_IDENTIFIER: _("Edit {}").format(ema.identifier), + } + context = BaseContext(request, context).context + return render(request, template, context) + + +@login_required +@conservation_office_group_required +@shared_access_required(Ema, "id") +def remove_view(request: HttpRequest, id: str): + """ Renders a modal view for removing the EMA + + Args: + request (HttpRequest): The incoming request + id (str): The EMA's id + + Returns: + + """ + ema = get_object_or_404(Ema, id=id) + form = RemoveModalForm(request.POST or None, instance=ema, request=request) + return form.process_request( + request=request, + msg_success=_("EMA removed"), + redirect_url=reverse("ema:index"), + ) + diff --git a/ema/views/log.py b/ema/views/log.py new file mode 100644 index 00000000..3e3f869f --- /dev/null +++ b/ema/views/log.py @@ -0,0 +1,41 @@ +""" +Author: Michel Peltriaux +Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany +Contact: ksp-servicestelle@sgdnord.rlp.de +Created on: 19.08.22 + +""" +from django.contrib.auth.decorators import login_required +from django.http import HttpRequest +from django.shortcuts import get_object_or_404, render +from django.utils.translation import gettext_lazy as _ + +from ema.models import Ema +from konova.contexts import BaseContext +from konova.decorators import shared_access_required, conservation_office_group_required + + +@login_required +@conservation_office_group_required +@shared_access_required(Ema, "id") +def log_view(request: HttpRequest, id: str): + """ Renders a log view using modal + + Args: + request (HttpRequest): The incoming request + id (str): The EMA's id + + Returns: + + """ + ema = get_object_or_404(Ema, id=id) + template = "modal/modal_generic.html" + body_template = "log.html" + + context = { + "modal_body_template": body_template, + "log": ema.log.all(), + "modal_title": _("Log"), + } + context = BaseContext(request, context).context + return render(request, template, context) diff --git a/ema/views/record.py b/ema/views/record.py new file mode 100644 index 00000000..4ae40d2f --- /dev/null +++ b/ema/views/record.py @@ -0,0 +1,37 @@ +""" +Author: Michel Peltriaux +Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany +Contact: ksp-servicestelle@sgdnord.rlp.de +Created on: 19.08.22 + +""" +from django.contrib.auth.decorators import login_required +from django.http import HttpRequest +from django.shortcuts import get_object_or_404 +from django.utils.translation import gettext_lazy as _ + +from ema.models import Ema +from konova.decorators import shared_access_required, conservation_office_group_required +from konova.forms.modals import RecordModalForm + + +@login_required +@conservation_office_group_required +@shared_access_required(Ema, "id") +def record_view(request: HttpRequest, id: str): + """ Renders a modal view for recording the EMA + + Args: + request (HttpRequest): The incoming request + id (str): The EMA's id + + Returns: + + """ + ema = get_object_or_404(Ema, id=id) + msg_succ = _("{} unrecorded") if ema.recorded else _("{} recorded") + form = RecordModalForm(request.POST or None, instance=ema, request=request) + return form.process_request( + request=request, + msg_success=msg_succ.format("EMA"), + ) diff --git a/ema/views/report.py b/ema/views/report.py new file mode 100644 index 00000000..daea0b44 --- /dev/null +++ b/ema/views/report.py @@ -0,0 +1,79 @@ +""" +Author: Michel Peltriaux +Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany +Contact: ksp-servicestelle@sgdnord.rlp.de +Created on: 19.08.22 + +""" +from django.http import HttpRequest +from django.shortcuts import get_object_or_404, render +from django.urls import reverse +from django.utils.translation import gettext_lazy as _ + +from ema.models import Ema +from konova.contexts import BaseContext +from konova.forms import SimpleGeomForm +from konova.sub_settings.context_settings import TAB_TITLE_IDENTIFIER +from konova.utils.generators import generate_qr_code + + +def report_view(request:HttpRequest, id: str): + """ Renders the public report view + + Args: + request (HttpRequest): The incoming request + id (str): The id of the intervention + + Returns: + + """ + # Reuse the compensation report template since EMAs are structurally identical + template = "ema/report/report.html" + ema = get_object_or_404(Ema, id=id) + + tab_title = _("Report {}").format(ema.identifier) + # If intervention is not recorded (yet or currently) we need to render another template without any data + if not ema.is_ready_for_publish(): + template = "report/unavailable.html" + context = { + TAB_TITLE_IDENTIFIER: tab_title, + } + context = BaseContext(request, context).context + return render(request, template, context) + + # Prepare data for map viewer + geom_form = SimpleGeomForm( + instance=ema, + ) + parcels = ema.get_underlying_parcels() + + qrcode_url = request.build_absolute_uri(reverse("ema:report", args=(id,))) + qrcode_img = generate_qr_code(qrcode_url, 10) + qrcode_lanis_url = ema.get_LANIS_link() + qrcode_img_lanis = generate_qr_code(qrcode_lanis_url, 7) + + # Order states by surface + before_states = ema.before_states.all().order_by("-surface").prefetch_related("biotope_type") + after_states = ema.after_states.all().order_by("-surface").prefetch_related("biotope_type") + actions = ema.actions.all().prefetch_related("action_type") + + context = { + "obj": ema, + "qrcode": { + "img": qrcode_img, + "url": qrcode_url + }, + "qrcode_lanis": { + "img": qrcode_img_lanis, + "url": qrcode_lanis_url + }, + "has_access": False, # disables action buttons during rendering + "before_states": before_states, + "after_states": after_states, + "geom_form": geom_form, + "parcels": parcels, + "actions": actions, + TAB_TITLE_IDENTIFIER: tab_title, + } + context = BaseContext(request, context).context + return render(request, template, context) diff --git a/ema/views/resubmission.py b/ema/views/resubmission.py new file mode 100644 index 00000000..838cab3a --- /dev/null +++ b/ema/views/resubmission.py @@ -0,0 +1,39 @@ +""" +Author: Michel Peltriaux +Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany +Contact: ksp-servicestelle@sgdnord.rlp.de +Created on: 19.08.22 + +""" +from django.contrib.auth.decorators import login_required +from django.http import HttpRequest +from django.shortcuts import get_object_or_404 +from django.urls import reverse +from django.utils.translation import gettext_lazy as _ + +from ema.models import Ema +from konova.decorators import shared_access_required, conservation_office_group_required +from konova.forms.modals import ResubmissionModalForm + + +@login_required +@conservation_office_group_required +@shared_access_required(Ema, "id") +def create_resubmission_view(request: HttpRequest, id: str): + """ Renders resubmission form for an EMA + + Args: + request (HttpRequest): The incoming request + id (str): EMA's id + + Returns: + + """ + ema = get_object_or_404(Ema, id=id) + form = ResubmissionModalForm(request.POST or None, instance=ema, request=request) + form.action_url = reverse("ema:resubmission-create", args=(id,)) + return form.process_request( + request, + msg_success=_("Resubmission set"), + redirect_url=reverse("ema:detail", args=(id,)) + ) diff --git a/ema/views/share.py b/ema/views/share.py new file mode 100644 index 00000000..83aae91d --- /dev/null +++ b/ema/views/share.py @@ -0,0 +1,77 @@ +""" +Author: Michel Peltriaux +Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany +Contact: ksp-servicestelle@sgdnord.rlp.de +Created on: 19.08.22 + +""" +from django.contrib import messages +from django.contrib.auth.decorators import login_required +from django.http import HttpRequest +from django.shortcuts import get_object_or_404, redirect +from django.utils.translation import gettext_lazy as _ + +from ema.models import Ema +from intervention.forms.modals.share import ShareModalForm +from konova.decorators import conservation_office_group_required, shared_access_required + + +@login_required +def share_view(request: HttpRequest, id: str, token: str): + """ Performs sharing of an ema + + If token given in url is not valid, the user will be redirected to the dashboard + + Args: + request (HttpRequest): The incoming request + id (str): EMA's id + token (str): Access token for EMA + + Returns: + + """ + user = request.user + obj = get_object_or_404(Ema, id=id) + # Check tokens + if obj.access_token == token: + # Send different messages in case user has already been added to list of sharing users + if obj.is_shared_with(user): + messages.info( + request, + _("{} has already been shared with you").format(obj.identifier) + ) + else: + messages.success( + request, + _("{} has been shared with you").format(obj.identifier) + ) + obj.share_with_user(user) + return redirect("ema:detail", id=id) + else: + messages.error( + request, + _("Share link invalid"), + extra_tags="danger", + ) + return redirect("home") + + +@login_required +@conservation_office_group_required +@shared_access_required(Ema, "id") +def create_share_view(request: HttpRequest, id: str): + """ Renders sharing form for an Ema + + Args: + request (HttpRequest): The incoming request + id (str): Ema's id + + Returns: + + """ + obj = get_object_or_404(Ema, id=id) + form = ShareModalForm(request.POST or None, instance=obj, request=request) + return form.process_request( + request, + msg_success=_("Share settings updated") + ) diff --git a/ema/views/state.py b/ema/views/state.py new file mode 100644 index 00000000..1c7b0a44 --- /dev/null +++ b/ema/views/state.py @@ -0,0 +1,90 @@ +""" +Author: Michel Peltriaux +Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany +Contact: ksp-servicestelle@sgdnord.rlp.de +Created on: 19.08.22 + +""" +from django.contrib.auth.decorators import login_required +from django.http import HttpRequest +from django.shortcuts import get_object_or_404 +from django.urls import reverse + +from compensation.forms.modals.state import NewCompensationStateModalForm, RemoveCompensationStateModalForm, \ + EditCompensationStateModalForm +from compensation.models import CompensationState +from ema.models import Ema +from konova.decorators import conservation_office_group_required, shared_access_required +from konova.utils.message_templates import COMPENSATION_STATE_ADDED, COMPENSATION_STATE_REMOVED, \ + COMPENSATION_STATE_EDITED + + +@login_required +@conservation_office_group_required +@shared_access_required(Ema, "id") +def state_new_view(request: HttpRequest, id: str): + """ Renders a form for adding new states for an EMA + + Args: + request (HttpRequest): The incoming request + id (str): The EMA's id to which the new state will be related + + Returns: + + """ + ema = get_object_or_404(Ema, id=id) + form = NewCompensationStateModalForm(request.POST or None, instance=ema, request=request) + return form.process_request( + request, + msg_success=COMPENSATION_STATE_ADDED, + redirect_url=reverse("ema:detail", args=(id,)) + "#related_data" + ) + + +@login_required +@conservation_office_group_required +@shared_access_required(Ema, "id") +def state_remove_view(request: HttpRequest, id: str, state_id: str): + """ Renders a form for removing an EMA state + + Args: + request (HttpRequest): The incoming request + id (str): The ema id + state_id (str): The state's id + + Returns: + + """ + ema = get_object_or_404(Ema, id=id) + state = get_object_or_404(CompensationState, id=state_id) + form = RemoveCompensationStateModalForm(request.POST or None, instance=ema, state=state, request=request) + return form.process_request( + request, + msg_success=COMPENSATION_STATE_REMOVED, + redirect_url=reverse("ema:detail", args=(id,)) + "#related_data" + ) + + +@login_required +@conservation_office_group_required +@shared_access_required(Ema, "id") +def state_edit_view(request: HttpRequest, id: str, state_id: str): + """ Renders a form for editing an EMA state + + Args: + request (HttpRequest): The incoming request + id (str): The ema id + state_id (str): The state's id + + Returns: + + """ + ema = get_object_or_404(Ema, id=id) + state = get_object_or_404(CompensationState, id=state_id) + form = EditCompensationStateModalForm(request.POST or None, instance=ema, state=state, request=request) + return form.process_request( + request, + msg_success=COMPENSATION_STATE_EDITED, + redirect_url=reverse("ema:detail", args=(id,)) + "#related_data" + ) + -- 2.45.2 From 8c3e8b596ac9c417b266314f7761e607b31214d3 Mon Sep 17 00:00:00 2001 From: mpeltriaux Date: Fri, 19 Aug 2022 08:12:32 +0200 Subject: [PATCH 10/21] Compensation views * splits compensation/views/compensation.py (+700 lines) into separate files in new module * view files can now be found in /compensation/views/compensation/... --- compensation/urls/compensation.py | 12 +- compensation/views/__init__.py | 1 - compensation/views/compensation.py | 685 ------------------ compensation/views/compensation/__init__.py | 7 + compensation/views/compensation/action.py | 89 +++ .../views/compensation/compensation.py | 272 +++++++ compensation/views/compensation/deadline.py | 89 +++ compensation/views/compensation/document.py | 111 +++ compensation/views/compensation/log.py | 41 ++ compensation/views/compensation/report.py | 79 ++ .../views/compensation/resubmission.py | 39 + compensation/views/compensation/state.py | 89 +++ 12 files changed, 827 insertions(+), 687 deletions(-) delete mode 100644 compensation/views/compensation.py create mode 100644 compensation/views/compensation/__init__.py create mode 100644 compensation/views/compensation/action.py create mode 100644 compensation/views/compensation/compensation.py create mode 100644 compensation/views/compensation/deadline.py create mode 100644 compensation/views/compensation/document.py create mode 100644 compensation/views/compensation/log.py create mode 100644 compensation/views/compensation/report.py create mode 100644 compensation/views/compensation/resubmission.py create mode 100644 compensation/views/compensation/state.py diff --git a/compensation/urls/compensation.py b/compensation/urls/compensation.py index 66020055..75ec9297 100644 --- a/compensation/urls/compensation.py +++ b/compensation/urls/compensation.py @@ -6,7 +6,17 @@ Created on: 24.08.21 """ from django.urls import path -from compensation.views.compensation import * + +from compensation.views.compensation.document import edit_document_view, new_document_view, remove_document_view, \ + get_document_view +from compensation.views.compensation.resubmission import create_resubmission_view +from compensation.views.compensation.report import report_view +from compensation.views.compensation.deadline import deadline_new_view, deadline_edit_view, deadline_remove_view +from compensation.views.compensation.action import action_edit_view, action_new_view, action_remove_view +from compensation.views.compensation.state import state_new_view, state_remove_view, state_edit_view +from compensation.views.compensation.compensation import index_view, new_view, new_id_view, detail_view, edit_view, \ + remove_view +from compensation.views.compensation.log import log_view urlpatterns = [ # Main compensation diff --git a/compensation/views/__init__.py b/compensation/views/__init__.py index db03b5a1..dc6f522a 100644 --- a/compensation/views/__init__.py +++ b/compensation/views/__init__.py @@ -5,6 +5,5 @@ Contact: michel.peltriaux@sgdnord.rlp.de Created on: 16.11.21 """ -from .compensation import * from .eco_account import * from .payment import * diff --git a/compensation/views/compensation.py b/compensation/views/compensation.py deleted file mode 100644 index c1bec047..00000000 --- a/compensation/views/compensation.py +++ /dev/null @@ -1,685 +0,0 @@ -from django.contrib.auth.decorators import login_required -from django.core.exceptions import ObjectDoesNotExist -from django.db.models import Sum -from django.http import HttpRequest, JsonResponse -from django.shortcuts import render -from django.utils.translation import gettext_lazy as _ - -from compensation.forms.compensation import NewCompensationForm, EditCompensationForm -from compensation.forms.modals.state import NewCompensationStateModalForm, RemoveCompensationStateModalForm, EditCompensationStateModalForm -from compensation.forms.modals.document import NewCompensationDocumentModalForm -from compensation.forms.modals.compensation_action import NewCompensationActionModalForm, \ - EditCompensationActionModalForm, RemoveCompensationActionModalForm -from compensation.forms.modals.deadline import NewDeadlineModalForm, EditDeadlineModalForm -from compensation.models import Compensation, CompensationState, CompensationAction, CompensationDocument -from compensation.tables.compensation import CompensationTable -from intervention.models import Intervention -from konova.contexts import BaseContext -from konova.decorators import * -from konova.forms.modals import RemoveModalForm,RemoveDeadlineModalForm, EditDocumentModalForm, \ - ResubmissionModalForm -from konova.forms import SimpleGeomForm -from konova.models import Deadline -from konova.sub_settings.context_settings import TAB_TITLE_IDENTIFIER -from konova.utils.documents import get_document, remove_document -from konova.utils.generators import generate_qr_code -from konova.utils.message_templates import FORM_INVALID, IDENTIFIER_REPLACED, \ - CHECKED_RECORDED_RESET, COMPENSATION_ADDED_TEMPLATE, COMPENSATION_REMOVED_TEMPLATE, DOCUMENT_ADDED, \ - COMPENSATION_STATE_REMOVED, COMPENSATION_STATE_ADDED, COMPENSATION_ACTION_REMOVED, COMPENSATION_ACTION_ADDED, \ - DEADLINE_ADDED, DEADLINE_REMOVED, DOCUMENT_EDITED, COMPENSATION_STATE_EDITED, COMPENSATION_ACTION_EDITED, \ - DEADLINE_EDITED, RECORDED_BLOCKS_EDIT, PARAMS_INVALID, DATA_CHECKED_PREVIOUSLY_TEMPLATE -from konova.utils.user_checks import in_group - - -@login_required -@any_group_check -def index_view(request: HttpRequest): - """ - Renders the index view for compensation - - Args: - request (HttpRequest): The incoming request - - Returns: - A rendered view - """ - template = "generic_index.html" - 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 - ) - table = CompensationTable( - request=request, - queryset=compensations - ) - context = { - "table": table, - TAB_TITLE_IDENTIFIER: _("Compensations - Overview"), - } - context = BaseContext(request, context).context - return render(request, template, context) - - -@login_required -@default_group_required -@shared_access_required(Intervention, "intervention_id") -def new_view(request: HttpRequest, intervention_id: str = None): - """ - Renders a view for a new compensation creation - - Args: - request (HttpRequest): The incoming request - - Returns: - - """ - template = "compensation/form/view.html" - if intervention_id is not None: - try: - intervention = Intervention.objects.get(id=intervention_id) - except ObjectDoesNotExist: - messages.error(request, PARAMS_INVALID) - return redirect("home") - if intervention.is_recorded: - messages.info( - request, - RECORDED_BLOCKS_EDIT - ) - return redirect("intervention:detail", id=intervention_id) - - data_form = NewCompensationForm(request.POST or None, intervention_id=intervention_id) - geom_form = SimpleGeomForm(request.POST or None, read_only=False) - if request.method == "POST": - if data_form.is_valid() and geom_form.is_valid(): - generated_identifier = data_form.cleaned_data.get("identifier", None) - comp = data_form.save(request.user, geom_form) - if generated_identifier != comp.identifier: - messages.info( - request, - IDENTIFIER_REPLACED.format( - generated_identifier, - comp.identifier - ) - ) - messages.success(request, COMPENSATION_ADDED_TEMPLATE.format(comp.identifier)) - return redirect("compensation:detail", id=comp.id) - else: - messages.error(request, FORM_INVALID, extra_tags="danger",) - else: - # For clarification: nothing in this case - pass - context = { - "form": data_form, - "geom_form": geom_form, - TAB_TITLE_IDENTIFIER: _("New compensation"), - } - context = BaseContext(request, context).context - return render(request, template, context) - - -@login_required -@default_group_required -def new_id_view(request: HttpRequest): - """ JSON endpoint - - Provides fetching of free identifiers for e.g. AJAX calls - - """ - tmp = Compensation() - identifier = tmp.generate_new_identifier() - while Compensation.objects.filter(identifier=identifier).exists(): - identifier = tmp.generate_new_identifier() - return JsonResponse( - data={ - "gen_data": identifier - } - ) - - -@login_required -@default_group_required -@shared_access_required(Compensation, "id") -def edit_view(request: HttpRequest, id: str): - """ - Renders a view for editing compensations - - Args: - request (HttpRequest): The incoming request - - Returns: - - """ - template = "compensation/form/view.html" - # Get object from db - comp = get_object_or_404(Compensation, id=id) - if comp.is_recorded: - messages.info( - request, - RECORDED_BLOCKS_EDIT - ) - return redirect("compensation:detail", id=id) - - # Create forms, initialize with values from db/from POST request - data_form = EditCompensationForm(request.POST or None, instance=comp) - geom_form = SimpleGeomForm(request.POST or None, read_only=False, instance=comp) - if request.method == "POST": - if data_form.is_valid() and geom_form.is_valid(): - # Preserve state of intervention recorded/checked to determine whether the user must be informed or not - # about a change of the recorded/checked state - intervention_recorded = comp.intervention.recorded is not None - intervention_checked = comp.intervention.checked is not None - - # The data form takes the geom form for processing, as well as the performing user - comp = data_form.save(request.user, geom_form) - if intervention_recorded or intervention_checked: - messages.info(request, CHECKED_RECORDED_RESET) - messages.success(request, _("Compensation {} edited").format(comp.identifier)) - return redirect("compensation:detail", id=comp.id) - else: - messages.error(request, FORM_INVALID, extra_tags="danger",) - else: - # For clarification: nothing in this case - pass - context = { - "form": data_form, - "geom_form": geom_form, - TAB_TITLE_IDENTIFIER: _("Edit {}").format(comp.identifier), - } - context = BaseContext(request, context).context - return render(request, template, context) - - -@login_required -@any_group_check -def detail_view(request: HttpRequest, id: str): - """ Renders a detail view for a compensation - - Args: - request (HttpRequest): The incoming request - id (str): The compensation's id - - Returns: - - """ - template = "compensation/detail/compensation/view.html" - comp = get_object_or_404(Compensation, id=id) - geom_form = SimpleGeomForm(instance=comp) - parcels = comp.get_underlying_parcels() - _user = request.user - is_data_shared = comp.intervention.is_shared_with(_user) - - # Order states according to surface - before_states = comp.before_states.all().prefetch_related("biotope_type").order_by("-surface") - after_states = comp.after_states.all().prefetch_related("biotope_type").order_by("-surface") - actions = comp.actions.all().prefetch_related("action_type") - - # Precalculate logical errors between before- and after-states - # Sum() returns None in case of no states, so we catch that and replace it with 0 for easier handling - sum_before_states = before_states.aggregate(Sum("surface"))["surface__sum"] or 0 - sum_after_states = after_states.aggregate(Sum("surface"))["surface__sum"] or 0 - diff_states = abs(sum_before_states - sum_after_states) - - request = comp.set_status_messages(request) - - last_checked = comp.intervention.get_last_checked_action() - last_checked_tooltip = "" - if last_checked: - last_checked_tooltip = DATA_CHECKED_PREVIOUSLY_TEMPLATE.format(last_checked.get_timestamp_str_formatted(), last_checked.user) - - context = { - "obj": comp, - "last_checked": last_checked, - "last_checked_tooltip": last_checked_tooltip, - "geom_form": geom_form, - "parcels": parcels, - "has_access": is_data_shared, - "actions": actions, - "before_states": before_states, - "after_states": after_states, - "sum_before_states": sum_before_states, - "sum_after_states": sum_after_states, - "diff_states": diff_states, - "is_default_member": in_group(_user, DEFAULT_GROUP), - "is_zb_member": in_group(_user, ZB_GROUP), - "is_ets_member": in_group(_user, ETS_GROUP), - "LANIS_LINK": comp.get_LANIS_link(), - TAB_TITLE_IDENTIFIER: f"{comp.identifier} - {comp.title}", - "has_finished_deadlines": comp.get_finished_deadlines().exists(), - } - context = BaseContext(request, context).context - return render(request, template, context) - - -@login_required -@default_group_required -@shared_access_required(Compensation, "id") -def log_view(request: HttpRequest, id: str): - """ Renders a log view using modal - - Args: - request (HttpRequest): The incoming request - id (str): The compensation's id - - Returns: - - """ - comp = get_object_or_404(Compensation, id=id) - template = "modal/modal_generic.html" - body_template = "log.html" - - context = { - "modal_body_template": body_template, - "log": comp.log.all(), - "modal_title": _("Log"), - } - context = BaseContext(request, context).context - return render(request, template, context) - - -@login_required -@default_group_required -@shared_access_required(Compensation, "id") -def remove_view(request: HttpRequest, id: str): - """ Renders a modal view for removing the compensation - - Args: - request (HttpRequest): The incoming request - id (str): The compensation's id - - Returns: - - """ - comp = get_object_or_404(Compensation, id=id) - form = RemoveModalForm(request.POST or None, instance=comp, request=request) - return form.process_request( - request=request, - msg_success=COMPENSATION_REMOVED_TEMPLATE.format(comp.identifier), - redirect_url=reverse("compensation:index"), - ) - - -@login_required -@default_group_required -@shared_access_required(Compensation, "id") -def new_document_view(request: HttpRequest, id: str): - """ Renders a form for uploading new documents - - Args: - request (HttpRequest): The incoming request - id (str): The compensation's id to which the new document will be related - Returns: - - """ - comp = get_object_or_404(Compensation, id=id) - form = NewCompensationDocumentModalForm(request.POST or None, request.FILES or None, instance=comp, request=request) - return form.process_request( - request, - msg_success=DOCUMENT_ADDED, - redirect_url=reverse("compensation:detail", args=(id,)) + "#related_data" - ) - - -@login_required -@default_group_required -@shared_access_required(Compensation, "id") -def get_document_view(request: HttpRequest, id: str, doc_id: str): - """ Returns the document as downloadable file - - Wraps the generic document fetcher function from konova.utils. - - Args: - request (HttpRequest): The incoming request - id (str): The compensation id - doc_id (str): The document id - - Returns: - - """ - comp = get_object_or_404(Compensation, id=id) - doc = get_object_or_404(CompensationDocument, id=doc_id) - return get_document(doc) - - -@login_required -@default_group_required -@shared_access_required(Compensation, "id") -def remove_document_view(request: HttpRequest, id: str, doc_id: str): - """ Removes the document from the database and file system - - Wraps the generic functionality from konova.utils. - - Args: - request (HttpRequest): The incoming request - id (str): The compensation id - doc_id (str): The document id - - Returns: - - """ - comp = get_object_or_404(Compensation, id=id) - doc = get_object_or_404(CompensationDocument, id=doc_id) - return remove_document( - request, - doc - ) - - -@login_required -@default_group_required -@shared_access_required(Compensation, "id") -def edit_document_view(request: HttpRequest, id: str, doc_id: str): - """ Removes the document from the database and file system - - Wraps the generic functionality from konova.utils. - - Args: - request (HttpRequest): The incoming request - id (str): The compensation id - doc_id (str): The document id - - Returns: - - """ - comp = get_object_or_404(Compensation, id=id) - doc = get_object_or_404(CompensationDocument, id=doc_id) - form = EditDocumentModalForm(request.POST or None, request.FILES or None, instance=comp, document=doc, request=request) - return form.process_request( - request, - DOCUMENT_EDITED, - reverse("compensation:detail", args=(id,)) + "#related_data" - ) - - -@login_required -@default_group_required -@shared_access_required(Compensation, "id") -def state_new_view(request: HttpRequest, id: str): - """ Renders a form for adding new states for a compensation - - Args: - request (HttpRequest): The incoming request - id (str): The compensation's id to which the new state will be related - - Returns: - - """ - comp = get_object_or_404(Compensation, id=id) - form = NewCompensationStateModalForm(request.POST or None, instance=comp, request=request) - return form.process_request( - request, - msg_success=COMPENSATION_STATE_ADDED, - redirect_url=reverse("compensation:detail", args=(id,)) + "#related_data" - ) - - -@login_required -@default_group_required -@shared_access_required(Compensation, "id") -def action_new_view(request: HttpRequest, id: str): - """ Renders a form for adding new actions for a compensation - - Args: - request (HttpRequest): The incoming request - id (str): The compensation's id to which the new state will be related - - Returns: - - """ - comp = get_object_or_404(Compensation, id=id) - form = NewCompensationActionModalForm(request.POST or None, instance=comp, request=request) - return form.process_request( - request, - msg_success=COMPENSATION_ACTION_ADDED, - redirect_url=reverse("compensation:detail", args=(id,)) + "#related_data" - ) - - -@login_required -@default_group_required -@shared_access_required(Compensation, "id") -def action_edit_view(request: HttpRequest, id: str, action_id: str): - """ Renders a form for editing actions for a compensation - - Args: - request (HttpRequest): The incoming request - id (str): The compensation's id - action_id (str): The action's id - - Returns: - - """ - comp = get_object_or_404(Compensation, id=id) - action = get_object_or_404(CompensationAction, id=action_id) - form = EditCompensationActionModalForm(request.POST or None, instance=comp, action=action, request=request) - return form.process_request( - request, - msg_success=COMPENSATION_ACTION_EDITED, - redirect_url=reverse("compensation:detail", args=(id,)) + "#related_data" - ) - - -@login_required -@default_group_required -@shared_access_required(Compensation, "id") -def deadline_new_view(request: HttpRequest, id: str): - """ Renders a form for adding new states for a compensation - - Args: - request (HttpRequest): The incoming request - id (str): The compensation's id to which the new state will be related - - Returns: - - """ - comp = get_object_or_404(Compensation, id=id) - form = NewDeadlineModalForm(request.POST or None, instance=comp, request=request) - return form.process_request( - request, - msg_success=DEADLINE_ADDED, - redirect_url=reverse("compensation:detail", args=(id,)) + "#related_data" - ) - - -@login_required -@default_group_required -@shared_access_required(Compensation, "id") -def deadline_edit_view(request: HttpRequest, id: str, deadline_id: str): - """ Renders a form for editing deadlines from a compensation - - Args: - request (HttpRequest): The incoming request - id (str): The compensation's id - deadline_id (str): The deadline's id - - Returns: - - """ - comp = get_object_or_404(Compensation, id=id) - deadline = get_object_or_404(Deadline, id=deadline_id) - form = EditDeadlineModalForm(request.POST or None, instance=comp, deadline=deadline, request=request) - return form.process_request( - request, - msg_success=DEADLINE_EDITED, - redirect_url=reverse("compensation:detail", args=(id,)) + "#related_data" - ) - - -@login_required -@default_group_required -@shared_access_required(Compensation, "id") -def deadline_remove_view(request: HttpRequest, id: str, deadline_id: str): - """ Renders a form for removing deadlines from a compensation - - Args: - request (HttpRequest): The incoming request - id (str): The compensation's id - deadline_id (str): The deadline's id - - Returns: - - """ - comp = get_object_or_404(Compensation, id=id) - deadline = get_object_or_404(Deadline, id=deadline_id) - form = RemoveDeadlineModalForm(request.POST or None, instance=comp, deadline=deadline, request=request) - return form.process_request( - request, - msg_success=DEADLINE_REMOVED, - redirect_url=reverse("compensation:detail", args=(id,)) + "#related_data" - ) - - -@login_required -@default_group_required -@shared_access_required(Compensation, "id") -def state_remove_view(request: HttpRequest, id: str, state_id: str): - """ Renders a form for removing a compensation state - - Args: - request (HttpRequest): The incoming request - id (str): The compensation's id - state_id (str): The state's id - - Returns: - - """ - comp = get_object_or_404(Compensation, id=id) - state = get_object_or_404(CompensationState, id=state_id) - form = RemoveCompensationStateModalForm(request.POST or None, instance=comp, state=state, request=request) - return form.process_request( - request, - msg_success=COMPENSATION_STATE_REMOVED, - redirect_url=reverse("compensation:detail", args=(id,)) + "#related_data" - ) - - -@login_required -@default_group_required -@shared_access_required(Compensation, "id") -def state_edit_view(request: HttpRequest, id: str, state_id: str): - """ Renders a form for editing a compensation state - - Args: - request (HttpRequest): The incoming request - id (str): The compensation's id - state_id (str): The state's id - - Returns: - - """ - comp = get_object_or_404(Compensation, id=id) - state = get_object_or_404(CompensationState, id=state_id) - form = EditCompensationStateModalForm(request.POST or None, instance=comp, state=state, request=request) - return form.process_request( - request, - msg_success=COMPENSATION_STATE_EDITED, - redirect_url=reverse("compensation:detail", args=(id,)) + "#related_data" - ) - - -@login_required -@default_group_required -@shared_access_required(Compensation, "id") -def action_remove_view(request: HttpRequest, id: str, action_id: str): - """ Renders a form for removing a compensation action - - Args: - request (HttpRequest): The incoming request - id (str): The compensation's id - id (str): The action's id - - Returns: - - """ - comp = get_object_or_404(Compensation, id=id) - action = get_object_or_404(CompensationAction, id=action_id) - form = RemoveCompensationActionModalForm(request.POST or None, instance=comp, action=action, request=request) - return form.process_request( - request, - msg_success=COMPENSATION_ACTION_REMOVED, - redirect_url=reverse("compensation:detail", args=(id,)) + "#related_data" - ) - - -def report_view(request: HttpRequest, id: str): - """ Renders the public report view - - Args: - request (HttpRequest): The incoming request - id (str): The id of the intervention - - Returns: - - """ - # Reuse the compensation report template since compensations are structurally identical - template = "compensation/report/compensation/report.html" - comp = get_object_or_404(Compensation, id=id) - - tab_title = _("Report {}").format(comp.identifier) - # If intervention is not recorded (yet or currently) we need to render another template without any data - if not comp.is_ready_for_publish(): - template = "report/unavailable.html" - context = { - TAB_TITLE_IDENTIFIER: tab_title, - } - context = BaseContext(request, context).context - return render(request, template, context) - - # Prepare data for map viewer - geom_form = SimpleGeomForm( - instance=comp - ) - parcels = comp.get_underlying_parcels() - - qrcode_url = request.build_absolute_uri(reverse("compensation:report", args=(id,))) - qrcode_img = generate_qr_code(qrcode_url, 10) - qrcode_lanis_url = comp.get_LANIS_link() - qrcode_img_lanis = generate_qr_code(qrcode_lanis_url, 7) - - # Order states by surface - before_states = comp.before_states.all().order_by("-surface").prefetch_related("biotope_type") - after_states = comp.after_states.all().order_by("-surface").prefetch_related("biotope_type") - actions = comp.actions.all().prefetch_related("action_type") - - context = { - "obj": comp, - "qrcode": { - "img": qrcode_img, - "url": qrcode_url, - }, - "qrcode_lanis": { - "img": qrcode_img_lanis, - "url": qrcode_lanis_url, - }, - "has_access": False, # disables action buttons during rendering - "before_states": before_states, - "after_states": after_states, - "geom_form": geom_form, - "parcels": parcels, - "actions": actions, - TAB_TITLE_IDENTIFIER: tab_title, - } - context = BaseContext(request, context).context - return render(request, template, context) - - -@login_required -@default_group_required -@shared_access_required(Compensation, "id") -def create_resubmission_view(request: HttpRequest, id: str): - """ Renders resubmission form for a compensation - - Args: - request (HttpRequest): The incoming request - id (str): Compensation's id - - Returns: - - """ - com = get_object_or_404(Compensation, id=id) - form = ResubmissionModalForm(request.POST or None, instance=com, request=request) - form.action_url = reverse("compensation:resubmission-create", args=(id,)) - return form.process_request( - request, - msg_success=_("Resubmission set"), - redirect_url=reverse("compensation:detail", args=(id,)) - ) diff --git a/compensation/views/compensation/__init__.py b/compensation/views/compensation/__init__.py new file mode 100644 index 00000000..3a996e1f --- /dev/null +++ b/compensation/views/compensation/__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: 19.08.22 + +""" diff --git a/compensation/views/compensation/action.py b/compensation/views/compensation/action.py new file mode 100644 index 00000000..54f6bc39 --- /dev/null +++ b/compensation/views/compensation/action.py @@ -0,0 +1,89 @@ +""" +Author: Michel Peltriaux +Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany +Contact: ksp-servicestelle@sgdnord.rlp.de +Created on: 19.08.22 + +""" +from django.contrib.auth.decorators import login_required +from django.http import HttpRequest +from django.shortcuts import get_object_or_404 +from django.urls import reverse + +from compensation.forms.modals.compensation_action import RemoveCompensationActionModalForm, \ + EditCompensationActionModalForm, NewCompensationActionModalForm +from compensation.models import Compensation, CompensationAction +from konova.decorators import shared_access_required, default_group_required +from konova.utils.message_templates import COMPENSATION_ACTION_REMOVED, COMPENSATION_ACTION_EDITED, \ + COMPENSATION_ACTION_ADDED + + +@login_required +@default_group_required +@shared_access_required(Compensation, "id") +def action_new_view(request: HttpRequest, id: str): + """ Renders a form for adding new actions for a compensation + + Args: + request (HttpRequest): The incoming request + id (str): The compensation's id to which the new state will be related + + Returns: + + """ + comp = get_object_or_404(Compensation, id=id) + form = NewCompensationActionModalForm(request.POST or None, instance=comp, request=request) + return form.process_request( + request, + msg_success=COMPENSATION_ACTION_ADDED, + redirect_url=reverse("compensation:detail", args=(id,)) + "#related_data" + ) + + +@login_required +@default_group_required +@shared_access_required(Compensation, "id") +def action_edit_view(request: HttpRequest, id: str, action_id: str): + """ Renders a form for editing actions for a compensation + + Args: + request (HttpRequest): The incoming request + id (str): The compensation's id + action_id (str): The action's id + + Returns: + + """ + comp = get_object_or_404(Compensation, id=id) + action = get_object_or_404(CompensationAction, id=action_id) + form = EditCompensationActionModalForm(request.POST or None, instance=comp, action=action, request=request) + return form.process_request( + request, + msg_success=COMPENSATION_ACTION_EDITED, + redirect_url=reverse("compensation:detail", args=(id,)) + "#related_data" + ) + + +@login_required +@default_group_required +@shared_access_required(Compensation, "id") +def action_remove_view(request: HttpRequest, id: str, action_id: str): + """ Renders a form for removing a compensation action + + Args: + request (HttpRequest): The incoming request + id (str): The compensation's id + id (str): The action's id + + Returns: + + """ + comp = get_object_or_404(Compensation, id=id) + action = get_object_or_404(CompensationAction, id=action_id) + form = RemoveCompensationActionModalForm(request.POST or None, instance=comp, action=action, request=request) + return form.process_request( + request, + msg_success=COMPENSATION_ACTION_REMOVED, + redirect_url=reverse("compensation:detail", args=(id,)) + "#related_data" + ) + diff --git a/compensation/views/compensation/compensation.py b/compensation/views/compensation/compensation.py new file mode 100644 index 00000000..dd461100 --- /dev/null +++ b/compensation/views/compensation/compensation.py @@ -0,0 +1,272 @@ +""" +Author: Michel Peltriaux +Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany +Contact: ksp-servicestelle@sgdnord.rlp.de +Created on: 19.08.22 + +""" +from django.contrib import messages +from django.contrib.auth.decorators import login_required +from django.core.exceptions import ObjectDoesNotExist +from django.db.models import Sum +from django.http import HttpRequest, JsonResponse +from django.shortcuts import get_object_or_404, render, redirect +from django.urls import reverse +from django.utils.translation import gettext_lazy as _ + +from compensation.forms.compensation import EditCompensationForm, NewCompensationForm +from compensation.models import Compensation +from compensation.tables.compensation import CompensationTable +from intervention.models import Intervention +from konova.contexts import BaseContext +from konova.decorators import shared_access_required, default_group_required, any_group_check +from konova.forms import SimpleGeomForm +from konova.forms.modals import RemoveModalForm +from konova.settings import DEFAULT_GROUP, ZB_GROUP, ETS_GROUP +from konova.sub_settings.context_settings import TAB_TITLE_IDENTIFIER +from konova.utils.message_templates import COMPENSATION_REMOVED_TEMPLATE, DATA_CHECKED_PREVIOUSLY_TEMPLATE, \ + RECORDED_BLOCKS_EDIT, CHECKED_RECORDED_RESET, FORM_INVALID, PARAMS_INVALID, IDENTIFIER_REPLACED, \ + COMPENSATION_ADDED_TEMPLATE +from konova.utils.user_checks import in_group + + +@login_required +@any_group_check +def index_view(request: HttpRequest): + """ + Renders the index view for compensation + + Args: + request (HttpRequest): The incoming request + + Returns: + A rendered view + """ + template = "generic_index.html" + 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 + ) + table = CompensationTable( + request=request, + queryset=compensations + ) + context = { + "table": table, + TAB_TITLE_IDENTIFIER: _("Compensations - Overview"), + } + context = BaseContext(request, context).context + return render(request, template, context) + + +@login_required +@default_group_required +@shared_access_required(Intervention, "intervention_id") +def new_view(request: HttpRequest, intervention_id: str = None): + """ + Renders a view for a new compensation creation + + Args: + request (HttpRequest): The incoming request + + Returns: + + """ + template = "compensation/form/view.html" + if intervention_id is not None: + try: + intervention = Intervention.objects.get(id=intervention_id) + except ObjectDoesNotExist: + messages.error(request, PARAMS_INVALID) + return redirect("home") + if intervention.is_recorded: + messages.info( + request, + RECORDED_BLOCKS_EDIT + ) + return redirect("intervention:detail", id=intervention_id) + + data_form = NewCompensationForm(request.POST or None, intervention_id=intervention_id) + geom_form = SimpleGeomForm(request.POST or None, read_only=False) + if request.method == "POST": + if data_form.is_valid() and geom_form.is_valid(): + generated_identifier = data_form.cleaned_data.get("identifier", None) + comp = data_form.save(request.user, geom_form) + if generated_identifier != comp.identifier: + messages.info( + request, + IDENTIFIER_REPLACED.format( + generated_identifier, + comp.identifier + ) + ) + messages.success(request, COMPENSATION_ADDED_TEMPLATE.format(comp.identifier)) + return redirect("compensation:detail", id=comp.id) + else: + messages.error(request, FORM_INVALID, extra_tags="danger",) + else: + # For clarification: nothing in this case + pass + context = { + "form": data_form, + "geom_form": geom_form, + TAB_TITLE_IDENTIFIER: _("New compensation"), + } + context = BaseContext(request, context).context + return render(request, template, context) + + +@login_required +@default_group_required +def new_id_view(request: HttpRequest): + """ JSON endpoint + + Provides fetching of free identifiers for e.g. AJAX calls + + """ + tmp = Compensation() + identifier = tmp.generate_new_identifier() + while Compensation.objects.filter(identifier=identifier).exists(): + identifier = tmp.generate_new_identifier() + return JsonResponse( + data={ + "gen_data": identifier + } + ) + + +@login_required +@default_group_required +@shared_access_required(Compensation, "id") +def edit_view(request: HttpRequest, id: str): + """ + Renders a view for editing compensations + + Args: + request (HttpRequest): The incoming request + + Returns: + + """ + template = "compensation/form/view.html" + # Get object from db + comp = get_object_or_404(Compensation, id=id) + if comp.is_recorded: + messages.info( + request, + RECORDED_BLOCKS_EDIT + ) + return redirect("compensation:detail", id=id) + + # Create forms, initialize with values from db/from POST request + data_form = EditCompensationForm(request.POST or None, instance=comp) + geom_form = SimpleGeomForm(request.POST or None, read_only=False, instance=comp) + if request.method == "POST": + if data_form.is_valid() and geom_form.is_valid(): + # Preserve state of intervention recorded/checked to determine whether the user must be informed or not + # about a change of the recorded/checked state + intervention_recorded = comp.intervention.recorded is not None + intervention_checked = comp.intervention.checked is not None + + # The data form takes the geom form for processing, as well as the performing user + comp = data_form.save(request.user, geom_form) + if intervention_recorded or intervention_checked: + messages.info(request, CHECKED_RECORDED_RESET) + messages.success(request, _("Compensation {} edited").format(comp.identifier)) + return redirect("compensation:detail", id=comp.id) + else: + messages.error(request, FORM_INVALID, extra_tags="danger",) + else: + # For clarification: nothing in this case + pass + context = { + "form": data_form, + "geom_form": geom_form, + TAB_TITLE_IDENTIFIER: _("Edit {}").format(comp.identifier), + } + context = BaseContext(request, context).context + return render(request, template, context) + + +@login_required +@any_group_check +def detail_view(request: HttpRequest, id: str): + """ Renders a detail view for a compensation + + Args: + request (HttpRequest): The incoming request + id (str): The compensation's id + + Returns: + + """ + template = "compensation/detail/compensation/view.html" + comp = get_object_or_404(Compensation, id=id) + geom_form = SimpleGeomForm(instance=comp) + parcels = comp.get_underlying_parcels() + _user = request.user + is_data_shared = comp.intervention.is_shared_with(_user) + + # Order states according to surface + before_states = comp.before_states.all().prefetch_related("biotope_type").order_by("-surface") + after_states = comp.after_states.all().prefetch_related("biotope_type").order_by("-surface") + actions = comp.actions.all().prefetch_related("action_type") + + # Precalculate logical errors between before- and after-states + # Sum() returns None in case of no states, so we catch that and replace it with 0 for easier handling + sum_before_states = before_states.aggregate(Sum("surface"))["surface__sum"] or 0 + sum_after_states = after_states.aggregate(Sum("surface"))["surface__sum"] or 0 + diff_states = abs(sum_before_states - sum_after_states) + + request = comp.set_status_messages(request) + + last_checked = comp.intervention.get_last_checked_action() + last_checked_tooltip = "" + if last_checked: + last_checked_tooltip = DATA_CHECKED_PREVIOUSLY_TEMPLATE.format(last_checked.get_timestamp_str_formatted(), last_checked.user) + + context = { + "obj": comp, + "last_checked": last_checked, + "last_checked_tooltip": last_checked_tooltip, + "geom_form": geom_form, + "parcels": parcels, + "has_access": is_data_shared, + "actions": actions, + "before_states": before_states, + "after_states": after_states, + "sum_before_states": sum_before_states, + "sum_after_states": sum_after_states, + "diff_states": diff_states, + "is_default_member": in_group(_user, DEFAULT_GROUP), + "is_zb_member": in_group(_user, ZB_GROUP), + "is_ets_member": in_group(_user, ETS_GROUP), + "LANIS_LINK": comp.get_LANIS_link(), + TAB_TITLE_IDENTIFIER: f"{comp.identifier} - {comp.title}", + "has_finished_deadlines": comp.get_finished_deadlines().exists(), + } + context = BaseContext(request, context).context + return render(request, template, context) + + +@login_required +@default_group_required +@shared_access_required(Compensation, "id") +def remove_view(request: HttpRequest, id: str): + """ Renders a modal view for removing the compensation + + Args: + request (HttpRequest): The incoming request + id (str): The compensation's id + + Returns: + + """ + comp = get_object_or_404(Compensation, id=id) + form = RemoveModalForm(request.POST or None, instance=comp, request=request) + return form.process_request( + request=request, + msg_success=COMPENSATION_REMOVED_TEMPLATE.format(comp.identifier), + redirect_url=reverse("compensation:index"), + ) + diff --git a/compensation/views/compensation/deadline.py b/compensation/views/compensation/deadline.py new file mode 100644 index 00000000..ee6a5120 --- /dev/null +++ b/compensation/views/compensation/deadline.py @@ -0,0 +1,89 @@ +""" +Author: Michel Peltriaux +Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany +Contact: ksp-servicestelle@sgdnord.rlp.de +Created on: 19.08.22 + +""" +from django.contrib.auth.decorators import login_required +from django.http import HttpRequest +from django.shortcuts import get_object_or_404 +from django.urls import reverse + +from compensation.forms.modals.deadline import EditDeadlineModalForm, NewDeadlineModalForm +from compensation.models import Compensation +from konova.decorators import shared_access_required, default_group_required +from konova.forms.modals import RemoveDeadlineModalForm +from konova.models import Deadline +from konova.utils.message_templates import DEADLINE_REMOVED, DEADLINE_EDITED, DEADLINE_ADDED + + +@login_required +@default_group_required +@shared_access_required(Compensation, "id") +def deadline_new_view(request: HttpRequest, id: str): + """ Renders a form for adding new states for a compensation + + Args: + request (HttpRequest): The incoming request + id (str): The compensation's id to which the new state will be related + + Returns: + + """ + comp = get_object_or_404(Compensation, id=id) + form = NewDeadlineModalForm(request.POST or None, instance=comp, request=request) + return form.process_request( + request, + msg_success=DEADLINE_ADDED, + redirect_url=reverse("compensation:detail", args=(id,)) + "#related_data" + ) + + +@login_required +@default_group_required +@shared_access_required(Compensation, "id") +def deadline_edit_view(request: HttpRequest, id: str, deadline_id: str): + """ Renders a form for editing deadlines from a compensation + + Args: + request (HttpRequest): The incoming request + id (str): The compensation's id + deadline_id (str): The deadline's id + + Returns: + + """ + comp = get_object_or_404(Compensation, id=id) + deadline = get_object_or_404(Deadline, id=deadline_id) + form = EditDeadlineModalForm(request.POST or None, instance=comp, deadline=deadline, request=request) + return form.process_request( + request, + msg_success=DEADLINE_EDITED, + redirect_url=reverse("compensation:detail", args=(id,)) + "#related_data" + ) + + +@login_required +@default_group_required +@shared_access_required(Compensation, "id") +def deadline_remove_view(request: HttpRequest, id: str, deadline_id: str): + """ Renders a form for removing deadlines from a compensation + + Args: + request (HttpRequest): The incoming request + id (str): The compensation's id + deadline_id (str): The deadline's id + + Returns: + + """ + comp = get_object_or_404(Compensation, id=id) + deadline = get_object_or_404(Deadline, id=deadline_id) + form = RemoveDeadlineModalForm(request.POST or None, instance=comp, deadline=deadline, request=request) + return form.process_request( + request, + msg_success=DEADLINE_REMOVED, + redirect_url=reverse("compensation:detail", args=(id,)) + "#related_data" + ) + diff --git a/compensation/views/compensation/document.py b/compensation/views/compensation/document.py new file mode 100644 index 00000000..8ca99edd --- /dev/null +++ b/compensation/views/compensation/document.py @@ -0,0 +1,111 @@ +""" +Author: Michel Peltriaux +Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany +Contact: ksp-servicestelle@sgdnord.rlp.de +Created on: 19.08.22 + +""" +from django.contrib.auth.decorators import login_required +from django.http import HttpRequest +from django.shortcuts import get_object_or_404 +from django.urls import reverse + +from compensation.forms.modals.document import NewCompensationDocumentModalForm +from compensation.models import Compensation, CompensationDocument +from konova.decorators import shared_access_required, default_group_required +from konova.forms.modals import EditDocumentModalForm +from konova.utils.documents import remove_document, get_document +from konova.utils.message_templates import DOCUMENT_EDITED, DOCUMENT_ADDED + + +@login_required +@default_group_required +@shared_access_required(Compensation, "id") +def new_document_view(request: HttpRequest, id: str): + """ Renders a form for uploading new documents + + Args: + request (HttpRequest): The incoming request + id (str): The compensation's id to which the new document will be related + Returns: + + """ + comp = get_object_or_404(Compensation, id=id) + form = NewCompensationDocumentModalForm(request.POST or None, request.FILES or None, instance=comp, request=request) + return form.process_request( + request, + msg_success=DOCUMENT_ADDED, + redirect_url=reverse("compensation:detail", args=(id,)) + "#related_data" + ) + + +@login_required +@default_group_required +@shared_access_required(Compensation, "id") +def get_document_view(request: HttpRequest, id: str, doc_id: str): + """ Returns the document as downloadable file + + Wraps the generic document fetcher function from konova.utils. + + Args: + request (HttpRequest): The incoming request + id (str): The compensation id + doc_id (str): The document id + + Returns: + + """ + comp = get_object_or_404(Compensation, id=id) + doc = get_object_or_404(CompensationDocument, id=doc_id) + return get_document(doc) + + +@login_required +@default_group_required +@shared_access_required(Compensation, "id") +def remove_document_view(request: HttpRequest, id: str, doc_id: str): + """ Removes the document from the database and file system + + Wraps the generic functionality from konova.utils. + + Args: + request (HttpRequest): The incoming request + id (str): The compensation id + doc_id (str): The document id + + Returns: + + """ + comp = get_object_or_404(Compensation, id=id) + doc = get_object_or_404(CompensationDocument, id=doc_id) + return remove_document( + request, + doc + ) + + +@login_required +@default_group_required +@shared_access_required(Compensation, "id") +def edit_document_view(request: HttpRequest, id: str, doc_id: str): + """ Removes the document from the database and file system + + Wraps the generic functionality from konova.utils. + + Args: + request (HttpRequest): The incoming request + id (str): The compensation id + doc_id (str): The document id + + Returns: + + """ + comp = get_object_or_404(Compensation, id=id) + doc = get_object_or_404(CompensationDocument, id=doc_id) + form = EditDocumentModalForm(request.POST or None, request.FILES or None, instance=comp, document=doc, request=request) + return form.process_request( + request, + DOCUMENT_EDITED, + reverse("compensation:detail", args=(id,)) + "#related_data" + ) + diff --git a/compensation/views/compensation/log.py b/compensation/views/compensation/log.py new file mode 100644 index 00000000..91b38aa5 --- /dev/null +++ b/compensation/views/compensation/log.py @@ -0,0 +1,41 @@ +""" +Author: Michel Peltriaux +Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany +Contact: ksp-servicestelle@sgdnord.rlp.de +Created on: 19.08.22 + +""" +from django.contrib.auth.decorators import login_required +from django.http import HttpRequest +from django.shortcuts import get_object_or_404, render +from django.utils.translation import gettext_lazy as _ + +from compensation.models import Compensation +from konova.contexts import BaseContext +from konova.decorators import shared_access_required, default_group_required + + +@login_required +@default_group_required +@shared_access_required(Compensation, "id") +def log_view(request: HttpRequest, id: str): + """ Renders a log view using modal + + Args: + request (HttpRequest): The incoming request + id (str): The compensation's id + + Returns: + + """ + comp = get_object_or_404(Compensation, id=id) + template = "modal/modal_generic.html" + body_template = "log.html" + + context = { + "modal_body_template": body_template, + "log": comp.log.all(), + "modal_title": _("Log"), + } + context = BaseContext(request, context).context + return render(request, template, context) diff --git a/compensation/views/compensation/report.py b/compensation/views/compensation/report.py new file mode 100644 index 00000000..28d563e9 --- /dev/null +++ b/compensation/views/compensation/report.py @@ -0,0 +1,79 @@ +""" +Author: Michel Peltriaux +Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany +Contact: ksp-servicestelle@sgdnord.rlp.de +Created on: 19.08.22 + +""" +from django.http import HttpRequest +from django.shortcuts import get_object_or_404, render +from django.urls import reverse +from django.utils.translation import gettext_lazy as _ + +from compensation.models import Compensation +from konova.contexts import BaseContext +from konova.forms import SimpleGeomForm +from konova.sub_settings.context_settings import TAB_TITLE_IDENTIFIER +from konova.utils.generators import generate_qr_code + + +def report_view(request: HttpRequest, id: str): + """ Renders the public report view + + Args: + request (HttpRequest): The incoming request + id (str): The id of the intervention + + Returns: + + """ + # Reuse the compensation report template since compensations are structurally identical + template = "compensation/report/compensation/report.html" + comp = get_object_or_404(Compensation, id=id) + + tab_title = _("Report {}").format(comp.identifier) + # If intervention is not recorded (yet or currently) we need to render another template without any data + if not comp.is_ready_for_publish(): + template = "report/unavailable.html" + context = { + TAB_TITLE_IDENTIFIER: tab_title, + } + context = BaseContext(request, context).context + return render(request, template, context) + + # Prepare data for map viewer + geom_form = SimpleGeomForm( + instance=comp + ) + parcels = comp.get_underlying_parcels() + + qrcode_url = request.build_absolute_uri(reverse("compensation:report", args=(id,))) + qrcode_img = generate_qr_code(qrcode_url, 10) + qrcode_lanis_url = comp.get_LANIS_link() + qrcode_img_lanis = generate_qr_code(qrcode_lanis_url, 7) + + # Order states by surface + before_states = comp.before_states.all().order_by("-surface").prefetch_related("biotope_type") + after_states = comp.after_states.all().order_by("-surface").prefetch_related("biotope_type") + actions = comp.actions.all().prefetch_related("action_type") + + context = { + "obj": comp, + "qrcode": { + "img": qrcode_img, + "url": qrcode_url, + }, + "qrcode_lanis": { + "img": qrcode_img_lanis, + "url": qrcode_lanis_url, + }, + "has_access": False, # disables action buttons during rendering + "before_states": before_states, + "after_states": after_states, + "geom_form": geom_form, + "parcels": parcels, + "actions": actions, + TAB_TITLE_IDENTIFIER: tab_title, + } + context = BaseContext(request, context).context + return render(request, template, context) diff --git a/compensation/views/compensation/resubmission.py b/compensation/views/compensation/resubmission.py new file mode 100644 index 00000000..d90a91ce --- /dev/null +++ b/compensation/views/compensation/resubmission.py @@ -0,0 +1,39 @@ +""" +Author: Michel Peltriaux +Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany +Contact: ksp-servicestelle@sgdnord.rlp.de +Created on: 19.08.22 + +""" +from django.contrib.auth.decorators import login_required +from django.http import HttpRequest +from django.shortcuts import get_object_or_404 +from django.urls import reverse +from django.utils.translation import gettext_lazy as _ + +from compensation.models import Compensation +from konova.decorators import shared_access_required, default_group_required +from konova.forms.modals import ResubmissionModalForm + + +@login_required +@default_group_required +@shared_access_required(Compensation, "id") +def create_resubmission_view(request: HttpRequest, id: str): + """ Renders resubmission form for a compensation + + Args: + request (HttpRequest): The incoming request + id (str): Compensation's id + + Returns: + + """ + com = get_object_or_404(Compensation, id=id) + form = ResubmissionModalForm(request.POST or None, instance=com, request=request) + form.action_url = reverse("compensation:resubmission-create", args=(id,)) + return form.process_request( + request, + msg_success=_("Resubmission set"), + redirect_url=reverse("compensation:detail", args=(id,)) + ) diff --git a/compensation/views/compensation/state.py b/compensation/views/compensation/state.py new file mode 100644 index 00000000..ca8c5d0c --- /dev/null +++ b/compensation/views/compensation/state.py @@ -0,0 +1,89 @@ +""" +Author: Michel Peltriaux +Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany +Contact: ksp-servicestelle@sgdnord.rlp.de +Created on: 19.08.22 + +""" +from django.contrib.auth.decorators import login_required +from django.http import HttpRequest +from django.shortcuts import get_object_or_404 +from django.urls import reverse + +from compensation.forms.modals.state import EditCompensationStateModalForm, RemoveCompensationStateModalForm, \ + NewCompensationStateModalForm +from compensation.models import Compensation, CompensationState +from konova.decorators import shared_access_required, default_group_required +from konova.utils.message_templates import COMPENSATION_STATE_EDITED, COMPENSATION_STATE_REMOVED, \ + COMPENSATION_STATE_ADDED + + +@login_required +@default_group_required +@shared_access_required(Compensation, "id") +def state_new_view(request: HttpRequest, id: str): + """ Renders a form for adding new states for a compensation + + Args: + request (HttpRequest): The incoming request + id (str): The compensation's id to which the new state will be related + + Returns: + + """ + comp = get_object_or_404(Compensation, id=id) + form = NewCompensationStateModalForm(request.POST or None, instance=comp, request=request) + return form.process_request( + request, + msg_success=COMPENSATION_STATE_ADDED, + redirect_url=reverse("compensation:detail", args=(id,)) + "#related_data" + ) + + +@login_required +@default_group_required +@shared_access_required(Compensation, "id") +def state_remove_view(request: HttpRequest, id: str, state_id: str): + """ Renders a form for removing a compensation state + + Args: + request (HttpRequest): The incoming request + id (str): The compensation's id + state_id (str): The state's id + + Returns: + + """ + comp = get_object_or_404(Compensation, id=id) + state = get_object_or_404(CompensationState, id=state_id) + form = RemoveCompensationStateModalForm(request.POST or None, instance=comp, state=state, request=request) + return form.process_request( + request, + msg_success=COMPENSATION_STATE_REMOVED, + redirect_url=reverse("compensation:detail", args=(id,)) + "#related_data" + ) + + +@login_required +@default_group_required +@shared_access_required(Compensation, "id") +def state_edit_view(request: HttpRequest, id: str, state_id: str): + """ Renders a form for editing a compensation state + + Args: + request (HttpRequest): The incoming request + id (str): The compensation's id + state_id (str): The state's id + + Returns: + + """ + comp = get_object_or_404(Compensation, id=id) + state = get_object_or_404(CompensationState, id=state_id) + form = EditCompensationStateModalForm(request.POST or None, instance=comp, state=state, request=request) + return form.process_request( + request, + msg_success=COMPENSATION_STATE_EDITED, + redirect_url=reverse("compensation:detail", args=(id,)) + "#related_data" + ) + -- 2.45.2 From d168ec47ce96a9eefef04522a79e2081f1b093b1 Mon Sep 17 00:00:00 2001 From: mpeltriaux Date: Fri, 19 Aug 2022 08:27:42 +0200 Subject: [PATCH 11/21] EcoAccount views * splits compensation/views/eco_account.py (+700 lines) into separate files in new module * view files can now be found in /compensation/views/eco_account/... --- compensation/urls/eco_account.py | 16 +- compensation/views/eco_account.py | 869 ------------------ compensation/views/eco_account/__init__.py | 7 + compensation/views/eco_account/action.py | 89 ++ compensation/views/eco_account/deadline.py | 89 ++ compensation/views/eco_account/deduction.py | 101 ++ compensation/views/eco_account/document.py | 111 +++ compensation/views/eco_account/eco_account.py | 266 ++++++ compensation/views/eco_account/log.py | 42 + compensation/views/eco_account/record.py | 38 + compensation/views/eco_account/report.py | 86 ++ .../views/eco_account/resubmission.py | 39 + compensation/views/eco_account/share.py | 78 ++ compensation/views/eco_account/state.py | 88 ++ 14 files changed, 1048 insertions(+), 871 deletions(-) delete mode 100644 compensation/views/eco_account.py create mode 100644 compensation/views/eco_account/__init__.py create mode 100644 compensation/views/eco_account/action.py create mode 100644 compensation/views/eco_account/deadline.py create mode 100644 compensation/views/eco_account/deduction.py create mode 100644 compensation/views/eco_account/document.py create mode 100644 compensation/views/eco_account/eco_account.py create mode 100644 compensation/views/eco_account/log.py create mode 100644 compensation/views/eco_account/record.py create mode 100644 compensation/views/eco_account/report.py create mode 100644 compensation/views/eco_account/resubmission.py create mode 100644 compensation/views/eco_account/share.py create mode 100644 compensation/views/eco_account/state.py diff --git a/compensation/urls/eco_account.py b/compensation/urls/eco_account.py index c57540e5..85f74121 100644 --- a/compensation/urls/eco_account.py +++ b/compensation/urls/eco_account.py @@ -8,7 +8,19 @@ Created on: 24.08.21 from django.urls import path from compensation.autocomplete.eco_account import EcoAccountAutocomplete -from compensation.views.eco_account import * +from compensation.views.eco_account.eco_account import index_view, new_view, new_id_view, edit_view, remove_view, \ + detail_view +from compensation.views.eco_account.log import log_view +from compensation.views.eco_account.record import record_view +from compensation.views.eco_account.report import report_view +from compensation.views.eco_account.resubmission import create_resubmission_view +from compensation.views.eco_account.state import state_new_view, state_remove_view, state_edit_view +from compensation.views.eco_account.action import action_edit_view, action_new_view, action_remove_view +from compensation.views.eco_account.deadline import deadline_new_view, deadline_edit_view, deadline_remove_view +from compensation.views.eco_account.share import share_view, create_share_view +from compensation.views.eco_account.document import get_document_view, new_document_view, remove_document_view, \ + edit_document_view +from compensation.views.eco_account.deduction import deduction_edit_view, deduction_remove_view, new_deduction_view app_name = "acc" urlpatterns = [ @@ -51,4 +63,4 @@ urlpatterns = [ # Autocomplete path("atcmplt/eco-accounts", EcoAccountAutocomplete.as_view(), name="autocomplete"), -] \ No newline at end of file +] diff --git a/compensation/views/eco_account.py b/compensation/views/eco_account.py deleted file mode 100644 index 51aa925d..00000000 --- a/compensation/views/eco_account.py +++ /dev/null @@ -1,869 +0,0 @@ -""" -Author: Michel Peltriaux -Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany -Contact: michel.peltriaux@sgdnord.rlp.de -Created on: 09.08.21 - -""" -from django.contrib import messages -from django.db.models import Sum -from django.urls import reverse -from django.utils.translation import gettext_lazy as _ -from django.contrib.auth.decorators import login_required -from django.core.exceptions import ObjectDoesNotExist -from django.http import HttpRequest, Http404, JsonResponse -from django.shortcuts import render, get_object_or_404, redirect - -from compensation.forms.eco_account import NewEcoAccountForm, EditEcoAccountForm -from compensation.forms.modals.compensation_action import NewCompensationActionModalForm, \ - RemoveCompensationActionModalForm, EditCompensationActionModalForm -from compensation.forms.modals.deadline import EditDeadlineModalForm, NewDeadlineModalForm -from compensation.forms.modals.document import NewEcoAccountDocumentModalForm -from compensation.forms.modals.state import NewCompensationStateModalForm, RemoveCompensationStateModalForm, \ - EditCompensationStateModalForm -from compensation.models import EcoAccount, EcoAccountDocument, CompensationState, CompensationAction -from compensation.tables.eco_account import EcoAccountTable -from intervention.forms.modals.deduction import RemoveEcoAccountDeductionModalForm, NewEcoAccountDeductionModalForm, \ - EditEcoAccountDeductionModalForm -from intervention.forms.modals.share import ShareModalForm -from konova.contexts import BaseContext -from konova.decorators import any_group_check, default_group_required, conservation_office_group_required, \ - shared_access_required -from konova.forms.modals import RemoveModalForm, RecordModalForm, \ - RemoveDeadlineModalForm, EditDocumentModalForm, ResubmissionModalForm -from konova.forms import SimpleGeomForm -from konova.models import Deadline -from konova.settings import DEFAULT_GROUP, ZB_GROUP, ETS_GROUP -from konova.sub_settings.context_settings import TAB_TITLE_IDENTIFIER -from konova.utils.documents import get_document, remove_document -from konova.utils.generators import generate_qr_code -from konova.utils.message_templates import IDENTIFIER_REPLACED, FORM_INVALID, \ - CANCEL_ACC_RECORDED_OR_DEDUCTED, DEDUCTION_REMOVED, DEDUCTION_ADDED, DOCUMENT_ADDED, COMPENSATION_STATE_REMOVED, \ - COMPENSATION_STATE_ADDED, COMPENSATION_ACTION_REMOVED, COMPENSATION_ACTION_ADDED, DEADLINE_ADDED, DEADLINE_REMOVED, \ - DEDUCTION_EDITED, DOCUMENT_EDITED, COMPENSATION_STATE_EDITED, COMPENSATION_ACTION_EDITED, DEADLINE_EDITED, \ - RECORDED_BLOCKS_EDIT -from konova.utils.user_checks import in_group - - -@login_required -@any_group_check -def index_view(request: HttpRequest): - """ - Renders the index view for eco accounts - - Args: - request (HttpRequest): The incoming request - - Returns: - A rendered view - """ - template = "generic_index.html" - eco_accounts = EcoAccount.objects.filter( - deleted=None, - ) - table = EcoAccountTable( - request=request, - queryset=eco_accounts - ) - context = { - "table": table, - TAB_TITLE_IDENTIFIER: _("Eco-account - Overview"), - } - context = BaseContext(request, context).context - return render(request, template, context) - - -@login_required -@default_group_required -def new_view(request: HttpRequest): - """ - Renders a view for a new eco account creation - - Args: - request (HttpRequest): The incoming request - - Returns: - - """ - template = "compensation/form/view.html" - data_form = NewEcoAccountForm(request.POST or None) - geom_form = SimpleGeomForm(request.POST or None, read_only=False) - if request.method == "POST": - if data_form.is_valid() and geom_form.is_valid(): - generated_identifier = data_form.cleaned_data.get("identifier", None) - acc = data_form.save(request.user, geom_form) - if generated_identifier != acc.identifier: - messages.info( - request, - IDENTIFIER_REPLACED.format( - generated_identifier, - acc.identifier - ) - ) - messages.success(request, _("Eco-Account {} added").format(acc.identifier)) - return redirect("compensation:acc:detail", id=acc.id) - else: - messages.error(request, FORM_INVALID, extra_tags="danger",) - else: - # For clarification: nothing in this case - pass - context = { - "form": data_form, - "geom_form": geom_form, - TAB_TITLE_IDENTIFIER: _("New Eco-Account"), - } - context = BaseContext(request, context).context - return render(request, template, context) - - -@login_required -@default_group_required -def new_id_view(request: HttpRequest): - """ JSON endpoint - - Provides fetching of free identifiers for e.g. AJAX calls - - """ - tmp = EcoAccount() - identifier = tmp.generate_new_identifier() - while EcoAccount.objects.filter(identifier=identifier).exists(): - identifier = tmp.generate_new_identifier() - return JsonResponse( - data={ - "gen_data": identifier - } - ) - - -@login_required -@default_group_required -@shared_access_required(EcoAccount, "id") -def edit_view(request: HttpRequest, id: str): - """ - Renders a view for editing compensations - - Args: - request (HttpRequest): The incoming request - - Returns: - - """ - template = "compensation/form/view.html" - # Get object from db - acc = get_object_or_404(EcoAccount, id=id) - if acc.is_recorded: - messages.info( - request, - RECORDED_BLOCKS_EDIT - ) - return redirect("compensation:acc:detail", id=id) - - # Create forms, initialize with values from db/from POST request - data_form = EditEcoAccountForm(request.POST or None, instance=acc) - geom_form = SimpleGeomForm(request.POST or None, read_only=False, instance=acc) - if request.method == "POST": - if data_form.is_valid() and geom_form.is_valid(): - # The data form takes the geom form for processing, as well as the performing user - acc = data_form.save(request.user, geom_form) - messages.success(request, _("Eco-Account {} edited").format(acc.identifier)) - return redirect("compensation:acc:detail", id=acc.id) - else: - messages.error(request, FORM_INVALID, extra_tags="danger",) - else: - # For clarification: nothing in this case - pass - context = { - "form": data_form, - "geom_form": geom_form, - TAB_TITLE_IDENTIFIER: _("Edit {}").format(acc.identifier), - } - context = BaseContext(request, context).context - return render(request, template, context) - - -@login_required -@any_group_check -def detail_view(request: HttpRequest, id: str): - """ Renders a detail view for a compensation - - Args: - request (HttpRequest): The incoming request - id (str): The compensation's id - - Returns: - - """ - template = "compensation/detail/eco_account/view.html" - acc = get_object_or_404( - EcoAccount.objects.prefetch_related( - "deadlines", - ).select_related( - 'geometry', - 'responsible', - ), - id=id - ) - geom_form = SimpleGeomForm(instance=acc) - parcels = acc.get_underlying_parcels() - _user = request.user - is_data_shared = acc.is_shared_with(_user) - - # Order states according to surface - before_states = acc.before_states.order_by("-surface") - after_states = acc.after_states.order_by("-surface") - - # Precalculate logical errors between before- and after-states - # Sum() returns None in case of no states, so we catch that and replace it with 0 for easier handling - sum_before_states = before_states.aggregate(Sum("surface"))["surface__sum"] or 0 - sum_after_states = after_states.aggregate(Sum("surface"))["surface__sum"] or 0 - diff_states = abs(sum_before_states - sum_after_states) - # Calculate rest of available surface for deductions - available_total, available_relative = acc.get_available_rest() - - # Prefetch related data to decrease the amount of db connections - deductions = acc.deductions.filter( - intervention__deleted=None, - ) - actions = acc.actions.all() - - request = acc.set_status_messages(request) - - context = { - "obj": acc, - "geom_form": geom_form, - "parcels": parcels, - "has_access": is_data_shared, - "before_states": before_states, - "after_states": after_states, - "sum_before_states": sum_before_states, - "sum_after_states": sum_after_states, - "diff_states": diff_states, - "available": available_relative, - "available_total": available_total, - "is_default_member": in_group(_user, DEFAULT_GROUP), - "is_zb_member": in_group(_user, ZB_GROUP), - "is_ets_member": in_group(_user, ETS_GROUP), - "LANIS_LINK": acc.get_LANIS_link(), - "deductions": deductions, - "actions": actions, - TAB_TITLE_IDENTIFIER: f"{acc.identifier} - {acc.title}", - "has_finished_deadlines": acc.get_finished_deadlines().exists(), - } - context = BaseContext(request, context).context - return render(request, template, context) - - -@login_required -@default_group_required -@shared_access_required(EcoAccount, "id") -def remove_view(request: HttpRequest, id: str): - """ Renders a modal view for removing the eco account - - Args: - request (HttpRequest): The incoming request - id (str): The account's id - - Returns: - - """ - acc = get_object_or_404(EcoAccount, id=id) - - # If the eco account has already been recorded OR there are already deductions, it can not be deleted by a regular - # default group user - if acc.recorded is not None or acc.deductions.exists(): - user = request.user - if not in_group(user, ETS_GROUP): - messages.info(request, CANCEL_ACC_RECORDED_OR_DEDUCTED) - return redirect("compensation:acc:detail", id=id) - - form = RemoveModalForm(request.POST or None, instance=acc, request=request) - return form.process_request( - request=request, - msg_success=_("Eco-account removed"), - redirect_url=reverse("compensation:acc:index"), - ) - - -@login_required -@default_group_required -def deduction_remove_view(request: HttpRequest, id: str, deduction_id: str): - """ Renders a modal view for removing deductions - - Args: - request (HttpRequest): The incoming request - id (str): The eco account's id - deduction_id (str): The deduction's id - - Returns: - - """ - acc = get_object_or_404(EcoAccount, id=id) - try: - eco_deduction = acc.deductions.get(id=deduction_id) - if not eco_deduction.intervention.is_shared_with(request.user): - raise ObjectDoesNotExist() - except ObjectDoesNotExist: - raise Http404("Unknown deduction") - - form = RemoveEcoAccountDeductionModalForm(request.POST or None, instance=acc, deduction=eco_deduction, request=request) - return form.process_request( - request=request, - msg_success=DEDUCTION_REMOVED, - redirect_url=reverse("compensation:acc:detail", args=(id,)) + "#related_data" - ) - - -@login_required -@default_group_required -def deduction_edit_view(request: HttpRequest, id: str, deduction_id: str): - """ Renders a modal view for editing deductions - - Args: - request (HttpRequest): The incoming request - id (str): The eco account's id - deduction_id (str): The deduction's id - - Returns: - - """ - acc = get_object_or_404(EcoAccount, id=id) - try: - eco_deduction = acc.deductions.get(id=deduction_id) - if not eco_deduction.intervention.is_shared_with(request.user): - raise ObjectDoesNotExist - except ObjectDoesNotExist: - raise Http404("Unknown deduction") - - form = EditEcoAccountDeductionModalForm(request.POST or None, instance=acc, deduction=eco_deduction, request=request) - return form.process_request( - request=request, - msg_success=DEDUCTION_EDITED, - redirect_url=reverse("compensation:acc:detail", args=(id,)) + "#related_data" - ) - - -@login_required -@default_group_required -@shared_access_required(EcoAccount, "id") -def log_view(request: HttpRequest, id: str): - """ Renders a log view using modal - - Args: - request (HttpRequest): The incoming request - id (str): The eco acount's id - - Returns: - - """ - comp = get_object_or_404(EcoAccount, id=id) - template = "modal/modal_generic.html" - body_template = "log.html" - - context = { - "modal_body_template": body_template, - "log": comp.log.all(), - "modal_title": _("Log"), - } - context = BaseContext(request, context).context - return render(request, template, context) - - -@login_required -@conservation_office_group_required -@shared_access_required(EcoAccount, "id") -def record_view(request: HttpRequest, id:str): - """ Renders a modal form for recording an eco account - - Args: - request (HttpRequest): The incoming request - id (str): The account's id - - Returns: - - """ - acc = get_object_or_404(EcoAccount, id=id) - form = RecordModalForm(request.POST or None, instance=acc, request=request) - msg_succ = _("{} unrecorded") if acc.recorded else _("{} recorded") - msg_succ = msg_succ.format(acc.identifier) - return form.process_request( - request, - msg_succ - ) - - -@login_required -@default_group_required -@shared_access_required(EcoAccount, "id") -def state_new_view(request: HttpRequest, id: str): - """ Renders a form for adding new states for an eco account - - Args: - request (HttpRequest): The incoming request - id (str): The account's id to which the new state will be related - - Returns: - - """ - acc = get_object_or_404(EcoAccount, id=id) - form = NewCompensationStateModalForm(request.POST or None, instance=acc, request=request) - return form.process_request( - request, - msg_success=COMPENSATION_STATE_ADDED, - redirect_url=reverse("compensation:acc:detail", args=(id,)) + "#related_data" - ) - - -@login_required -@default_group_required -@shared_access_required(EcoAccount, "id") -def action_new_view(request: HttpRequest, id: str): - """ Renders a form for adding new actions for an eco account - - Args: - request (HttpRequest): The incoming request - id (str): The account's id to which the new state will be related - - Returns: - - """ - acc = get_object_or_404(EcoAccount, id=id) - form = NewCompensationActionModalForm(request.POST or None, instance=acc, request=request) - return form.process_request( - request, - msg_success=COMPENSATION_ACTION_ADDED, - redirect_url=reverse("compensation:acc:detail", args=(id,)) + "#related_data" - ) - - -@login_required -@default_group_required -@shared_access_required(EcoAccount, "id") -def state_remove_view(request: HttpRequest, id: str, state_id: str): - """ Renders a form for removing a compensation state - - Args: - request (HttpRequest): The incoming request - id (str): The compensation's id - state_id (str): The state's id - - Returns: - - """ - acc = get_object_or_404(EcoAccount, id=id) - state = get_object_or_404(CompensationState, id=state_id) - form = RemoveCompensationStateModalForm(request.POST or None, instance=acc, state=state, request=request) - return form.process_request( - request, - msg_success=COMPENSATION_STATE_REMOVED, - redirect_url=reverse("compensation:acc:detail", args=(id,)) + "#related_data" - ) - - -@login_required -@default_group_required -@shared_access_required(EcoAccount, "id") -def state_edit_view(request: HttpRequest, id: str, state_id: str): - """ Renders a form for editing a compensation state - - Args: - request (HttpRequest): The incoming request - id (str): The compensation's id - state_id (str): The state's id - - Returns: - - """ - acc = get_object_or_404(EcoAccount, id=id) - state = get_object_or_404(CompensationState, id=state_id) - form = EditCompensationStateModalForm(request.POST or None, instance=acc, state=state, request=request) - return form.process_request( - request, - msg_success=COMPENSATION_STATE_EDITED, - redirect_url=reverse("compensation:acc:detail", args=(id,)) + "#related_data" - ) - - -@login_required -@default_group_required -@shared_access_required(EcoAccount, "id") -def action_remove_view(request: HttpRequest, id: str, action_id: str): - """ Renders a form for removing a compensation action - - Args: - request (HttpRequest): The incoming request - id (str): The compensation's id - id (str): The action's id - - Returns: - - """ - acc = get_object_or_404(EcoAccount, id=id) - action = get_object_or_404(CompensationAction, id=action_id) - form = RemoveCompensationActionModalForm(request.POST or None, instance=acc, action=action, request=request) - return form.process_request( - request, - msg_success=COMPENSATION_ACTION_REMOVED, - redirect_url=reverse("compensation:acc:detail", args=(id,)) + "#related_data" - ) - - -@login_required -@default_group_required -@shared_access_required(EcoAccount, "id") -def action_edit_view(request: HttpRequest, id: str, action_id: str): - """ Renders a form for editing a compensation action - - Args: - request (HttpRequest): The incoming request - id (str): The compensation's id - id (str): The action's id - - Returns: - - """ - acc = get_object_or_404(EcoAccount, id=id) - action = get_object_or_404(CompensationAction, id=action_id) - form = EditCompensationActionModalForm(request.POST or None, instance=acc, action=action, request=request) - return form.process_request( - request, - msg_success=COMPENSATION_ACTION_EDITED, - redirect_url=reverse("compensation:acc:detail", args=(id,)) + "#related_data" - ) - - -@login_required -@default_group_required -@shared_access_required(EcoAccount, "id") -def deadline_edit_view(request: HttpRequest, id: str, deadline_id: str): - """ Renders a form for editing deadlines from a compensation - - Args: - request (HttpRequest): The incoming request - id (str): The compensation's id - deadline_id (str): The deadline's id - - Returns: - - """ - comp = get_object_or_404(EcoAccount, id=id) - deadline = get_object_or_404(Deadline, id=deadline_id) - form = EditDeadlineModalForm(request.POST or None, instance=comp, deadline=deadline, request=request) - return form.process_request( - request, - msg_success=DEADLINE_EDITED, - redirect_url=reverse("compensation:acc:detail", args=(id,)) + "#related_data" - ) - - -@login_required -@default_group_required -@shared_access_required(EcoAccount, "id") -def deadline_remove_view(request: HttpRequest, id: str, deadline_id: str): - """ Renders a form for removing deadlines from a compensation - - Args: - request (HttpRequest): The incoming request - id (str): The compensation's id - deadline_id (str): The deadline's id - - Returns: - - """ - comp = get_object_or_404(EcoAccount, id=id) - deadline = get_object_or_404(Deadline, id=deadline_id) - form = RemoveDeadlineModalForm(request.POST or None, instance=comp, deadline=deadline, request=request) - return form.process_request( - request, - msg_success=DEADLINE_REMOVED, - redirect_url=reverse("compensation:acc:detail", args=(id,)) + "#related_data" - ) - - -@login_required -@default_group_required -@shared_access_required(EcoAccount, "id") -def deadline_new_view(request: HttpRequest, id: str): - """ Renders a form for adding new states for an eco account - - Args: - request (HttpRequest): The incoming request - id (str): The account's id to which the new state will be related - - Returns: - - """ - acc = get_object_or_404(EcoAccount, id=id) - form = NewDeadlineModalForm(request.POST or None, instance=acc, request=request) - return form.process_request( - request, - msg_success=DEADLINE_ADDED, - redirect_url=reverse("compensation:acc:detail", args=(id,)) + "#related_data" - ) - - -@login_required -@default_group_required -@shared_access_required(EcoAccount, "id") -def new_document_view(request: HttpRequest, id: str): - """ Renders a form for uploading new documents - - Args: - request (HttpRequest): The incoming request - id (str): The account's id to which the new document will be related - Returns: - - """ - acc = get_object_or_404(EcoAccount, id=id) - form = NewEcoAccountDocumentModalForm(request.POST or None, request.FILES or None, instance=acc, request=request) - return form.process_request( - request, - msg_success=DOCUMENT_ADDED, - redirect_url=reverse("compensation:acc:detail", args=(id,)) + "#related_data", - ) - - -@login_required -@default_group_required -@shared_access_required(EcoAccount, "id") -def get_document_view(request: HttpRequest, id:str, doc_id: str): - """ Returns the document as downloadable file - - Wraps the generic document fetcher function from konova.utils. - - Args: - request (HttpRequest): The incoming request - id (str): The account id - doc_id (str): The document id - - Returns: - - """ - acc = get_object_or_404(EcoAccount, id=id) - doc = get_object_or_404(EcoAccountDocument, id=doc_id) - return get_document(doc) - - -@login_required -@default_group_required -@shared_access_required(EcoAccount, "id") -def edit_document_view(request: HttpRequest, id: str, doc_id: str): - """ Removes the document from the database and file system - - Wraps the generic functionality from konova.utils. - - Args: - request (HttpRequest): The incoming request - id (str): The account id - doc_id (str): The document id - - Returns: - - """ - acc = get_object_or_404(EcoAccount, id=id) - doc = get_object_or_404(EcoAccountDocument, id=doc_id) - form = EditDocumentModalForm(request.POST or None, request.FILES or None, instance=acc, document=doc, request=request) - return form.process_request( - request, - DOCUMENT_EDITED, - reverse("compensation:acc:detail", args=(id,)) + "#related_data" - ) - - -@login_required -@default_group_required -@shared_access_required(EcoAccount, "id") -def remove_document_view(request: HttpRequest, id: str, doc_id: str): - """ Removes the document from the database and file system - - Wraps the generic functionality from konova.utils. - - Args: - request (HttpRequest): The incoming request - id (str): The account id - doc_id (str): The document id - - Returns: - - """ - acc = get_object_or_404(EcoAccount, id=id) - doc = get_object_or_404(EcoAccountDocument, id=doc_id) - return remove_document( - request, - doc - ) - - -@login_required -@default_group_required -def new_deduction_view(request: HttpRequest, id: str): - """ Renders a modal form view for creating deductions - - Args: - request (HttpRequest): THe incoming request - id (str): The eco account's id - - Returns: - - """ - acc = get_object_or_404(EcoAccount, id=id) - if not acc.recorded: - raise Http404() - form = NewEcoAccountDeductionModalForm(request.POST or None, instance=acc, request=request) - return form.process_request( - request, - msg_success=DEDUCTION_ADDED, - redirect_url=reverse("compensation:acc:detail", args=(id,)) + "#related_data" - ) - - -def report_view(request:HttpRequest, id: str): - """ Renders the public report view - - Args: - request (HttpRequest): The incoming request - id (str): The id of the intervention - - Returns: - - """ - # Reuse the compensation report template since EcoAccounts are structurally identical - template = "compensation/report/eco_account/report.html" - acc = get_object_or_404(EcoAccount, id=id) - - tab_title = _("Report {}").format(acc.identifier) - # If intervention is not recorded (yet or currently) we need to render another template without any data - if not acc.is_ready_for_publish(): - template = "report/unavailable.html" - context = { - TAB_TITLE_IDENTIFIER: tab_title, - } - context = BaseContext(request, context).context - return render(request, template, context) - - # Prepare data for map viewer - geom_form = SimpleGeomForm( - instance=acc - ) - parcels = acc.get_underlying_parcels() - - qrcode_url = request.build_absolute_uri(reverse("ema:report", args=(id,))) - qrcode_img = generate_qr_code(qrcode_url, 10) - qrcode_lanis_url = acc.get_LANIS_link() - qrcode_img_lanis = generate_qr_code(qrcode_lanis_url, 7) - - # Order states by surface - before_states = acc.before_states.all().order_by("-surface").select_related("biotope_type__parent") - after_states = acc.after_states.all().order_by("-surface").select_related("biotope_type__parent") - actions = acc.actions.all().prefetch_related("action_type__parent") - - # Reduce amount of db fetched data to the bare minimum we need in the template (deduction's intervention id and identifier) - deductions = acc.deductions.all()\ - .distinct("intervention")\ - .select_related("intervention")\ - .values_list("intervention__id", "intervention__identifier", "intervention__title", named=True) - - context = { - "obj": acc, - "qrcode": { - "img": qrcode_img, - "url": qrcode_url, - }, - "qrcode_lanis": { - "img": qrcode_img_lanis, - "url": qrcode_lanis_url, - }, - "has_access": False, # disables action buttons during rendering - "before_states": before_states, - "after_states": after_states, - "geom_form": geom_form, - "parcels": parcels, - "actions": actions, - "deductions": deductions, - TAB_TITLE_IDENTIFIER: tab_title, - } - context = BaseContext(request, context).context - return render(request, template, context) - - -@login_required -def share_view(request: HttpRequest, id: str, token: str): - """ Performs sharing of an eco account - - If token given in url is not valid, the user will be redirected to the dashboard - - Args: - request (HttpRequest): The incoming request - id (str): EcoAccount's id - token (str): Access token for EcoAccount - - Returns: - - """ - user = request.user - obj = get_object_or_404(EcoAccount, id=id) - # Check tokens - if obj.access_token == token: - # Send different messages in case user has already been added to list of sharing users - if obj.is_shared_with(user): - messages.info( - request, - _("{} has already been shared with you").format(obj.identifier) - ) - else: - messages.success( - request, - _("{} has been shared with you").format(obj.identifier) - ) - obj.share_with_user(user) - return redirect("compensation:acc:detail", id=id) - else: - messages.error( - request, - _("Share link invalid"), - extra_tags="danger", - ) - return redirect("home") - - -@login_required -@default_group_required -@shared_access_required(EcoAccount, "id") -def create_share_view(request: HttpRequest, id: str): - """ Renders sharing form for an eco account - - Args: - request (HttpRequest): The incoming request - id (str): EcoAccount's id - - Returns: - - """ - obj = get_object_or_404(EcoAccount, id=id) - form = ShareModalForm(request.POST or None, instance=obj, request=request) - return form.process_request( - request, - msg_success=_("Share settings updated") - ) - - -@login_required -@default_group_required -@shared_access_required(EcoAccount, "id") -def create_resubmission_view(request: HttpRequest, id: str): - """ Renders resubmission form for an eco account - - Args: - request (HttpRequest): The incoming request - id (str): EcoAccount's id - - Returns: - - """ - acc = get_object_or_404(EcoAccount, id=id) - form = ResubmissionModalForm(request.POST or None, instance=acc, request=request) - form.action_url = reverse("compensation:acc:resubmission-create", args=(id,)) - return form.process_request( - request, - msg_success=_("Resubmission set"), - redirect_url=reverse("compensation:acc:detail", args=(id,)) - ) \ No newline at end of file diff --git a/compensation/views/eco_account/__init__.py b/compensation/views/eco_account/__init__.py new file mode 100644 index 00000000..3a996e1f --- /dev/null +++ b/compensation/views/eco_account/__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: 19.08.22 + +""" diff --git a/compensation/views/eco_account/action.py b/compensation/views/eco_account/action.py new file mode 100644 index 00000000..c7eb2185 --- /dev/null +++ b/compensation/views/eco_account/action.py @@ -0,0 +1,89 @@ +""" +Author: Michel Peltriaux +Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany +Contact: ksp-servicestelle@sgdnord.rlp.de +Created on: 19.08.22 + +""" +from django.contrib.auth.decorators import login_required +from django.http import HttpRequest +from django.shortcuts import get_object_or_404 +from django.urls import reverse + +from compensation.forms.modals.compensation_action import EditCompensationActionModalForm, \ + RemoveCompensationActionModalForm, NewCompensationActionModalForm +from compensation.models import EcoAccount, CompensationAction +from konova.decorators import shared_access_required, default_group_required +from konova.utils.message_templates import COMPENSATION_ACTION_EDITED, COMPENSATION_ACTION_REMOVED, \ + COMPENSATION_ACTION_ADDED + + +@login_required +@default_group_required +@shared_access_required(EcoAccount, "id") +def action_new_view(request: HttpRequest, id: str): + """ Renders a form for adding new actions for an eco account + + Args: + request (HttpRequest): The incoming request + id (str): The account's id to which the new state will be related + + Returns: + + """ + acc = get_object_or_404(EcoAccount, id=id) + form = NewCompensationActionModalForm(request.POST or None, instance=acc, request=request) + return form.process_request( + request, + msg_success=COMPENSATION_ACTION_ADDED, + redirect_url=reverse("compensation:acc:detail", args=(id,)) + "#related_data" + ) + + +@login_required +@default_group_required +@shared_access_required(EcoAccount, "id") +def action_remove_view(request: HttpRequest, id: str, action_id: str): + """ Renders a form for removing a compensation action + + Args: + request (HttpRequest): The incoming request + id (str): The compensation's id + id (str): The action's id + + Returns: + + """ + acc = get_object_or_404(EcoAccount, id=id) + action = get_object_or_404(CompensationAction, id=action_id) + form = RemoveCompensationActionModalForm(request.POST or None, instance=acc, action=action, request=request) + return form.process_request( + request, + msg_success=COMPENSATION_ACTION_REMOVED, + redirect_url=reverse("compensation:acc:detail", args=(id,)) + "#related_data" + ) + + +@login_required +@default_group_required +@shared_access_required(EcoAccount, "id") +def action_edit_view(request: HttpRequest, id: str, action_id: str): + """ Renders a form for editing a compensation action + + Args: + request (HttpRequest): The incoming request + id (str): The compensation's id + id (str): The action's id + + Returns: + + """ + acc = get_object_or_404(EcoAccount, id=id) + action = get_object_or_404(CompensationAction, id=action_id) + form = EditCompensationActionModalForm(request.POST or None, instance=acc, action=action, request=request) + return form.process_request( + request, + msg_success=COMPENSATION_ACTION_EDITED, + redirect_url=reverse("compensation:acc:detail", args=(id,)) + "#related_data" + ) + diff --git a/compensation/views/eco_account/deadline.py b/compensation/views/eco_account/deadline.py new file mode 100644 index 00000000..37e35202 --- /dev/null +++ b/compensation/views/eco_account/deadline.py @@ -0,0 +1,89 @@ +""" +Author: Michel Peltriaux +Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany +Contact: ksp-servicestelle@sgdnord.rlp.de +Created on: 19.08.22 + +""" +from django.contrib.auth.decorators import login_required +from django.http import HttpRequest +from django.shortcuts import get_object_or_404 +from django.urls import reverse + +from compensation.forms.modals.deadline import NewDeadlineModalForm, EditDeadlineModalForm +from compensation.models import EcoAccount +from konova.decorators import shared_access_required, default_group_required +from konova.forms.modals import RemoveDeadlineModalForm +from konova.models import Deadline +from konova.utils.message_templates import DEADLINE_ADDED, DEADLINE_REMOVED, DEADLINE_EDITED + + +@login_required +@default_group_required +@shared_access_required(EcoAccount, "id") +def deadline_edit_view(request: HttpRequest, id: str, deadline_id: str): + """ Renders a form for editing deadlines from a compensation + + Args: + request (HttpRequest): The incoming request + id (str): The compensation's id + deadline_id (str): The deadline's id + + Returns: + + """ + comp = get_object_or_404(EcoAccount, id=id) + deadline = get_object_or_404(Deadline, id=deadline_id) + form = EditDeadlineModalForm(request.POST or None, instance=comp, deadline=deadline, request=request) + return form.process_request( + request, + msg_success=DEADLINE_EDITED, + redirect_url=reverse("compensation:acc:detail", args=(id,)) + "#related_data" + ) + + +@login_required +@default_group_required +@shared_access_required(EcoAccount, "id") +def deadline_remove_view(request: HttpRequest, id: str, deadline_id: str): + """ Renders a form for removing deadlines from a compensation + + Args: + request (HttpRequest): The incoming request + id (str): The compensation's id + deadline_id (str): The deadline's id + + Returns: + + """ + comp = get_object_or_404(EcoAccount, id=id) + deadline = get_object_or_404(Deadline, id=deadline_id) + form = RemoveDeadlineModalForm(request.POST or None, instance=comp, deadline=deadline, request=request) + return form.process_request( + request, + msg_success=DEADLINE_REMOVED, + redirect_url=reverse("compensation:acc:detail", args=(id,)) + "#related_data" + ) + + +@login_required +@default_group_required +@shared_access_required(EcoAccount, "id") +def deadline_new_view(request: HttpRequest, id: str): + """ Renders a form for adding new states for an eco account + + Args: + request (HttpRequest): The incoming request + id (str): The account's id to which the new state will be related + + Returns: + + """ + acc = get_object_or_404(EcoAccount, id=id) + form = NewDeadlineModalForm(request.POST or None, instance=acc, request=request) + return form.process_request( + request, + msg_success=DEADLINE_ADDED, + redirect_url=reverse("compensation:acc:detail", args=(id,)) + "#related_data" + ) + diff --git a/compensation/views/eco_account/deduction.py b/compensation/views/eco_account/deduction.py new file mode 100644 index 00000000..e9b1dcb9 --- /dev/null +++ b/compensation/views/eco_account/deduction.py @@ -0,0 +1,101 @@ +""" +Author: Michel Peltriaux +Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany +Contact: ksp-servicestelle@sgdnord.rlp.de +Created on: 19.08.22 + +""" +from django.contrib.auth.decorators import login_required +from django.core.exceptions import ObjectDoesNotExist +from django.http import HttpRequest, Http404 +from django.shortcuts import get_object_or_404 +from django.urls import reverse + +from compensation.models import EcoAccount +from intervention.forms.modals.deduction import EditEcoAccountDeductionModalForm, RemoveEcoAccountDeductionModalForm, \ + NewEcoAccountDeductionModalForm +from konova.decorators import default_group_required +from konova.utils.message_templates import DEDUCTION_EDITED, DEDUCTION_REMOVED, DEDUCTION_ADDED + + +@login_required +@default_group_required +def new_deduction_view(request: HttpRequest, id: str): + """ Renders a modal form view for creating deductions + + Args: + request (HttpRequest): THe incoming request + id (str): The eco account's id + + Returns: + + """ + acc = get_object_or_404(EcoAccount, id=id) + if not acc.recorded: + raise Http404() + form = NewEcoAccountDeductionModalForm(request.POST or None, instance=acc, request=request) + return form.process_request( + request, + msg_success=DEDUCTION_ADDED, + redirect_url=reverse("compensation:acc:detail", args=(id,)) + "#related_data" + ) + + +@login_required +@default_group_required +def deduction_remove_view(request: HttpRequest, id: str, deduction_id: str): + """ Renders a modal view for removing deductions + + Args: + request (HttpRequest): The incoming request + id (str): The eco account's id + deduction_id (str): The deduction's id + + Returns: + + """ + acc = get_object_or_404(EcoAccount, id=id) + try: + eco_deduction = acc.deductions.get(id=deduction_id) + if not eco_deduction.intervention.is_shared_with(request.user): + raise ObjectDoesNotExist() + except ObjectDoesNotExist: + raise Http404("Unknown deduction") + + form = RemoveEcoAccountDeductionModalForm(request.POST or None, instance=acc, deduction=eco_deduction, request=request) + return form.process_request( + request=request, + msg_success=DEDUCTION_REMOVED, + redirect_url=reverse("compensation:acc:detail", args=(id,)) + "#related_data" + ) + + +@login_required +@default_group_required +def deduction_edit_view(request: HttpRequest, id: str, deduction_id: str): + """ Renders a modal view for editing deductions + + Args: + request (HttpRequest): The incoming request + id (str): The eco account's id + deduction_id (str): The deduction's id + + Returns: + + """ + acc = get_object_or_404(EcoAccount, id=id) + try: + eco_deduction = acc.deductions.get(id=deduction_id) + if not eco_deduction.intervention.is_shared_with(request.user): + raise ObjectDoesNotExist + except ObjectDoesNotExist: + raise Http404("Unknown deduction") + + form = EditEcoAccountDeductionModalForm(request.POST or None, instance=acc, deduction=eco_deduction, request=request) + return form.process_request( + request=request, + msg_success=DEDUCTION_EDITED, + redirect_url=reverse("compensation:acc:detail", args=(id,)) + "#related_data" + ) + + diff --git a/compensation/views/eco_account/document.py b/compensation/views/eco_account/document.py new file mode 100644 index 00000000..53e0a200 --- /dev/null +++ b/compensation/views/eco_account/document.py @@ -0,0 +1,111 @@ +""" +Author: Michel Peltriaux +Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany +Contact: ksp-servicestelle@sgdnord.rlp.de +Created on: 19.08.22 + +""" +from django.contrib.auth.decorators import login_required +from django.http import HttpRequest +from django.shortcuts import get_object_or_404 +from django.urls import reverse + +from compensation.forms.modals.document import NewEcoAccountDocumentModalForm +from compensation.models import EcoAccount, EcoAccountDocument +from konova.decorators import shared_access_required, default_group_required +from konova.forms.modals import EditDocumentModalForm +from konova.utils.documents import remove_document, get_document +from konova.utils.message_templates import DOCUMENT_EDITED, DOCUMENT_ADDED + + +@login_required +@default_group_required +@shared_access_required(EcoAccount, "id") +def new_document_view(request: HttpRequest, id: str): + """ Renders a form for uploading new documents + + Args: + request (HttpRequest): The incoming request + id (str): The account's id to which the new document will be related + Returns: + + """ + acc = get_object_or_404(EcoAccount, id=id) + form = NewEcoAccountDocumentModalForm(request.POST or None, request.FILES or None, instance=acc, request=request) + return form.process_request( + request, + msg_success=DOCUMENT_ADDED, + redirect_url=reverse("compensation:acc:detail", args=(id,)) + "#related_data", + ) + + +@login_required +@default_group_required +@shared_access_required(EcoAccount, "id") +def get_document_view(request: HttpRequest, id:str, doc_id: str): + """ Returns the document as downloadable file + + Wraps the generic document fetcher function from konova.utils. + + Args: + request (HttpRequest): The incoming request + id (str): The account id + doc_id (str): The document id + + Returns: + + """ + acc = get_object_or_404(EcoAccount, id=id) + doc = get_object_or_404(EcoAccountDocument, id=doc_id) + return get_document(doc) + + +@login_required +@default_group_required +@shared_access_required(EcoAccount, "id") +def edit_document_view(request: HttpRequest, id: str, doc_id: str): + """ Removes the document from the database and file system + + Wraps the generic functionality from konova.utils. + + Args: + request (HttpRequest): The incoming request + id (str): The account id + doc_id (str): The document id + + Returns: + + """ + acc = get_object_or_404(EcoAccount, id=id) + doc = get_object_or_404(EcoAccountDocument, id=doc_id) + form = EditDocumentModalForm(request.POST or None, request.FILES or None, instance=acc, document=doc, request=request) + return form.process_request( + request, + DOCUMENT_EDITED, + reverse("compensation:acc:detail", args=(id,)) + "#related_data" + ) + + +@login_required +@default_group_required +@shared_access_required(EcoAccount, "id") +def remove_document_view(request: HttpRequest, id: str, doc_id: str): + """ Removes the document from the database and file system + + Wraps the generic functionality from konova.utils. + + Args: + request (HttpRequest): The incoming request + id (str): The account id + doc_id (str): The document id + + Returns: + + """ + acc = get_object_or_404(EcoAccount, id=id) + doc = get_object_or_404(EcoAccountDocument, id=doc_id) + return remove_document( + request, + doc + ) + diff --git a/compensation/views/eco_account/eco_account.py b/compensation/views/eco_account/eco_account.py new file mode 100644 index 00000000..df99b957 --- /dev/null +++ b/compensation/views/eco_account/eco_account.py @@ -0,0 +1,266 @@ +""" +Author: Michel Peltriaux +Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany +Contact: ksp-servicestelle@sgdnord.rlp.de +Created on: 19.08.22 + +""" +from django.contrib import messages +from django.contrib.auth.decorators import login_required +from django.db.models import Sum +from django.http import HttpRequest, JsonResponse +from django.shortcuts import get_object_or_404, redirect, render +from django.urls import reverse +from django.utils.translation import gettext_lazy as _ + +from compensation.forms.eco_account import EditEcoAccountForm, NewEcoAccountForm +from compensation.models import EcoAccount +from compensation.tables.eco_account import EcoAccountTable +from konova.contexts import BaseContext +from konova.decorators import shared_access_required, default_group_required, any_group_check +from konova.forms import SimpleGeomForm +from konova.forms.modals import RemoveModalForm +from konova.settings import ETS_GROUP, DEFAULT_GROUP, ZB_GROUP +from konova.sub_settings.context_settings import TAB_TITLE_IDENTIFIER +from konova.utils.message_templates import CANCEL_ACC_RECORDED_OR_DEDUCTED, RECORDED_BLOCKS_EDIT, FORM_INVALID +from konova.utils.user_checks import in_group + + +@login_required +@any_group_check +def index_view(request: HttpRequest): + """ + Renders the index view for eco accounts + + Args: + request (HttpRequest): The incoming request + + Returns: + A rendered view + """ + template = "generic_index.html" + eco_accounts = EcoAccount.objects.filter( + deleted=None, + ) + table = EcoAccountTable( + request=request, + queryset=eco_accounts + ) + context = { + "table": table, + TAB_TITLE_IDENTIFIER: _("Eco-account - Overview"), + } + context = BaseContext(request, context).context + return render(request, template, context) + + +@login_required +@default_group_required +def new_view(request: HttpRequest): + """ + Renders a view for a new eco account creation + + Args: + request (HttpRequest): The incoming request + + Returns: + + """ + template = "compensation/form/view.html" + data_form = NewEcoAccountForm(request.POST or None) + geom_form = SimpleGeomForm(request.POST or None, read_only=False) + if request.method == "POST": + if data_form.is_valid() and geom_form.is_valid(): + generated_identifier = data_form.cleaned_data.get("identifier", None) + acc = data_form.save(request.user, geom_form) + if generated_identifier != acc.identifier: + messages.info( + request, + IDENTIFIER_REPLACED.format( + generated_identifier, + acc.identifier + ) + ) + messages.success(request, _("Eco-Account {} added").format(acc.identifier)) + return redirect("compensation:acc:detail", id=acc.id) + else: + messages.error(request, FORM_INVALID, extra_tags="danger",) + else: + # For clarification: nothing in this case + pass + context = { + "form": data_form, + "geom_form": geom_form, + TAB_TITLE_IDENTIFIER: _("New Eco-Account"), + } + context = BaseContext(request, context).context + return render(request, template, context) + + +@login_required +@default_group_required +def new_id_view(request: HttpRequest): + """ JSON endpoint + + Provides fetching of free identifiers for e.g. AJAX calls + + """ + tmp = EcoAccount() + identifier = tmp.generate_new_identifier() + while EcoAccount.objects.filter(identifier=identifier).exists(): + identifier = tmp.generate_new_identifier() + return JsonResponse( + data={ + "gen_data": identifier + } + ) + + +@login_required +@default_group_required +@shared_access_required(EcoAccount, "id") +def edit_view(request: HttpRequest, id: str): + """ + Renders a view for editing compensations + + Args: + request (HttpRequest): The incoming request + + Returns: + + """ + template = "compensation/form/view.html" + # Get object from db + acc = get_object_or_404(EcoAccount, id=id) + if acc.is_recorded: + messages.info( + request, + RECORDED_BLOCKS_EDIT + ) + return redirect("compensation:acc:detail", id=id) + + # Create forms, initialize with values from db/from POST request + data_form = EditEcoAccountForm(request.POST or None, instance=acc) + geom_form = SimpleGeomForm(request.POST or None, read_only=False, instance=acc) + if request.method == "POST": + if data_form.is_valid() and geom_form.is_valid(): + # The data form takes the geom form for processing, as well as the performing user + acc = data_form.save(request.user, geom_form) + messages.success(request, _("Eco-Account {} edited").format(acc.identifier)) + return redirect("compensation:acc:detail", id=acc.id) + else: + messages.error(request, FORM_INVALID, extra_tags="danger",) + else: + # For clarification: nothing in this case + pass + context = { + "form": data_form, + "geom_form": geom_form, + TAB_TITLE_IDENTIFIER: _("Edit {}").format(acc.identifier), + } + context = BaseContext(request, context).context + return render(request, template, context) + + +@login_required +@any_group_check +def detail_view(request: HttpRequest, id: str): + """ Renders a detail view for a compensation + + Args: + request (HttpRequest): The incoming request + id (str): The compensation's id + + Returns: + + """ + template = "compensation/detail/eco_account/view.html" + acc = get_object_or_404( + EcoAccount.objects.prefetch_related( + "deadlines", + ).select_related( + 'geometry', + 'responsible', + ), + id=id + ) + geom_form = SimpleGeomForm(instance=acc) + parcels = acc.get_underlying_parcels() + _user = request.user + is_data_shared = acc.is_shared_with(_user) + + # Order states according to surface + before_states = acc.before_states.order_by("-surface") + after_states = acc.after_states.order_by("-surface") + + # Precalculate logical errors between before- and after-states + # Sum() returns None in case of no states, so we catch that and replace it with 0 for easier handling + sum_before_states = before_states.aggregate(Sum("surface"))["surface__sum"] or 0 + sum_after_states = after_states.aggregate(Sum("surface"))["surface__sum"] or 0 + diff_states = abs(sum_before_states - sum_after_states) + # Calculate rest of available surface for deductions + available_total, available_relative = acc.get_available_rest() + + # Prefetch related data to decrease the amount of db connections + deductions = acc.deductions.filter( + intervention__deleted=None, + ) + actions = acc.actions.all() + + request = acc.set_status_messages(request) + + context = { + "obj": acc, + "geom_form": geom_form, + "parcels": parcels, + "has_access": is_data_shared, + "before_states": before_states, + "after_states": after_states, + "sum_before_states": sum_before_states, + "sum_after_states": sum_after_states, + "diff_states": diff_states, + "available": available_relative, + "available_total": available_total, + "is_default_member": in_group(_user, DEFAULT_GROUP), + "is_zb_member": in_group(_user, ZB_GROUP), + "is_ets_member": in_group(_user, ETS_GROUP), + "LANIS_LINK": acc.get_LANIS_link(), + "deductions": deductions, + "actions": actions, + TAB_TITLE_IDENTIFIER: f"{acc.identifier} - {acc.title}", + "has_finished_deadlines": acc.get_finished_deadlines().exists(), + } + context = BaseContext(request, context).context + return render(request, template, context) + + +@login_required +@default_group_required +@shared_access_required(EcoAccount, "id") +def remove_view(request: HttpRequest, id: str): + """ Renders a modal view for removing the eco account + + Args: + request (HttpRequest): The incoming request + id (str): The account's id + + Returns: + + """ + acc = get_object_or_404(EcoAccount, id=id) + + # If the eco account has already been recorded OR there are already deductions, it can not be deleted by a regular + # default group user + if acc.recorded is not None or acc.deductions.exists(): + user = request.user + if not in_group(user, ETS_GROUP): + messages.info(request, CANCEL_ACC_RECORDED_OR_DEDUCTED) + return redirect("compensation:acc:detail", id=id) + + form = RemoveModalForm(request.POST or None, instance=acc, request=request) + return form.process_request( + request=request, + msg_success=_("Eco-account removed"), + redirect_url=reverse("compensation:acc:index"), + ) + diff --git a/compensation/views/eco_account/log.py b/compensation/views/eco_account/log.py new file mode 100644 index 00000000..0a795199 --- /dev/null +++ b/compensation/views/eco_account/log.py @@ -0,0 +1,42 @@ +""" +Author: Michel Peltriaux +Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany +Contact: ksp-servicestelle@sgdnord.rlp.de +Created on: 19.08.22 + +""" +from django.contrib.auth.decorators import login_required +from django.http import HttpRequest +from django.shortcuts import get_object_or_404, render +from django.utils.translation import gettext_lazy as _ + +from compensation.models import EcoAccount +from konova.contexts import BaseContext +from konova.decorators import shared_access_required, default_group_required + + +@login_required +@default_group_required +@shared_access_required(EcoAccount, "id") +def log_view(request: HttpRequest, id: str): + """ Renders a log view using modal + + Args: + request (HttpRequest): The incoming request + id (str): The eco acount's id + + Returns: + + """ + comp = get_object_or_404(EcoAccount, id=id) + template = "modal/modal_generic.html" + body_template = "log.html" + + context = { + "modal_body_template": body_template, + "log": comp.log.all(), + "modal_title": _("Log"), + } + context = BaseContext(request, context).context + return render(request, template, context) + diff --git a/compensation/views/eco_account/record.py b/compensation/views/eco_account/record.py new file mode 100644 index 00000000..c1fe1384 --- /dev/null +++ b/compensation/views/eco_account/record.py @@ -0,0 +1,38 @@ +""" +Author: Michel Peltriaux +Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany +Contact: ksp-servicestelle@sgdnord.rlp.de +Created on: 19.08.22 + +""" +from django.contrib.auth.decorators import login_required +from django.http import HttpRequest +from django.shortcuts import get_object_or_404 +from django.utils.translation import gettext_lazy as _ + +from compensation.models import EcoAccount +from konova.decorators import shared_access_required, conservation_office_group_required +from konova.forms.modals import RecordModalForm + + +@login_required +@conservation_office_group_required +@shared_access_required(EcoAccount, "id") +def record_view(request: HttpRequest, id:str): + """ Renders a modal form for recording an eco account + + Args: + request (HttpRequest): The incoming request + id (str): The account's id + + Returns: + + """ + acc = get_object_or_404(EcoAccount, id=id) + form = RecordModalForm(request.POST or None, instance=acc, request=request) + msg_succ = _("{} unrecorded") if acc.recorded else _("{} recorded") + msg_succ = msg_succ.format(acc.identifier) + return form.process_request( + request, + msg_succ + ) diff --git a/compensation/views/eco_account/report.py b/compensation/views/eco_account/report.py new file mode 100644 index 00000000..9bbf32b1 --- /dev/null +++ b/compensation/views/eco_account/report.py @@ -0,0 +1,86 @@ +""" +Author: Michel Peltriaux +Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany +Contact: ksp-servicestelle@sgdnord.rlp.de +Created on: 19.08.22 + +""" +from django.http import HttpRequest +from django.shortcuts import get_object_or_404, render +from django.urls import reverse +from django.utils.translation import gettext_lazy as _ + +from compensation.models import EcoAccount +from konova.contexts import BaseContext +from konova.forms import SimpleGeomForm +from konova.sub_settings.context_settings import TAB_TITLE_IDENTIFIER +from konova.utils.generators import generate_qr_code + + +def report_view(request: HttpRequest, id: str): + """ Renders the public report view + + Args: + request (HttpRequest): The incoming request + id (str): The id of the intervention + + Returns: + + """ + # Reuse the compensation report template since EcoAccounts are structurally identical + template = "compensation/report/eco_account/report.html" + acc = get_object_or_404(EcoAccount, id=id) + + tab_title = _("Report {}").format(acc.identifier) + # If intervention is not recorded (yet or currently) we need to render another template without any data + if not acc.is_ready_for_publish(): + template = "report/unavailable.html" + context = { + TAB_TITLE_IDENTIFIER: tab_title, + } + context = BaseContext(request, context).context + return render(request, template, context) + + # Prepare data for map viewer + geom_form = SimpleGeomForm( + instance=acc + ) + parcels = acc.get_underlying_parcels() + + qrcode_url = request.build_absolute_uri(reverse("compensation:acc:report", args=(id,))) + qrcode_img = generate_qr_code(qrcode_url, 10) + qrcode_lanis_url = acc.get_LANIS_link() + qrcode_img_lanis = generate_qr_code(qrcode_lanis_url, 7) + + # Order states by surface + before_states = acc.before_states.all().order_by("-surface").select_related("biotope_type__parent") + after_states = acc.after_states.all().order_by("-surface").select_related("biotope_type__parent") + actions = acc.actions.all().prefetch_related("action_type__parent") + + # Reduce amount of db fetched data to the bare minimum we need in the template (deduction's intervention id and identifier) + deductions = acc.deductions.all()\ + .distinct("intervention")\ + .select_related("intervention")\ + .values_list("intervention__id", "intervention__identifier", "intervention__title", named=True) + + context = { + "obj": acc, + "qrcode": { + "img": qrcode_img, + "url": qrcode_url, + }, + "qrcode_lanis": { + "img": qrcode_img_lanis, + "url": qrcode_lanis_url, + }, + "has_access": False, # disables action buttons during rendering + "before_states": before_states, + "after_states": after_states, + "geom_form": geom_form, + "parcels": parcels, + "actions": actions, + "deductions": deductions, + TAB_TITLE_IDENTIFIER: tab_title, + } + context = BaseContext(request, context).context + return render(request, template, context) diff --git a/compensation/views/eco_account/resubmission.py b/compensation/views/eco_account/resubmission.py new file mode 100644 index 00000000..43c52224 --- /dev/null +++ b/compensation/views/eco_account/resubmission.py @@ -0,0 +1,39 @@ +""" +Author: Michel Peltriaux +Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany +Contact: ksp-servicestelle@sgdnord.rlp.de +Created on: 19.08.22 + +""" +from django.contrib.auth.decorators import login_required +from django.http import HttpRequest +from django.shortcuts import get_object_or_404 +from django.urls import reverse +from django.utils.translation import gettext_lazy as _ + +from compensation.models import EcoAccount +from konova.decorators import shared_access_required, default_group_required +from konova.forms.modals import ResubmissionModalForm + + +@login_required +@default_group_required +@shared_access_required(EcoAccount, "id") +def create_resubmission_view(request: HttpRequest, id: str): + """ Renders resubmission form for an eco account + + Args: + request (HttpRequest): The incoming request + id (str): EcoAccount's id + + Returns: + + """ + acc = get_object_or_404(EcoAccount, id=id) + form = ResubmissionModalForm(request.POST or None, instance=acc, request=request) + form.action_url = reverse("compensation:acc:resubmission-create", args=(id,)) + return form.process_request( + request, + msg_success=_("Resubmission set"), + redirect_url=reverse("compensation:acc:detail", args=(id,)) + ) diff --git a/compensation/views/eco_account/share.py b/compensation/views/eco_account/share.py new file mode 100644 index 00000000..7b1916e4 --- /dev/null +++ b/compensation/views/eco_account/share.py @@ -0,0 +1,78 @@ +""" +Author: Michel Peltriaux +Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany +Contact: ksp-servicestelle@sgdnord.rlp.de +Created on: 19.08.22 + +""" +from django.contrib import messages +from django.contrib.auth.decorators import login_required +from django.http import HttpRequest +from django.shortcuts import get_object_or_404, redirect +from django.utils.translation import gettext_lazy as _ + +from compensation.models import EcoAccount +from intervention.forms.modals.share import ShareModalForm +from konova.decorators import shared_access_required, default_group_required + + +@login_required +def share_view(request: HttpRequest, id: str, token: str): + """ Performs sharing of an eco account + + If token given in url is not valid, the user will be redirected to the dashboard + + Args: + request (HttpRequest): The incoming request + id (str): EcoAccount's id + token (str): Access token for EcoAccount + + Returns: + + """ + user = request.user + obj = get_object_or_404(EcoAccount, id=id) + # Check tokens + if obj.access_token == token: + # Send different messages in case user has already been added to list of sharing users + if obj.is_shared_with(user): + messages.info( + request, + _("{} has already been shared with you").format(obj.identifier) + ) + else: + messages.success( + request, + _("{} has been shared with you").format(obj.identifier) + ) + obj.share_with_user(user) + return redirect("compensation:acc:detail", id=id) + else: + messages.error( + request, + _("Share link invalid"), + extra_tags="danger", + ) + return redirect("home") + + +@login_required +@default_group_required +@shared_access_required(EcoAccount, "id") +def create_share_view(request: HttpRequest, id: str): + """ Renders sharing form for an eco account + + Args: + request (HttpRequest): The incoming request + id (str): EcoAccount's id + + Returns: + + """ + obj = get_object_or_404(EcoAccount, id=id) + form = ShareModalForm(request.POST or None, instance=obj, request=request) + return form.process_request( + request, + msg_success=_("Share settings updated") + ) + diff --git a/compensation/views/eco_account/state.py b/compensation/views/eco_account/state.py new file mode 100644 index 00000000..15590fc7 --- /dev/null +++ b/compensation/views/eco_account/state.py @@ -0,0 +1,88 @@ +""" +Author: Michel Peltriaux +Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany +Contact: ksp-servicestelle@sgdnord.rlp.de +Created on: 19.08.22 + +""" +from django.contrib.auth.decorators import login_required +from django.http import HttpRequest +from django.shortcuts import get_object_or_404 +from django.urls import reverse + +from compensation.forms.modals.state import EditCompensationStateModalForm, RemoveCompensationStateModalForm, \ + NewCompensationStateModalForm +from compensation.models import EcoAccount, CompensationState +from konova.decorators import shared_access_required, default_group_required +from konova.utils.message_templates import COMPENSATION_STATE_EDITED, COMPENSATION_STATE_REMOVED, \ + COMPENSATION_STATE_ADDED + + +@login_required +@default_group_required +@shared_access_required(EcoAccount, "id") +def state_new_view(request: HttpRequest, id: str): + """ Renders a form for adding new states for an eco account + + Args: + request (HttpRequest): The incoming request + id (str): The account's id to which the new state will be related + + Returns: + + """ + acc = get_object_or_404(EcoAccount, id=id) + form = NewCompensationStateModalForm(request.POST or None, instance=acc, request=request) + return form.process_request( + request, + msg_success=COMPENSATION_STATE_ADDED, + redirect_url=reverse("compensation:acc:detail", args=(id,)) + "#related_data" + ) + +@login_required +@default_group_required +@shared_access_required(EcoAccount, "id") +def state_remove_view(request: HttpRequest, id: str, state_id: str): + """ Renders a form for removing a compensation state + + Args: + request (HttpRequest): The incoming request + id (str): The compensation's id + state_id (str): The state's id + + Returns: + + """ + acc = get_object_or_404(EcoAccount, id=id) + state = get_object_or_404(CompensationState, id=state_id) + form = RemoveCompensationStateModalForm(request.POST or None, instance=acc, state=state, request=request) + return form.process_request( + request, + msg_success=COMPENSATION_STATE_REMOVED, + redirect_url=reverse("compensation:acc:detail", args=(id,)) + "#related_data" + ) + + +@login_required +@default_group_required +@shared_access_required(EcoAccount, "id") +def state_edit_view(request: HttpRequest, id: str, state_id: str): + """ Renders a form for editing a compensation state + + Args: + request (HttpRequest): The incoming request + id (str): The compensation's id + state_id (str): The state's id + + Returns: + + """ + acc = get_object_or_404(EcoAccount, id=id) + state = get_object_or_404(CompensationState, id=state_id) + form = EditCompensationStateModalForm(request.POST or None, instance=acc, state=state, request=request) + return form.process_request( + request, + msg_success=COMPENSATION_STATE_EDITED, + redirect_url=reverse("compensation:acc:detail", args=(id,)) + "#related_data" + ) + -- 2.45.2 From 3c416fa26401203e9b0023798c7a86ab021e395a Mon Sep 17 00:00:00 2001 From: mpeltriaux Date: Fri, 19 Aug 2022 10:25:27 +0200 Subject: [PATCH 12/21] Konova views * splits konova/views.py into separate files in new module * view files can now be found in /konova/views/... * introduces first class based view AbstractLogView * implemented for Ema, Intervention, Compensation and EcoAccount --- compensation/urls/compensation.py | 4 +- compensation/urls/eco_account.py | 4 +- compensation/views/compensation/log.py | 36 +--- compensation/views/eco_account/log.py | 37 +--- ema/urls.py | 4 +- ema/views/log.py | 36 +--- intervention/urls.py | 4 +- intervention/views/log.py | 36 +--- konova/urls.py | 9 +- konova/views.py | 248 ------------------------- konova/views/__init__.py | 7 + konova/views/error.py | 38 ++++ konova/views/geometry.py | 108 +++++++++++ konova/views/home.py | 82 ++++++++ konova/views/log.py | 41 ++++ konova/views/logout.py | 26 +++ konova/views/map_proxy.py | 35 ++++ 17 files changed, 387 insertions(+), 368 deletions(-) delete mode 100644 konova/views.py create mode 100644 konova/views/__init__.py create mode 100644 konova/views/error.py create mode 100644 konova/views/geometry.py create mode 100644 konova/views/home.py create mode 100644 konova/views/log.py create mode 100644 konova/views/logout.py create mode 100644 konova/views/map_proxy.py diff --git a/compensation/urls/compensation.py b/compensation/urls/compensation.py index 75ec9297..5b27906e 100644 --- a/compensation/urls/compensation.py +++ b/compensation/urls/compensation.py @@ -16,7 +16,7 @@ from compensation.views.compensation.action import action_edit_view, action_new_ from compensation.views.compensation.state import state_new_view, state_remove_view, state_edit_view from compensation.views.compensation.compensation import index_view, new_view, new_id_view, detail_view, edit_view, \ remove_view -from compensation.views.compensation.log import log_view +from compensation.views.compensation.log import CompensationLogView urlpatterns = [ # Main compensation @@ -25,7 +25,7 @@ urlpatterns = [ path('new/', new_view, name='new'), path('new', new_view, name='new'), path('', detail_view, name='detail'), - path('/log', log_view, name='log'), + path('/log', CompensationLogView.as_view(), name='log'), path('/edit', edit_view, name='edit'), path('/remove', remove_view, name='remove'), diff --git a/compensation/urls/eco_account.py b/compensation/urls/eco_account.py index 85f74121..e15dd58f 100644 --- a/compensation/urls/eco_account.py +++ b/compensation/urls/eco_account.py @@ -10,7 +10,7 @@ from django.urls import path from compensation.autocomplete.eco_account import EcoAccountAutocomplete from compensation.views.eco_account.eco_account import index_view, new_view, new_id_view, edit_view, remove_view, \ detail_view -from compensation.views.eco_account.log import log_view +from compensation.views.eco_account.log import EcoAccountLogView from compensation.views.eco_account.record import record_view from compensation.views.eco_account.report import report_view from compensation.views.eco_account.resubmission import create_resubmission_view @@ -28,7 +28,7 @@ urlpatterns = [ path('new/', new_view, name='new'), path('new/id', new_id_view, name='new-id'), path('', detail_view, name='detail'), - path('/log', log_view, name='log'), + path('/log', EcoAccountLogView.as_view(), name='log'), path('/record', record_view, name='record'), path('/report', report_view, name='report'), path('/edit', edit_view, name='edit'), diff --git a/compensation/views/compensation/log.py b/compensation/views/compensation/log.py index 91b38aa5..22406843 100644 --- a/compensation/views/compensation/log.py +++ b/compensation/views/compensation/log.py @@ -6,36 +6,18 @@ Created on: 19.08.22 """ from django.contrib.auth.decorators import login_required -from django.http import HttpRequest -from django.shortcuts import get_object_or_404, render -from django.utils.translation import gettext_lazy as _ +from django.utils.decorators import method_decorator from compensation.models import Compensation -from konova.contexts import BaseContext from konova.decorators import shared_access_required, default_group_required +from konova.views.log import AbstractLogView -@login_required -@default_group_required -@shared_access_required(Compensation, "id") -def log_view(request: HttpRequest, id: str): - """ Renders a log view using modal +class CompensationLogView(AbstractLogView): + model = Compensation - Args: - request (HttpRequest): The incoming request - id (str): The compensation's id - - Returns: - - """ - comp = get_object_or_404(Compensation, id=id) - template = "modal/modal_generic.html" - body_template = "log.html" - - context = { - "modal_body_template": body_template, - "log": comp.log.all(), - "modal_title": _("Log"), - } - context = BaseContext(request, context).context - return render(request, template, context) + @method_decorator(login_required) + @method_decorator(default_group_required) + @method_decorator(shared_access_required(Compensation, "id")) + def dispatch(self, request, *args, **kwargs): + return super().dispatch(request, *args, **kwargs) diff --git a/compensation/views/eco_account/log.py b/compensation/views/eco_account/log.py index 0a795199..b9ca5bc3 100644 --- a/compensation/views/eco_account/log.py +++ b/compensation/views/eco_account/log.py @@ -6,37 +6,18 @@ Created on: 19.08.22 """ from django.contrib.auth.decorators import login_required -from django.http import HttpRequest -from django.shortcuts import get_object_or_404, render -from django.utils.translation import gettext_lazy as _ +from django.utils.decorators import method_decorator from compensation.models import EcoAccount -from konova.contexts import BaseContext from konova.decorators import shared_access_required, default_group_required +from konova.views.log import AbstractLogView -@login_required -@default_group_required -@shared_access_required(EcoAccount, "id") -def log_view(request: HttpRequest, id: str): - """ Renders a log view using modal - - Args: - request (HttpRequest): The incoming request - id (str): The eco acount's id - - Returns: - - """ - comp = get_object_or_404(EcoAccount, id=id) - template = "modal/modal_generic.html" - body_template = "log.html" - - context = { - "modal_body_template": body_template, - "log": comp.log.all(), - "modal_title": _("Log"), - } - context = BaseContext(request, context).context - return render(request, template, context) +class EcoAccountLogView(AbstractLogView): + model = EcoAccount + @method_decorator(login_required) + @method_decorator(default_group_required) + @method_decorator(shared_access_required(EcoAccount, "id")) + def dispatch(self, request, *args, **kwargs): + return super().dispatch(request, *args, **kwargs) diff --git a/ema/urls.py b/ema/urls.py index 92877271..d4972557 100644 --- a/ema/urls.py +++ b/ema/urls.py @@ -11,7 +11,7 @@ from ema.views.action import action_new_view, action_edit_view, action_remove_vi from ema.views.deadline import deadline_new_view, deadline_edit_view, deadline_remove_view from ema.views.document import document_new_view, get_document_view, remove_document_view, edit_document_view from ema.views.ema import index_view, new_view, new_id_view, detail_view, edit_view, remove_view -from ema.views.log import log_view +from ema.views.log import EmaLogView from ema.views.record import record_view from ema.views.report import report_view from ema.views.resubmission import create_resubmission_view @@ -24,7 +24,7 @@ urlpatterns = [ path("new/", new_view, name="new"), path("new/id", new_id_view, name="new-id"), path("", detail_view, name="detail"), - path('/log', log_view, name='log'), + path('/log', EmaLogView.as_view(), name='log'), path('/edit', edit_view, name='edit'), path('/remove', remove_view, name='remove'), path('/record', record_view, name='record'), diff --git a/ema/views/log.py b/ema/views/log.py index 3e3f869f..80b4a9ff 100644 --- a/ema/views/log.py +++ b/ema/views/log.py @@ -6,36 +6,18 @@ Created on: 19.08.22 """ from django.contrib.auth.decorators import login_required -from django.http import HttpRequest -from django.shortcuts import get_object_or_404, render -from django.utils.translation import gettext_lazy as _ +from django.utils.decorators import method_decorator from ema.models import Ema -from konova.contexts import BaseContext from konova.decorators import shared_access_required, conservation_office_group_required +from konova.views.log import AbstractLogView -@login_required -@conservation_office_group_required -@shared_access_required(Ema, "id") -def log_view(request: HttpRequest, id: str): - """ Renders a log view using modal +class EmaLogView(AbstractLogView): + model = Ema - Args: - request (HttpRequest): The incoming request - id (str): The EMA's id - - Returns: - - """ - ema = get_object_or_404(Ema, id=id) - template = "modal/modal_generic.html" - body_template = "log.html" - - context = { - "modal_body_template": body_template, - "log": ema.log.all(), - "modal_title": _("Log"), - } - context = BaseContext(request, context).context - return render(request, template, context) + @method_decorator(login_required) + @method_decorator(conservation_office_group_required) + @method_decorator(shared_access_required(Ema, "id")) + def dispatch(self, request, *args, **kwargs): + return super().dispatch(request, *args, **kwargs) diff --git a/intervention/urls.py b/intervention/urls.py index 2d0dfdb5..ed9dbaae 100644 --- a/intervention/urls.py +++ b/intervention/urls.py @@ -13,7 +13,7 @@ from intervention.views.compensation import remove_compensation_view from intervention.views.deduction import new_deduction_view, edit_deduction_view, remove_deduction_view from intervention.views.document import new_document_view, get_document_view, remove_document_view, edit_document_view from intervention.views.intervention import index_view, new_view, new_id_view, detail_view, edit_view, remove_view -from intervention.views.log import log_view +from intervention.views.log import InterventionLogView from intervention.views.record import record_view from intervention.views.report import report_view from intervention.views.resubmission import create_resubmission_view @@ -27,7 +27,7 @@ urlpatterns = [ path('new/', new_view, name='new'), path('new/id', new_id_view, name='new-id'), path('', detail_view, name='detail'), - path('/log', log_view, name='log'), + path('/log', InterventionLogView.as_view(), name='log'), path('/edit', edit_view, name='edit'), path('/remove', remove_view, name='remove'), path('/share/', share_view, name='share'), diff --git a/intervention/views/log.py b/intervention/views/log.py index fcb69197..709829c6 100644 --- a/intervention/views/log.py +++ b/intervention/views/log.py @@ -6,36 +6,18 @@ Created on: 19.08.22 """ from django.contrib.auth.decorators import login_required -from django.http import HttpRequest -from django.shortcuts import get_object_or_404, render -from django.utils.translation import gettext_lazy as _ +from django.utils.decorators import method_decorator from intervention.models import Intervention -from konova.contexts import BaseContext from konova.decorators import shared_access_required, default_group_required +from konova.views.log import AbstractLogView -@login_required -@default_group_required -@shared_access_required(Intervention, "id") -def log_view(request: HttpRequest, id: str): - """ Renders a log view using modal +class InterventionLogView(AbstractLogView): + model = Intervention - Args: - request (HttpRequest): The incoming request - id (str): The compensation's id - - Returns: - - """ - intervention = get_object_or_404(Intervention, id=id) - template = "modal/modal_generic.html" - body_template = "log.html" - - context = { - "modal_body_template": body_template, - "log": intervention.log.all(), - "modal_title": _("Log"), - } - context = BaseContext(request, context).context - return render(request, template, context) + @method_decorator(login_required) + @method_decorator(default_group_required) + @method_decorator(shared_access_required(Intervention, "id")) + def dispatch(self, request, *args, **kwargs): + return super().dispatch(request, *args, **kwargs) diff --git a/konova/urls.py b/konova/urls.py index 1909091e..a8c2426a 100644 --- a/konova/urls.py +++ b/konova/urls.py @@ -19,7 +19,10 @@ from django.urls import path, include from konova.settings import SSO_SERVER, SSO_PUBLIC_KEY, SSO_PRIVATE_KEY, DEBUG from konova.sso.sso import KonovaSSOClient -from konova.views import logout_view, home_view, get_geom_parcels, get_geom_parcels_content, map_client_proxy_view +from konova.views.logout import logout_view +from konova.views.geometry import get_geom_parcels, get_geom_parcels_content +from konova.views.home import home_view +from konova.views.map_proxy import map_client_proxy_view sso_client = KonovaSSOClient(SSO_SERVER, SSO_PUBLIC_KEY, SSO_PRIVATE_KEY) urlpatterns = [ @@ -45,5 +48,5 @@ if DEBUG: path('__debug__/', include(debug_toolbar.urls)), ] -handler404 = "konova.views.get_404_view" -handler500 = "konova.views.get_500_view" \ No newline at end of file +handler404 = "konova.views.error.get_404_view" +handler500 = "konova.views.error.get_500_view" \ No newline at end of file diff --git a/konova/views.py b/konova/views.py deleted file mode 100644 index 48572a85..00000000 --- a/konova/views.py +++ /dev/null @@ -1,248 +0,0 @@ -""" -Author: Michel Peltriaux -Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany -Contact: michel.peltriaux@sgdnord.rlp.de -Created on: 16.11.20 - -""" -import json - -import requests -from django.contrib.auth import logout -from django.contrib.auth.decorators import login_required -from django.http import HttpRequest, HttpResponse, JsonResponse -from django.shortcuts import redirect, render, get_object_or_404 -from django.template.loader import render_to_string -from django.utils import timezone -from django.utils.translation import gettext_lazy as _ - -from compensation.models import Compensation, EcoAccount -from intervention.models import Intervention -from konova.contexts import BaseContext -from konova.decorators import any_group_check -from konova.models import Deadline, Geometry, Municipal -from konova.sub_settings.context_settings import TAB_TITLE_IDENTIFIER -from news.models import ServerMessage -from konova.settings import SSO_SERVER_BASE - - -def logout_view(request: HttpRequest): - """ - Logout route for ending the session manually. - - Args: - request (HttpRequest): The used request object - - Returns: - A redirect - """ - logout(request) - return redirect(SSO_SERVER_BASE) - - -@login_required -@any_group_check -def home_view(request: HttpRequest): - """ - Renders the landing page - - Args: - request (HttpRequest): The used request object - - Returns: - A redirect - """ - template = "konova/home.html" - now = timezone.now() - user = request.user - - # Fetch the four newest active and published ServerMessages - msgs = ServerMessage.objects.filter( - is_active=True, - publish_on__lte=now, - unpublish_on__gte=now, - ).order_by( - "-publish_on" - )[:3] - - # First fetch all valid objects (undeleted, only newest versions) - interventions = Intervention.objects.filter( - deleted=None, - ) - # Then fetch only user related ones - user_interventions = interventions.filter( - users__in=[user] - ) - - # Repeat for other objects - comps = Compensation.objects.filter( - deleted=None, - ) - user_comps = comps.filter( - intervention__users__in=[user] - ) - eco_accs = EcoAccount.objects.filter( - deleted=None, - ) - user_ecco_accs = eco_accs.filter( - users__in=[user] - ) - - additional_context = { - "msgs": msgs, - "total_intervention_count": interventions.count(), - "user_intervention_count": user_interventions.count(), - "total_compensation_count": comps.count(), - "user_compensation_count": user_comps.count(), - "total_eco_count": eco_accs.count(), - "user_eco_count": user_ecco_accs.count(), - TAB_TITLE_IDENTIFIER: _("Home"), - } - context = BaseContext(request, additional_context).context - return render(request, template, context) - - -def get_geom_parcels(request: HttpRequest, id: str): - """ Getter for HTMX - - Returns all parcels of the requested geometry rendered into a simple HTML table - - Args: - request (HttpRequest): The incoming request - id (str): The geometry's id - - Returns: - A rendered piece of HTML - """ - # HTTP code 286 states that the HTMX should stop polling for updates - # https://htmx.org/docs/#polling - status_code = 286 - template = "konova/includes/parcels/parcel_table_frame.html" - geom = get_object_or_404(Geometry, id=id) - parcels = geom.get_underlying_parcels() - geos_geom = geom.geom - - parcels_are_currently_calculated = geos_geom is not None and geos_geom.area > 0 and len(parcels) == 0 - parcels_available = len(parcels) > 0 - no_geometry_given = geos_geom is None - - if parcels_are_currently_calculated: - # Parcels are being calculated right now. Change the status code, so polling stays active for fetching - # resutls after the calculation - status_code = 200 - - if parcels_available or no_geometry_given: - parcels = parcels.order_by("-municipal", "flr", "flrstck_zhlr", "flrstck_nnr") - municipals = parcels.order_by("municipal").distinct("municipal").values("municipal__id") - municipals = Municipal.objects.filter(id__in=municipals) - - rpp = 100 - num_all_parcels = parcels.count() - parcels = parcels[:rpp] - next_page = 1 - if len(parcels) < rpp: - next_page = None - - context = { - "num_parcels": num_all_parcels, - "parcels": parcels, - "municipals": municipals, - "geom_id": str(id), - "next_page": next_page, - } - html = render_to_string(template, context, request) - return HttpResponse(html, status=status_code) - else: - return HttpResponse(None, status=404) - - -def get_geom_parcels_content(request: HttpRequest, id: str, page: int): - """ Getter for infinite scroll of HTMX - - Returns parcels of a specific page/slice of the found parcel set. - Implementation of infinite scroll htmx example: https://htmx.org/examples/infinite-scroll/ - - Args: - request (HttpRequest): The incoming request - id (str): The geometry's id - page (int): The requested page number - - Returns: - A rendered piece of HTML - """ - if page < 0: - raise AssertionError("Parcel page can not be negative") - - # HTTP code 286 states that the HTMX should stop polling for updates - # https://htmx.org/docs/#polling - status_code = 286 - template = "konova/includes/parcels/parcel_table_content.html" - geom = get_object_or_404(Geometry, id=id) - parcels = geom.get_underlying_parcels() - - parcels = parcels.order_by("-municipal", "flr", "flrstck_zhlr", "flrstck_nnr") - rpp = 100 - from_p = rpp * (page-1) - to_p = rpp * (page) - next_page = page + 1 - parcels = parcels[from_p:to_p] - if len(parcels) < rpp: - next_page = None - - context = { - "parcels": parcels, - "geom_id": str(id), - "next_page": next_page, - } - html = render_to_string(template, context, request) - return HttpResponse(html, status=status_code) - - -def get_404_view(request: HttpRequest, exception=None): - """ Returns a 404 handling view - - Args: - request (): - exception (): - - Returns: - - """ - context = BaseContext.context - return render(request, "404.html", context, status=404) - - -def get_500_view(request: HttpRequest): - """ Returns a 404 handling view - - Args: - request (): - - Returns: - - """ - context = BaseContext.context - return render(request, "500.html", context, status=500) - - -@login_required -def map_client_proxy_view(request: HttpRequest): - """ Provides proxy functionality for NETGIS map client. - - Used for fetching content of a provided url - - Args: - request (HttpRequest): The incoming request - - Returns: - - """ - url = request.META.get("QUERY_STRING") - response = requests.get(url) - body = json.loads(response.content) - if response.status_code != 200: - return JsonResponse({ - "status_code": response.status_code, - "content": body, - }) - return JsonResponse(body) diff --git a/konova/views/__init__.py b/konova/views/__init__.py new file mode 100644 index 00000000..3a996e1f --- /dev/null +++ b/konova/views/__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: 19.08.22 + +""" diff --git a/konova/views/error.py b/konova/views/error.py new file mode 100644 index 00000000..6a85948a --- /dev/null +++ b/konova/views/error.py @@ -0,0 +1,38 @@ +""" +Author: Michel Peltriaux +Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany +Contact: michel.peltriaux@sgdnord.rlp.de +Created on: 16.11.20 + +""" +from django.http import HttpRequest +from django.shortcuts import render + +from konova.contexts import BaseContext + + +def get_404_view(request: HttpRequest, exception=None): + """ Returns a 404 handling view + + Args: + request (): + exception (): + + Returns: + + """ + context = BaseContext.context + return render(request, "404.html", context, status=404) + + +def get_500_view(request: HttpRequest): + """ Returns a 404 handling view + + Args: + request (): + + Returns: + + """ + context = BaseContext.context + return render(request, "500.html", context, status=500) diff --git a/konova/views/geometry.py b/konova/views/geometry.py new file mode 100644 index 00000000..e2e8737f --- /dev/null +++ b/konova/views/geometry.py @@ -0,0 +1,108 @@ +""" +Author: Michel Peltriaux +Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany +Contact: ksp-servicestelle@sgdnord.rlp.de +Created on: 19.08.22 + +""" +from django.http import HttpResponse, HttpRequest +from django.shortcuts import get_object_or_404 +from django.template.loader import render_to_string + +from konova.models import Geometry, Municipal + + +def get_geom_parcels(request: HttpRequest, id: str): + """ Getter for HTMX + + Returns all parcels of the requested geometry rendered into a simple HTML table + + Args: + request (HttpRequest): The incoming request + id (str): The geometry's id + + Returns: + A rendered piece of HTML + """ + # HTTP code 286 states that the HTMX should stop polling for updates + # https://htmx.org/docs/#polling + status_code = 286 + template = "konova/includes/parcels/parcel_table_frame.html" + geom = get_object_or_404(Geometry, id=id) + parcels = geom.get_underlying_parcels() + geos_geom = geom.geom + + parcels_are_currently_calculated = geos_geom is not None and geos_geom.area > 0 and len(parcels) == 0 + parcels_available = len(parcels) > 0 + no_geometry_given = geos_geom is None + + if parcels_are_currently_calculated: + # Parcels are being calculated right now. Change the status code, so polling stays active for fetching + # resutls after the calculation + status_code = 200 + + if parcels_available or no_geometry_given: + parcels = parcels.order_by("-municipal", "flr", "flrstck_zhlr", "flrstck_nnr") + municipals = parcels.order_by("municipal").distinct("municipal").values("municipal__id") + municipals = Municipal.objects.filter(id__in=municipals) + + rpp = 100 + num_all_parcels = parcels.count() + parcels = parcels[:rpp] + next_page = 1 + if len(parcels) < rpp: + next_page = None + + context = { + "num_parcels": num_all_parcels, + "parcels": parcels, + "municipals": municipals, + "geom_id": str(id), + "next_page": next_page, + } + html = render_to_string(template, context, request) + return HttpResponse(html, status=status_code) + else: + return HttpResponse(None, status=404) + + +def get_geom_parcels_content(request: HttpRequest, id: str, page: int): + """ Getter for infinite scroll of HTMX + + Returns parcels of a specific page/slice of the found parcel set. + Implementation of infinite scroll htmx example: https://htmx.org/examples/infinite-scroll/ + + Args: + request (HttpRequest): The incoming request + id (str): The geometry's id + page (int): The requested page number + + Returns: + A rendered piece of HTML + """ + if page < 0: + raise AssertionError("Parcel page can not be negative") + + # HTTP code 286 states that the HTMX should stop polling for updates + # https://htmx.org/docs/#polling + status_code = 286 + template = "konova/includes/parcels/parcel_table_content.html" + geom = get_object_or_404(Geometry, id=id) + parcels = geom.get_underlying_parcels() + + parcels = parcels.order_by("-municipal", "flr", "flrstck_zhlr", "flrstck_nnr") + rpp = 100 + from_p = rpp * (page-1) + to_p = rpp * (page) + next_page = page + 1 + parcels = parcels[from_p:to_p] + if len(parcels) < rpp: + next_page = None + + context = { + "parcels": parcels, + "geom_id": str(id), + "next_page": next_page, + } + html = render_to_string(template, context, request) + return HttpResponse(html, status=status_code) diff --git a/konova/views/home.py b/konova/views/home.py new file mode 100644 index 00000000..3118956c --- /dev/null +++ b/konova/views/home.py @@ -0,0 +1,82 @@ +""" +Author: Michel Peltriaux +Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany +Contact: ksp-servicestelle@sgdnord.rlp.de +Created on: 19.08.22 + +""" +from django.contrib.auth.decorators import login_required +from django.http import HttpRequest +from django.shortcuts import render +from django.utils import timezone +from django.utils.translation import gettext_lazy as _ + +from compensation.models import EcoAccount, Compensation +from intervention.models import Intervention +from konova.contexts import BaseContext +from konova.decorators import any_group_check +from konova.sub_settings.context_settings import TAB_TITLE_IDENTIFIER +from news.models import ServerMessage + + +@login_required +@any_group_check +def home_view(request: HttpRequest): + """ + Renders the landing page + + Args: + request (HttpRequest): The used request object + + Returns: + A redirect + """ + template = "konova/home.html" + now = timezone.now() + user = request.user + + # Fetch the four newest active and published ServerMessages + msgs = ServerMessage.objects.filter( + is_active=True, + publish_on__lte=now, + unpublish_on__gte=now, + ).order_by( + "-publish_on" + )[:3] + + # First fetch all valid objects (undeleted, only newest versions) + interventions = Intervention.objects.filter( + deleted=None, + ) + # Then fetch only user related ones + user_interventions = interventions.filter( + users__in=[user] + ) + + # Repeat for other objects + comps = Compensation.objects.filter( + deleted=None, + ) + user_comps = comps.filter( + intervention__users__in=[user] + ) + eco_accs = EcoAccount.objects.filter( + deleted=None, + ) + user_ecco_accs = eco_accs.filter( + users__in=[user] + ) + + additional_context = { + "msgs": msgs, + "total_intervention_count": interventions.count(), + "user_intervention_count": user_interventions.count(), + "total_compensation_count": comps.count(), + "user_compensation_count": user_comps.count(), + "total_eco_count": eco_accs.count(), + "user_eco_count": user_ecco_accs.count(), + TAB_TITLE_IDENTIFIER: _("Home"), + } + context = BaseContext(request, additional_context).context + return render(request, template, context) + diff --git a/konova/views/log.py b/konova/views/log.py new file mode 100644 index 00000000..b6d44c35 --- /dev/null +++ b/konova/views/log.py @@ -0,0 +1,41 @@ +""" +Author: Michel Peltriaux +Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany +Contact: ksp-servicestelle@sgdnord.rlp.de +Created on: 19.08.22 + +""" +from django.shortcuts import get_object_or_404, render +from django.views import View +from django.utils.translation import gettext_lazy as _ + +from konova.contexts import BaseContext + + +class AbstractLogView(View): + model = None + + class Meta: + abstract = True + + def get(self, request, id: str): + """ Renders a log view using modal + + Args: + request (HttpRequest): The incoming request + id (str): The compensation's id + + Returns: + + """ + intervention = get_object_or_404(self.model, id=id) + template = "modal/modal_generic.html" + body_template = "log.html" + + context = { + "modal_body_template": body_template, + "log": intervention.log.all(), + "modal_title": _("Log"), + } + context = BaseContext(request, context).context + return render(request, template, context) diff --git a/konova/views/logout.py b/konova/views/logout.py new file mode 100644 index 00000000..943673d0 --- /dev/null +++ b/konova/views/logout.py @@ -0,0 +1,26 @@ +""" +Author: Michel Peltriaux +Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany +Contact: ksp-servicestelle@sgdnord.rlp.de +Created on: 19.08.22 + +""" +from django.contrib.auth import logout +from django.http import HttpRequest +from django.shortcuts import redirect + +from konova.sub_settings.sso_settings import SSO_SERVER_BASE + + +def logout_view(request: HttpRequest): + """ + Logout route for ending the session manually. + + Args: + request (HttpRequest): The used request object + + Returns: + A redirect + """ + logout(request) + return redirect(SSO_SERVER_BASE) diff --git a/konova/views/map_proxy.py b/konova/views/map_proxy.py new file mode 100644 index 00000000..13920fd3 --- /dev/null +++ b/konova/views/map_proxy.py @@ -0,0 +1,35 @@ +""" +Author: Michel Peltriaux +Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany +Contact: ksp-servicestelle@sgdnord.rlp.de +Created on: 19.08.22 + +""" +import json + +import requests +from django.contrib.auth.decorators import login_required +from django.http import JsonResponse, HttpRequest + + +@login_required +def map_client_proxy_view(request: HttpRequest): + """ Provides proxy functionality for NETGIS map client. + + Used for fetching content of a provided url + + Args: + request (HttpRequest): The incoming request + + Returns: + + """ + url = request.META.get("QUERY_STRING") + response = requests.get(url) + body = json.loads(response.content) + if response.status_code != 200: + return JsonResponse({ + "status_code": response.status_code, + "content": body, + }) + return JsonResponse(body) -- 2.45.2 From ef3507f0587dbf813c5388c51571aaf77649188f Mon Sep 17 00:00:00 2001 From: mpeltriaux Date: Fri, 19 Aug 2022 10:47:59 +0200 Subject: [PATCH 13/21] Resubmission class view * adds AbstractResubmissionView to konova app * implemented for all major data types * replaces function based views --- compensation/urls/compensation.py | 4 +- compensation/urls/eco_account.py | 4 +- .../views/compensation/resubmission.py | 36 ++++-------- .../views/eco_account/resubmission.py | 36 ++++-------- ema/urls.py | 4 +- ema/views/resubmission.py | 36 ++++-------- intervention/urls.py | 4 +- intervention/views/resubmission.py | 36 ++++-------- konova/views/resubmission.py | 55 +++++++++++++++++++ 9 files changed, 107 insertions(+), 108 deletions(-) create mode 100644 konova/views/resubmission.py diff --git a/compensation/urls/compensation.py b/compensation/urls/compensation.py index 5b27906e..f2ff5793 100644 --- a/compensation/urls/compensation.py +++ b/compensation/urls/compensation.py @@ -9,7 +9,7 @@ from django.urls import path from compensation.views.compensation.document import edit_document_view, new_document_view, remove_document_view, \ get_document_view -from compensation.views.compensation.resubmission import create_resubmission_view +from compensation.views.compensation.resubmission import CompensationResubmissionView from compensation.views.compensation.report import report_view from compensation.views.compensation.deadline import deadline_new_view, deadline_edit_view, deadline_remove_view from compensation.views.compensation.action import action_edit_view, action_new_view, action_remove_view @@ -41,7 +41,7 @@ urlpatterns = [ path('/deadline//edit', deadline_edit_view, name='deadline-edit'), path('/deadline//remove', deadline_remove_view, name='deadline-remove'), path('/report', report_view, name='report'), - path('/resub', create_resubmission_view, name='resubmission-create'), + path('/resub', CompensationResubmissionView.as_view(), name='resubmission-create'), # Documents path('/document/new/', new_document_view, name='new-doc'), diff --git a/compensation/urls/eco_account.py b/compensation/urls/eco_account.py index e15dd58f..8f9c3b19 100644 --- a/compensation/urls/eco_account.py +++ b/compensation/urls/eco_account.py @@ -13,7 +13,7 @@ from compensation.views.eco_account.eco_account import index_view, new_view, new from compensation.views.eco_account.log import EcoAccountLogView from compensation.views.eco_account.record import record_view from compensation.views.eco_account.report import report_view -from compensation.views.eco_account.resubmission import create_resubmission_view +from compensation.views.eco_account.resubmission import EcoAccountResubmissionView from compensation.views.eco_account.state import state_new_view, state_remove_view, state_edit_view from compensation.views.eco_account.action import action_edit_view, action_new_view, action_remove_view from compensation.views.eco_account.deadline import deadline_new_view, deadline_edit_view, deadline_remove_view @@ -33,7 +33,7 @@ urlpatterns = [ path('/report', report_view, name='report'), path('/edit', edit_view, name='edit'), path('/remove', remove_view, name='remove'), - path('/resub', create_resubmission_view, name='resubmission-create'), + path('/resub', EcoAccountResubmissionView.as_view(), name='resubmission-create'), path('/state/new', state_new_view, name='new-state'), path('/state//edit', state_edit_view, name='state-edit'), diff --git a/compensation/views/compensation/resubmission.py b/compensation/views/compensation/resubmission.py index d90a91ce..dfcbad20 100644 --- a/compensation/views/compensation/resubmission.py +++ b/compensation/views/compensation/resubmission.py @@ -6,34 +6,20 @@ Created on: 19.08.22 """ from django.contrib.auth.decorators import login_required -from django.http import HttpRequest -from django.shortcuts import get_object_or_404 -from django.urls import reverse -from django.utils.translation import gettext_lazy as _ +from django.utils.decorators import method_decorator from compensation.models import Compensation from konova.decorators import shared_access_required, default_group_required -from konova.forms.modals import ResubmissionModalForm +from konova.views.resubmission import AbstractResubmissionView -@login_required -@default_group_required -@shared_access_required(Compensation, "id") -def create_resubmission_view(request: HttpRequest, id: str): - """ Renders resubmission form for a compensation +class CompensationResubmissionView(AbstractResubmissionView): + model = Compensation + redirect_url_base = "compensation:detail" + form_action_url_base = "compensation:resubmission-create" - Args: - request (HttpRequest): The incoming request - id (str): Compensation's id - - Returns: - - """ - com = get_object_or_404(Compensation, id=id) - form = ResubmissionModalForm(request.POST or None, instance=com, request=request) - form.action_url = reverse("compensation:resubmission-create", args=(id,)) - return form.process_request( - request, - msg_success=_("Resubmission set"), - redirect_url=reverse("compensation:detail", args=(id,)) - ) + @method_decorator(login_required) + @method_decorator(default_group_required) + @method_decorator(shared_access_required(Compensation, "id")) + def dispatch(self, request, *args, **kwargs): + return super().dispatch(request, *args, **kwargs) diff --git a/compensation/views/eco_account/resubmission.py b/compensation/views/eco_account/resubmission.py index 43c52224..afe8c713 100644 --- a/compensation/views/eco_account/resubmission.py +++ b/compensation/views/eco_account/resubmission.py @@ -6,34 +6,20 @@ Created on: 19.08.22 """ from django.contrib.auth.decorators import login_required -from django.http import HttpRequest -from django.shortcuts import get_object_or_404 -from django.urls import reverse -from django.utils.translation import gettext_lazy as _ +from django.utils.decorators import method_decorator from compensation.models import EcoAccount from konova.decorators import shared_access_required, default_group_required -from konova.forms.modals import ResubmissionModalForm +from konova.views.resubmission import AbstractResubmissionView -@login_required -@default_group_required -@shared_access_required(EcoAccount, "id") -def create_resubmission_view(request: HttpRequest, id: str): - """ Renders resubmission form for an eco account +class EcoAccountResubmissionView(AbstractResubmissionView): + model = EcoAccount + redirect_url_base = "compensation:acc:detail" + form_action_url_base = "compensation:acc:resubmission-create" - Args: - request (HttpRequest): The incoming request - id (str): EcoAccount's id - - Returns: - - """ - acc = get_object_or_404(EcoAccount, id=id) - form = ResubmissionModalForm(request.POST or None, instance=acc, request=request) - form.action_url = reverse("compensation:acc:resubmission-create", args=(id,)) - return form.process_request( - request, - msg_success=_("Resubmission set"), - redirect_url=reverse("compensation:acc:detail", args=(id,)) - ) + @method_decorator(login_required) + @method_decorator(default_group_required) + @method_decorator(shared_access_required(EcoAccount, "id")) + def dispatch(self, request, *args, **kwargs): + return super().dispatch(request, *args, **kwargs) diff --git a/ema/urls.py b/ema/urls.py index d4972557..726ec653 100644 --- a/ema/urls.py +++ b/ema/urls.py @@ -14,7 +14,7 @@ from ema.views.ema import index_view, new_view, new_id_view, detail_view, edit_v from ema.views.log import EmaLogView from ema.views.record import record_view from ema.views.report import report_view -from ema.views.resubmission import create_resubmission_view +from ema.views.resubmission import EmaResubmissionView from ema.views.share import share_view, create_share_view from ema.views.state import state_new_view, state_remove_view, state_edit_view @@ -29,7 +29,7 @@ urlpatterns = [ path('/remove', remove_view, name='remove'), path('/record', record_view, name='record'), path('/report', report_view, name='report'), - path('/resub', create_resubmission_view, name='resubmission-create'), + path('/resub', EmaResubmissionView.as_view(), name='resubmission-create'), path('/state/new', state_new_view, name='new-state'), path('/state//remove', state_remove_view, name='state-remove'), diff --git a/ema/views/resubmission.py b/ema/views/resubmission.py index 838cab3a..384c3cde 100644 --- a/ema/views/resubmission.py +++ b/ema/views/resubmission.py @@ -6,34 +6,20 @@ Created on: 19.08.22 """ from django.contrib.auth.decorators import login_required -from django.http import HttpRequest -from django.shortcuts import get_object_or_404 -from django.urls import reverse -from django.utils.translation import gettext_lazy as _ +from django.utils.decorators import method_decorator from ema.models import Ema from konova.decorators import shared_access_required, conservation_office_group_required -from konova.forms.modals import ResubmissionModalForm +from konova.views.resubmission import AbstractResubmissionView -@login_required -@conservation_office_group_required -@shared_access_required(Ema, "id") -def create_resubmission_view(request: HttpRequest, id: str): - """ Renders resubmission form for an EMA +class EmaResubmissionView(AbstractResubmissionView): + model = Ema + redirect_url_base = "ema:detail" + form_action_url_base = "ema:resubmission-create" - Args: - request (HttpRequest): The incoming request - id (str): EMA's id - - Returns: - - """ - ema = get_object_or_404(Ema, id=id) - form = ResubmissionModalForm(request.POST or None, instance=ema, request=request) - form.action_url = reverse("ema:resubmission-create", args=(id,)) - return form.process_request( - request, - msg_success=_("Resubmission set"), - redirect_url=reverse("ema:detail", args=(id,)) - ) + @method_decorator(login_required) + @method_decorator(conservation_office_group_required) + @method_decorator(shared_access_required(Ema, "id")) + def dispatch(self, request, *args, **kwargs): + return super().dispatch(request, *args, **kwargs) diff --git a/intervention/urls.py b/intervention/urls.py index ed9dbaae..31148d33 100644 --- a/intervention/urls.py +++ b/intervention/urls.py @@ -16,7 +16,7 @@ from intervention.views.intervention import index_view, new_view, new_id_view, d from intervention.views.log import InterventionLogView from intervention.views.record import record_view from intervention.views.report import report_view -from intervention.views.resubmission import create_resubmission_view +from intervention.views.resubmission import InterventionResubmissionView from intervention.views.revocation import new_revocation_view, edit_revocation_view, remove_revocation_view, \ get_revocation_view from intervention.views.share import share_view, create_share_view @@ -35,7 +35,7 @@ urlpatterns = [ path('/check', check_view, name='check'), path('/record', record_view, name='record'), path('/report', report_view, name='report'), - path('/resub', create_resubmission_view, name='resubmission-create'), + path('/resub', InterventionResubmissionView.as_view(), name='resubmission-create'), # Compensations path('/compensation//remove', remove_compensation_view, name='remove-compensation'), diff --git a/intervention/views/resubmission.py b/intervention/views/resubmission.py index 34a618c2..452a3e38 100644 --- a/intervention/views/resubmission.py +++ b/intervention/views/resubmission.py @@ -6,34 +6,20 @@ Created on: 19.08.22 """ from django.contrib.auth.decorators import login_required -from django.http import HttpRequest -from django.shortcuts import get_object_or_404 -from django.urls import reverse -from django.utils.translation import gettext_lazy as _ +from django.utils.decorators import method_decorator from intervention.models import Intervention from konova.decorators import default_group_required, shared_access_required -from konova.forms.modals import ResubmissionModalForm +from konova.views.resubmission import AbstractResubmissionView -@login_required -@default_group_required -@shared_access_required(Intervention, "id") -def create_resubmission_view(request: HttpRequest, id: str): - """ Renders resubmission form for an intervention +class InterventionResubmissionView(AbstractResubmissionView): + model = Intervention + redirect_url_base = "intervention:detail" + form_action_url_base = "intervention:resubmission-create" - Args: - request (HttpRequest): The incoming request - id (str): Intervention's id - - Returns: - - """ - intervention = get_object_or_404(Intervention, id=id) - form = ResubmissionModalForm(request.POST or None, instance=intervention, request=request) - form.action_url = reverse("intervention:resubmission-create", args=(id,)) - return form.process_request( - request, - msg_success=_("Resubmission set"), - redirect_url=reverse("intervention:detail", args=(id,)) - ) + @method_decorator(login_required) + @method_decorator(default_group_required) + @method_decorator(shared_access_required(Intervention, "id")) + def dispatch(self, request, *args, **kwargs): + return super().dispatch(request, *args, **kwargs) diff --git a/konova/views/resubmission.py b/konova/views/resubmission.py new file mode 100644 index 00000000..92ad056e --- /dev/null +++ b/konova/views/resubmission.py @@ -0,0 +1,55 @@ +""" +Author: Michel Peltriaux +Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany +Contact: ksp-servicestelle@sgdnord.rlp.de +Created on: 19.08.22 + +""" +from django.shortcuts import get_object_or_404 +from django.urls import reverse +from django.views import View +from django.utils.translation import gettext_lazy as _ + +from konova.forms.modals import ResubmissionModalForm + + +class AbstractResubmissionView(View): + model = None + form_action_url_base = None + redirect_url_base = None + + class Meta: + abstract = True + + def get(self, request, id: str): + """ Renders resubmission form for an intervention + + Args: + request (HttpRequest): The incoming request + id (str): Intervention's id + + Returns: + + """ + obj = get_object_or_404(self.model, id=id) + form = ResubmissionModalForm(request.POST or None, instance=obj, request=request) + form.action_url = reverse(self.form_action_url_base, args=(id,)) + return form.process_request( + request, + msg_success=_("Resubmission set"), + redirect_url=reverse(self.redirect_url_base, args=(id,)) + ) + + def post(self, request, id: str): + """ + + BaseModalForm provides the method process_request() which handles GET as well as POST requests. It was written + for easier handling of function based views. To support process_request() on class based views, the post() + call needs to be treated the same way as the get() call. + + Args: + request (HttpRequest): The incoming request + id (str): Intervention's id + + """ + return self.get(request, id) -- 2.45.2 From 7b35591f5d69612996af4c8b0fc31f607b7c0890 Mon Sep 17 00:00:00 2001 From: mpeltriaux Date: Fri, 19 Aug 2022 11:01:33 +0200 Subject: [PATCH 14/21] Record class view * adds AbstractRecordView to konova/views/record.py * implements for all major data types --- compensation/urls/eco_account.py | 4 +- compensation/views/eco_account/record.py | 33 +++++----------- ema/urls.py | 4 +- ema/views/record.py | 32 +++++---------- intervention/urls.py | 4 +- intervention/views/record.py | 34 +++++----------- konova/views/log.py | 2 +- konova/views/record.py | 50 ++++++++++++++++++++++++ konova/views/resubmission.py | 4 +- 9 files changed, 86 insertions(+), 81 deletions(-) create mode 100644 konova/views/record.py diff --git a/compensation/urls/eco_account.py b/compensation/urls/eco_account.py index 8f9c3b19..862d5f4a 100644 --- a/compensation/urls/eco_account.py +++ b/compensation/urls/eco_account.py @@ -11,7 +11,7 @@ from compensation.autocomplete.eco_account import EcoAccountAutocomplete from compensation.views.eco_account.eco_account import index_view, new_view, new_id_view, edit_view, remove_view, \ detail_view from compensation.views.eco_account.log import EcoAccountLogView -from compensation.views.eco_account.record import record_view +from compensation.views.eco_account.record import EcoAccountRecordView from compensation.views.eco_account.report import report_view from compensation.views.eco_account.resubmission import EcoAccountResubmissionView from compensation.views.eco_account.state import state_new_view, state_remove_view, state_edit_view @@ -29,7 +29,7 @@ urlpatterns = [ path('new/id', new_id_view, name='new-id'), path('', detail_view, name='detail'), path('/log', EcoAccountLogView.as_view(), name='log'), - path('/record', record_view, name='record'), + path('/record', EcoAccountRecordView.as_view(), name='record'), path('/report', report_view, name='report'), path('/edit', edit_view, name='edit'), path('/remove', remove_view, name='remove'), diff --git a/compensation/views/eco_account/record.py b/compensation/views/eco_account/record.py index c1fe1384..18ccf237 100644 --- a/compensation/views/eco_account/record.py +++ b/compensation/views/eco_account/record.py @@ -6,33 +6,18 @@ Created on: 19.08.22 """ from django.contrib.auth.decorators import login_required -from django.http import HttpRequest -from django.shortcuts import get_object_or_404 -from django.utils.translation import gettext_lazy as _ +from django.utils.decorators import method_decorator from compensation.models import EcoAccount from konova.decorators import shared_access_required, conservation_office_group_required -from konova.forms.modals import RecordModalForm +from konova.views.record import AbstractRecordView -@login_required -@conservation_office_group_required -@shared_access_required(EcoAccount, "id") -def record_view(request: HttpRequest, id:str): - """ Renders a modal form for recording an eco account +class EcoAccountRecordView(AbstractRecordView): + model = EcoAccount - Args: - request (HttpRequest): The incoming request - id (str): The account's id - - Returns: - - """ - acc = get_object_or_404(EcoAccount, id=id) - form = RecordModalForm(request.POST or None, instance=acc, request=request) - msg_succ = _("{} unrecorded") if acc.recorded else _("{} recorded") - msg_succ = msg_succ.format(acc.identifier) - return form.process_request( - request, - msg_succ - ) + @method_decorator(login_required) + @method_decorator(conservation_office_group_required) + @method_decorator(shared_access_required(EcoAccount, "id")) + def dispatch(self, request, *args, **kwargs): + return super().dispatch(request, *args, **kwargs) diff --git a/ema/urls.py b/ema/urls.py index 726ec653..f68145ba 100644 --- a/ema/urls.py +++ b/ema/urls.py @@ -12,7 +12,7 @@ from ema.views.deadline import deadline_new_view, deadline_edit_view, deadline_r from ema.views.document import document_new_view, get_document_view, remove_document_view, edit_document_view from ema.views.ema import index_view, new_view, new_id_view, detail_view, edit_view, remove_view from ema.views.log import EmaLogView -from ema.views.record import record_view +from ema.views.record import EmaRecordView from ema.views.report import report_view from ema.views.resubmission import EmaResubmissionView from ema.views.share import share_view, create_share_view @@ -27,7 +27,7 @@ urlpatterns = [ path('/log', EmaLogView.as_view(), name='log'), path('/edit', edit_view, name='edit'), path('/remove', remove_view, name='remove'), - path('/record', record_view, name='record'), + path('/record', EmaRecordView.as_view(), name='record'), path('/report', report_view, name='report'), path('/resub', EmaResubmissionView.as_view(), name='resubmission-create'), diff --git a/ema/views/record.py b/ema/views/record.py index 4ae40d2f..7dfc946b 100644 --- a/ema/views/record.py +++ b/ema/views/record.py @@ -6,32 +6,18 @@ Created on: 19.08.22 """ from django.contrib.auth.decorators import login_required -from django.http import HttpRequest -from django.shortcuts import get_object_or_404 -from django.utils.translation import gettext_lazy as _ +from django.utils.decorators import method_decorator from ema.models import Ema from konova.decorators import shared_access_required, conservation_office_group_required -from konova.forms.modals import RecordModalForm +from konova.views.record import AbstractRecordView -@login_required -@conservation_office_group_required -@shared_access_required(Ema, "id") -def record_view(request: HttpRequest, id: str): - """ Renders a modal view for recording the EMA +class EmaRecordView(AbstractRecordView): + model = Ema - Args: - request (HttpRequest): The incoming request - id (str): The EMA's id - - Returns: - - """ - ema = get_object_or_404(Ema, id=id) - msg_succ = _("{} unrecorded") if ema.recorded else _("{} recorded") - form = RecordModalForm(request.POST or None, instance=ema, request=request) - return form.process_request( - request=request, - msg_success=msg_succ.format("EMA"), - ) + @method_decorator(login_required) + @method_decorator(conservation_office_group_required) + @method_decorator(shared_access_required(Ema, "id")) + def dispatch(self, request, *args, **kwargs): + return super().dispatch(request, *args, **kwargs) diff --git a/intervention/urls.py b/intervention/urls.py index 31148d33..284a3440 100644 --- a/intervention/urls.py +++ b/intervention/urls.py @@ -14,7 +14,7 @@ from intervention.views.deduction import new_deduction_view, edit_deduction_view from intervention.views.document import new_document_view, get_document_view, remove_document_view, edit_document_view from intervention.views.intervention import index_view, new_view, new_id_view, detail_view, edit_view, remove_view from intervention.views.log import InterventionLogView -from intervention.views.record import record_view +from intervention.views.record import InterventionRecordView from intervention.views.report import report_view from intervention.views.resubmission import InterventionResubmissionView from intervention.views.revocation import new_revocation_view, edit_revocation_view, remove_revocation_view, \ @@ -33,7 +33,7 @@ urlpatterns = [ path('/share/', share_view, name='share'), path('/share', create_share_view, name='share-create'), path('/check', check_view, name='check'), - path('/record', record_view, name='record'), + path('/record', InterventionRecordView.as_view(), name='record'), path('/report', report_view, name='report'), path('/resub', InterventionResubmissionView.as_view(), name='resubmission-create'), diff --git a/intervention/views/record.py b/intervention/views/record.py index c5709b22..a845fdfd 100644 --- a/intervention/views/record.py +++ b/intervention/views/record.py @@ -6,34 +6,18 @@ Created on: 19.08.22 """ from django.contrib.auth.decorators import login_required -from django.http import HttpRequest -from django.shortcuts import get_object_or_404 -from django.utils.translation import gettext_lazy as _ +from django.utils.decorators import method_decorator from intervention.models import Intervention from konova.decorators import conservation_office_group_required, shared_access_required -from konova.forms.modals import RecordModalForm +from konova.views.record import AbstractRecordView -@login_required -@conservation_office_group_required -@shared_access_required(Intervention, "id") -def record_view(request: HttpRequest, id: str): - """ Renders a modal form for recording an intervention +class InterventionRecordView(AbstractRecordView): + model = Intervention - Args: - request (HttpRequest): The incoming request - id (str): The intervention's id - - Returns: - - """ - intervention = get_object_or_404(Intervention, id=id) - form = RecordModalForm(request.POST or None, instance=intervention, request=request) - msg_succ = _("{} unrecorded") if intervention.recorded else _("{} recorded") - msg_succ = msg_succ.format(intervention.identifier) - return form.process_request( - request, - msg_succ, - msg_error=_("There are errors on this intervention:") - ) + @method_decorator(login_required) + @method_decorator(conservation_office_group_required) + @method_decorator(shared_access_required(Intervention, "id")) + def dispatch(self, request, *args, **kwargs): + return super().dispatch(request, *args, **kwargs) diff --git a/konova/views/log.py b/konova/views/log.py index b6d44c35..7cc9d56a 100644 --- a/konova/views/log.py +++ b/konova/views/log.py @@ -23,7 +23,7 @@ class AbstractLogView(View): Args: request (HttpRequest): The incoming request - id (str): The compensation's id + id (str): The object's id Returns: diff --git a/konova/views/record.py b/konova/views/record.py new file mode 100644 index 00000000..b80d1b0f --- /dev/null +++ b/konova/views/record.py @@ -0,0 +1,50 @@ +""" +Author: Michel Peltriaux +Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany +Contact: ksp-servicestelle@sgdnord.rlp.de +Created on: 19.08.22 + +""" +from django.shortcuts import get_object_or_404 +from django.views import View +from django.utils.translation import gettext_lazy as _ + +from konova.forms.modals import RecordModalForm + + +class AbstractRecordView(View): + model = None + + def get(self, request, id: str): + """ Renders a modal form for recording an object + + Args: + request (HttpRequest): The incoming request + id (str): The object's id + + Returns: + + """ + obj = get_object_or_404(self.model, id=id) + form = RecordModalForm(request.POST or None, instance=obj, request=request) + msg_succ = _("{} unrecorded") if obj.recorded else _("{} recorded") + msg_succ = msg_succ.format(obj.identifier) + return form.process_request( + request, + msg_succ, + msg_error=_("Errors found:") + ) + + def post(self, request, id: str): + """ + + BaseModalForm provides the method process_request() which handles GET as well as POST requests. It was written + for easier handling of function based views. To support process_request() on class based views, the post() + call needs to be treated the same way as the get() call. + + Args: + request (HttpRequest): The incoming request + id (str): Intervention's id + + """ + return self.get(request, id) diff --git a/konova/views/resubmission.py b/konova/views/resubmission.py index 92ad056e..634949de 100644 --- a/konova/views/resubmission.py +++ b/konova/views/resubmission.py @@ -22,11 +22,11 @@ class AbstractResubmissionView(View): abstract = True def get(self, request, id: str): - """ Renders resubmission form for an intervention + """ Renders resubmission form for an object Args: request (HttpRequest): The incoming request - id (str): Intervention's id + id (str): Object's id Returns: -- 2.45.2 From a73046aa02ef7eeb2675fd7a8a44e0c76cb2142c Mon Sep 17 00:00:00 2001 From: mpeltriaux Date: Mon, 22 Aug 2022 07:52:22 +0200 Subject: [PATCH 15/21] Document views * replaces function based views for creating, editing, removing and fetching documents with class based views * implemented for all major data types --- compensation/urls/compensation.py | 12 +- compensation/urls/eco_account.py | 12 +- compensation/views/compensation/document.py | 124 ++++++------------ compensation/views/eco_account/document.py | 119 ++++++----------- ema/urls.py | 10 +- ema/views/document.py | 124 ++++++------------ intervention/urls.py | 11 +- intervention/views/document.py | 125 ++++++------------ konova/views/document.py | 138 ++++++++++++++++++++ 9 files changed, 313 insertions(+), 362 deletions(-) create mode 100644 konova/views/document.py diff --git a/compensation/urls/compensation.py b/compensation/urls/compensation.py index f2ff5793..ea60bafa 100644 --- a/compensation/urls/compensation.py +++ b/compensation/urls/compensation.py @@ -7,8 +7,8 @@ Created on: 24.08.21 """ from django.urls import path -from compensation.views.compensation.document import edit_document_view, new_document_view, remove_document_view, \ - get_document_view +from compensation.views.compensation.document import EditCompensationDocumentView, NewCompensationDocumentView, \ + GetCompensationDocumentView, RemoveCompensationDocumentView from compensation.views.compensation.resubmission import CompensationResubmissionView from compensation.views.compensation.report import report_view from compensation.views.compensation.deadline import deadline_new_view, deadline_edit_view, deadline_remove_view @@ -44,9 +44,9 @@ urlpatterns = [ path('/resub', CompensationResubmissionView.as_view(), name='resubmission-create'), # Documents - path('/document/new/', new_document_view, name='new-doc'), - path('/document/', get_document_view, name='get-doc'), - path('/document//remove/', remove_document_view, name='remove-doc'), - path('/document//edit/', edit_document_view, name='edit-doc'), + path('/document/new/', NewCompensationDocumentView.as_view(), name='new-doc'), + path('/document/', GetCompensationDocumentView.as_view(), name='get-doc'), + path('/document//remove/', RemoveCompensationDocumentView.as_view(), name='remove-doc'), + path('/document//edit/', EditCompensationDocumentView.as_view(), name='edit-doc'), ] \ No newline at end of file diff --git a/compensation/urls/eco_account.py b/compensation/urls/eco_account.py index 862d5f4a..252d8e67 100644 --- a/compensation/urls/eco_account.py +++ b/compensation/urls/eco_account.py @@ -18,8 +18,8 @@ from compensation.views.eco_account.state import state_new_view, state_remove_vi from compensation.views.eco_account.action import action_edit_view, action_new_view, action_remove_view from compensation.views.eco_account.deadline import deadline_new_view, deadline_edit_view, deadline_remove_view from compensation.views.eco_account.share import share_view, create_share_view -from compensation.views.eco_account.document import get_document_view, new_document_view, remove_document_view, \ - edit_document_view +from compensation.views.eco_account.document import GetEcoAccountDocumentView, NewEcoAccountDocumentView, \ + EditEcoAccountDocumentView, RemoveEcoAccountDocumentView from compensation.views.eco_account.deduction import deduction_edit_view, deduction_remove_view, new_deduction_view app_name = "acc" @@ -51,10 +51,10 @@ urlpatterns = [ path('/share', create_share_view, name='share-create'), # Documents - path('/document/new/', new_document_view, name='new-doc'), - path('/document/', get_document_view, name='get-doc'), - path('/document//edit', edit_document_view, name='edit-doc'), - path('/document//remove/', remove_document_view, name='remove-doc'), + path('/document/new/', NewEcoAccountDocumentView.as_view(), name='new-doc'), + path('/document/', GetEcoAccountDocumentView.as_view(), name='get-doc'), + path('/document//edit', EditEcoAccountDocumentView.as_view(), name='edit-doc'), + path('/document//remove/', RemoveEcoAccountDocumentView.as_view(), name='remove-doc'), # Eco-account deductions path('/deduction//remove', deduction_remove_view, name='remove-deduction'), diff --git a/compensation/views/compensation/document.py b/compensation/views/compensation/document.py index 8ca99edd..cb31739e 100644 --- a/compensation/views/compensation/document.py +++ b/compensation/views/compensation/document.py @@ -6,106 +6,58 @@ Created on: 19.08.22 """ from django.contrib.auth.decorators import login_required -from django.http import HttpRequest -from django.shortcuts import get_object_or_404 -from django.urls import reverse +from django.utils.decorators import method_decorator from compensation.forms.modals.document import NewCompensationDocumentModalForm from compensation.models import Compensation, CompensationDocument from konova.decorators import shared_access_required, default_group_required from konova.forms.modals import EditDocumentModalForm -from konova.utils.documents import remove_document, get_document -from konova.utils.message_templates import DOCUMENT_EDITED, DOCUMENT_ADDED +from konova.views.document import AbstractNewDocumentView, AbstractGetDocumentView, AbstractRemoveDocumentView, \ + AbstractEditDocumentView -@login_required -@default_group_required -@shared_access_required(Compensation, "id") -def new_document_view(request: HttpRequest, id: str): - """ Renders a form for uploading new documents +class NewCompensationDocumentView(AbstractNewDocumentView): + model = Compensation + form = NewCompensationDocumentModalForm + redirect_url = "compensation:detail" - Args: - request (HttpRequest): The incoming request - id (str): The compensation's id to which the new document will be related - Returns: - - """ - comp = get_object_or_404(Compensation, id=id) - form = NewCompensationDocumentModalForm(request.POST or None, request.FILES or None, instance=comp, request=request) - return form.process_request( - request, - msg_success=DOCUMENT_ADDED, - redirect_url=reverse("compensation:detail", args=(id,)) + "#related_data" - ) + @method_decorator(login_required) + @method_decorator(default_group_required) + @method_decorator(shared_access_required(Compensation, "id")) + def dispatch(self, request, *args, **kwargs): + return super().dispatch(request, *args, **kwargs) -@login_required -@default_group_required -@shared_access_required(Compensation, "id") -def get_document_view(request: HttpRequest, id: str, doc_id: str): - """ Returns the document as downloadable file +class GetCompensationDocumentView(AbstractGetDocumentView): + model = Compensation + document_model = CompensationDocument - Wraps the generic document fetcher function from konova.utils. - - Args: - request (HttpRequest): The incoming request - id (str): The compensation id - doc_id (str): The document id - - Returns: - - """ - comp = get_object_or_404(Compensation, id=id) - doc = get_object_or_404(CompensationDocument, id=doc_id) - return get_document(doc) + @method_decorator(login_required) + @method_decorator(default_group_required) + @method_decorator(shared_access_required(Compensation, "id")) + def dispatch(self, request, *args, **kwargs): + return super().dispatch(request, *args, **kwargs) -@login_required -@default_group_required -@shared_access_required(Compensation, "id") -def remove_document_view(request: HttpRequest, id: str, doc_id: str): - """ Removes the document from the database and file system +class RemoveCompensationDocumentView(AbstractRemoveDocumentView): + model = Compensation + document_model = CompensationDocument - Wraps the generic functionality from konova.utils. - - Args: - request (HttpRequest): The incoming request - id (str): The compensation id - doc_id (str): The document id - - Returns: - - """ - comp = get_object_or_404(Compensation, id=id) - doc = get_object_or_404(CompensationDocument, id=doc_id) - return remove_document( - request, - doc - ) + @method_decorator(login_required) + @method_decorator(default_group_required) + @method_decorator(shared_access_required(Compensation, "id")) + def dispatch(self, request, *args, **kwargs): + return super().dispatch(request, *args, **kwargs) -@login_required -@default_group_required -@shared_access_required(Compensation, "id") -def edit_document_view(request: HttpRequest, id: str, doc_id: str): - """ Removes the document from the database and file system - - Wraps the generic functionality from konova.utils. - - Args: - request (HttpRequest): The incoming request - id (str): The compensation id - doc_id (str): The document id - - Returns: - - """ - comp = get_object_or_404(Compensation, id=id) - doc = get_object_or_404(CompensationDocument, id=doc_id) - form = EditDocumentModalForm(request.POST or None, request.FILES or None, instance=comp, document=doc, request=request) - return form.process_request( - request, - DOCUMENT_EDITED, - reverse("compensation:detail", args=(id,)) + "#related_data" - ) +class EditCompensationDocumentView(AbstractEditDocumentView): + model = Compensation + document_model = CompensationDocument + form = EditDocumentModalForm + redirect_url = "compensation:detail" + @method_decorator(login_required) + @method_decorator(default_group_required) + @method_decorator(shared_access_required(Compensation, "id")) + def dispatch(self, request, *args, **kwargs): + return super().dispatch(request, *args, **kwargs) diff --git a/compensation/views/eco_account/document.py b/compensation/views/eco_account/document.py index 53e0a200..40b40a04 100644 --- a/compensation/views/eco_account/document.py +++ b/compensation/views/eco_account/document.py @@ -9,6 +9,7 @@ from django.contrib.auth.decorators import login_required from django.http import HttpRequest from django.shortcuts import get_object_or_404 from django.urls import reverse +from django.utils.decorators import method_decorator from compensation.forms.modals.document import NewEcoAccountDocumentModalForm from compensation.models import EcoAccount, EcoAccountDocument @@ -16,96 +17,52 @@ from konova.decorators import shared_access_required, default_group_required from konova.forms.modals import EditDocumentModalForm from konova.utils.documents import remove_document, get_document from konova.utils.message_templates import DOCUMENT_EDITED, DOCUMENT_ADDED +from konova.views.document import AbstractNewDocumentView, AbstractGetDocumentView, AbstractRemoveDocumentView, \ + AbstractEditDocumentView -@login_required -@default_group_required -@shared_access_required(EcoAccount, "id") -def new_document_view(request: HttpRequest, id: str): - """ Renders a form for uploading new documents +class NewEcoAccountDocumentView(AbstractNewDocumentView): + model = EcoAccount + form = NewEcoAccountDocumentModalForm + redirect_url = "compensation:acc:detail" - Args: - request (HttpRequest): The incoming request - id (str): The account's id to which the new document will be related - Returns: - - """ - acc = get_object_or_404(EcoAccount, id=id) - form = NewEcoAccountDocumentModalForm(request.POST or None, request.FILES or None, instance=acc, request=request) - return form.process_request( - request, - msg_success=DOCUMENT_ADDED, - redirect_url=reverse("compensation:acc:detail", args=(id,)) + "#related_data", - ) + @method_decorator(login_required) + @method_decorator(default_group_required) + @method_decorator(shared_access_required(EcoAccount, "id")) + def dispatch(self, request, *args, **kwargs): + return super().dispatch(request, *args, **kwargs) -@login_required -@default_group_required -@shared_access_required(EcoAccount, "id") -def get_document_view(request: HttpRequest, id:str, doc_id: str): - """ Returns the document as downloadable file +class GetEcoAccountDocumentView(AbstractGetDocumentView): + model = EcoAccount + document_model = EcoAccountDocument - Wraps the generic document fetcher function from konova.utils. - - Args: - request (HttpRequest): The incoming request - id (str): The account id - doc_id (str): The document id - - Returns: - - """ - acc = get_object_or_404(EcoAccount, id=id) - doc = get_object_or_404(EcoAccountDocument, id=doc_id) - return get_document(doc) + @method_decorator(login_required) + @method_decorator(default_group_required) + @method_decorator(shared_access_required(EcoAccount, "id")) + def dispatch(self, request, *args, **kwargs): + return super().dispatch(request, *args, **kwargs) -@login_required -@default_group_required -@shared_access_required(EcoAccount, "id") -def edit_document_view(request: HttpRequest, id: str, doc_id: str): - """ Removes the document from the database and file system +class RemoveEcoAccountDocumentView(AbstractRemoveDocumentView): + model = EcoAccount + document_model = EcoAccountDocument - Wraps the generic functionality from konova.utils. - - Args: - request (HttpRequest): The incoming request - id (str): The account id - doc_id (str): The document id - - Returns: - - """ - acc = get_object_or_404(EcoAccount, id=id) - doc = get_object_or_404(EcoAccountDocument, id=doc_id) - form = EditDocumentModalForm(request.POST or None, request.FILES or None, instance=acc, document=doc, request=request) - return form.process_request( - request, - DOCUMENT_EDITED, - reverse("compensation:acc:detail", args=(id,)) + "#related_data" - ) + @method_decorator(login_required) + @method_decorator(default_group_required) + @method_decorator(shared_access_required(EcoAccount, "id")) + def dispatch(self, request, *args, **kwargs): + return super().dispatch(request, *args, **kwargs) -@login_required -@default_group_required -@shared_access_required(EcoAccount, "id") -def remove_document_view(request: HttpRequest, id: str, doc_id: str): - """ Removes the document from the database and file system - - Wraps the generic functionality from konova.utils. - - Args: - request (HttpRequest): The incoming request - id (str): The account id - doc_id (str): The document id - - Returns: - - """ - acc = get_object_or_404(EcoAccount, id=id) - doc = get_object_or_404(EcoAccountDocument, id=doc_id) - return remove_document( - request, - doc - ) +class EditEcoAccountDocumentView(AbstractEditDocumentView): + model = EcoAccount + document_model = EcoAccountDocument + form = EditDocumentModalForm + redirect_url = "compensation:acc:detail" + @method_decorator(login_required) + @method_decorator(default_group_required) + @method_decorator(shared_access_required(EcoAccount, "id")) + def dispatch(self, request, *args, **kwargs): + return super().dispatch(request, *args, **kwargs) diff --git a/ema/urls.py b/ema/urls.py index f68145ba..770e24c8 100644 --- a/ema/urls.py +++ b/ema/urls.py @@ -9,7 +9,7 @@ from django.urls import path from ema.views.action import action_new_view, action_edit_view, action_remove_view from ema.views.deadline import deadline_new_view, deadline_edit_view, deadline_remove_view -from ema.views.document import document_new_view, get_document_view, remove_document_view, edit_document_view +from ema.views.document import NewEmaDocumentView, EditEmaDocumentView, RemoveEmaDocumentView, GetEmaDocumentView from ema.views.ema import index_view, new_view, new_id_view, detail_view, edit_view, remove_view from ema.views.log import EmaLogView from ema.views.record import EmaRecordView @@ -47,9 +47,9 @@ urlpatterns = [ path('/share', create_share_view, name='share-create'), # Documents - path('/document/new/', document_new_view, name='new-doc'), - path('/document/', get_document_view, name='get-doc'), - path('/document//edit/', edit_document_view, name='edit-doc'), - path('/document//remove/', remove_document_view, name='remove-doc'), + path('/document/new/', NewEmaDocumentView.as_view(), name='new-doc'), + path('/document/', GetEmaDocumentView.as_view(), name='get-doc'), + path('/document//edit/', EditEmaDocumentView.as_view(), name='edit-doc'), + path('/document//remove/', RemoveEmaDocumentView.as_view(), name='remove-doc'), ] \ No newline at end of file diff --git a/ema/views/document.py b/ema/views/document.py index faacb5bc..d394c0fe 100644 --- a/ema/views/document.py +++ b/ema/views/document.py @@ -6,106 +6,58 @@ Created on: 19.08.22 """ from django.contrib.auth.decorators import login_required -from django.http import HttpRequest -from django.shortcuts import get_object_or_404 -from django.urls import reverse +from django.utils.decorators import method_decorator from ema.forms import NewEmaDocumentModalForm from ema.models import Ema, EmaDocument from konova.decorators import shared_access_required, conservation_office_group_required from konova.forms.modals import EditDocumentModalForm -from konova.utils.documents import get_document, remove_document -from konova.utils.message_templates import DOCUMENT_ADDED, DOCUMENT_EDITED +from konova.views.document import AbstractEditDocumentView, AbstractRemoveDocumentView, AbstractGetDocumentView, \ + AbstractNewDocumentView -@login_required -@conservation_office_group_required -@shared_access_required(Ema, "id") -def document_new_view(request: HttpRequest, id: str): - """ Renders a form for uploading new documents +class NewEmaDocumentView(AbstractNewDocumentView): + model = Ema + form = NewEmaDocumentModalForm + redirect_url = "ema:detail" - Args: - request (HttpRequest): The incoming request - id (str): The EMA's id to which the new document will be related - Returns: - - """ - ema = get_object_or_404(Ema, id=id) - form = NewEmaDocumentModalForm(request.POST or None, request.FILES or None, instance=ema, request=request) - return form.process_request( - request, - msg_success=DOCUMENT_ADDED, - redirect_url=reverse("ema:detail", args=(id,)) + "#related_data" - ) + @method_decorator(login_required) + @method_decorator(conservation_office_group_required) + @method_decorator(shared_access_required(Ema, "id")) + def dispatch(self, request, *args, **kwargs): + return super().dispatch(request, *args, **kwargs) -@login_required -@conservation_office_group_required -@shared_access_required(Ema, "id") -def get_document_view(request: HttpRequest, id: str, doc_id: str): - """ Returns the document as downloadable file +class GetEmaDocumentView(AbstractGetDocumentView): + model = Ema + document_model = EmaDocument - Wraps the generic document fetcher function from konova.utils. - - Args: - request (HttpRequest): The incoming request - id (str): The EMA id - doc_id (str): The document id - - Returns: - - """ - ema = get_object_or_404(Ema, id=id) - doc = get_object_or_404(EmaDocument, id=doc_id) - return get_document(doc) + @method_decorator(login_required) + @method_decorator(conservation_office_group_required) + @method_decorator(shared_access_required(Ema, "id")) + def dispatch(self, request, *args, **kwargs): + return super().dispatch(request, *args, **kwargs) -@login_required -@conservation_office_group_required -@shared_access_required(Ema, "id") -def edit_document_view(request: HttpRequest, id: str, doc_id: str): - """ Removes the document from the database and file system +class RemoveEmaDocumentView(AbstractRemoveDocumentView): + model = Ema + document_model = EmaDocument - Wraps the generic functionality from konova.utils. - - Args: - request (HttpRequest): The incoming request - id (str): The EMA id - doc_id (str): The document id - - Returns: - - """ - ema = get_object_or_404(Ema, id=id) - doc = get_object_or_404(EmaDocument, id=doc_id) - form = EditDocumentModalForm(request.POST or None, request.FILES or None, instance=ema, document=doc, request=request) - return form.process_request( - request, - DOCUMENT_EDITED, - reverse("ema:detail", args=(id,)) + "#related_data" - ) + @method_decorator(login_required) + @method_decorator(conservation_office_group_required) + @method_decorator(shared_access_required(Ema, "id")) + def dispatch(self, request, *args, **kwargs): + return super().dispatch(request, *args, **kwargs) -@login_required -@conservation_office_group_required -@shared_access_required(Ema, "id") -def remove_document_view(request: HttpRequest, id:str, doc_id: str): - """ Removes the document from the database and file system - - Wraps the generic functionality from konova.utils. - - Args: - request (HttpRequest): The incoming request - id (str): The EMA id - doc_id (str): The document id - - Returns: - - """ - ema = get_object_or_404(Ema, id=id) - doc = get_object_or_404(EmaDocument, id=doc_id) - return remove_document( - request, - doc - ) +class EditEmaDocumentView(AbstractEditDocumentView): + model = Ema + document_model = EmaDocument + form = EditDocumentModalForm + redirect_url = "ema:detail" + @method_decorator(login_required) + @method_decorator(conservation_office_group_required) + @method_decorator(shared_access_required(Ema, "id")) + def dispatch(self, request, *args, **kwargs): + return super().dispatch(request, *args, **kwargs) diff --git a/intervention/urls.py b/intervention/urls.py index 284a3440..20bd5c16 100644 --- a/intervention/urls.py +++ b/intervention/urls.py @@ -11,7 +11,8 @@ from intervention.autocomplete.intervention import InterventionAutocomplete from intervention.views.check import check_view from intervention.views.compensation import remove_compensation_view from intervention.views.deduction import new_deduction_view, edit_deduction_view, remove_deduction_view -from intervention.views.document import new_document_view, get_document_view, remove_document_view, edit_document_view +from intervention.views.document import NewInterventionDocumentView, GetInterventionDocumentView, \ + RemoveInterventionDocumentView, EditInterventionDocumentView from intervention.views.intervention import index_view, new_view, new_id_view, detail_view, edit_view, remove_view from intervention.views.log import InterventionLogView from intervention.views.record import InterventionRecordView @@ -41,10 +42,10 @@ urlpatterns = [ path('/compensation//remove', remove_compensation_view, name='remove-compensation'), # Documents - path('/document/new/', new_document_view, name='new-doc'), - path('/document/', get_document_view, name='get-doc'), - path('/document//remove/', remove_document_view, name='remove-doc'), - path('/document//edit/', edit_document_view, name='edit-doc'), + path('/document/new/', NewInterventionDocumentView.as_view(), name='new-doc'), + path('/document/', GetInterventionDocumentView.as_view(), name='get-doc'), + path('/document//remove/', RemoveInterventionDocumentView.as_view(), name='remove-doc'), + path('/document//edit/', EditInterventionDocumentView.as_view(), name='edit-doc'), # Deductions path('/deduction/new', new_deduction_view, name='new-deduction'), diff --git a/intervention/views/document.py b/intervention/views/document.py index be43fbd5..80612781 100644 --- a/intervention/views/document.py +++ b/intervention/views/document.py @@ -6,107 +6,58 @@ Created on: 19.08.22 """ from django.contrib.auth.decorators import login_required -from django.http import HttpRequest -from django.shortcuts import get_object_or_404 -from django.urls import reverse -from django.utils.translation import gettext_lazy as _ +from django.utils.decorators import method_decorator from intervention.forms.modals.document import NewInterventionDocumentModalForm from intervention.models import Intervention, InterventionDocument from konova.decorators import default_group_required, shared_access_required from konova.forms.modals import EditDocumentModalForm -from konova.utils.documents import get_document, remove_document -from konova.utils.message_templates import DOCUMENT_ADDED, DOCUMENT_EDITED +from konova.views.document import AbstractNewDocumentView, AbstractGetDocumentView, AbstractRemoveDocumentView, \ + AbstractEditDocumentView -@login_required -@default_group_required -@shared_access_required(Intervention, "id") -def new_document_view(request: HttpRequest, id: str): - """ Renders a form for uploading new documents +class NewInterventionDocumentView(AbstractNewDocumentView): + model = Intervention + form = NewInterventionDocumentModalForm + redirect_url = "intervention:detail" - Args: - request (HttpRequest): The incoming request - id (str): The intervention's id to which the new document will be related - Returns: - - """ - intervention = get_object_or_404(Intervention, id=id) - form = NewInterventionDocumentModalForm(request.POST or None, request.FILES or None, instance=intervention, request=request) - return form.process_request( - request, - msg_success=DOCUMENT_ADDED, - redirect_url=reverse("intervention:detail", args=(id,)) + "#related_data" - ) + @method_decorator(login_required) + @method_decorator(default_group_required) + @method_decorator(shared_access_required(Intervention, "id")) + def dispatch(self, request, *args, **kwargs): + return super().dispatch(request, *args, **kwargs) -@login_required -@default_group_required -@shared_access_required(Intervention, "id") -def get_document_view(request: HttpRequest, id: str, doc_id: str): - """ Returns the document as downloadable file +class GetInterventionDocumentView(AbstractGetDocumentView): + model = Intervention + document_model = InterventionDocument - Wraps the generic document fetcher function from konova.utils. - - Args: - request (HttpRequest): The incoming request - id (str): The intervention id - doc_id (str): The document id - - Returns: - - """ - intervention = get_object_or_404(Intervention, id=id) - doc = get_object_or_404(InterventionDocument, id=doc_id) - return get_document(doc) + @method_decorator(login_required) + @method_decorator(default_group_required) + @method_decorator(shared_access_required(Intervention, "id")) + def dispatch(self, request, *args, **kwargs): + return super().dispatch(request, *args, **kwargs) -@login_required -@default_group_required -@shared_access_required(Intervention, "id") -def remove_document_view(request: HttpRequest, id: str, doc_id: str): - """ Removes the document from the database and file system +class RemoveInterventionDocumentView(AbstractRemoveDocumentView): + model = Intervention + document_model = InterventionDocument - Wraps the generic functionality from konova.utils. - - Args: - request (HttpRequest): The incoming request - id (str): The intervention id - doc_id (str): The document id - - Returns: - - """ - intervention = get_object_or_404(Intervention, id=id) - doc = get_object_or_404(InterventionDocument, id=doc_id) - return remove_document( - request, - doc - ) + @method_decorator(login_required) + @method_decorator(default_group_required) + @method_decorator(shared_access_required(Intervention, "id")) + def dispatch(self, request, *args, **kwargs): + return super().dispatch(request, *args, **kwargs) -@login_required -@default_group_required -@shared_access_required(Intervention, "id") -def edit_document_view(request: HttpRequest, id: str, doc_id: str): - """ Removes the document from the database and file system - - Wraps the generic functionality from konova.utils. - - Args: - request (HttpRequest): The incoming request - id (str): The intervention id - doc_id (str): The document id - - Returns: - - """ - intervention = get_object_or_404(Intervention, id=id) - doc = get_object_or_404(InterventionDocument, id=doc_id) - form = EditDocumentModalForm(request.POST or None, request.FILES or None, instance=intervention, document=doc, request=request) - return form.process_request( - request, - DOCUMENT_EDITED, - redirect_url=reverse("intervention:detail", args=(intervention.id,)) + "#related_data" - ) +class EditInterventionDocumentView(AbstractEditDocumentView): + model = Intervention + document_model = InterventionDocument + form = EditDocumentModalForm + redirect_url = "intervention:detail" + @method_decorator(login_required) + @method_decorator(default_group_required) + @method_decorator(shared_access_required(Intervention, "id")) + def dispatch(self, request, *args, **kwargs): + return super().dispatch(request, *args, **kwargs) diff --git a/konova/views/document.py b/konova/views/document.py new file mode 100644 index 00000000..8dba6fd5 --- /dev/null +++ b/konova/views/document.py @@ -0,0 +1,138 @@ +""" +Author: Michel Peltriaux +Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany +Contact: ksp-servicestelle@sgdnord.rlp.de +Created on: 22.08.22 + +""" +from django.shortcuts import get_object_or_404 +from django.urls import reverse +from django.views import View + +from konova.utils.documents import get_document, remove_document +from konova.utils.message_templates import DOCUMENT_ADDED, DOCUMENT_EDITED + + +class AbstractNewDocumentView(View): + model = None + form = None + redirect_url = None + + class Meta: + abstract = True + + def get(self, request, id: str): + """ Renders a form for uploading new documents + + Args: + request (HttpRequest): The incoming request + id (str): The object's id to which the new document will be related + Returns: + + """ + intervention = get_object_or_404(self.model, id=id) + form = self.form(request.POST or None, request.FILES or None, instance=intervention, request=request) + return form.process_request( + request, + msg_success=DOCUMENT_ADDED, + redirect_url=reverse(self.redirect_url, args=(id,)) + "#related_data" + ) + + def post(self, request, id: str): + return self.get(request, id) + + +class AbstractGetDocumentView(View): + model = None + document_model = None + + class Meta: + abstract = True + + def get(self, request, id: str, doc_id: str): + """ Returns the document as downloadable file + + Wraps the generic document fetcher function from konova.utils. + + Args: + request (HttpRequest): The incoming request + id (str): The object id + doc_id (str): The document id + + Returns: + + """ + get_object_or_404(self.model, id=id) + doc = get_object_or_404(self.document_model, id=doc_id) + return get_document(doc) + + def post(self, request, id: str, doc_id: str): + return self.get(request, id, doc_id) + + +class AbstractRemoveDocumentView(View): + model = None + document_model = None + + class Meta: + abstract = True + + def get(self, request, id: str, doc_id: str): + """ Removes the document from the database and file system + + Wraps the generic functionality from konova.utils. + + Args: + request (HttpRequest): The incoming request + id (str): The intervention id + doc_id (str): The document id + + Returns: + + """ + get_object_or_404(self.model, id=id) + doc = get_object_or_404(self.document_model, id=doc_id) + return remove_document( + request, + doc + ) + + def post(self, request, id: str, doc_id: str): + return self.get(request, id, doc_id) + + +class AbstractEditDocumentView(View): + model = None + document_model = None + form = None + redirect_url = None + + class Meta: + abstract = True + + def get(self, request, id: str, doc_id: str): + """ GET handling for editing of existing document + + Wraps the generic functionality from konova.utils. + + Args: + request (HttpRequest): The incoming request + id (str): The intervention id + doc_id (str): The document id + + Returns: + + """ + obj = get_object_or_404(self.model, id=id) + doc = get_object_or_404(self.document_model, id=doc_id) + form = self.form(request.POST or None, request.FILES or None, instance=obj, document=doc, + request=request) + return form.process_request( + request, + DOCUMENT_EDITED, + redirect_url=reverse(self.redirect_url, args=(obj.id,)) + "#related_data" + ) + + def post(self, request, id: str, doc_id: str): + return self.get(request, id, doc_id) + -- 2.45.2 From 9e6a9f4902a0eeaa17999a451d5fecf3728b38bb Mon Sep 17 00:00:00 2001 From: mpeltriaux Date: Mon, 22 Aug 2022 08:07:35 +0200 Subject: [PATCH 16/21] Deadline views * replaces function based views for deadlines with class based views --- compensation/urls/compensation.py | 9 +- compensation/urls/eco_account.py | 9 +- compensation/views/compensation/deadline.py | 95 +++++------------- compensation/views/eco_account/deadline.py | 95 +++++------------- konova/views/deadline.py | 106 ++++++++++++++++++++ 5 files changed, 168 insertions(+), 146 deletions(-) create mode 100644 konova/views/deadline.py diff --git a/compensation/urls/compensation.py b/compensation/urls/compensation.py index ea60bafa..dd089510 100644 --- a/compensation/urls/compensation.py +++ b/compensation/urls/compensation.py @@ -11,7 +11,8 @@ from compensation.views.compensation.document import EditCompensationDocumentVie GetCompensationDocumentView, RemoveCompensationDocumentView from compensation.views.compensation.resubmission import CompensationResubmissionView from compensation.views.compensation.report import report_view -from compensation.views.compensation.deadline import deadline_new_view, deadline_edit_view, deadline_remove_view +from compensation.views.compensation.deadline import NewCompensationDeadlineView, EditCompensationDeadlineView, \ + RemoveCompensationDeadlineView from compensation.views.compensation.action import action_edit_view, action_new_view, action_remove_view from compensation.views.compensation.state import state_new_view, state_remove_view, state_edit_view from compensation.views.compensation.compensation import index_view, new_view, new_id_view, detail_view, edit_view, \ @@ -37,9 +38,9 @@ urlpatterns = [ path('/action//edit', action_edit_view, name='action-edit'), path('/action//remove', action_remove_view, name='action-remove'), - path('/deadline/new', deadline_new_view, name="new-deadline"), - path('/deadline//edit', deadline_edit_view, name='deadline-edit'), - path('/deadline//remove', deadline_remove_view, name='deadline-remove'), + path('/deadline/new', NewCompensationDeadlineView.as_view(), name="new-deadline"), + path('/deadline//edit', EditCompensationDeadlineView.as_view(), name='deadline-edit'), + path('/deadline//remove', RemoveCompensationDeadlineView.as_view(), name='deadline-remove'), path('/report', report_view, name='report'), path('/resub', CompensationResubmissionView.as_view(), name='resubmission-create'), diff --git a/compensation/urls/eco_account.py b/compensation/urls/eco_account.py index 252d8e67..90784fb4 100644 --- a/compensation/urls/eco_account.py +++ b/compensation/urls/eco_account.py @@ -16,7 +16,8 @@ from compensation.views.eco_account.report import report_view from compensation.views.eco_account.resubmission import EcoAccountResubmissionView from compensation.views.eco_account.state import state_new_view, state_remove_view, state_edit_view from compensation.views.eco_account.action import action_edit_view, action_new_view, action_remove_view -from compensation.views.eco_account.deadline import deadline_new_view, deadline_edit_view, deadline_remove_view +from compensation.views.eco_account.deadline import NewEcoAccountDeadlineView, EditEcoAccountDeadlineView, \ + RemoveEcoAccountDeadlineView from compensation.views.eco_account.share import share_view, create_share_view from compensation.views.eco_account.document import GetEcoAccountDocumentView, NewEcoAccountDocumentView, \ EditEcoAccountDocumentView, RemoveEcoAccountDocumentView @@ -43,9 +44,9 @@ urlpatterns = [ path('/action//edit', action_edit_view, name='action-edit'), path('/action//remove', action_remove_view, name='action-remove'), - path('/deadline/new', deadline_new_view, name="new-deadline"), - path('/deadline//edit', deadline_edit_view, name='deadline-edit'), - path('/deadline//remove', deadline_remove_view, name='deadline-remove'), + path('/deadline/new', NewEcoAccountDeadlineView.as_view(), name="new-deadline"), + path('/deadline//edit', EditEcoAccountDeadlineView.as_view(), name='deadline-edit'), + path('/deadline//remove', RemoveEcoAccountDeadlineView.as_view(), name='deadline-remove'), path('/share/', share_view, name='share'), path('/share', create_share_view, name='share-create'), diff --git a/compensation/views/compensation/deadline.py b/compensation/views/compensation/deadline.py index ee6a5120..7463b7ec 100644 --- a/compensation/views/compensation/deadline.py +++ b/compensation/views/compensation/deadline.py @@ -6,84 +6,41 @@ Created on: 19.08.22 """ from django.contrib.auth.decorators import login_required -from django.http import HttpRequest -from django.shortcuts import get_object_or_404 -from django.urls import reverse +from django.utils.decorators import method_decorator -from compensation.forms.modals.deadline import EditDeadlineModalForm, NewDeadlineModalForm from compensation.models import Compensation from konova.decorators import shared_access_required, default_group_required -from konova.forms.modals import RemoveDeadlineModalForm -from konova.models import Deadline -from konova.utils.message_templates import DEADLINE_REMOVED, DEADLINE_EDITED, DEADLINE_ADDED +from konova.views.deadline import AbstractRemoveDeadlineView, AbstractEditDeadlineView, AbstractNewDeadlineView -@login_required -@default_group_required -@shared_access_required(Compensation, "id") -def deadline_new_view(request: HttpRequest, id: str): - """ Renders a form for adding new states for a compensation +class NewCompensationDeadlineView(AbstractNewDeadlineView): + model = Compensation + redirect_url = "compensation:detail" - Args: - request (HttpRequest): The incoming request - id (str): The compensation's id to which the new state will be related - - Returns: - - """ - comp = get_object_or_404(Compensation, id=id) - form = NewDeadlineModalForm(request.POST or None, instance=comp, request=request) - return form.process_request( - request, - msg_success=DEADLINE_ADDED, - redirect_url=reverse("compensation:detail", args=(id,)) + "#related_data" - ) + @method_decorator(login_required) + @method_decorator(default_group_required) + @method_decorator(shared_access_required(Compensation, "id")) + def dispatch(self, request, *args, **kwargs): + return super().dispatch(request, *args, **kwargs) -@login_required -@default_group_required -@shared_access_required(Compensation, "id") -def deadline_edit_view(request: HttpRequest, id: str, deadline_id: str): - """ Renders a form for editing deadlines from a compensation +class EditCompensationDeadlineView(AbstractEditDeadlineView): + model = Compensation + redirect_url = "compensation:detail" - Args: - request (HttpRequest): The incoming request - id (str): The compensation's id - deadline_id (str): The deadline's id - - Returns: - - """ - comp = get_object_or_404(Compensation, id=id) - deadline = get_object_or_404(Deadline, id=deadline_id) - form = EditDeadlineModalForm(request.POST or None, instance=comp, deadline=deadline, request=request) - return form.process_request( - request, - msg_success=DEADLINE_EDITED, - redirect_url=reverse("compensation:detail", args=(id,)) + "#related_data" - ) + @method_decorator(login_required) + @method_decorator(default_group_required) + @method_decorator(shared_access_required(Compensation, "id")) + def dispatch(self, request, *args, **kwargs): + return super().dispatch(request, *args, **kwargs) -@login_required -@default_group_required -@shared_access_required(Compensation, "id") -def deadline_remove_view(request: HttpRequest, id: str, deadline_id: str): - """ Renders a form for removing deadlines from a compensation - - Args: - request (HttpRequest): The incoming request - id (str): The compensation's id - deadline_id (str): The deadline's id - - Returns: - - """ - comp = get_object_or_404(Compensation, id=id) - deadline = get_object_or_404(Deadline, id=deadline_id) - form = RemoveDeadlineModalForm(request.POST or None, instance=comp, deadline=deadline, request=request) - return form.process_request( - request, - msg_success=DEADLINE_REMOVED, - redirect_url=reverse("compensation:detail", args=(id,)) + "#related_data" - ) +class RemoveCompensationDeadlineView(AbstractRemoveDeadlineView): + model = Compensation + redirect_url = "compensation:detail" + @method_decorator(login_required) + @method_decorator(default_group_required) + @method_decorator(shared_access_required(Compensation, "id")) + def dispatch(self, request, *args, **kwargs): + return super().dispatch(request, *args, **kwargs) diff --git a/compensation/views/eco_account/deadline.py b/compensation/views/eco_account/deadline.py index 37e35202..15b4aa8c 100644 --- a/compensation/views/eco_account/deadline.py +++ b/compensation/views/eco_account/deadline.py @@ -6,84 +6,41 @@ Created on: 19.08.22 """ from django.contrib.auth.decorators import login_required -from django.http import HttpRequest -from django.shortcuts import get_object_or_404 -from django.urls import reverse +from django.utils.decorators import method_decorator -from compensation.forms.modals.deadline import NewDeadlineModalForm, EditDeadlineModalForm from compensation.models import EcoAccount from konova.decorators import shared_access_required, default_group_required -from konova.forms.modals import RemoveDeadlineModalForm -from konova.models import Deadline -from konova.utils.message_templates import DEADLINE_ADDED, DEADLINE_REMOVED, DEADLINE_EDITED +from konova.views.deadline import AbstractNewDeadlineView, AbstractEditDeadlineView, AbstractRemoveDeadlineView -@login_required -@default_group_required -@shared_access_required(EcoAccount, "id") -def deadline_edit_view(request: HttpRequest, id: str, deadline_id: str): - """ Renders a form for editing deadlines from a compensation +class NewEcoAccountDeadlineView(AbstractNewDeadlineView): + model = EcoAccount + redirect_url = "compensation:acc:detail" - Args: - request (HttpRequest): The incoming request - id (str): The compensation's id - deadline_id (str): The deadline's id - - Returns: - - """ - comp = get_object_or_404(EcoAccount, id=id) - deadline = get_object_or_404(Deadline, id=deadline_id) - form = EditDeadlineModalForm(request.POST or None, instance=comp, deadline=deadline, request=request) - return form.process_request( - request, - msg_success=DEADLINE_EDITED, - redirect_url=reverse("compensation:acc:detail", args=(id,)) + "#related_data" - ) + @method_decorator(login_required) + @method_decorator(default_group_required) + @method_decorator(shared_access_required(EcoAccount, "id")) + def dispatch(self, request, *args, **kwargs): + return super().dispatch(request, *args, **kwargs) -@login_required -@default_group_required -@shared_access_required(EcoAccount, "id") -def deadline_remove_view(request: HttpRequest, id: str, deadline_id: str): - """ Renders a form for removing deadlines from a compensation +class EditEcoAccountDeadlineView(AbstractEditDeadlineView): + model = EcoAccount + redirect_url = "compensation:acc:detail" - Args: - request (HttpRequest): The incoming request - id (str): The compensation's id - deadline_id (str): The deadline's id - - Returns: - - """ - comp = get_object_or_404(EcoAccount, id=id) - deadline = get_object_or_404(Deadline, id=deadline_id) - form = RemoveDeadlineModalForm(request.POST or None, instance=comp, deadline=deadline, request=request) - return form.process_request( - request, - msg_success=DEADLINE_REMOVED, - redirect_url=reverse("compensation:acc:detail", args=(id,)) + "#related_data" - ) + @method_decorator(login_required) + @method_decorator(default_group_required) + @method_decorator(shared_access_required(EcoAccount, "id")) + def dispatch(self, request, *args, **kwargs): + return super().dispatch(request, *args, **kwargs) -@login_required -@default_group_required -@shared_access_required(EcoAccount, "id") -def deadline_new_view(request: HttpRequest, id: str): - """ Renders a form for adding new states for an eco account - - Args: - request (HttpRequest): The incoming request - id (str): The account's id to which the new state will be related - - Returns: - - """ - acc = get_object_or_404(EcoAccount, id=id) - form = NewDeadlineModalForm(request.POST or None, instance=acc, request=request) - return form.process_request( - request, - msg_success=DEADLINE_ADDED, - redirect_url=reverse("compensation:acc:detail", args=(id,)) + "#related_data" - ) +class RemoveEcoAccountDeadlineView(AbstractRemoveDeadlineView): + model = EcoAccount + redirect_url = "compensation:acc:detail" + @method_decorator(login_required) + @method_decorator(default_group_required) + @method_decorator(shared_access_required(EcoAccount, "id")) + def dispatch(self, request, *args, **kwargs): + return super().dispatch(request, *args, **kwargs) diff --git a/konova/views/deadline.py b/konova/views/deadline.py new file mode 100644 index 00000000..4350073d --- /dev/null +++ b/konova/views/deadline.py @@ -0,0 +1,106 @@ +""" +Author: Michel Peltriaux +Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany +Contact: ksp-servicestelle@sgdnord.rlp.de +Created on: 22.08.22 + +""" +from django.shortcuts import get_object_or_404 +from django.urls import reverse +from django.views import View + +from compensation.forms.modals.deadline import NewDeadlineModalForm, EditDeadlineModalForm +from konova.forms.modals import RemoveDeadlineModalForm +from konova.models import Deadline +from konova.utils.message_templates import DEADLINE_ADDED, DEADLINE_EDITED, DEADLINE_REMOVED + + +class AbstractNewDeadlineView(View): + model = None + redirect_url = None + + class Meta: + abstract = True + + def get(self, request, id: str): + """ Renders a form for adding new deadlines + + Args: + request (HttpRequest): The incoming request + id (str): The account's id to which the new state will be related + + Returns: + + """ + obj = get_object_or_404(self.model, id=id) + form = NewDeadlineModalForm(request.POST or None, instance=obj, request=request) + return form.process_request( + request, + msg_success=DEADLINE_ADDED, + redirect_url=reverse(self.redirect_url, args=(id,)) + "#related_data" + ) + + def post(self, request, id: str): + return self.get(request, id) + + +class AbstractEditDeadlineView(View): + model = None + redirect_url = None + + class Meta: + abstract = True + + def get(self, request, id: str, deadline_id: str): + """ Renders a form for editing deadlines + + Args: + request (HttpRequest): The incoming request + id (str): The compensation's id + deadline_id (str): The deadline's id + + Returns: + + """ + obj = get_object_or_404(self.model, id=id) + deadline = get_object_or_404(Deadline, id=deadline_id) + form = EditDeadlineModalForm(request.POST or None, instance=obj, deadline=deadline, request=request) + return form.process_request( + request, + msg_success=DEADLINE_EDITED, + redirect_url=reverse(self.redirect_url, args=(id,)) + "#related_data" + ) + + def post(self, request, id: str, deadline_id: str): + return self.get(request, id, deadline_id) + + +class AbstractRemoveDeadlineView(View): + model = None + redirect_url = None + + class Meta: + abstract = True + + def get(self, request, id: str, deadline_id: str): + """ Renders a form for removing deadlines + + Args: + request (HttpRequest): The incoming request + id (str): The compensation's id + deadline_id (str): The deadline's id + + Returns: + + """ + obj = get_object_or_404(self.model, id=id) + deadline = get_object_or_404(Deadline, id=deadline_id) + form = RemoveDeadlineModalForm(request.POST or None, instance=obj, deadline=deadline, request=request) + return form.process_request( + request, + msg_success=DEADLINE_REMOVED, + redirect_url=reverse(self.redirect_url, args=(id,)) + "#related_data" + ) + + def post(self, request, id: str, deadline_id: str): + return self.get(request, id, deadline_id) -- 2.45.2 From 59b77fe567e232fe3e372451ea8cedc92d622e78 Mon Sep 17 00:00:00 2001 From: mpeltriaux Date: Mon, 22 Aug 2022 08:12:55 +0200 Subject: [PATCH 17/21] Ema Deadline views * replaces ema deadline views with class based --- ema/urls.py | 8 ++-- ema/views/deadline.py | 95 ++++++++++++------------------------------- 2 files changed, 30 insertions(+), 73 deletions(-) diff --git a/ema/urls.py b/ema/urls.py index 770e24c8..eda06728 100644 --- a/ema/urls.py +++ b/ema/urls.py @@ -8,7 +8,7 @@ Created on: 19.08.21 from django.urls import path from ema.views.action import action_new_view, action_edit_view, action_remove_view -from ema.views.deadline import deadline_new_view, deadline_edit_view, deadline_remove_view +from ema.views.deadline import NewEmaDeadlineView, EditEmaDeadlineView, RemoveEmaDeadlineView from ema.views.document import NewEmaDocumentView, EditEmaDocumentView, RemoveEmaDocumentView, GetEmaDocumentView from ema.views.ema import index_view, new_view, new_id_view, detail_view, edit_view, remove_view from ema.views.log import EmaLogView @@ -39,9 +39,9 @@ urlpatterns = [ path('/action//edit', action_edit_view, name='action-edit'), path('/action//remove', action_remove_view, name='action-remove'), - path('/deadline/new', deadline_new_view, name="new-deadline"), - path('/deadline//edit', deadline_edit_view, name='deadline-edit'), - path('/deadline//remove', deadline_remove_view, name='deadline-remove'), + path('/deadline/new', NewEmaDeadlineView.as_view(), name="new-deadline"), + path('/deadline//edit', EditEmaDeadlineView.as_view(), name='deadline-edit'), + path('/deadline//remove', RemoveEmaDeadlineView.as_view(), name='deadline-remove'), path('/share/', share_view, name='share'), path('/share', create_share_view, name='share-create'), diff --git a/ema/views/deadline.py b/ema/views/deadline.py index 223ceeb0..76c2bded 100644 --- a/ema/views/deadline.py +++ b/ema/views/deadline.py @@ -6,85 +6,42 @@ Created on: 19.08.22 """ from django.contrib.auth.decorators import login_required -from django.http import HttpRequest -from django.shortcuts import get_object_or_404 -from django.urls import reverse +from django.utils.decorators import method_decorator -from compensation.forms.modals.deadline import EditDeadlineModalForm, NewDeadlineModalForm from ema.models import Ema from konova.decorators import shared_access_required, conservation_office_group_required -from konova.forms.modals import RemoveDeadlineModalForm -from konova.models import Deadline -from konova.utils.message_templates import DEADLINE_REMOVED, DEADLINE_EDITED, DEADLINE_ADDED +from konova.views.deadline import AbstractNewDeadlineView, AbstractRemoveDeadlineView, AbstractEditDeadlineView -@login_required -@conservation_office_group_required -@shared_access_required(Ema, "id") -def deadline_new_view(request: HttpRequest, id: str): - """ Renders a form for adding new states for an EMA +class NewEmaDeadlineView(AbstractNewDeadlineView): + model = Ema + redirect_url = "ema:detail" - Args: - request (HttpRequest): The incoming request - id (str): The EMA's id to which the new state will be related - - Returns: - - """ - ema = get_object_or_404(Ema, id=id) - form = NewDeadlineModalForm(request.POST or None, instance=ema, request=request) - return form.process_request( - request, - msg_success=DEADLINE_ADDED, - redirect_url=reverse("ema:detail", args=(id,)) + "#related_data" - ) + @method_decorator(login_required) + @method_decorator(conservation_office_group_required) + @method_decorator(shared_access_required(Ema, "id")) + def dispatch(self, request, *args, **kwargs): + return super().dispatch(request, *args, **kwargs) -@login_required -@conservation_office_group_required -@shared_access_required(Ema, "id") -def deadline_edit_view(request: HttpRequest, id: str, deadline_id: str): - """ Renders a form for editing deadlines from a compensation +class EditEmaDeadlineView(AbstractEditDeadlineView): + model = Ema + redirect_url = "ema:detail" - Args: - request (HttpRequest): The incoming request - id (str): The compensation's id - deadline_id (str): The deadline's id - - Returns: - - """ - ema = get_object_or_404(Ema, id=id) - deadline = get_object_or_404(Deadline, id=deadline_id) - form = EditDeadlineModalForm(request.POST or None, instance=ema, deadline=deadline, request=request) - return form.process_request( - request, - msg_success=DEADLINE_EDITED, - redirect_url=reverse("ema:detail", args=(id,)) + "#related_data" - ) + @method_decorator(login_required) + @method_decorator(conservation_office_group_required) + @method_decorator(shared_access_required(Ema, "id")) + def dispatch(self, request, *args, **kwargs): + return super().dispatch(request, *args, **kwargs) -@login_required -@conservation_office_group_required -@shared_access_required(Ema, "id") -def deadline_remove_view(request: HttpRequest, id: str, deadline_id: str): - """ Renders a form for removing deadlines from a compensation - - Args: - request (HttpRequest): The incoming request - id (str): The compensation's id - deadline_id (str): The deadline's id - - Returns: - - """ - ema = get_object_or_404(Ema, id=id) - deadline = get_object_or_404(Deadline, id=deadline_id) - form = RemoveDeadlineModalForm(request.POST or None, instance=ema, deadline=deadline, request=request) - return form.process_request( - request, - msg_success=DEADLINE_REMOVED, - redirect_url=reverse("ema:detail", args=(id,)) + "#related_data" - ) +class RemoveEmaDeadlineView(AbstractRemoveDeadlineView): + model = Ema + redirect_url = "ema:detail" + @method_decorator(login_required) + @method_decorator(conservation_office_group_required) + @method_decorator(shared_access_required(Ema, "id")) + def dispatch(self, request, *args, **kwargs): + return super().dispatch(request, *args, **kwargs) -- 2.45.2 From 75802c5f663be78bfed20c92e01e7757f71363cb Mon Sep 17 00:00:00 2001 From: mpeltriaux Date: Mon, 22 Aug 2022 08:27:36 +0200 Subject: [PATCH 18/21] State views * replaces function based state views with class based --- compensation/urls/compensation.py | 9 +- compensation/urls/eco_account.py | 9 +- compensation/views/compensation/state.py | 98 ++++++--------------- compensation/views/eco_account/state.py | 97 ++++++-------------- ema/urls.py | 8 +- ema/views/state.py | 97 ++++++-------------- konova/views/state.py | 107 +++++++++++++++++++++++ 7 files changed, 204 insertions(+), 221 deletions(-) create mode 100644 konova/views/state.py diff --git a/compensation/urls/compensation.py b/compensation/urls/compensation.py index dd089510..dcd065fd 100644 --- a/compensation/urls/compensation.py +++ b/compensation/urls/compensation.py @@ -14,7 +14,8 @@ from compensation.views.compensation.report import report_view from compensation.views.compensation.deadline import NewCompensationDeadlineView, EditCompensationDeadlineView, \ RemoveCompensationDeadlineView from compensation.views.compensation.action import action_edit_view, action_new_view, action_remove_view -from compensation.views.compensation.state import state_new_view, state_remove_view, state_edit_view +from compensation.views.compensation.state import NewCompensationStateView, EditCompensationStateView, \ + RemoveCompensationStateView from compensation.views.compensation.compensation import index_view, new_view, new_id_view, detail_view, edit_view, \ remove_view from compensation.views.compensation.log import CompensationLogView @@ -30,9 +31,9 @@ urlpatterns = [ path('/edit', edit_view, name='edit'), path('/remove', remove_view, name='remove'), - path('/state/new', state_new_view, name='new-state'), - path('/state//edit', state_edit_view, name='state-edit'), - path('/state//remove', state_remove_view, name='state-remove'), + path('/state/new', NewCompensationStateView.as_view(), name='new-state'), + path('/state//edit', EditCompensationStateView.as_view(), name='state-edit'), + path('/state//remove', RemoveCompensationStateView.as_view(), name='state-remove'), path('/action/new', action_new_view, name='new-action'), path('/action//edit', action_edit_view, name='action-edit'), diff --git a/compensation/urls/eco_account.py b/compensation/urls/eco_account.py index 90784fb4..60ee786c 100644 --- a/compensation/urls/eco_account.py +++ b/compensation/urls/eco_account.py @@ -14,7 +14,8 @@ from compensation.views.eco_account.log import EcoAccountLogView from compensation.views.eco_account.record import EcoAccountRecordView from compensation.views.eco_account.report import report_view from compensation.views.eco_account.resubmission import EcoAccountResubmissionView -from compensation.views.eco_account.state import state_new_view, state_remove_view, state_edit_view +from compensation.views.eco_account.state import NewEcoAccountStateView, EditEcoAccountStateView, \ + RemoveEcoAccountStateView from compensation.views.eco_account.action import action_edit_view, action_new_view, action_remove_view from compensation.views.eco_account.deadline import NewEcoAccountDeadlineView, EditEcoAccountDeadlineView, \ RemoveEcoAccountDeadlineView @@ -36,9 +37,9 @@ urlpatterns = [ path('/remove', remove_view, name='remove'), path('/resub', EcoAccountResubmissionView.as_view(), name='resubmission-create'), - path('/state/new', state_new_view, name='new-state'), - path('/state//edit', state_edit_view, name='state-edit'), - path('/state//remove', state_remove_view, name='state-remove'), + path('/state/new', NewEcoAccountStateView.as_view(), name='new-state'), + path('/state//edit', EditEcoAccountStateView.as_view(), name='state-edit'), + path('/state//remove', RemoveEcoAccountStateView.as_view(), name='state-remove'), path('/action/new', action_new_view, name='new-action'), path('/action//edit', action_edit_view, name='action-edit'), diff --git a/compensation/views/compensation/state.py b/compensation/views/compensation/state.py index ca8c5d0c..136e8604 100644 --- a/compensation/views/compensation/state.py +++ b/compensation/views/compensation/state.py @@ -6,84 +6,42 @@ Created on: 19.08.22 """ from django.contrib.auth.decorators import login_required -from django.http import HttpRequest -from django.shortcuts import get_object_or_404 -from django.urls import reverse +from django.utils.decorators import method_decorator -from compensation.forms.modals.state import EditCompensationStateModalForm, RemoveCompensationStateModalForm, \ - NewCompensationStateModalForm -from compensation.models import Compensation, CompensationState +from compensation.models import Compensation from konova.decorators import shared_access_required, default_group_required -from konova.utils.message_templates import COMPENSATION_STATE_EDITED, COMPENSATION_STATE_REMOVED, \ - COMPENSATION_STATE_ADDED +from konova.views.state import AbstractNewCompensationStateView, AbstractEditCompensationStateView, \ + AbstractRemoveCompensationStateView -@login_required -@default_group_required -@shared_access_required(Compensation, "id") -def state_new_view(request: HttpRequest, id: str): - """ Renders a form for adding new states for a compensation +class NewCompensationStateView(AbstractNewCompensationStateView): + model = Compensation + redirect_url = "compensation:detail" - Args: - request (HttpRequest): The incoming request - id (str): The compensation's id to which the new state will be related - - Returns: - - """ - comp = get_object_or_404(Compensation, id=id) - form = NewCompensationStateModalForm(request.POST or None, instance=comp, request=request) - return form.process_request( - request, - msg_success=COMPENSATION_STATE_ADDED, - redirect_url=reverse("compensation:detail", args=(id,)) + "#related_data" - ) + @method_decorator(login_required) + @method_decorator(default_group_required) + @method_decorator(shared_access_required(Compensation, "id")) + def dispatch(self, request, *args, **kwargs): + return super().dispatch(request, *args, **kwargs) -@login_required -@default_group_required -@shared_access_required(Compensation, "id") -def state_remove_view(request: HttpRequest, id: str, state_id: str): - """ Renders a form for removing a compensation state +class EditCompensationStateView(AbstractEditCompensationStateView): + model = Compensation + redirect_url = "compensation:detail" - Args: - request (HttpRequest): The incoming request - id (str): The compensation's id - state_id (str): The state's id - - Returns: - - """ - comp = get_object_or_404(Compensation, id=id) - state = get_object_or_404(CompensationState, id=state_id) - form = RemoveCompensationStateModalForm(request.POST or None, instance=comp, state=state, request=request) - return form.process_request( - request, - msg_success=COMPENSATION_STATE_REMOVED, - redirect_url=reverse("compensation:detail", args=(id,)) + "#related_data" - ) + @method_decorator(login_required) + @method_decorator(default_group_required) + @method_decorator(shared_access_required(Compensation, "id")) + def dispatch(self, request, *args, **kwargs): + return super().dispatch(request, *args, **kwargs) -@login_required -@default_group_required -@shared_access_required(Compensation, "id") -def state_edit_view(request: HttpRequest, id: str, state_id: str): - """ Renders a form for editing a compensation state - - Args: - request (HttpRequest): The incoming request - id (str): The compensation's id - state_id (str): The state's id - - Returns: - - """ - comp = get_object_or_404(Compensation, id=id) - state = get_object_or_404(CompensationState, id=state_id) - form = EditCompensationStateModalForm(request.POST or None, instance=comp, state=state, request=request) - return form.process_request( - request, - msg_success=COMPENSATION_STATE_EDITED, - redirect_url=reverse("compensation:detail", args=(id,)) + "#related_data" - ) +class RemoveCompensationStateView(AbstractRemoveCompensationStateView): + model = Compensation + redirect_url = "compensation:detail" + @method_decorator(login_required) + @method_decorator(default_group_required) + @method_decorator(shared_access_required(Compensation, "id")) + def dispatch(self, request, *args, **kwargs): + return super().dispatch(request, *args, **kwargs) diff --git a/compensation/views/eco_account/state.py b/compensation/views/eco_account/state.py index 15590fc7..0591a17c 100644 --- a/compensation/views/eco_account/state.py +++ b/compensation/views/eco_account/state.py @@ -6,83 +6,42 @@ Created on: 19.08.22 """ from django.contrib.auth.decorators import login_required -from django.http import HttpRequest -from django.shortcuts import get_object_or_404 -from django.urls import reverse +from django.utils.decorators import method_decorator -from compensation.forms.modals.state import EditCompensationStateModalForm, RemoveCompensationStateModalForm, \ - NewCompensationStateModalForm -from compensation.models import EcoAccount, CompensationState +from compensation.models import EcoAccount from konova.decorators import shared_access_required, default_group_required -from konova.utils.message_templates import COMPENSATION_STATE_EDITED, COMPENSATION_STATE_REMOVED, \ - COMPENSATION_STATE_ADDED +from konova.views.state import AbstractNewCompensationStateView, AbstractEditCompensationStateView, \ + AbstractRemoveCompensationStateView -@login_required -@default_group_required -@shared_access_required(EcoAccount, "id") -def state_new_view(request: HttpRequest, id: str): - """ Renders a form for adding new states for an eco account +class NewEcoAccountStateView(AbstractNewCompensationStateView): + model = EcoAccount + redirect_url = "compensation:acc:detail" - Args: - request (HttpRequest): The incoming request - id (str): The account's id to which the new state will be related - - Returns: - - """ - acc = get_object_or_404(EcoAccount, id=id) - form = NewCompensationStateModalForm(request.POST or None, instance=acc, request=request) - return form.process_request( - request, - msg_success=COMPENSATION_STATE_ADDED, - redirect_url=reverse("compensation:acc:detail", args=(id,)) + "#related_data" - ) - -@login_required -@default_group_required -@shared_access_required(EcoAccount, "id") -def state_remove_view(request: HttpRequest, id: str, state_id: str): - """ Renders a form for removing a compensation state - - Args: - request (HttpRequest): The incoming request - id (str): The compensation's id - state_id (str): The state's id - - Returns: - - """ - acc = get_object_or_404(EcoAccount, id=id) - state = get_object_or_404(CompensationState, id=state_id) - form = RemoveCompensationStateModalForm(request.POST or None, instance=acc, state=state, request=request) - return form.process_request( - request, - msg_success=COMPENSATION_STATE_REMOVED, - redirect_url=reverse("compensation:acc:detail", args=(id,)) + "#related_data" - ) + @method_decorator(login_required) + @method_decorator(default_group_required) + @method_decorator(shared_access_required(EcoAccount, "id")) + def dispatch(self, request, *args, **kwargs): + return super().dispatch(request, *args, **kwargs) -@login_required -@default_group_required -@shared_access_required(EcoAccount, "id") -def state_edit_view(request: HttpRequest, id: str, state_id: str): - """ Renders a form for editing a compensation state +class EditEcoAccountStateView(AbstractEditCompensationStateView): + model = EcoAccount + redirect_url = "compensation:acc:detail" - Args: - request (HttpRequest): The incoming request - id (str): The compensation's id - state_id (str): The state's id + @method_decorator(login_required) + @method_decorator(default_group_required) + @method_decorator(shared_access_required(EcoAccount, "id")) + def dispatch(self, request, *args, **kwargs): + return super().dispatch(request, *args, **kwargs) - Returns: - """ - acc = get_object_or_404(EcoAccount, id=id) - state = get_object_or_404(CompensationState, id=state_id) - form = EditCompensationStateModalForm(request.POST or None, instance=acc, state=state, request=request) - return form.process_request( - request, - msg_success=COMPENSATION_STATE_EDITED, - redirect_url=reverse("compensation:acc:detail", args=(id,)) + "#related_data" - ) +class RemoveEcoAccountStateView(AbstractRemoveCompensationStateView): + model = EcoAccount + redirect_url = "compensation:acc:detail" + @method_decorator(login_required) + @method_decorator(default_group_required) + @method_decorator(shared_access_required(EcoAccount, "id")) + def dispatch(self, request, *args, **kwargs): + return super().dispatch(request, *args, **kwargs) diff --git a/ema/urls.py b/ema/urls.py index eda06728..faeb0f2c 100644 --- a/ema/urls.py +++ b/ema/urls.py @@ -16,7 +16,7 @@ from ema.views.record import EmaRecordView from ema.views.report import report_view from ema.views.resubmission import EmaResubmissionView from ema.views.share import share_view, create_share_view -from ema.views.state import state_new_view, state_remove_view, state_edit_view +from ema.views.state import NewEmaStateView, EditEmaStateView, RemoveEmaStateView app_name = "ema" urlpatterns = [ @@ -31,9 +31,9 @@ urlpatterns = [ path('/report', report_view, name='report'), path('/resub', EmaResubmissionView.as_view(), name='resubmission-create'), - path('/state/new', state_new_view, name='new-state'), - path('/state//remove', state_remove_view, name='state-remove'), - path('/state//edit', state_edit_view, name='state-edit'), + path('/state/new', NewEmaStateView.as_view(), name='new-state'), + path('/state//remove', RemoveEmaStateView.as_view(), name='state-remove'), + path('/state//edit', EditEmaStateView.as_view(), name='state-edit'), path('/action/new', action_new_view, name='new-action'), path('/action//edit', action_edit_view, name='action-edit'), diff --git a/ema/views/state.py b/ema/views/state.py index 1c7b0a44..717ae7f7 100644 --- a/ema/views/state.py +++ b/ema/views/state.py @@ -6,85 +6,42 @@ Created on: 19.08.22 """ from django.contrib.auth.decorators import login_required -from django.http import HttpRequest -from django.shortcuts import get_object_or_404 -from django.urls import reverse +from django.utils.decorators import method_decorator -from compensation.forms.modals.state import NewCompensationStateModalForm, RemoveCompensationStateModalForm, \ - EditCompensationStateModalForm -from compensation.models import CompensationState from ema.models import Ema from konova.decorators import conservation_office_group_required, shared_access_required -from konova.utils.message_templates import COMPENSATION_STATE_ADDED, COMPENSATION_STATE_REMOVED, \ - COMPENSATION_STATE_EDITED +from konova.views.state import AbstractNewCompensationStateView, AbstractEditCompensationStateView, \ + AbstractRemoveCompensationStateView -@login_required -@conservation_office_group_required -@shared_access_required(Ema, "id") -def state_new_view(request: HttpRequest, id: str): - """ Renders a form for adding new states for an EMA +class NewEmaStateView(AbstractNewCompensationStateView): + model = Ema + redirect_url = "ema:detail" - Args: - request (HttpRequest): The incoming request - id (str): The EMA's id to which the new state will be related - - Returns: - - """ - ema = get_object_or_404(Ema, id=id) - form = NewCompensationStateModalForm(request.POST or None, instance=ema, request=request) - return form.process_request( - request, - msg_success=COMPENSATION_STATE_ADDED, - redirect_url=reverse("ema:detail", args=(id,)) + "#related_data" - ) + @method_decorator(login_required) + @method_decorator(conservation_office_group_required) + @method_decorator(shared_access_required(Ema, "id")) + def dispatch(self, request, *args, **kwargs): + return super().dispatch(request, *args, **kwargs) -@login_required -@conservation_office_group_required -@shared_access_required(Ema, "id") -def state_remove_view(request: HttpRequest, id: str, state_id: str): - """ Renders a form for removing an EMA state +class EditEmaStateView(AbstractEditCompensationStateView): + model = Ema + redirect_url = "ema:detail" - Args: - request (HttpRequest): The incoming request - id (str): The ema id - state_id (str): The state's id - - Returns: - - """ - ema = get_object_or_404(Ema, id=id) - state = get_object_or_404(CompensationState, id=state_id) - form = RemoveCompensationStateModalForm(request.POST or None, instance=ema, state=state, request=request) - return form.process_request( - request, - msg_success=COMPENSATION_STATE_REMOVED, - redirect_url=reverse("ema:detail", args=(id,)) + "#related_data" - ) + @method_decorator(login_required) + @method_decorator(conservation_office_group_required) + @method_decorator(shared_access_required(Ema, "id")) + def dispatch(self, request, *args, **kwargs): + return super().dispatch(request, *args, **kwargs) -@login_required -@conservation_office_group_required -@shared_access_required(Ema, "id") -def state_edit_view(request: HttpRequest, id: str, state_id: str): - """ Renders a form for editing an EMA state - - Args: - request (HttpRequest): The incoming request - id (str): The ema id - state_id (str): The state's id - - Returns: - - """ - ema = get_object_or_404(Ema, id=id) - state = get_object_or_404(CompensationState, id=state_id) - form = EditCompensationStateModalForm(request.POST or None, instance=ema, state=state, request=request) - return form.process_request( - request, - msg_success=COMPENSATION_STATE_EDITED, - redirect_url=reverse("ema:detail", args=(id,)) + "#related_data" - ) +class RemoveEmaStateView(AbstractRemoveCompensationStateView): + model = Ema + redirect_url = "ema:detail" + @method_decorator(login_required) + @method_decorator(conservation_office_group_required) + @method_decorator(shared_access_required(Ema, "id")) + def dispatch(self, request, *args, **kwargs): + return super().dispatch(request, *args, **kwargs) diff --git a/konova/views/state.py b/konova/views/state.py new file mode 100644 index 00000000..1165e08b --- /dev/null +++ b/konova/views/state.py @@ -0,0 +1,107 @@ +""" +Author: Michel Peltriaux +Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany +Contact: ksp-servicestelle@sgdnord.rlp.de +Created on: 22.08.22 + +""" +from django.shortcuts import get_object_or_404 +from django.urls import reverse +from django.views import View + +from compensation.forms.modals.state import NewCompensationStateModalForm, EditCompensationStateModalForm, \ + RemoveCompensationStateModalForm +from compensation.models import CompensationState +from konova.utils.message_templates import COMPENSATION_STATE_ADDED, COMPENSATION_STATE_EDITED, \ + COMPENSATION_STATE_REMOVED + + +class AbstractCompensationStateView(View): + model = None + redirect_url = None + + class Meta: + abstract = True + + +class AbstractNewCompensationStateView(AbstractCompensationStateView): + class Meta: + abstract = True + + def get(self, request, id: str): + """ Renders a form for adding new states + + Args: + request (HttpRequest): The incoming request + id (str): The object's id to which the new state will be related + + Returns: + + """ + obj = get_object_or_404(self.model, id=id) + form = NewCompensationStateModalForm(request.POST or None, instance=obj, request=request) + return form.process_request( + request, + msg_success=COMPENSATION_STATE_ADDED, + redirect_url=reverse(self.redirect_url, args=(id,)) + "#related_data" + ) + + def post(self, request, id: str): + return self.get(request, id) + + +class AbstractEditCompensationStateView(AbstractCompensationStateView): + class Meta: + abstract = True + + def get(self, request, id: str, state_id: str): + """ Renders a form for editing a state + + Args: + request (HttpRequest): The incoming request + id (str): The object id + state_id (str): The state's id + + Returns: + + """ + obj = get_object_or_404(self.model, id=id) + state = get_object_or_404(CompensationState, id=state_id) + form = EditCompensationStateModalForm(request.POST or None, instance=obj, state=state, request=request) + return form.process_request( + request, + msg_success=COMPENSATION_STATE_EDITED, + redirect_url=reverse(self.redirect_url, args=(id,)) + "#related_data" + ) + + def post(self, request, id: str, state_id: str): + return self.get(request, id, state_id) + + +class AbstractRemoveCompensationStateView(AbstractCompensationStateView): + class Meta: + abstract = True + + def get(self, request, id: str, state_id: str): + """ Renders a form for removing astate + + Args: + request (HttpRequest): The incoming request + id (str): The object id + state_id (str): The state's id + + Returns: + + """ + obj = get_object_or_404(self.model, id=id) + state = get_object_or_404(CompensationState, id=state_id) + form = RemoveCompensationStateModalForm(request.POST or None, instance=obj, state=state, request=request) + return form.process_request( + request, + msg_success=COMPENSATION_STATE_REMOVED, + redirect_url=reverse(self.redirect_url, args=(id,)) + "#related_data" + ) + + def post(self, request, id: str, state_id: str): + return self.get(request, id, state_id) + -- 2.45.2 From e66c5369a7a3f8e8639b89d722da4edbf001d159 Mon Sep 17 00:00:00 2001 From: mpeltriaux Date: Mon, 22 Aug 2022 08:38:23 +0200 Subject: [PATCH 19/21] CompensationAction views * replaces function based action views with class based --- compensation/urls/compensation.py | 9 +- compensation/urls/eco_account.py | 9 +- compensation/views/compensation/action.py | 89 ++++++------------ compensation/views/eco_account/action.py | 98 ++++++-------------- ema/urls.py | 8 +- ema/views/action.py | 96 ++++++------------- konova/views/action.py | 108 ++++++++++++++++++++++ 7 files changed, 204 insertions(+), 213 deletions(-) create mode 100644 konova/views/action.py diff --git a/compensation/urls/compensation.py b/compensation/urls/compensation.py index dcd065fd..45a11594 100644 --- a/compensation/urls/compensation.py +++ b/compensation/urls/compensation.py @@ -13,7 +13,8 @@ from compensation.views.compensation.resubmission import CompensationResubmissio from compensation.views.compensation.report import report_view from compensation.views.compensation.deadline import NewCompensationDeadlineView, EditCompensationDeadlineView, \ RemoveCompensationDeadlineView -from compensation.views.compensation.action import action_edit_view, action_new_view, action_remove_view +from compensation.views.compensation.action import NewCompensationActionView, EditCompensationActionView, \ + RemoveCompensationActionView from compensation.views.compensation.state import NewCompensationStateView, EditCompensationStateView, \ RemoveCompensationStateView from compensation.views.compensation.compensation import index_view, new_view, new_id_view, detail_view, edit_view, \ @@ -35,9 +36,9 @@ urlpatterns = [ path('/state//edit', EditCompensationStateView.as_view(), name='state-edit'), path('/state//remove', RemoveCompensationStateView.as_view(), name='state-remove'), - path('/action/new', action_new_view, name='new-action'), - path('/action//edit', action_edit_view, name='action-edit'), - path('/action//remove', action_remove_view, name='action-remove'), + path('/action/new', NewCompensationActionView.as_view(), name='new-action'), + path('/action//edit', EditCompensationActionView.as_view(), name='action-edit'), + path('/action//remove', RemoveCompensationActionView.as_view(), name='action-remove'), path('/deadline/new', NewCompensationDeadlineView.as_view(), name="new-deadline"), path('/deadline//edit', EditCompensationDeadlineView.as_view(), name='deadline-edit'), diff --git a/compensation/urls/eco_account.py b/compensation/urls/eco_account.py index 60ee786c..01fafc47 100644 --- a/compensation/urls/eco_account.py +++ b/compensation/urls/eco_account.py @@ -16,7 +16,8 @@ from compensation.views.eco_account.report import report_view from compensation.views.eco_account.resubmission import EcoAccountResubmissionView from compensation.views.eco_account.state import NewEcoAccountStateView, EditEcoAccountStateView, \ RemoveEcoAccountStateView -from compensation.views.eco_account.action import action_edit_view, action_new_view, action_remove_view +from compensation.views.eco_account.action import NewEcoAccountActionView, EditEcoAccountActionView, \ + RemoveEcoAccountActionView from compensation.views.eco_account.deadline import NewEcoAccountDeadlineView, EditEcoAccountDeadlineView, \ RemoveEcoAccountDeadlineView from compensation.views.eco_account.share import share_view, create_share_view @@ -41,9 +42,9 @@ urlpatterns = [ path('/state//edit', EditEcoAccountStateView.as_view(), name='state-edit'), path('/state//remove', RemoveEcoAccountStateView.as_view(), name='state-remove'), - path('/action/new', action_new_view, name='new-action'), - path('/action//edit', action_edit_view, name='action-edit'), - path('/action//remove', action_remove_view, name='action-remove'), + path('/action/new', NewEcoAccountActionView.as_view(), name='new-action'), + path('/action//edit', EditEcoAccountActionView.as_view(), name='action-edit'), + path('/action//remove', RemoveEcoAccountActionView.as_view(), name='action-remove'), path('/deadline/new', NewEcoAccountDeadlineView.as_view(), name="new-deadline"), path('/deadline//edit', EditEcoAccountDeadlineView.as_view(), name='deadline-edit'), diff --git a/compensation/views/compensation/action.py b/compensation/views/compensation/action.py index 54f6bc39..1f5b9339 100644 --- a/compensation/views/compensation/action.py +++ b/compensation/views/compensation/action.py @@ -9,6 +9,7 @@ from django.contrib.auth.decorators import login_required from django.http import HttpRequest from django.shortcuts import get_object_or_404 from django.urls import reverse +from django.utils.decorators import method_decorator from compensation.forms.modals.compensation_action import RemoveCompensationActionModalForm, \ EditCompensationActionModalForm, NewCompensationActionModalForm @@ -16,74 +17,38 @@ from compensation.models import Compensation, CompensationAction from konova.decorators import shared_access_required, default_group_required from konova.utils.message_templates import COMPENSATION_ACTION_REMOVED, COMPENSATION_ACTION_EDITED, \ COMPENSATION_ACTION_ADDED +from konova.views.action import AbstractNewCompensationActionView, AbstractEditCompensationActionView, \ + AbstractRemoveCompensationActionView -@login_required -@default_group_required -@shared_access_required(Compensation, "id") -def action_new_view(request: HttpRequest, id: str): - """ Renders a form for adding new actions for a compensation +class NewCompensationActionView(AbstractNewCompensationActionView): + model = Compensation + redirect_url = "compensation:detail" - Args: - request (HttpRequest): The incoming request - id (str): The compensation's id to which the new state will be related - - Returns: - - """ - comp = get_object_or_404(Compensation, id=id) - form = NewCompensationActionModalForm(request.POST or None, instance=comp, request=request) - return form.process_request( - request, - msg_success=COMPENSATION_ACTION_ADDED, - redirect_url=reverse("compensation:detail", args=(id,)) + "#related_data" - ) + @method_decorator(login_required) + @method_decorator(default_group_required) + @method_decorator(shared_access_required(Compensation, "id")) + def dispatch(self, request, *args, **kwargs): + return super().dispatch(request, *args, **kwargs) -@login_required -@default_group_required -@shared_access_required(Compensation, "id") -def action_edit_view(request: HttpRequest, id: str, action_id: str): - """ Renders a form for editing actions for a compensation +class EditCompensationActionView(AbstractEditCompensationActionView): + model = Compensation + redirect_url = "compensation:detail" - Args: - request (HttpRequest): The incoming request - id (str): The compensation's id - action_id (str): The action's id - - Returns: - - """ - comp = get_object_or_404(Compensation, id=id) - action = get_object_or_404(CompensationAction, id=action_id) - form = EditCompensationActionModalForm(request.POST or None, instance=comp, action=action, request=request) - return form.process_request( - request, - msg_success=COMPENSATION_ACTION_EDITED, - redirect_url=reverse("compensation:detail", args=(id,)) + "#related_data" - ) + @method_decorator(login_required) + @method_decorator(default_group_required) + @method_decorator(shared_access_required(Compensation, "id")) + def dispatch(self, request, *args, **kwargs): + return super().dispatch(request, *args, **kwargs) -@login_required -@default_group_required -@shared_access_required(Compensation, "id") -def action_remove_view(request: HttpRequest, id: str, action_id: str): - """ Renders a form for removing a compensation action - - Args: - request (HttpRequest): The incoming request - id (str): The compensation's id - id (str): The action's id - - Returns: - - """ - comp = get_object_or_404(Compensation, id=id) - action = get_object_or_404(CompensationAction, id=action_id) - form = RemoveCompensationActionModalForm(request.POST or None, instance=comp, action=action, request=request) - return form.process_request( - request, - msg_success=COMPENSATION_ACTION_REMOVED, - redirect_url=reverse("compensation:detail", args=(id,)) + "#related_data" - ) +class RemoveCompensationActionView(AbstractRemoveCompensationActionView): + model = Compensation + redirect_url = "compensation:detail" + @method_decorator(login_required) + @method_decorator(default_group_required) + @method_decorator(shared_access_required(Compensation, "id")) + def dispatch(self, request, *args, **kwargs): + return super().dispatch(request, *args, **kwargs) diff --git a/compensation/views/eco_account/action.py b/compensation/views/eco_account/action.py index c7eb2185..e459def7 100644 --- a/compensation/views/eco_account/action.py +++ b/compensation/views/eco_account/action.py @@ -6,84 +6,42 @@ Created on: 19.08.22 """ from django.contrib.auth.decorators import login_required -from django.http import HttpRequest -from django.shortcuts import get_object_or_404 -from django.urls import reverse +from django.utils.decorators import method_decorator -from compensation.forms.modals.compensation_action import EditCompensationActionModalForm, \ - RemoveCompensationActionModalForm, NewCompensationActionModalForm -from compensation.models import EcoAccount, CompensationAction +from compensation.models import EcoAccount from konova.decorators import shared_access_required, default_group_required -from konova.utils.message_templates import COMPENSATION_ACTION_EDITED, COMPENSATION_ACTION_REMOVED, \ - COMPENSATION_ACTION_ADDED +from konova.views.action import AbstractNewCompensationActionView, AbstractEditCompensationActionView, \ + AbstractRemoveCompensationActionView -@login_required -@default_group_required -@shared_access_required(EcoAccount, "id") -def action_new_view(request: HttpRequest, id: str): - """ Renders a form for adding new actions for an eco account +class NewEcoAccountActionView(AbstractNewCompensationActionView): + model = EcoAccount + redirect_url = "compensation:acc:detail" - Args: - request (HttpRequest): The incoming request - id (str): The account's id to which the new state will be related - - Returns: - - """ - acc = get_object_or_404(EcoAccount, id=id) - form = NewCompensationActionModalForm(request.POST or None, instance=acc, request=request) - return form.process_request( - request, - msg_success=COMPENSATION_ACTION_ADDED, - redirect_url=reverse("compensation:acc:detail", args=(id,)) + "#related_data" - ) + @method_decorator(login_required) + @method_decorator(default_group_required) + @method_decorator(shared_access_required(EcoAccount, "id")) + def dispatch(self, request, *args, **kwargs): + return super().dispatch(request, *args, **kwargs) -@login_required -@default_group_required -@shared_access_required(EcoAccount, "id") -def action_remove_view(request: HttpRequest, id: str, action_id: str): - """ Renders a form for removing a compensation action +class EditEcoAccountActionView(AbstractEditCompensationActionView): + model = EcoAccount + redirect_url = "compensation:acc:detail" - Args: - request (HttpRequest): The incoming request - id (str): The compensation's id - id (str): The action's id - - Returns: - - """ - acc = get_object_or_404(EcoAccount, id=id) - action = get_object_or_404(CompensationAction, id=action_id) - form = RemoveCompensationActionModalForm(request.POST or None, instance=acc, action=action, request=request) - return form.process_request( - request, - msg_success=COMPENSATION_ACTION_REMOVED, - redirect_url=reverse("compensation:acc:detail", args=(id,)) + "#related_data" - ) + @method_decorator(login_required) + @method_decorator(default_group_required) + @method_decorator(shared_access_required(EcoAccount, "id")) + def dispatch(self, request, *args, **kwargs): + return super().dispatch(request, *args, **kwargs) -@login_required -@default_group_required -@shared_access_required(EcoAccount, "id") -def action_edit_view(request: HttpRequest, id: str, action_id: str): - """ Renders a form for editing a compensation action - - Args: - request (HttpRequest): The incoming request - id (str): The compensation's id - id (str): The action's id - - Returns: - - """ - acc = get_object_or_404(EcoAccount, id=id) - action = get_object_or_404(CompensationAction, id=action_id) - form = EditCompensationActionModalForm(request.POST or None, instance=acc, action=action, request=request) - return form.process_request( - request, - msg_success=COMPENSATION_ACTION_EDITED, - redirect_url=reverse("compensation:acc:detail", args=(id,)) + "#related_data" - ) +class RemoveEcoAccountActionView(AbstractRemoveCompensationActionView): + model = EcoAccount + redirect_url = "compensation:acc:detail" + @method_decorator(login_required) + @method_decorator(default_group_required) + @method_decorator(shared_access_required(EcoAccount, "id")) + def dispatch(self, request, *args, **kwargs): + return super().dispatch(request, *args, **kwargs) diff --git a/ema/urls.py b/ema/urls.py index faeb0f2c..a9c6dc41 100644 --- a/ema/urls.py +++ b/ema/urls.py @@ -7,7 +7,7 @@ Created on: 19.08.21 """ from django.urls import path -from ema.views.action import action_new_view, action_edit_view, action_remove_view +from ema.views.action import NewEmaActionView, EditEmaActionView, RemoveEmaActionView from ema.views.deadline import NewEmaDeadlineView, EditEmaDeadlineView, RemoveEmaDeadlineView from ema.views.document import NewEmaDocumentView, EditEmaDocumentView, RemoveEmaDocumentView, GetEmaDocumentView from ema.views.ema import index_view, new_view, new_id_view, detail_view, edit_view, remove_view @@ -35,9 +35,9 @@ urlpatterns = [ path('/state//remove', RemoveEmaStateView.as_view(), name='state-remove'), path('/state//edit', EditEmaStateView.as_view(), name='state-edit'), - path('/action/new', action_new_view, name='new-action'), - path('/action//edit', action_edit_view, name='action-edit'), - path('/action//remove', action_remove_view, name='action-remove'), + path('/action/new', NewEmaActionView.as_view(), name='new-action'), + path('/action//edit', EditEmaActionView.as_view(), name='action-edit'), + path('/action//remove', RemoveEmaActionView.as_view(), name='action-remove'), path('/deadline/new', NewEmaDeadlineView.as_view(), name="new-deadline"), path('/deadline//edit', EditEmaDeadlineView.as_view(), name='deadline-edit'), diff --git a/ema/views/action.py b/ema/views/action.py index bd13646c..bae950c6 100644 --- a/ema/views/action.py +++ b/ema/views/action.py @@ -6,84 +6,42 @@ Created on: 19.08.22 """ from django.contrib.auth.decorators import login_required -from django.http import HttpRequest -from django.shortcuts import get_object_or_404 -from django.urls import reverse +from django.utils.decorators import method_decorator -from compensation.forms.modals.compensation_action import RemoveCompensationActionModalForm, \ - EditCompensationActionModalForm, NewCompensationActionModalForm -from compensation.models import CompensationAction from ema.models import Ema from konova.decorators import shared_access_required, conservation_office_group_required -from konova.utils.message_templates import COMPENSATION_ACTION_REMOVED, COMPENSATION_ACTION_EDITED, \ - COMPENSATION_ACTION_ADDED +from konova.views.action import AbstractNewCompensationActionView, AbstractEditCompensationActionView, \ + AbstractRemoveCompensationActionView -@login_required -@conservation_office_group_required -@shared_access_required(Ema, "id") -def action_new_view(request: HttpRequest, id: str): - """ Renders a form for adding new actions for an EMA +class NewEmaActionView(AbstractNewCompensationActionView): + model = Ema + redirect_url = "ema:detail" - Args: - request (HttpRequest): The incoming request - id (str): The EMA's id to which the new state will be related - - Returns: - - """ - ema = get_object_or_404(Ema, id=id) - form = NewCompensationActionModalForm(request.POST or None, instance=ema, request=request) - return form.process_request( - request, - msg_success=COMPENSATION_ACTION_ADDED, - redirect_url=reverse("ema:detail", args=(id,)) + "#related_data" - ) + @method_decorator(login_required) + @method_decorator(conservation_office_group_required) + @method_decorator(shared_access_required(Ema, "id")) + def dispatch(self, request, *args, **kwargs): + return super().dispatch(request, *args, **kwargs) -@login_required -@conservation_office_group_required -@shared_access_required(Ema, "id") -def action_edit_view(request: HttpRequest, id: str, action_id: str): - """ Renders a form for editing an actions for an EMA +class EditEmaActionView(AbstractEditCompensationActionView): + model = Ema + redirect_url = "ema:detail" - Args: - request (HttpRequest): The incoming request - id (str): The EMA's id - action_id (str): The action id - - Returns: - - """ - ema = get_object_or_404(Ema, id=id) - action = get_object_or_404(CompensationAction, id=action_id) - form = EditCompensationActionModalForm(request.POST or None, instance=ema, action=action, request=request) - return form.process_request( - request, - msg_success=COMPENSATION_ACTION_EDITED, - redirect_url=reverse("ema:detail", args=(id,)) + "#related_data" - ) + @method_decorator(login_required) + @method_decorator(conservation_office_group_required) + @method_decorator(shared_access_required(Ema, "id")) + def dispatch(self, request, *args, **kwargs): + return super().dispatch(request, *args, **kwargs) -@login_required -@conservation_office_group_required -@shared_access_required(Ema, "id") -def action_remove_view(request: HttpRequest, id: str, action_id: str): - """ Renders a form for removing an EMA action +class RemoveEmaActionView(AbstractRemoveCompensationActionView): + model = Ema + redirect_url = "ema:detail" - Args: - request (HttpRequest): The incoming request - id (str): The ema id - id (str): The action's id - - Returns: - - """ - ema = get_object_or_404(Ema, id=id) - action = get_object_or_404(CompensationAction, id=action_id) - form = RemoveCompensationActionModalForm(request.POST or None, instance=ema, action=action, request=request) - return form.process_request( - request, - msg_success=COMPENSATION_ACTION_REMOVED, - redirect_url=reverse("ema:detail", args=(id,)) + "#related_data" - ) + @method_decorator(login_required) + @method_decorator(conservation_office_group_required) + @method_decorator(shared_access_required(Ema, "id")) + def dispatch(self, request, *args, **kwargs): + return super().dispatch(request, *args, **kwargs) diff --git a/konova/views/action.py b/konova/views/action.py new file mode 100644 index 00000000..5699a963 --- /dev/null +++ b/konova/views/action.py @@ -0,0 +1,108 @@ +""" +Author: Michel Peltriaux +Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany +Contact: ksp-servicestelle@sgdnord.rlp.de +Created on: 22.08.22 + +""" +from django.shortcuts import get_object_or_404 +from django.urls import reverse +from django.views import View + +from compensation.forms.modals.compensation_action import NewCompensationActionModalForm, \ + EditCompensationActionModalForm, RemoveCompensationActionModalForm +from compensation.models import CompensationAction +from konova.utils.message_templates import COMPENSATION_STATE_ADDED, COMPENSATION_STATE_EDITED, \ + COMPENSATION_STATE_REMOVED + + +class AbstractCompensationActionView(View): + model = None + redirect_url = None + + class Meta: + abstract = True + + +class AbstractNewCompensationActionView(AbstractCompensationActionView): + class Meta: + abstract = True + + def get(self, request, id: str): + """ Renders a form for adding new actions + + Args: + request (HttpRequest): The incoming request + id (str): The object's id to which the new action will be related + + Returns: + + """ + obj = get_object_or_404(self.model, id=id) + form = NewCompensationActionModalForm(request.POST or None, instance=obj, request=request) + return form.process_request( + request, + msg_success=COMPENSATION_STATE_ADDED, + redirect_url=reverse(self.redirect_url, args=(id,)) + "#related_data" + ) + + def post(self, request, id: str): + return self.get(request, id) + + +class AbstractEditCompensationActionView(AbstractCompensationActionView): + class Meta: + abstract = True + + def get(self, request, id: str, action_id: str): + """ Renders a form for editing a action + + Args: + request (HttpRequest): The incoming request + id (str): The object id + action_id (str): The action's id + + Returns: + + """ + obj = get_object_or_404(self.model, id=id) + action = get_object_or_404(CompensationAction, id=action_id) + form = EditCompensationActionModalForm(request.POST or None, instance=obj, action=action, request=request) + return form.process_request( + request, + msg_success=COMPENSATION_STATE_EDITED, + redirect_url=reverse(self.redirect_url, args=(id,)) + "#related_data" + ) + + def post(self, request, id: str, action_id: str): + return self.get(request, id, action_id) + + +class AbstractRemoveCompensationActionView(AbstractCompensationActionView): + class Meta: + abstract = True + + def get(self, request, id: str, action_id: str): + """ Renders a form for removing aaction + + Args: + request (HttpRequest): The incoming request + id (str): The object id + action_id (str): The action's id + + Returns: + + """ + obj = get_object_or_404(self.model, id=id) + action = get_object_or_404(CompensationAction, id=action_id) + form = RemoveCompensationActionModalForm(request.POST or None, instance=obj, action=action, request=request) + return form.process_request( + request, + msg_success=COMPENSATION_STATE_REMOVED, + redirect_url=reverse(self.redirect_url, args=(id,)) + "#related_data" + ) + + def post(self, request, id: str, action_id: str): + return self.get(request, id, action_id) + + -- 2.45.2 From 09402611dc72a21384c7531574c672794ca58de3 Mon Sep 17 00:00:00 2001 From: mpeltriaux Date: Mon, 22 Aug 2022 10:17:49 +0200 Subject: [PATCH 20/21] EcoAccount views * splits compensation/views/eco_account.py (+700 lines) into separate files in new module * view files can now be found in /compensation/views/eco_account/... --- compensation/urls/eco_account.py | 9 +- compensation/views/eco_account/deduction.py | 108 +++++----------- intervention/urls.py | 9 +- intervention/views/deduction.py | 106 +++++---------- konova/utils/message_templates.py | 1 + konova/views/deduction.py | 135 ++++++++++++++++++++ 6 files changed, 209 insertions(+), 159 deletions(-) create mode 100644 konova/views/deduction.py diff --git a/compensation/urls/eco_account.py b/compensation/urls/eco_account.py index 01fafc47..af430a93 100644 --- a/compensation/urls/eco_account.py +++ b/compensation/urls/eco_account.py @@ -23,7 +23,8 @@ from compensation.views.eco_account.deadline import NewEcoAccountDeadlineView, E from compensation.views.eco_account.share import share_view, create_share_view from compensation.views.eco_account.document import GetEcoAccountDocumentView, NewEcoAccountDocumentView, \ EditEcoAccountDocumentView, RemoveEcoAccountDocumentView -from compensation.views.eco_account.deduction import deduction_edit_view, deduction_remove_view, new_deduction_view +from compensation.views.eco_account.deduction import NewEcoAccountDeductionView, EditEcoAccountDeductionView, \ + RemoveEcoAccountDeductionView app_name = "acc" urlpatterns = [ @@ -60,9 +61,9 @@ urlpatterns = [ path('/document//remove/', RemoveEcoAccountDocumentView.as_view(), name='remove-doc'), # Eco-account deductions - path('/deduction//remove', deduction_remove_view, name='remove-deduction'), - path('/deduction//edit', deduction_edit_view, name='edit-deduction'), - path('/deduct/new', new_deduction_view, name='new-deduction'), + path('/deduction//remove', RemoveEcoAccountDeductionView.as_view(), name='remove-deduction'), + path('/deduction//edit', EditEcoAccountDeductionView.as_view(), name='edit-deduction'), + path('/deduct/new', NewEcoAccountDeductionView.as_view(), name='new-deduction'), # Autocomplete path("atcmplt/eco-accounts", EcoAccountAutocomplete.as_view(), name="autocomplete"), diff --git a/compensation/views/eco_account/deduction.py b/compensation/views/eco_account/deduction.py index e9b1dcb9..c7598bb8 100644 --- a/compensation/views/eco_account/deduction.py +++ b/compensation/views/eco_account/deduction.py @@ -6,96 +6,50 @@ Created on: 19.08.22 """ from django.contrib.auth.decorators import login_required -from django.core.exceptions import ObjectDoesNotExist -from django.http import HttpRequest, Http404 -from django.shortcuts import get_object_or_404 -from django.urls import reverse +from django.http import Http404 +from django.utils.decorators import method_decorator from compensation.models import EcoAccount -from intervention.forms.modals.deduction import EditEcoAccountDeductionModalForm, RemoveEcoAccountDeductionModalForm, \ - NewEcoAccountDeductionModalForm from konova.decorators import default_group_required -from konova.utils.message_templates import DEDUCTION_EDITED, DEDUCTION_REMOVED, DEDUCTION_ADDED +from konova.views.deduction import AbstractNewDeductionView, AbstractEditDeductionView, AbstractRemoveDeductionView -@login_required -@default_group_required -def new_deduction_view(request: HttpRequest, id: str): - """ Renders a modal form view for creating deductions +class NewEcoAccountDeductionView(AbstractNewDeductionView): + model = EcoAccount + redirect_url = "compensation:acc:detail" - Args: - request (HttpRequest): THe incoming request - id (str): The eco account's id + @method_decorator(login_required) + @method_decorator(default_group_required) + def dispatch(self, request, *args, **kwargs): + return super().dispatch(request, *args, **kwargs) - Returns: - - """ - acc = get_object_or_404(EcoAccount, id=id) - if not acc.recorded: - raise Http404() - form = NewEcoAccountDeductionModalForm(request.POST or None, instance=acc, request=request) - return form.process_request( - request, - msg_success=DEDUCTION_ADDED, - redirect_url=reverse("compensation:acc:detail", args=(id,)) + "#related_data" - ) + def _custom_check(self, obj): + if not obj.recorded: + raise Http404() -@login_required -@default_group_required -def deduction_remove_view(request: HttpRequest, id: str, deduction_id: str): - """ Renders a modal view for removing deductions +class EditEcoAccountDeductionView(AbstractEditDeductionView): + def _custom_check(self, obj): + pass - Args: - request (HttpRequest): The incoming request - id (str): The eco account's id - deduction_id (str): The deduction's id + model = EcoAccount + redirect_url = "compensation:acc:detail" - Returns: - - """ - acc = get_object_or_404(EcoAccount, id=id) - try: - eco_deduction = acc.deductions.get(id=deduction_id) - if not eco_deduction.intervention.is_shared_with(request.user): - raise ObjectDoesNotExist() - except ObjectDoesNotExist: - raise Http404("Unknown deduction") - - form = RemoveEcoAccountDeductionModalForm(request.POST or None, instance=acc, deduction=eco_deduction, request=request) - return form.process_request( - request=request, - msg_success=DEDUCTION_REMOVED, - redirect_url=reverse("compensation:acc:detail", args=(id,)) + "#related_data" - ) + @method_decorator(login_required) + @method_decorator(default_group_required) + def dispatch(self, request, *args, **kwargs): + return super().dispatch(request, *args, **kwargs) -@login_required -@default_group_required -def deduction_edit_view(request: HttpRequest, id: str, deduction_id: str): - """ Renders a modal view for editing deductions +class RemoveEcoAccountDeductionView(AbstractRemoveDeductionView): + def _custom_check(self, obj): + pass - Args: - request (HttpRequest): The incoming request - id (str): The eco account's id - deduction_id (str): The deduction's id - - Returns: - - """ - acc = get_object_or_404(EcoAccount, id=id) - try: - eco_deduction = acc.deductions.get(id=deduction_id) - if not eco_deduction.intervention.is_shared_with(request.user): - raise ObjectDoesNotExist - except ObjectDoesNotExist: - raise Http404("Unknown deduction") - - form = EditEcoAccountDeductionModalForm(request.POST or None, instance=acc, deduction=eco_deduction, request=request) - return form.process_request( - request=request, - msg_success=DEDUCTION_EDITED, - redirect_url=reverse("compensation:acc:detail", args=(id,)) + "#related_data" - ) + model = EcoAccount + redirect_url = "compensation:acc:detail" + @method_decorator(login_required) + @method_decorator(default_group_required) + def dispatch(self, request, *args, **kwargs): + return super().dispatch(request, *args, **kwargs) diff --git a/intervention/urls.py b/intervention/urls.py index 20bd5c16..69c5e767 100644 --- a/intervention/urls.py +++ b/intervention/urls.py @@ -10,7 +10,8 @@ from django.urls import path from intervention.autocomplete.intervention import InterventionAutocomplete from intervention.views.check import check_view from intervention.views.compensation import remove_compensation_view -from intervention.views.deduction import new_deduction_view, edit_deduction_view, remove_deduction_view +from intervention.views.deduction import NewInterventionDeductionView, EditInterventionDeductionView, \ + RemoveInterventionDeductionView from intervention.views.document import NewInterventionDocumentView, GetInterventionDocumentView, \ RemoveInterventionDocumentView, EditInterventionDocumentView from intervention.views.intervention import index_view, new_view, new_id_view, detail_view, edit_view, remove_view @@ -48,9 +49,9 @@ urlpatterns = [ path('/document//edit/', EditInterventionDocumentView.as_view(), name='edit-doc'), # Deductions - path('/deduction/new', new_deduction_view, name='new-deduction'), - path('/deduction//edit', edit_deduction_view, name='edit-deduction'), - path('/deduction//remove', remove_deduction_view, name='remove-deduction'), + path('/deduction/new', NewInterventionDeductionView.as_view(), name='new-deduction'), + path('/deduction//edit', EditInterventionDeductionView.as_view(), name='edit-deduction'), + path('/deduction//remove', RemoveInterventionDeductionView.as_view(), name='remove-deduction'), # Revocation routes path('/revocation/new', new_revocation_view, name='new-revocation'), diff --git a/intervention/views/deduction.py b/intervention/views/deduction.py index 2fb841c1..962fe807 100644 --- a/intervention/views/deduction.py +++ b/intervention/views/deduction.py @@ -6,92 +6,50 @@ Created on: 19.08.22 """ from django.contrib.auth.decorators import login_required -from django.core.exceptions import ObjectDoesNotExist -from django.http import HttpRequest, Http404 -from django.shortcuts import get_object_or_404 -from django.urls import reverse +from django.utils.decorators import method_decorator -from intervention.forms.modals.deduction import NewEcoAccountDeductionModalForm, RemoveEcoAccountDeductionModalForm, \ - EditEcoAccountDeductionModalForm from intervention.models import Intervention from konova.decorators import default_group_required, shared_access_required -from konova.utils.message_templates import DEDUCTION_ADDED, DEDUCTION_REMOVED, DEDUCTION_EDITED +from konova.views.deduction import AbstractNewDeductionView, AbstractEditDeductionView, AbstractRemoveDeductionView -@login_required -@default_group_required -@shared_access_required(Intervention, "id") -def new_deduction_view(request: HttpRequest, id: str): - """ Renders a modal form view for creating deductions +class NewInterventionDeductionView(AbstractNewDeductionView): + def _custom_check(self, obj): + pass - Args: - request (HttpRequest): The incoming request - id (str): The intervention's id which shall benefit from this deduction + model = Intervention + redirect_url = "intervention:detail" - Returns: - - """ - intervention = get_object_or_404(Intervention, id=id) - form = NewEcoAccountDeductionModalForm(request.POST or None, instance=intervention, request=request) - return form.process_request( - request, - msg_success=DEDUCTION_ADDED, - redirect_url=reverse("intervention:detail", args=(id,)) + "#related_data", - ) + @method_decorator(login_required) + @method_decorator(default_group_required) + @method_decorator(shared_access_required(Intervention, "id")) + def dispatch(self, request, *args, **kwargs): + return super().dispatch(request, *args, **kwargs) -@login_required -@default_group_required -@shared_access_required(Intervention, "id") -def remove_deduction_view(request: HttpRequest, id: str, deduction_id: str): - """ Renders a modal view for removing deductions +class EditInterventionDeductionView(AbstractEditDeductionView): + def _custom_check(self, obj): + pass - Args: - request (HttpRequest): The incoming request - id (str): The intervention's id - deduction_id (str): The deduction's id + model = Intervention + redirect_url = "intervention:detail" - Returns: - - """ - intervention = get_object_or_404(Intervention, id=id) - try: - eco_deduction = intervention.deductions.get(id=deduction_id) - except ObjectDoesNotExist: - raise Http404("Unknown deduction") - - form = RemoveEcoAccountDeductionModalForm(request.POST or None, instance=intervention, deduction=eco_deduction, request=request) - return form.process_request( - request=request, - msg_success=DEDUCTION_REMOVED, - redirect_url=reverse("intervention:detail", args=(id,)) + "#related_data" - ) + @method_decorator(login_required) + @method_decorator(default_group_required) + @method_decorator(shared_access_required(Intervention, "id")) + def dispatch(self, request, *args, **kwargs): + return super().dispatch(request, *args, **kwargs) -@login_required -@default_group_required -@shared_access_required(Intervention, "id") -def edit_deduction_view(request: HttpRequest, id: str, deduction_id: str): - """ Renders a modal view for removing deductions +class RemoveInterventionDeductionView(AbstractRemoveDeductionView): + def _custom_check(self, obj): + pass - Args: - request (HttpRequest): The incoming request - id (str): The intervention's id - deduction_id (str): The deduction's id - - Returns: - - """ - intervention = get_object_or_404(Intervention, id=id) - try: - eco_deduction = intervention.deductions.get(id=deduction_id) - except ObjectDoesNotExist: - raise Http404("Unknown deduction") - - form = EditEcoAccountDeductionModalForm(request.POST or None, instance=intervention, deduction=eco_deduction, request=request) - return form.process_request( - request=request, - msg_success=DEDUCTION_EDITED, - redirect_url=reverse("intervention:detail", args=(id,)) + "#related_data" - ) + model = Intervention + redirect_url = "intervention:detail" + @method_decorator(login_required) + @method_decorator(default_group_required) + @method_decorator(shared_access_required(Intervention, "id")) + def dispatch(self, request, *args, **kwargs): + return super().dispatch(request, *args, **kwargs) diff --git a/konova/utils/message_templates.py b/konova/utils/message_templates.py index f6e3ca18..e144a97f 100644 --- a/konova/utils/message_templates.py +++ b/konova/utils/message_templates.py @@ -51,6 +51,7 @@ COMPENSATION_ACTION_REMOVED = _("Action removed") DEDUCTION_ADDED = _("Deduction added") DEDUCTION_EDITED = _("Deduction edited") DEDUCTION_REMOVED = _("Deduction removed") +DEDUCTION_UNKNOWN = _("Unknown deduction") # DEADLINE DEADLINE_ADDED = _("Deadline added") diff --git a/konova/views/deduction.py b/konova/views/deduction.py new file mode 100644 index 00000000..f31a7015 --- /dev/null +++ b/konova/views/deduction.py @@ -0,0 +1,135 @@ +""" +Author: Michel Peltriaux +Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany +Contact: ksp-servicestelle@sgdnord.rlp.de +Created on: 22.08.22 + +""" +from django.core.exceptions import ObjectDoesNotExist +from django.http import Http404 +from django.shortcuts import get_object_or_404 +from django.urls import reverse +from django.views import View + +from intervention.forms.modals.deduction import NewEcoAccountDeductionModalForm, EditEcoAccountDeductionModalForm, \ + RemoveEcoAccountDeductionModalForm +from konova.utils.message_templates import DEDUCTION_ADDED, DEDUCTION_EDITED, DEDUCTION_REMOVED, DEDUCTION_UNKNOWN + + +class AbstractDeductionView(View): + model = None + redirect_url = None + + def _custom_check(self, obj): + """ + Can be used by inheriting classes to provide custom checks before further processing + + """ + raise NotImplementedError("Must be implemented in subclasses") + + +class AbstractNewDeductionView(AbstractDeductionView): + + class Meta: + abstract = True + + def get(self, request, id: str): + """ Renders a modal form view for creating deductions + + Args: + request (HttpRequest): The incoming request + id (str): The obj's id which shall benefit from this deduction + + Returns: + + """ + obj = get_object_or_404(self.model, id=id) + self._custom_check(obj) + form = NewEcoAccountDeductionModalForm(request.POST or None, instance=obj, request=request) + return form.process_request( + request, + msg_success=DEDUCTION_ADDED, + redirect_url=reverse(self.redirect_url, args=(id,)) + "#related_data", + ) + + def post(self, request, id: str): + return self.get(request, id) + + +class AbstractEditDeductionView(AbstractDeductionView): + + def _custom_check(self, obj): + pass + + class Meta: + abstract = True + + def get(self, request, id: str, deduction_id: str): + """ Renders a modal view for editing deductions + + Args: + request (HttpRequest): The incoming request + id (str): The object's id + deduction_id (str): The deduction's id + + Returns: + + """ + obj = get_object_or_404(self.model, id=id) + self._custom_check(obj) + try: + eco_deduction = obj.deductions.get(id=deduction_id) + if not eco_deduction.intervention.is_shared_with(request.user): + raise ObjectDoesNotExist + except ObjectDoesNotExist: + raise Http404(DEDUCTION_UNKNOWN) + + form = EditEcoAccountDeductionModalForm(request.POST or None, instance=obj, deduction=eco_deduction, + request=request) + return form.process_request( + request=request, + msg_success=DEDUCTION_EDITED, + redirect_url=reverse(self.redirect_url, args=(id,)) + "#related_data" + ) + + def post(self, request, id: str, deduction_id: str): + return self.get(request, id, deduction_id) + + +class AbstractRemoveDeductionView(AbstractDeductionView): + + def _custom_check(self, obj): + pass + + class Meta: + abstract = True + + def get(self, request, id: str, deduction_id: str): + """ Renders a modal view for removing deductions + + Args: + request (HttpRequest): The incoming request + id (str): The object's id + deduction_id (str): The deduction's id + + Returns: + + """ + obj = get_object_or_404(self.model, id=id) + self._custom_check(obj) + try: + eco_deduction = obj.deductions.get(id=deduction_id) + if not eco_deduction.intervention.is_shared_with(request.user): + raise ObjectDoesNotExist() + except ObjectDoesNotExist: + raise Http404(DEDUCTION_UNKNOWN) + form = RemoveEcoAccountDeductionModalForm(request.POST or None, instance=obj, deduction=eco_deduction, + request=request) + return form.process_request( + request=request, + msg_success=DEDUCTION_REMOVED, + redirect_url=reverse(self.redirect_url, args=(id,)) + "#related_data" + ) + + def post(self, request, id: str, deduction_id: str): + return self.get(request, id, deduction_id) -- 2.45.2 From fc19a4de5299609445577934b9c8ee8be9f62949 Mon Sep 17 00:00:00 2001 From: mpeltriaux Date: Mon, 22 Aug 2022 10:58:07 +0200 Subject: [PATCH 21/21] Share views * replaces function based share views with class based * improves team-share autocomplete search * renames internal share url names --- compensation/models/eco_account.py | 2 +- .../detail/eco_account/includes/controls.html | 2 +- compensation/urls/eco_account.py | 6 +- compensation/views/eco_account/share.py | 76 ++++------------ ema/models/ema.py | 2 +- .../ema/detail/includes/controls.html | 2 +- ema/tests/test_views.py | 4 +- ema/urls.py | 6 +- ema/views/share.py | 75 ++++------------ intervention/models/intervention.py | 2 +- .../detail/includes/controls.html | 2 +- intervention/tests/test_views.py | 4 +- intervention/urls.py | 6 +- intervention/views/share.py | 76 ++++------------ konova/utils/message_templates.py | 1 + konova/views/share.py | 88 +++++++++++++++++++ user/autocomplete/share.py | 8 +- 17 files changed, 158 insertions(+), 204 deletions(-) create mode 100644 konova/views/share.py diff --git a/compensation/models/eco_account.py b/compensation/models/eco_account.py index 42a202f7..dc9e336f 100644 --- a/compensation/models/eco_account.py +++ b/compensation/models/eco_account.py @@ -160,7 +160,7 @@ 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 diff --git a/compensation/templates/compensation/detail/eco_account/includes/controls.html b/compensation/templates/compensation/detail/eco_account/includes/controls.html index 42ce6067..c26883aa 100644 --- a/compensation/templates/compensation/detail/eco_account/includes/controls.html +++ b/compensation/templates/compensation/detail/eco_account/includes/controls.html @@ -15,7 +15,7 @@ - {% if is_ets_member %} diff --git a/compensation/urls/eco_account.py b/compensation/urls/eco_account.py index af430a93..beaae8d9 100644 --- a/compensation/urls/eco_account.py +++ b/compensation/urls/eco_account.py @@ -20,7 +20,7 @@ from compensation.views.eco_account.action import NewEcoAccountActionView, EditE RemoveEcoAccountActionView from compensation.views.eco_account.deadline import NewEcoAccountDeadlineView, EditEcoAccountDeadlineView, \ RemoveEcoAccountDeadlineView -from compensation.views.eco_account.share import share_view, create_share_view +from compensation.views.eco_account.share import EcoAccountShareByTokenView, EcoAccountShareFormView from compensation.views.eco_account.document import GetEcoAccountDocumentView, NewEcoAccountDocumentView, \ EditEcoAccountDocumentView, RemoveEcoAccountDocumentView from compensation.views.eco_account.deduction import NewEcoAccountDeductionView, EditEcoAccountDeductionView, \ @@ -51,8 +51,8 @@ urlpatterns = [ path('/deadline//edit', EditEcoAccountDeadlineView.as_view(), name='deadline-edit'), path('/deadline//remove', RemoveEcoAccountDeadlineView.as_view(), name='deadline-remove'), - path('/share/', share_view, name='share'), - path('/share', create_share_view, name='share-create'), + path('/share/', EcoAccountShareByTokenView.as_view(), name='share-token'), + path('/share', EcoAccountShareFormView.as_view(), name='share-form'), # Documents path('/document/new/', NewEcoAccountDocumentView.as_view(), name='new-doc'), diff --git a/compensation/views/eco_account/share.py b/compensation/views/eco_account/share.py index 7b1916e4..c2f2e53f 100644 --- a/compensation/views/eco_account/share.py +++ b/compensation/views/eco_account/share.py @@ -5,74 +5,28 @@ Contact: ksp-servicestelle@sgdnord.rlp.de Created on: 19.08.22 """ -from django.contrib import messages from django.contrib.auth.decorators import login_required -from django.http import HttpRequest -from django.shortcuts import get_object_or_404, redirect -from django.utils.translation import gettext_lazy as _ +from django.utils.decorators import method_decorator from compensation.models import EcoAccount -from intervention.forms.modals.share import ShareModalForm from konova.decorators import shared_access_required, default_group_required +from konova.views.share import AbstractShareByTokenView, AbstractShareFormView -@login_required -def share_view(request: HttpRequest, id: str, token: str): - """ Performs sharing of an eco account +class EcoAccountShareByTokenView(AbstractShareByTokenView): + model = EcoAccount + redirect_url = "compensation:acc:detail" - If token given in url is not valid, the user will be redirected to the dashboard - - Args: - request (HttpRequest): The incoming request - id (str): EcoAccount's id - token (str): Access token for EcoAccount - - Returns: - - """ - user = request.user - obj = get_object_or_404(EcoAccount, id=id) - # Check tokens - if obj.access_token == token: - # Send different messages in case user has already been added to list of sharing users - if obj.is_shared_with(user): - messages.info( - request, - _("{} has already been shared with you").format(obj.identifier) - ) - else: - messages.success( - request, - _("{} has been shared with you").format(obj.identifier) - ) - obj.share_with_user(user) - return redirect("compensation:acc:detail", id=id) - else: - messages.error( - request, - _("Share link invalid"), - extra_tags="danger", - ) - return redirect("home") + @method_decorator(login_required) + def dispatch(self, request, *args, **kwargs): + return super().dispatch(request, *args, **kwargs) -@login_required -@default_group_required -@shared_access_required(EcoAccount, "id") -def create_share_view(request: HttpRequest, id: str): - """ Renders sharing form for an eco account - - Args: - request (HttpRequest): The incoming request - id (str): EcoAccount's id - - Returns: - - """ - obj = get_object_or_404(EcoAccount, id=id) - form = ShareModalForm(request.POST or None, instance=obj, request=request) - return form.process_request( - request, - msg_success=_("Share settings updated") - ) +class EcoAccountShareFormView(AbstractShareFormView): + model = EcoAccount + @method_decorator(login_required) + @method_decorator(default_group_required) + @method_decorator(shared_access_required(EcoAccount, "id")) + def dispatch(self, request, *args, **kwargs): + return super().dispatch(request, *args, **kwargs) diff --git a/ema/models/ema.py b/ema/models/ema.py index abec7c43..a7172da8 100644 --- a/ema/models/ema.py +++ b/ema/models/ema.py @@ -103,7 +103,7 @@ class Ema(AbstractCompensation, ShareableObjectMixin, RecordableObjectMixin, Pik Returns: """ - return reverse("ema:share", args=(self.id, self.access_token)) + return reverse("ema:share-token", args=(self.id, self.access_token)) class EmaDocument(AbstractDocument): diff --git a/ema/templates/ema/detail/includes/controls.html b/ema/templates/ema/detail/includes/controls.html index a16071bf..182be481 100644 --- a/ema/templates/ema/detail/includes/controls.html +++ b/ema/templates/ema/detail/includes/controls.html @@ -15,7 +15,7 @@ - {% if is_ets_member %} diff --git a/ema/tests/test_views.py b/ema/tests/test_views.py index b0cba9a3..627753ac 100644 --- a/ema/tests/test_views.py +++ b/ema/tests/test_views.py @@ -49,8 +49,8 @@ class EmaViewTestCase(CompensationViewTestCase): self.log_url = reverse("ema:log", args=(self.ema.id,)) self.edit_url = reverse("ema:edit", args=(self.ema.id,)) self.remove_url = reverse("ema:remove", args=(self.ema.id,)) - self.share_url = reverse("ema:share", args=(self.ema.id, self.ema.access_token,)) - self.share_create_url = reverse("ema:share-create", args=(self.ema.id,)) + self.share_url = reverse("ema:share-token", args=(self.ema.id, self.ema.access_token,)) + self.share_create_url = reverse("ema:share-form", args=(self.ema.id,)) self.record_url = reverse("ema:record", args=(self.ema.id,)) self.report_url = reverse("ema:report", args=(self.ema.id,)) self.new_doc_url = reverse("ema:new-doc", args=(self.ema.id,)) diff --git a/ema/urls.py b/ema/urls.py index a9c6dc41..bff7c41d 100644 --- a/ema/urls.py +++ b/ema/urls.py @@ -15,7 +15,7 @@ from ema.views.log import EmaLogView from ema.views.record import EmaRecordView from ema.views.report import report_view from ema.views.resubmission import EmaResubmissionView -from ema.views.share import share_view, create_share_view +from ema.views.share import EmaShareFormView, EmaShareByTokenView from ema.views.state import NewEmaStateView, EditEmaStateView, RemoveEmaStateView app_name = "ema" @@ -43,8 +43,8 @@ urlpatterns = [ path('/deadline//edit', EditEmaDeadlineView.as_view(), name='deadline-edit'), path('/deadline//remove', RemoveEmaDeadlineView.as_view(), name='deadline-remove'), - path('/share/', share_view, name='share'), - path('/share', create_share_view, name='share-create'), + path('/share/', EmaShareByTokenView.as_view(), name='share-token'), + path('/share', EmaShareFormView.as_view(), name='share-form'), # Documents path('/document/new/', NewEmaDocumentView.as_view(), name='new-doc'), diff --git a/ema/views/share.py b/ema/views/share.py index 83aae91d..536fe31e 100644 --- a/ema/views/share.py +++ b/ema/views/share.py @@ -5,73 +5,28 @@ Contact: ksp-servicestelle@sgdnord.rlp.de Created on: 19.08.22 """ -from django.contrib import messages from django.contrib.auth.decorators import login_required -from django.http import HttpRequest -from django.shortcuts import get_object_or_404, redirect -from django.utils.translation import gettext_lazy as _ +from django.utils.decorators import method_decorator from ema.models import Ema -from intervention.forms.modals.share import ShareModalForm from konova.decorators import conservation_office_group_required, shared_access_required +from konova.views.share import AbstractShareByTokenView, AbstractShareFormView -@login_required -def share_view(request: HttpRequest, id: str, token: str): - """ Performs sharing of an ema +class EmaShareByTokenView(AbstractShareByTokenView): + model = Ema + redirect_url = "ema:detail" - If token given in url is not valid, the user will be redirected to the dashboard - - Args: - request (HttpRequest): The incoming request - id (str): EMA's id - token (str): Access token for EMA - - Returns: - - """ - user = request.user - obj = get_object_or_404(Ema, id=id) - # Check tokens - if obj.access_token == token: - # Send different messages in case user has already been added to list of sharing users - if obj.is_shared_with(user): - messages.info( - request, - _("{} has already been shared with you").format(obj.identifier) - ) - else: - messages.success( - request, - _("{} has been shared with you").format(obj.identifier) - ) - obj.share_with_user(user) - return redirect("ema:detail", id=id) - else: - messages.error( - request, - _("Share link invalid"), - extra_tags="danger", - ) - return redirect("home") + @method_decorator(login_required) + def dispatch(self, request, *args, **kwargs): + return super().dispatch(request, *args, **kwargs) -@login_required -@conservation_office_group_required -@shared_access_required(Ema, "id") -def create_share_view(request: HttpRequest, id: str): - """ Renders sharing form for an Ema +class EmaShareFormView(AbstractShareFormView): + model = Ema - Args: - request (HttpRequest): The incoming request - id (str): Ema's id - - Returns: - - """ - obj = get_object_or_404(Ema, id=id) - form = ShareModalForm(request.POST or None, instance=obj, request=request) - return form.process_request( - request, - msg_success=_("Share settings updated") - ) + @method_decorator(login_required) + @method_decorator(conservation_office_group_required) + @method_decorator(shared_access_required(Ema, "id")) + def dispatch(self, request, *args, **kwargs): + return super().dispatch(request, *args, **kwargs) diff --git a/intervention/models/intervention.py b/intervention/models/intervention.py index ea561c5b..91c0ddb6 100644 --- a/intervention/models/intervention.py +++ b/intervention/models/intervention.py @@ -337,7 +337,7 @@ class Intervention(BaseObject, Returns: """ - return reverse("intervention:share", args=(self.id, self.access_token)) + return reverse("intervention:share-token", args=(self.id, self.access_token)) def remove_payment(self, form): """ Removes a Payment from the intervention diff --git a/intervention/templates/intervention/detail/includes/controls.html b/intervention/templates/intervention/detail/includes/controls.html index 7af2165b..7008c101 100644 --- a/intervention/templates/intervention/detail/includes/controls.html +++ b/intervention/templates/intervention/detail/includes/controls.html @@ -15,7 +15,7 @@ - {% if is_zb_member %} diff --git a/intervention/tests/test_views.py b/intervention/tests/test_views.py index a049f3e7..e552dbe6 100644 --- a/intervention/tests/test_views.py +++ b/intervention/tests/test_views.py @@ -31,8 +31,8 @@ class InterventionViewTestCase(BaseViewTestCase): self.log_url = reverse("intervention:log", args=(self.intervention.id,)) self.edit_url = reverse("intervention:edit", args=(self.intervention.id,)) self.remove_url = reverse("intervention:remove", args=(self.intervention.id,)) - self.share_url = reverse("intervention:share", args=(self.intervention.id, self.intervention.access_token,)) - self.share_create_url = reverse("intervention:share-create", args=(self.intervention.id,)) + self.share_url = reverse("intervention:share-token", args=(self.intervention.id, self.intervention.access_token,)) + self.share_create_url = reverse("intervention:share-form", args=(self.intervention.id,)) self.run_check_url = reverse("intervention:check", args=(self.intervention.id,)) self.record_url = reverse("intervention:record", args=(self.intervention.id,)) self.report_url = reverse("intervention:report", args=(self.intervention.id,)) diff --git a/intervention/urls.py b/intervention/urls.py index 69c5e767..8a148197 100644 --- a/intervention/urls.py +++ b/intervention/urls.py @@ -21,7 +21,7 @@ from intervention.views.report import report_view from intervention.views.resubmission import InterventionResubmissionView from intervention.views.revocation import new_revocation_view, edit_revocation_view, remove_revocation_view, \ get_revocation_view -from intervention.views.share import share_view, create_share_view +from intervention.views.share import InterventionShareFormView, InterventionShareByTokenView app_name = "intervention" urlpatterns = [ @@ -32,8 +32,8 @@ urlpatterns = [ path('/log', InterventionLogView.as_view(), name='log'), path('/edit', edit_view, name='edit'), path('/remove', remove_view, name='remove'), - path('/share/', share_view, name='share'), - path('/share', create_share_view, name='share-create'), + path('/share/', InterventionShareByTokenView.as_view(), name='share-token'), + path('/share', InterventionShareFormView.as_view(), name='share-form'), path('/check', check_view, name='check'), path('/record', InterventionRecordView.as_view(), name='record'), path('/report', report_view, name='report'), diff --git a/intervention/views/share.py b/intervention/views/share.py index ba9cdd3a..f78d65b2 100644 --- a/intervention/views/share.py +++ b/intervention/views/share.py @@ -5,74 +5,28 @@ Contact: ksp-servicestelle@sgdnord.rlp.de Created on: 19.08.22 """ -from django.contrib import messages from django.contrib.auth.decorators import login_required -from django.http import HttpRequest -from django.shortcuts import get_object_or_404, redirect -from django.utils.translation import gettext_lazy as _ +from django.utils.decorators import method_decorator -from intervention.forms.modals.share import ShareModalForm from intervention.models import Intervention from konova.decorators import default_group_required, shared_access_required +from konova.views.share import AbstractShareByTokenView, AbstractShareFormView -@login_required -def share_view(request: HttpRequest, id: str, token: str): - """ Performs sharing of an intervention +class InterventionShareByTokenView(AbstractShareByTokenView): + model = Intervention + redirect_url = "intervention:detail" - If token given in url is not valid, the user will be redirected to the dashboard - - Args: - request (HttpRequest): The incoming request - id (str): Intervention's id - token (str): Access token for intervention - - Returns: - - """ - user = request.user - intervention = get_object_or_404(Intervention, id=id) - # Check tokens - if intervention.access_token == token: - # Send different messages in case user has already been added to list of sharing users - if intervention.is_shared_with(user): - messages.info( - request, - _("{} has already been shared with you").format(intervention.identifier) - ) - else: - messages.success( - request, - _("{} has been shared with you").format(intervention.identifier) - ) - intervention.share_with_user(user) - return redirect("intervention:detail", id=id) - else: - messages.error( - request, - _("Share link invalid"), - extra_tags="danger", - ) - return redirect("home") + @method_decorator(login_required) + def dispatch(self, request, *args, **kwargs): + return super().dispatch(request, *args, **kwargs) -@login_required -@default_group_required -@shared_access_required(Intervention, "id") -def create_share_view(request: HttpRequest, id: str): - """ Renders sharing form for an intervention - - Args: - request (HttpRequest): The incoming request - id (str): Intervention's id - - Returns: - - """ - intervention = get_object_or_404(Intervention, id=id) - form = ShareModalForm(request.POST or None, instance=intervention, request=request) - return form.process_request( - request, - msg_success=_("Share settings updated") - ) +class InterventionShareFormView(AbstractShareFormView): + model = Intervention + @method_decorator(login_required) + @method_decorator(default_group_required) + @method_decorator(shared_access_required(Intervention, "id")) + def dispatch(self, request, *args, **kwargs): + return super().dispatch(request, *args, **kwargs) diff --git a/konova/utils/message_templates.py b/konova/utils/message_templates.py index e144a97f..6ddbba99 100644 --- a/konova/utils/message_templates.py +++ b/konova/utils/message_templates.py @@ -22,6 +22,7 @@ RECORDED_BLOCKS_EDIT = _("Entry is recorded. To edit data, the entry first needs # SHARE DATA_UNSHARED = _("This data is not shared with you") DATA_UNSHARED_EXPLANATION = _("Remember: This data has not been shared with you, yet. This means you can only read but can not edit or perform any actions like running a check or recording.") +DATA_SHARE_SET = _("Share settings updated") # FILES FILE_TYPE_UNSUPPORTED = _("Unsupported file type") diff --git a/konova/views/share.py b/konova/views/share.py new file mode 100644 index 00000000..abcbecaa --- /dev/null +++ b/konova/views/share.py @@ -0,0 +1,88 @@ +""" +Author: Michel Peltriaux +Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany +Contact: ksp-servicestelle@sgdnord.rlp.de +Created on: 22.08.22 + +""" +from django.contrib import messages +from django.shortcuts import get_object_or_404, redirect +from django.views import View +from django.utils.translation import gettext_lazy as _ + +from intervention.forms.modals.share import ShareModalForm +from konova.utils.message_templates import DATA_SHARE_SET + + +class AbstractShareByTokenView(View): + model = None + redirect_url = None + + class Meta: + abstract = True + + def get(self, request, id: str, token: str): + + """ Performs sharing of an intervention + + If token given in url is not valid, the user will be redirected to the dashboard + + Args: + request (HttpRequest): The incoming request + id (str): Object's id + token (str): Access token for object + + Returns: + + """ + user = request.user + obj = get_object_or_404(self.model, id=id) + # Check tokens + if obj.access_token == token: + # Send different messages in case user has already been added to list of sharing users + if obj.is_shared_with(user): + messages.info( + request, + _("{} has already been shared with you").format(obj.identifier) + ) + else: + messages.success( + request, + _("{} has been shared with you").format(obj.identifier) + ) + obj.share_with_user(user) + return redirect(self.redirect_url, id=id) + else: + messages.error( + request, + _("Share link invalid"), + extra_tags="danger", + ) + return redirect("home") + + +class AbstractShareFormView(View): + model = None + + class Meta: + abstract = True + + def get(self, request, id: str): + """ Renders sharing form + + Args: + request (HttpRequest): The incoming request + id (str): Object's id + + Returns: + + """ + obj = get_object_or_404(self.model, id=id) + form = ShareModalForm(request.POST or None, instance=obj, request=request) + return form.process_request( + request, + msg_success=DATA_SHARE_SET + ) + + def post(self, request, id: str): + return self.get(request, id) diff --git a/user/autocomplete/share.py b/user/autocomplete/share.py index de634111..9331873d 100644 --- a/user/autocomplete/share.py +++ b/user/autocomplete/share.py @@ -42,9 +42,11 @@ class ShareTeamAutocomplete(Select2QuerySetView): ) if self.q: # Due to privacy concerns only a full username match will return the proper user entry - qs = qs.filter( - name__icontains=self.q - ) + q_parts = self.q.split(" ") + q = Q() + for part in q_parts: + q &= Q(name__icontains=part) + qs = qs.filter(q) qs = qs.order_by( "name" ) -- 2.45.2