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

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

compensation/templates/compensation/detail/eco_account/includes/controls.html

@@ -15,7 +15,7 @@
         <button class="btn btn-default btn-modal mr-2" title="{% trans 'Resubmission' %}" data-form-url="{% url 'compensation:acc:resubmission-create' obj.id %}">
             {% fa5_icon 'bell' %}
         </button>
-        <button class="btn btn-default btn-modal mr-2" title="{% trans 'Share' %}" data-form-url="{% url 'compensation:acc:share-create' obj.id %}">
+        <button class="btn btn-default btn-modal mr-2" title="{% trans 'Share' %}" data-form-url="{% url 'compensation:acc:share-form' obj.id %}">
             {% fa5_icon 'share-alt' %}
         </button>
         {% if is_ets_member %}

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('<id>/deadline/<deadline_id>/edit', EditEcoAccountDeadlineView.as_view(), name='deadline-edit'),
     path('<id>/deadline/<deadline_id>/remove', RemoveEcoAccountDeadlineView.as_view(), name='deadline-remove'),
 
-    path('<id>/share/<token>', share_view, name='share'),
+    path('<id>/share/<token>', EcoAccountShareByTokenView.as_view(), name='share-token'),
-    path('<id>/share', create_share_view, name='share-create'),
+    path('<id>/share', EcoAccountShareFormView.as_view(), name='share-form'),
 
     # Documents
     path('<id>/document/new/', NewEcoAccountDocumentView.as_view(), name='new-doc'),

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.utils.decorators import method_decorator
-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
+from konova.views.share import AbstractShareByTokenView, AbstractShareFormView
 
 
-@login_required
+class EcoAccountShareByTokenView(AbstractShareByTokenView):
-def share_view(request: HttpRequest, id: str, token: str):
+    model = EcoAccount
-    """ Performs sharing of an eco account
+    redirect_url = "compensation:acc:detail"
 
-    If token given in url is not valid, the user will be redirected to the dashboard
+    @method_decorator(login_required)
-
+    def dispatch(self, request, *args, **kwargs):
-    Args:
+        return super().dispatch(request, *args, **kwargs)
-        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
+class EcoAccountShareFormView(AbstractShareFormView):
-@default_group_required
+    model = EcoAccount
-@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")
-    )
 
+    @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)

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):

ema/templates/ema/detail/includes/controls.html

@@ -15,7 +15,7 @@
         <button class="btn btn-default btn-modal mr-2" title="{% trans 'Resubmission' %}" data-form-url="{% url 'ema:resubmission-create' obj.id %}">
             {% fa5_icon 'bell' %}
         </button>
-        <button class="btn btn-default btn-modal mr-2" title="{% trans 'Share' %}" data-form-url="{% url 'ema:share-create' obj.id %}">
+        <button class="btn btn-default btn-modal mr-2" title="{% trans 'Share' %}" data-form-url="{% url 'ema:share-form' obj.id %}">
             {% fa5_icon 'share-alt' %}
         </button>
         {% if is_ets_member %}

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_url = reverse("ema:share-token", args=(self.ema.id, self.ema.access_token,))
-        self.share_create_url = reverse("ema:share-create", args=(self.ema.id,))
+        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,))

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('<id>/deadline/<deadline_id>/edit', EditEmaDeadlineView.as_view(), name='deadline-edit'),
     path('<id>/deadline/<deadline_id>/remove', RemoveEmaDeadlineView.as_view(), name='deadline-remove'),
 
-    path('<id>/share/<token>', share_view, name='share'),
+    path('<id>/share/<token>', EmaShareByTokenView.as_view(), name='share-token'),
-    path('<id>/share', create_share_view, name='share-create'),
+    path('<id>/share', EmaShareFormView.as_view(), name='share-form'),
 
     # Documents
     path('<id>/document/new/', NewEmaDocumentView.as_view(), name='new-doc'),

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.utils.decorators import method_decorator
-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
+from konova.views.share import AbstractShareByTokenView, AbstractShareFormView
 
 
-@login_required
+class EmaShareByTokenView(AbstractShareByTokenView):
-def share_view(request: HttpRequest, id: str, token: str):
+    model = Ema
-    """ Performs sharing of an ema
+    redirect_url = "ema:detail"
 
