wbcore 1.59.9__py2.py3-none-any.whl

wbcore/contrib/documents/serializers/shareable_links.py

@@ -0,0 +1,91 @@
+from django.utils.translation import gettext_lazy as _
+from rest_framework.reverse import reverse
+
+from wbcore import serializers
+from wbcore.contrib.documents.models import Document, ShareableLink, ShareableLinkAccess
+from wbcore.contrib.documents.serializers import DocumentRepresentationSerializer
+from wbcore.utils.strings import snake_case_to_human
+
+
+class ShareableLinkModelSerializer(serializers.ModelSerializer):
+    document = serializers.PrimaryKeyRelatedField(
+        queryset=Document.objects.all(), label="Document", default=serializers.DefaultFromGET("document")
+    )
+    _document = DocumentRepresentationSerializer(source="document")
+    valid = serializers.BooleanField(label=_("Valid"), default=True, read_only=True)
+
+    @serializers.register_resource()
+    def hits(self, instance, request, user):
+        base_url = reverse("wbcore:documents:linkaccess-list", request=request)
+        return {"hits": f"{base_url}?shareable_link={instance.id}"}
+
+    @serializers.register_resource()
+    def manually_invalidate(self, instance, request, user):
+        if "view" in request.parser_context and hasattr(instance, "is_valid") and instance.is_valid():
+            return {
+                "manually_invalidate": reverse(
+                    "wbcore:documents:link-invalidate",
+                    args=[instance.id],
+                    request=request,
+                )
+            }
+        return {}
+
+    class Meta:
+        model = ShareableLink
+        fields = (
+            "id",
+            "link",
+            "document",
+            "_document",
+            "valid_until",
+            "one_time_link",
+            "manual_invalid",
+            "uuid",
+            "_additional_resources",
+            "valid",
+        )
+
+
+class ShareableLinkRepresentationSerializer(serializers.RepresentationSerializer):
+    endpoint = "wbcore:documents:linkrepresentation-list"
+    _detail = serializers.HyperlinkField(reverse_name="wbcore:documents:link-detail")
+    _detail_preview = serializers.HyperlinkField(reverse_name="wbcore:documents:link-detail")
+
+    class Meta:
+        model = ShareableLink
+        fields = ("id", "uuid", "_detail", "_detail_preview")
+
+
+class ShareableLinkAccessModelSerializer(serializers.ModelSerializer):
+    _shareable_link = ShareableLinkRepresentationSerializer(source="shareable_link")
+
+    metadata_repr = serializers.SerializerMethodField(read_only=True)
+
+    def get_metadata_repr(self, obj):
+        return f"""
+        <ul>
+        {"".join([f"<li>{snake_case_to_human(key)}: {value}</li>" for key, value in obj.metadata.items()])}
+        </ul>
+        """
+
+    class Meta:
+        model = ShareableLinkAccess
+        fields = (
+            "id",
+            "shareable_link",
+            "_shareable_link",
+            "metadata",
+            "metadata_repr",
+            "accessed",
+        )
+
+
+class ShareableLinkAccessRepresentationSerializer(serializers.RepresentationSerializer):
+    endpoint = "wbcore:documents:linkaccessrepresentation-list"
+    _detail = serializers.HyperlinkField(reverse_name="wbcore:documents:linkaccess-detail")
+    _detail_preview = serializers.HyperlinkField(reverse_name="wbcore:documents:linkaccess-detail")
+
+    class Meta:
+        model = ShareableLinkAccess
+        fields = ("id", "metadata", "_detail", "_detail_preview")

wbcore/contrib/documents/static/documents/markdown/documentation/document_types.md

@@ -0,0 +1,21 @@
+# Document Types:
+A list of document types used to categorize documents. Types are saved as a tree with the possibility of adding parent types to each node.
+
+
+## Columns:
+Each column title has three lines on the right if you hover over it. Click on them to show options for that column. The second tab of the options menu will allow you to filter the column, the third to completely hide entire columns. Click on anywhere else on the column to order it, cycling between ascending, descending and no ordering. Hold shift while clicking to order multiple columns with individual weights.
+
+### Name:
+The name of the document type.
+### Parent:
+The document type's parent type.
+
+## Buttons:
+### All Children:
+Displays a list of all child types of this document type.
+
+### All Documents:
+Displays a list with all documents of this type.
+
+## Search Field:
+Typing in the search field allows to filter the document types by name.

