From ed82109af98deceb5917113a217dae264f2c1e04 Mon Sep 17 00:00:00 2001 From: mpeltriaux Date: Mon, 22 Aug 2022 07:52:22 +0200 Subject: [PATCH] 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) +