konova/intervention/views/intervention.py

"""
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.contrib.auth.mixins import LoginRequiredMixin
from django.http import 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, login_required_modal
from konova.forms import SimpleGeomForm
from konova.forms.modals import RemoveModalForm
from konova.sub_settings.context_settings import TAB_TITLE_IDENTIFIER
from konova.utils.message_templates import DATA_CHECKED_PREVIOUSLY_TEMPLATE, RECORDED_BLOCKS_EDIT, \
    CHECK_STATE_RESET, FORM_INVALID, GEOMETRY_SIMPLIFIED, GEOMETRIES_IGNORED_TEMPLATE
from konova.views.base import BaseIndexView, BaseIdentifierGeneratorView, BaseNewSpatialLocatedObjectFormView, \
    BaseEditSpatialLocatedObjectFormView
from konova.views.detail import BaseDetailView


class InterventionIndexView(LoginRequiredMixin, BaseIndexView):
    _INDEX_TABLE_CLS = InterventionTable
    _TAB_TITLE = _("Interventions - Overview")

    def _get_queryset(self):
        qs = Intervention.objects.filter(
            deleted=None,
        ).select_related(
            "legal"
        ).order_by(
            "-modified__timestamp"
        )
        return qs


class NewInterventionFormView(BaseNewSpatialLocatedObjectFormView):
    _MODEL_CLS = Intervention
    _FORM_CLS = NewInterventionForm
    _TEMPLATE = "intervention/form/view.html"
    _REDIRECT_URL = "intervention:detail"
    _TAB_TITLE = _("New intervention")


class EditInterventionFormView(BaseEditSpatialLocatedObjectFormView):
    _MODEL_CLS = Intervention
    _FORM_CLS = EditInterventionForm
    _TEMPLATE = "intervention/form/view.html"
    _REDIRECT_URL = "intervention:detail"
    _TAB_TITLE = _("Edit {}")

    def _user_has_shared_access(self, user, **kwargs):
        obj = get_object_or_404(self._REDIRECT_URL, id=kwargs.get('id', None))
        return obj.is_shared_with(user)

    def _user_has_permission(self, user):
        return user.is_default_user()


class InterventionIdentifierGeneratorView(LoginRequiredMixin, BaseIdentifierGeneratorView):
    _MODEL_CLS = Intervention
    _REDIRECT_URL = "intervention:index"


class InterventionDetailView(BaseDetailView):
    _MODEL_CLS = Intervention
    _TEMPLATE = "intervention/detail/view.html"

    def _get_object(self, id: str):
        """ Returns the intervention

        Args:
            id (str): The intervention's id

        Returns:
            obj (Intervention): The intervention
        """
        # Fetch data, filter out deleted related data
        obj = get_object_or_404(
            self._MODEL_CLS.objects.select_related(
                "geometry",
                "legal",
                "responsible",
            ).prefetch_related(
                "legal__revocations",
            ),
            id=id,
            deleted=None
        )
        return obj

    def _get_detail_context(self, obj: Intervention):
        """ Generate object specific detail context for  view

        Args:
            obj (): The record

        Returns:

        """
        compensations = obj.compensations.filter(deleted=None)
        last_checked = obj.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
            )

        has_payment_without_document = obj.payments.exists() and not obj.get_documents()[1].exists()
        context = {
            "last_checked": last_checked,
            "last_checked_tooltip": last_checked_tooltip,
            "compensations": compensations,
            "has_payment_without_document": has_payment_without_document,
        }
        return 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
            intervention_is_checked = intervention.checked is not None
            intervention = data_form.save(request.user, geom_form)
            messages.success(request, _("Intervention {} edited").format(intervention.identifier))
            if intervention_is_checked:
                messages.info(request, CHECK_STATE_RESET)
            if geom_form.has_geometry_simplified():
                messages.info(
                    request,
                    GEOMETRY_SIMPLIFIED
                )

            num_ignored_geometries = geom_form.get_num_geometries_ignored()
            if num_ignored_geometries > 0:
                messages.info(
                    request,
                    GEOMETRIES_IGNORED_TEMPLATE.format(num_ignored_geometries)
                )

            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_modal
@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")
    )