wbcore/contrib/documents/static/documents/markdown/documentation/documents.md

@@ -0,0 +1,18 @@
+# Documents:
+A list of documents uploaded to the workbench.
+
+
+## Columns:
+Each column title has three lines on the right if you hover over it. Click on them to show options for that column. The second tab of the options menu will allow you to filter the column, the third to completely hide entire columns. Click on anywhere else on the column to order it, cycling between ascending, descending and no ordering. Hold shift while clicking to order multiple columns with individual weights.
+
+### Name:
+The name of the document.
+### Type:
+The document's type. Types can be added and edited under DMS > Document Types.
+
+## Buttons:
+### Download:
+Download this document on your computer.
+
+## Search Field:
+Typing in the search field allows to filter the documents by name.

wbcore/contrib/documents/static/documents/markdown/documentation/shareablelink.md

@@ -0,0 +1,28 @@
+# Shareable Links:
+A list of links to share the selected document.
+
+
+## Columns:
+Each column title has three lines on the right if you hover over it. Click on them to show options for that column. The second tab of the options menu will allow you to filter the column, the third to completely hide entire columns. Click on anywhere else on the column to order it, cycling between ascending, descending and no ordering. Hold shift while clicking to order multiple columns with individual weights.
+### Valid Until:
+Date and time at which the link loses its validity.
+### One Time Link:
+Specifies if the link can be accessed only one time or and infinite amount.
+### Link:
+The URL under which the document can be accessed.
+
+## Buttons:
+### Invalidate:
+Invalidate the selected link manually even if the validation date lies in the future.
+
+## Legend:
+Click on the legend to filter by link validity.
+
+## Filters:
+### Valid:
+Filter by link validity.
+### Document:
+Display links for a specific document. Will default to the current document displayed.
+
+## Search Field:
+Typing in the search field allows to filter by link uuid.

wbcore/contrib/documents/static/documents/markdown/documentation/shareablelinkaccess.md

@@ -0,0 +1,20 @@
+# Hits:
+A list of IP addresses that accessed the selected link.
+
+
+## Columns:
+Each column title has three lines on the right if you hover over it. Click on them to show options for that column. The second tab of the options menu will allow you to filter the column, the third to completely hide entire columns. Click on anywhere else on the column to order it, cycling between ascending, descending and no ordering. Hold shift while clicking to order multiple columns with individual weights.
+
+### Accessed:
+Date and time at which the link was accessed.
+### IP Address:
+The IP address that accessed the link.
+### Meta Data:
+The meta data that was provided when the link was accessed. Comprised of things like operating system and browser name.
+
+## Filters:
+### Shareable Link:
+Display hits for a specific link. Will default to the current link displayed.
+
+## Search Field:
+Typing in the search field allows to filter by IP address.

wbcore/contrib/documents/tests/conftest.py

@@ -0,0 +1,30 @@
+import pytest
+from django.apps import apps
+from django.db import connection
+from django.db.models.signals import pre_migrate
+from pytest_factoryboy import register
+from wbcore.contrib.documents.factories import (
+    DocumentFactory,
+    DocumentTypeFactory,
+    ShareableLinkAccessFactory,
+    ShareableLinkFactory,
+)
+from wbcore.contrib.geography.tests.signals import app_pre_migration
+from wbcore.tests.conftest import *
+
+register(DocumentFactory)
+register(DocumentTypeFactory)
+register(ShareableLinkAccessFactory)
+register(ShareableLinkFactory)
+
+
+@pytest.fixture(
+    autouse=True, scope="session"
+)  # Might want to find a way to registered default conftest logic automatically
+def django_test_environment(django_test_environment):
+    from django.apps import apps
+
+    get_models = apps.get_models
+
+    for m in [m for m in get_models() if not m._meta.managed]:
+        m._meta.managed = True

wbcore/contrib/documents/tests/test_models.py