-    If token given in url is not valid, the user will be redirected to the dashboard
+    @method_decorator(login_required)
-
+    def dispatch(self, request, *args, **kwargs):
-    Args:
+        return super().dispatch(request, *args, **kwargs)
-        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
+class EmaShareFormView(AbstractShareFormView):
-@conservation_office_group_required
+    model = Ema
-@shared_access_required(Ema, "id")
-def create_share_view(request: HttpRequest, id: str):
-    """ Renders sharing form for an Ema
 
-    Args:
+    @method_decorator(login_required)
-        request (HttpRequest): The incoming request
+    @method_decorator(conservation_office_group_required)
-        id (str): Ema's id
+    @method_decorator(shared_access_required(Ema, "id"))
-
+    def dispatch(self, request, *args, **kwargs):
-    Returns:
+        return super().dispatch(request, *args, **kwargs)
-
-    """
-    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")
-    )

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

intervention/templates/intervention/detail/includes/controls.html

@@ -15,7 +15,7 @@
         <button class="btn btn-default btn-modal mr-2" title="{% trans 'Resubmission' %}" data-form-url="{% url 'intervention:resubmission-create' obj.id %}">
             {% fa5_icon 'bell' %}
         </button>
-        <button class="btn btn-default btn-modal mr-2" title="{% trans 'Share' %}" data-form-url="{% url 'intervention:share-create' obj.id %}">
+        <button class="btn btn-default btn-modal mr-2" title="{% trans 'Share' %}" data-form-url="{% url 'intervention:share-form' obj.id %}">
             {% fa5_icon 'share-alt' %}
         </button>
         {% if is_zb_member %}

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_url = reverse("intervention:share-token", args=(self.intervention.id, self.intervention.access_token,))
-        self.share_create_url = reverse("intervention:share-create", args=(self.intervention.id,))
+        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,))

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('<id>/log', InterventionLogView.as_view(), name='log'),
     path('<id>/edit', edit_view, name='edit'),
     path('<id>/remove', remove_view, name='remove'),
-    path('<id>/share/<token>', share_view, name='share'),
+    path('<id>/share/<token>', InterventionShareByTokenView.as_view(), name='share-token'),
-    path('<id>/share', create_share_view, name='share-create'),
+    path('<id>/share', InterventionShareFormView.as_view(), name='share-form'),
     path('<id>/check', check_view, name='check'),
     path('<id>/record', InterventionRecordView.as_view(), name='record'),
     path('<id>/report', report_view, name='report'),

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.utils.decorators import method_decorator
-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
+from konova.views.share import AbstractShareByTokenView, AbstractShareFormView
 
 
-@login_required
+class InterventionShareByTokenView(AbstractShareByTokenView):
-def share_view(request: HttpRequest, id: str, token: str):
+    model = Intervention
-    """ Performs sharing of an intervention
+    redirect_url = "intervention:detail"
 
-    If token given in url is not valid, the user will be redirected to the dashboard
+    @method_decorator(login_required)
-
+    def dispatch(self, request, *args, **kwargs):
-    Args:
+        return super().dispatch(request, *args, **kwargs)
-        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
+class InterventionShareFormView(AbstractShareFormView):
-@default_group_required
+    model = Intervention
-@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")
-    )
 
+    @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)

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

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)

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(
+            q_parts = self.q.split(" ")
-                name__icontains=self.q
+            q = Q()
-            )
+            for part in q_parts:
+                q &= Q(name__icontains=part)
+            qs = qs.filter(q)
         qs = qs.order_by(
             "name"
         )