Initial commit

env/lib/python3.10/site-packages/wagtail/documents/wagtail_hooks.py

@@ -0,0 +1,226 @@
+from warnings import warn
+
+from django.conf import settings
+from django.template.response import TemplateResponse
+from django.urls import include, path, reverse, reverse_lazy
+from django.utils.translation import gettext, ngettext
+from django.utils.translation import gettext_lazy as _
+
+import wagtail.admin.rich_text.editors.draftail.features as draftail_features
+from wagtail import hooks
+from wagtail.admin.admin_url_finder import (
+    ModelAdminURLFinder,
+    register_admin_url_finder,
+)
+from wagtail.admin.menu import MenuItem
+from wagtail.admin.navigation import get_site_for_user
+from wagtail.admin.search import SearchArea
+from wagtail.admin.site_summary import SummaryItem
+from wagtail.documents import admin_urls, get_document_model
+from wagtail.documents.api.admin.views import DocumentsAdminAPIViewSet
+from wagtail.documents.forms import GroupDocumentPermissionFormSet
+from wagtail.documents.permissions import permission_policy
+from wagtail.documents.rich_text import DocumentLinkHandler
+from wagtail.documents.rich_text.contentstate import (
+    ContentstateDocumentLinkConversionRule,
+)
+from wagtail.documents.rich_text.editor_html import EditorHTMLDocumentLinkConversionRule
+from wagtail.documents.views.bulk_actions import (
+    AddTagsBulkAction,
+    AddToCollectionBulkAction,
+    DeleteBulkAction,
+)
+from wagtail.documents.views.chooser import viewset as chooser_viewset
+from wagtail.models import BaseViewRestriction
+from wagtail.utils.deprecation import RemovedInWagtail70Warning
+from wagtail.wagtail_hooks import require_wagtail_login
+
+
+@hooks.register("register_admin_urls")
+def register_admin_urls():
+    return [
+        path("documents/", include(admin_urls, namespace="wagtaildocs")),
+    ]
+
+
+@hooks.register("construct_admin_api")
+def construct_admin_api(router):
+    router.register_endpoint("documents", DocumentsAdminAPIViewSet)
+
+
+class DocumentsMenuItem(MenuItem):
+    def is_shown(self, request):
+        return permission_policy.user_has_any_permission(
+            request.user, ["add", "change", "delete"]
+        )
+
+
+@hooks.register("register_admin_menu_item")
+def register_documents_menu_item():
+    return DocumentsMenuItem(
+        _("Documents"),
+        reverse("wagtaildocs:index"),
+        name="documents",
+        icon_name="doc-full-inverse",
+        order=400,
+    )
+
+
+@hooks.register("register_rich_text_features")
+def register_document_feature(features):
+    features.register_link_type(DocumentLinkHandler)
+
+    features.register_editor_plugin(
+        "draftail",
+        "document-link",
+        draftail_features.EntityFeature(
+            {
+                "type": "DOCUMENT",
+                "icon": "doc-full-inverse",
+                "description": gettext("Document"),
+                "chooserUrls": {
+                    "documentChooser": reverse_lazy("wagtaildocs_chooser:choose")
+                },
+            },
+            js=["wagtaildocs/js/document-chooser-modal.js"],
+        ),
+    )
+
+    features.register_converter_rule(
+        "editorhtml", "document-link", EditorHTMLDocumentLinkConversionRule
+    )
+    features.register_converter_rule(
+        "contentstate", "document-link", ContentstateDocumentLinkConversionRule
+    )
+
+    features.default_features.append("document-link")
+
+
+class DocumentsSummaryItem(SummaryItem):
+    order = 300
+    template_name = "wagtaildocs/homepage/site_summary_documents.html"
+
+    def get_context_data(self, parent_context):
+        site_name = get_site_for_user(self.request.user)["site_name"]
+
+        return {
+            "total_docs": permission_policy.instances_user_has_any_permission_for(
+                self.request.user, {"add", "change", "delete", "choose"}
+            ).count(),
+            "site_name": site_name,
+        }
+
+    def is_shown(self):
+        return permission_policy.user_has_any_permission(
+            self.request.user, ["add", "change", "delete"]
+        )
+
+
+@hooks.register("construct_homepage_summary_items")
+def add_documents_summary_item(request, items):
+    items.append(DocumentsSummaryItem(request))
+
+
+class DocsSearchArea(SearchArea):
+    def is_shown(self, request):
+        return permission_policy.user_has_any_permission(
+            request.user, ["add", "change", "delete"]
+        )
+
+
+@hooks.register("register_admin_search_area")
+def register_documents_search_area():
+    return DocsSearchArea(
+        _("Documents"),
+        reverse("wagtaildocs:index"),
+        name="documents",
+        icon_name="doc-full-inverse",
+        order=400,
+    )
+
+
+@hooks.register("register_group_permission_panel")
+def register_document_permissions_panel():
+    return GroupDocumentPermissionFormSet
+
+
+@hooks.register("describe_collection_contents")
+def describe_collection_docs(collection):
+    docs_count = get_document_model().objects.filter(collection=collection).count()
+    if docs_count:
+        url = reverse("wagtaildocs:index") + ("?collection_id=%d" % collection.id)
+        return {
+            "count": docs_count,
+            "count_text": ngettext(
+                "%(count)s document", "%(count)s documents", docs_count
+            )
+            % {"count": docs_count},
+            "url": url,
+        }
+
+
+@hooks.register("before_serve_document")
+def check_view_restrictions(document, request):
+    """
+    Check whether there are any view restrictions on this document which are
+    not fulfilled by the given request object. If there are, return an
+    HttpResponse that will notify the user of that restriction (and possibly
+    include a password / login form that will allow them to proceed). If
+    there are no such restrictions, return None
+    """
+    for restriction in document.collection.get_view_restrictions():
+        if not restriction.accept_request(request):
+            if restriction.restriction_type == BaseViewRestriction.PASSWORD:
+                from wagtail.forms import PasswordViewRestrictionForm
+
+                form = PasswordViewRestrictionForm(
+                    instance=restriction,
+                    initial={"return_url": request.get_full_path()},
+                )
+                action_url = reverse(
+                    "wagtaildocs_authenticate_with_password", args=[restriction.id]
+                )
+
+                password_required_template = getattr(
+                    settings,
+                    "WAGTAILDOCS_PASSWORD_REQUIRED_TEMPLATE",
+                    "wagtaildocs/password_required.html",
+                )
+
+                if hasattr(settings, "DOCUMENT_PASSWORD_REQUIRED_TEMPLATE"):
+                    warn(
+                        "The `DOCUMENT_PASSWORD_REQUIRED_TEMPLATE` setting is deprecated - use `WAGTAILDOCS_PASSWORD_REQUIRED_TEMPLATE` instead.",
+                        category=RemovedInWagtail70Warning,
+                    )
+
+                    password_required_template = getattr(
+                        settings,
+                        "DOCUMENT_PASSWORD_REQUIRED_TEMPLATE",
+                        password_required_template,
+                    )
+
+                context = {"form": form, "action_url": action_url}
+                return TemplateResponse(request, password_required_template, context)
+
+            elif restriction.restriction_type in [
+                BaseViewRestriction.LOGIN,
+                BaseViewRestriction.GROUPS,
+            ]:
+                return require_wagtail_login(next=request.get_full_path())
+
+
+class DocumentAdminURLFinder(ModelAdminURLFinder):
+    edit_url_name = "wagtaildocs:edit"
+    permission_policy = permission_policy
+
+
+register_admin_url_finder(get_document_model(), DocumentAdminURLFinder)
+
+
+for action_class in [AddTagsBulkAction, AddToCollectionBulkAction, DeleteBulkAction]:
+    hooks.register("register_bulk_action", action_class)
+
+
+@hooks.register("register_admin_viewset")
+def register_document_chooser_viewset():
+    return chooser_viewset