@@ -0,0 +1,148 @@
+import os
+from datetime import timedelta
+from unittest.mock import patch
+
+import pytest
+from django.core import mail
+from django.core.validators import URLValidator
+from django.utils import timezone
+from slugify import slugify
+from wbcore.contrib.documents.models.documents import (
+    Document,
+    send_email_as_task,
+    upload_to,
+)
+
+
+@pytest.mark.django_db
+@pytest.mark.with_db
+class TestDocumentModel:
+    @pytest.fixture
+    def email(self):
+        return "foo@bar.com"
+
+    def test_init(self, document):
+        assert document.id is not None
+
+    def test_upload_to(self, document, document_type_factory):
+        parent_document_type = document_type_factory.create()
+        document_type = document_type_factory.create(parent=parent_document_type)
+        document.document_type = document_type
+        document.save()
+        assert (
+            upload_to(document, "foo")
+            == f"dms/document/{slugify(parent_document_type.name)}/{slugify(document_type.name)}/foo"
+        )
+
+    @pytest.mark.parametrize("document__file", ["/foo/bar"])
+    def test_filename(self, document):
+        assert document.filename == os.path.basename(document.file.name)
+
+    def test_linked_objects(self, document_factory):
+        document = document_factory.create()
+        link_obj = document_factory.create()
+        document.link(link_obj)
+        assert list(document.linked_objects)[0] == link_obj
+
+    @pytest.mark.parametrize(
+        "sharing_seconds_duration, one_time_link",
+        [(0, False), (1, False), (0, True), (1, True)],
+    )
+    def test_generate_shareable_link(self, document, sharing_seconds_duration, one_time_link):
+        document.generate_shareable_link(
+            sharing_seconds_duration=sharing_seconds_duration,
+            one_time_link=one_time_link,
+        )
+        assert (
+            document.shareable_links.filter(
+                valid_until__isnull=sharing_seconds_duration == 0,
+                one_time_link=one_time_link,
+            ).count()
+            == 1
+        )
+
+    @patch("wbcore.contrib.documents.models.documents.send_email_as_task.delay")
+    def test_send_email(self, mock_fct, document, email):
+        document.send_email(email)
+        assert mock_fct.call_count == 1
+
+    def test_get_for_object(self, document_factory):
+        document = document_factory.create()
+        link_obj = document_factory.create()
+        document.link(link_obj)
+        assert Document.get_for_object(link_obj).first() == document
+
+    @pytest.mark.parametrize(
+        "to_emails, as_link, subject, from_email, body",
+        [
+            (email, False, None, None, None),
+            (email, False, "Some paragraph", email, "A different paragraph"),
+            (email, True, None, None, None),
+        ],
+    )
+    def test_send_email_as_task(self, document, to_emails, as_link, subject, from_email, body):
+        assert len(mail.outbox) == 0
+        send_email_as_task(
+            document.id,
+            to_emails,
+            as_link=as_link,
+            subject=subject,
+            from_email=from_email,
+            body=body,
+        )
+        assert len(mail.outbox) == 1
+        msg = mail.outbox[0]
+        if as_link:
+            assert document.shareable_links.count() == 1
+            assert len(msg.attachments) == 0
+            assert len(msg.alternatives) == 1
+        else:
+            assert document.shareable_links.count() == 0
+            assert len(msg.attachments) == 1
+            assert len(msg.alternatives) == 2
+        assert msg
+
+
+@pytest.mark.django_db
+class TestDocumentTypeModel:
+    def test_init(self, document_type):
+        assert document_type.id is not None
+
+    def test_str(self, document_type_factory):
+        document_type = document_type_factory.create(parent=document_type_factory.create())
+        document_type.save()
+        assert str(document_type) == document_type.compute_str()
+
+
+@pytest.mark.django_db
+class TestShareableLinkModel:
+    @pytest.mark.parametrize(
+        "shareable_link__manual_invalid, shareable_link__valid_until, shareable_link__one_time_link",
+        [
+            (True, None, False),
+            (False, timezone.now() - timedelta(seconds=60), False),
+            (False, None, True),
+        ],
+    )
+    def test_unvalid_link(self, shareable_link):
+        if shareable_link.one_time_link:
+            assert shareable_link.is_valid()
+            shareable_link.access()
+        assert not shareable_link.is_valid()
+
+    def test_link(self, shareable_link):
+        URLValidator()(shareable_link.link)
+
+    def test_access(self, shareable_link):
+        assert shareable_link.accesses.count() == 0
+        shareable_link.access()
+        assert shareable_link.accesses.count() == 1
+
+    def test_init(self, shareable_link):
+        assert shareable_link.id is not None
+
+
+@pytest.mark.django_db
+class TestShareableLinkAccessModel:
+    def test_init(self, shareable_link_access):
+        assert shareable_link_access.id is not None

