Initial commit

env/lib/python3.10/site-packages/wagtail/admin/api/views.py

@@ -0,0 +1,161 @@
+from collections import OrderedDict
+
+from django.conf import settings
+from django.http import Http404
+from django.urls import path
+from rest_framework.authentication import SessionAuthentication
+from rest_framework.response import Response
+
+from wagtail.api.v2.views import PagesAPIViewSet
+from wagtail.models import Page
+
+from .actions.convert_alias import ConvertAliasPageAPIAction
+from .actions.copy import CopyPageAPIAction
+from .actions.copy_for_translation import CopyForTranslationAPIAction
+from .actions.create_alias import CreatePageAliasAPIAction
+from .actions.delete import DeletePageAPIAction
+from .actions.move import MovePageAPIAction
+from .actions.publish import PublishPageAPIAction
+from .actions.revert_to_page_revision import RevertToPageRevisionAPIAction
+from .actions.unpublish import UnpublishPageAPIAction
+from .filters import ForExplorerFilter, HasChildrenFilter
+from .serializers import AdminPageSerializer
+
+
+class PagesAdminAPIViewSet(PagesAPIViewSet):
+    base_serializer_class = AdminPageSerializer
+    authentication_classes = [SessionAuthentication]
+
+    actions = {
+        "convert_alias": ConvertAliasPageAPIAction,
+        "copy": CopyPageAPIAction,
+        "delete": DeletePageAPIAction,
+        "publish": PublishPageAPIAction,
+        "unpublish": UnpublishPageAPIAction,
+        "move": MovePageAPIAction,
+        "copy_for_translation": CopyForTranslationAPIAction,
+        "create_alias": CreatePageAliasAPIAction,
+        "revert_to_page_revision": RevertToPageRevisionAPIAction,
+    }
+
+    # Add has_children and for_explorer filters
+    filter_backends = PagesAPIViewSet.filter_backends + [
+        HasChildrenFilter,
+        ForExplorerFilter,
+    ]
+
+    meta_fields = PagesAPIViewSet.meta_fields + [
+        "latest_revision_created_at",
+        "status",
+        "children",
+        "descendants",
+        "parent",
+        "ancestors",
+        "translations",
+    ]
+
+    body_fields = PagesAPIViewSet.body_fields + [
+        "admin_display_title",
+    ]
+
+    listing_default_fields = PagesAPIViewSet.listing_default_fields + [
+        "latest_revision_created_at",
+        "status",
+        "children",
+        "admin_display_title",
+    ]
+
+    # Allow the parent field to appear on listings
+    detail_only_fields = []
+
+    known_query_parameters = PagesAPIViewSet.known_query_parameters.union(
+        ["for_explorer", "has_children"]
+    )
+
+    @classmethod
+    def get_detail_default_fields(cls, model):
+        detail_default_fields = super().get_detail_default_fields(model)
+
+        # When i18n is disabled, remove "translations" from default fields
+        if not getattr(settings, "WAGTAIL_I18N_ENABLED", False):
+            detail_default_fields.remove("translations")
+
+        return detail_default_fields
+
+    def get_root_page(self):
+        """
+        Returns the page that is used when the `&child_of=root` filter is used.
+        """
+        return Page.get_first_root_node()
+
+    def get_base_queryset(self):
+        """
+        Returns a queryset containing all pages that can be seen by this user.
+
+        This is used as the base for get_queryset and is also used to find the
+        parent pages when using the child_of and descendant_of filters as well.
+        """
+        return Page.objects.all()
+
+    def get_queryset(self):
+        queryset = super().get_queryset()
+
+        # Hide root page
+        # TODO: Add "include_root" flag
+        queryset = queryset.exclude(depth=1).defer_streamfields().specific()
+
+        return queryset
+
+    def get_type_info(self):
+        types = OrderedDict()
+
+        for name, model in self.seen_types.items():
+            types[name] = OrderedDict(
+                [
+                    ("verbose_name", model._meta.verbose_name),
+                    ("verbose_name_plural", model._meta.verbose_name_plural),
+                ]
+            )
+
+        return types
+
+    def listing_view(self, request):
+        response = super().listing_view(request)
+        response.data["__types"] = self.get_type_info()
+        return response
+
+    def detail_view(self, request, pk):
+        response = super().detail_view(request, pk)
+        response.data["__types"] = self.get_type_info()
+        return response
+
+    def action_view(self, request, pk, action_name):
+        instance = self.get_object()
+
+        if action_name not in self.actions:
+            raise Http404(f"unrecognised action '{action_name}'")
+
+        action = self.actions[action_name](self, request)
+        action_data = action.serializer(data=request.data)
+
+        if not action_data.is_valid():
+            return Response(action_data.errors, status=400)
+
+        return action.execute(instance, action_data.data)
+
+    @classmethod
+    def get_urlpatterns(cls):
+        """
+        This returns a list of URL patterns for the endpoint
+        """
+        urlpatterns = super().get_urlpatterns()
+        urlpatterns.extend(
+            [
+                path(
+                    "<int:pk>/action/<str:action_name>/",
+                    cls.as_view({"post": "action_view"}),
+                    name="action",
+                ),
+            ]
+        )
+        return urlpatterns