wbcore/contrib/documents/urls.py

@@ -0,0 +1,43 @@
+from django.urls import include, path
+
+from wbcore.routers import WBCoreRouter
+
+from . import viewsets
+
+router = WBCoreRouter()
+
+router.register(r"document", viewsets.DocumentModelViewSet, basename="document")
+router.register(r"documenttype", viewsets.DocumentTypeModelViewSet, basename="documenttype")
+router.register(r"link", viewsets.ShareableLinkModelViewSet, basename="link")
+router.register(r"linkaccess", viewsets.ShareableLinkAccessModelViewSet, basename="linkaccess")
+router.register(
+    r"documentmodelrelationship", viewsets.DocumentModelRelationshipModelViewSet, basename="documentmodelrelationship"
+)
+
+# Representations
+router.register(r"documentrepresentation", viewsets.DocumentRepresentationViewSet, basename="documentrepresentation")
+router.register(
+    r"documenttyperepresentation", viewsets.DocumentTypeRepresentationViewSet, basename="documenttyperepresentation"
+)
+router.register(r"linkrepresentation", viewsets.ShareableLinkRepresentationViewSet, basename="linkrepresentation")
+router.register(
+    r"linkaccessrepresentation", viewsets.ShareableLinkAccessRepresentationViewSet, basename="linkaccessrepresentation"
+)
+
+document_router = WBCoreRouter()
+document_router.register(
+    r"documentmodelrelationship",
+    viewsets.DocumentModelRelationshipModelViewSet,
+    basename="document-documentmodelrelationship",
+)
+
+urlpatterns = [
+    path("", include(router.urls)),
+    path("document/<int:document_id>/", include(document_router.urls)),
+    path("download/<uuid:uuid>/", viewsets.DownloadShareableLinkView.as_view(), name="download"),
+    path(
+        "contentdocument/<int:content_type>/<str:content_id>/",
+        viewsets.DocumentModelViewSet.as_view({"get": "list", "post": "create"}),
+        name="document_content_object",
+    ),
+]

wbcore/contrib/documents/viewsets/__init__.py

@@ -0,0 +1,10 @@
+from .document_types import DocumentTypeModelViewSet, DocumentTypeRepresentationViewSet
+from .documents import DocumentModelViewSet, DocumentRepresentationViewSet
+from .document_model_relationships import DocumentModelRelationshipModelViewSet
+from .shareable_links import (
+    DownloadShareableLinkView,
+    ShareableLinkAccessModelViewSet,
+    ShareableLinkAccessRepresentationViewSet,
+    ShareableLinkModelViewSet,
+    ShareableLinkRepresentationViewSet,
+)

wbcore/contrib/documents/viewsets/buttons/__init__.py

@@ -0,0 +1,3 @@
+from .documents import DocumentButtonConfig, DocumentTypeButtonConfig
+from .shareable_links import ShareableLinkModelButtonConfig
+from .signals import *  # noqa

wbcore/contrib/documents/viewsets/buttons/documents.py

@@ -0,0 +1,54 @@
+from django.utils.translation import gettext as _
+from django.utils.translation import gettext_lazy
+
+from wbcore import serializers as wb_serializers
+from wbcore.contrib.icons import WBIcon
+from wbcore.enums import RequestType
+from wbcore.metadata.configs import buttons as bt
+from wbcore.metadata.configs.buttons.view_config import ButtonViewConfig
+from wbcore.metadata.configs.display.instance_display import create_simple_display
+from wbcore.serializers import Serializer
+
+
+class DocumentTypeButtonConfig(ButtonViewConfig):
+    def get_custom_list_instance_buttons(self):
+        return {
+            bt.WidgetButton(
+                key="list_of_children",
+                label=_("All Children"),
+                icon=WBIcon.ENUMERATION.icon,
+            ),
+            bt.WidgetButton(
+                key="list_of_documents",
+                label=_("All Documents"),
+                icon=WBIcon.DOCUMENT.icon,
+            ),
+        }
+
+
+class DocumentButtonConfig(ButtonViewConfig):
+    def get_custom_list_instance_buttons(self):
+        class SendMailSerializer(Serializer):
+            to_email = wb_serializers.CharField(default=self.request.user.email, label=gettext_lazy("Recipient"))
+
+            class Meta:
+                fields = "to_email"
+
+        return {
+            bt.HyperlinkButton(key="download_file", label=_("Download"), icon=WBIcon.LINK.icon),
+            bt.ActionButton(
+                method=RequestType.PATCH,
+                identifiers=("wbcore:documents:document",),
+                key="send_mail",
+                icon=WBIcon.SEND.icon,
+                label=_("Send Mail"),
+                description_fields=_("""<p>Send this document as mail?</p>"""),
+                action_label=_("Sending Mail"),
+                title=_("Send document as mail"),
+                serializer=SendMailSerializer,
+                instance_display=create_simple_display([["to_email"]]),
+            ),
+        }
+
+    def get_custom_instance_buttons(self):
+        return self.get_custom_list_instance_buttons()

wbcore/contrib/documents/viewsets/buttons/shareable_links.py

@@ -0,0 +1,21 @@
+from django.utils.translation import gettext as _
+
+from wbcore.contrib.icons import WBIcon
+from wbcore.enums import RequestType
+from wbcore.metadata.configs import buttons as bt
+from wbcore.metadata.configs.buttons.view_config import ButtonViewConfig
+
+
+class ShareableLinkModelButtonConfig(ButtonViewConfig):
+    def get_custom_list_instance_buttons(self):
+        return {
+            bt.ActionButton(
+                method=RequestType.PATCH,
+                key="manually_invalidate",
+                label=_("Invalidate"),
+                icon=WBIcon.UNLINK.icon,
+                description_fields=_("<p> Are you sure you want to invalidate this link? </p>"),
+                title=_("Invalidate"),
+                action_label=_("Invalidation"),
+            )
+        }

wbcore/contrib/documents/viewsets/buttons/signals.py

@@ -0,0 +1,14 @@
+from django.dispatch import receiver
+from rest_framework.reverse import reverse
+
+from wbcore.contrib.icons import WBIcon
+from wbcore.metadata.configs import buttons as bt
+from wbcore.signals.instance_buttons import add_extra_button
+
+
+@receiver(add_extra_button)
+def add_extra_documents(sender, instance, request, view, pk=None, **kwargs):
+    if instance and pk and view:
+        content_type = view.get_content_type()
+        endpoint = reverse("wbcore:documents:document_content_object", args=[content_type.id, pk], request=request)
+        return bt.WidgetButton(endpoint=endpoint, label="Documents", icon=WBIcon.DOCUMENT_WITH_ATTACHMENT.icon)

wbcore/contrib/documents/viewsets/display/__init__.py

@@ -0,0 +1,4 @@
+from .document_types import DocumentTypeModelDisplay
+from .documents import DocumentModelDisplay
+from .shareable_links import ShareableLinkAccessModelDisplay, ShareableLinkModelDisplay
+from .document_model_relationships import DocumentModelRelationshipViewConfig

wbcore/contrib/documents/viewsets/display/document_model_relationships.py

@@ -0,0 +1,19 @@
+from typing import Optional
+
+from django.utils.translation import gettext as _
+
+from wbcore.metadata.configs import display as dp
+from wbcore.metadata.configs.display.view_config import DisplayViewConfig
+
+
+class DocumentModelRelationshipViewConfig(DisplayViewConfig):
+    def get_list_display(self) -> Optional[dp.ListDisplay]:
+        return dp.ListDisplay(
+            fields=[
+                dp.Field(key="content_type", label=_("Type")),
+                dp.Field(key="content_object_repr", label=_("Instance"), width=500),
+            ],
+        )
+
+    def get_instance_display(self) -> dp.Display:
+        return dp.create_simple_display([["content_type"], ["object_id"]])

wbcore/contrib/documents/viewsets/display/document_types.py

@@ -0,0 +1,24 @@
+from typing import Optional
+
+from django.utils.translation import gettext as _
+
+from wbcore.metadata.configs import display as dp
+from wbcore.metadata.configs.display.instance_display.shortcuts import (
+    Display,
+    create_simple_display,
+)
+from wbcore.metadata.configs.display.view_config import DisplayViewConfig
+
+
+class DocumentTypeModelDisplay(DisplayViewConfig):
+    def get_list_display(self) -> Optional[dp.ListDisplay]:
+        return dp.ListDisplay(
+            fields=[
+                dp.Field(key="name", label=_("Name")),
+                dp.Field(key="parent", label=_("Parent")),
+                dp.Field(key="document_count", label=_("Number of Documents")),
+            ],
+        )
+
+    def get_instance_display(self) -> Display:
+        return create_simple_display([["name", "parent"]])

wbcore/contrib/documents/viewsets/display/documents.py

@@ -0,0 +1,102 @@
+from typing import Optional
+
+from django.utils.translation import gettext as _
+from django.utils.translation import gettext_lazy
+
+from wbcore.contrib.color.enums import WBColor
+from wbcore.metadata.configs import display as dp
+from wbcore.metadata.configs.display.instance_display.shortcuts import Display
+from wbcore.metadata.configs.display.view_config import DisplayViewConfig
+
+
+class DocumentModelDisplay(DisplayViewConfig):
+    def get_list_display(self) -> Optional[dp.ListDisplay]:
+        return dp.ListDisplay(
+            fields=[
+                dp.Field(key="name", label=_("Name")),
+                dp.Field(key="document_type", label=_("Type")),
+                dp.Field(key="valid_from", label=_("Valid From")),
+                dp.Field(key="valid_until", label=_("Valid Until")),
+                dp.Field(key="updated", label=_("Updated")),
+            ],
+            legends=[
+                dp.Legend(
+                    key="system_created",
+                    items=[
+                        dp.LegendItem(
+                            icon=WBColor.YELLOW_LIGHT.value,
+                            label=gettext_lazy("Created By System"),
+                            value=True,
+                        ),
+                    ],
+                ),
+            ],
+            formatting=[
+                dp.Formatting(
+                    column="system_created",
+                    formatting_rules=[
+                        dp.FormattingRule(
+                            style={"backgroundColor": WBColor.YELLOW_LIGHT.value},
+                            condition=("==", True),
+                        ),
+                    ],
+                ),
+            ],
+        )
+
+    def get_instance_display(self) -> Display:
+        return Display(
+            pages=[
+                dp.Page(
+                    title="Main Information",
+                    layouts={
+                        dp.default(): dp.Layout(
+                            grid_template_areas=[
+                                ["file", "file", "file", "file", "file", "file"],
+                                ["name", "name", "name", "document_type", "document_type", "document_type"],
+                                ["created", "created", "updated", "updated", "system_created", "system_created"],
+                                [
+                                    "valid_from",
+                                    "valid_from",
+                                    "valid_from",
+                                    "valid_until",
+                                    "valid_until",
+                                    "valid_until",
+                                ],
+                                [
+                                    "description",
+                                    "description",
+                                    "description",
+                                    "description",
+                                    "description",
+                                    "description",
+                                ],
+                            ],
+                            grid_template_columns=[dp.repeat_field(6, "1fr")],
+                        )
+                    },
+                ),
+                dp.Page(
+                    title="Connected Items",
+                    layouts={
+                        dp.default(): dp.Layout(
+                            grid_template_areas=[["relationships"]],
+                            grid_template_columns=[dp.Style.fr(1)],
+                            grid_template_rows=[dp.Style.fr(1)],
+                            inlines=[dp.Inline(key="relationships", endpoint="relationships")],
+                        )
+                    },
+                ),
+                dp.Page(
+                    title="Sharable Links",
+                    layouts={
+                        dp.default(): dp.Layout(
+                            grid_template_areas=[["shareable_links"]],
+                            grid_template_columns=[dp.Style.fr(1)],
+                            grid_template_rows=[dp.Style.fr(1)],
+                            inlines=[dp.Inline(key="shareable_links", endpoint="shareable_links")],
+                        )
+                    },
+                ),
+            ]
+        )