Merge 4792364 into 4a3ad2b

news/995.feature

@@ -0,0 +1 @@
+- Add expandable `@layout` endpoint to easily access content-type blocks layout [@avoinea]

src/plone/restapi/services/configure.zcml

@@ -15,6 +15,7 @@
   <include package=".database"/>
   <include package=".discussion"/>
   <include package=".groups"/>
+  <include package=".layout"/>
   <include package=".navigation"/>
   <include package=".history"/>
   <include package=".locking" />

src/plone/restapi/services/layout/configure.zcml

@@ -0,0 +1,24 @@
+<configure
+    xmlns="http://namespaces.zope.org/zope"
+    xmlns:plone="http://namespaces.plone.org/plone"
+    xmlns:zcml="http://namespaces.zope.org/zcml">
+
+  <plone:service
+    method="GET"
+    name="@layout"
+    for="Products.CMFPlone.interfaces.IPloneSiteRoot"
+    factory=".get.Layout"
+    permission="zope2.View"
+    />
+
+  <plone:service
+    method="GET"
+    name="@layout"
+    for="Products.CMFCore.interfaces.IContentish"
+    factory=".get.LayoutGet"
+    permission="zope2.View"
+    />
+
+  <adapter factory=".get.Layout" name="layout" />
+
+</configure>

src/plone/restapi/services/layout/get.py

@@ -0,0 +1,45 @@
+# -*- coding: utf-8 -*-
+from plone.restapi.interfaces import IExpandableElement
+from plone.restapi.serializer.converters import json_compatible
+from plone.restapi.services import Service
+from Products.CMFCore.utils import getToolByName
+from Products.CMFPlone.interfaces import IPloneSiteRoot
+from zope.component import adapter
+from zope.interface import implementer
+from zope.interface import Interface
+
+
+@implementer(IExpandableElement)
+@adapter(Interface, Interface)
+class Layout(object):
+    def __init__(self, context, request):
+        self.context = context
+        self.request = request
+
+    def __call__(self, expand=False):
+        result = {"layout": {"@id": "{}/@layout".format(self.context.absolute_url())}}
+        if not expand:
+            return result
+
+        if IPloneSiteRoot.providedBy(self.context):
+            return result
+
+        ttool = getToolByName(self.context, "portal_types")
+        ptype = getattr(self.context, "portal_type")
+        if not ptype:
+            return result
+
+        fti = ttool[ptype]
+        schema = fti.lookupSchema()
+        for field in schema:
+            if field.endswith("blocks") or field.endswith("blocks_layout"):
+                result["layout"][field] = json_compatible(schema[field].default)
+        return result
+
+
+class LayoutGet(Service):
+    """Get layout information"""
+
+    def reply(self):
+        info = Layout(self.context, self.request)
+        return info(expand=True)["layout"]

src/plone/restapi/tests/http-examples/collection.resp

@@ -9,6 +9,9 @@ Content-Type: application/json
     "breadcrumbs": {
       "@id": "http://localhost:55001/plone/collection/@breadcrumbs"
     }, 
+    "layout": {
+      "@id": "http://localhost:55001/plone/collection/@layout"
+    }, 
     "navigation": {
       "@id": "http://localhost:55001/plone/collection/@navigation"
     }, 

src/plone/restapi/tests/http-examples/collection_fullobjects.resp

@@ -9,6 +9,9 @@ Content-Type: application/json
     "breadcrumbs": {
       "@id": "http://localhost:55001/plone/collection/@breadcrumbs"
     }, 
+    "layout": {
+      "@id": "http://localhost:55001/plone/collection/@layout"
+    }, 
     "navigation": {
       "@id": "http://localhost:55001/plone/collection/@navigation"
     }, 
@@ -62,6 +65,9 @@ Content-Type: application/json
         "breadcrumbs": {
           "@id": "http://localhost:55001/plone/front-page/@breadcrumbs"
         }, 
+        "layout": {
+          "@id": "http://localhost:55001/plone/front-page/@layout"
+        }, 
         "navigation": {
           "@id": "http://localhost:55001/plone/front-page/@navigation"
         }, 
@@ -126,6 +132,9 @@ Content-Type: application/json
         "breadcrumbs": {
           "@id": "http://localhost:55001/plone/doc1/@breadcrumbs"
         }, 
+        "layout": {
+          "@id": "http://localhost:55001/plone/doc1/@layout"
+        }, 
         "navigation": {
           "@id": "http://localhost:55001/plone/doc1/@navigation"
         }, 
@@ -191,6 +200,9 @@ Content-Type: application/json
         "breadcrumbs": {
           "@id": "http://localhost:55001/plone/doc2/@breadcrumbs"
         }, 
+        "layout": {
+          "@id": "http://localhost:55001/plone/doc2/@layout"
+        }, 
         "navigation": {
           "@id": "http://localhost:55001/plone/doc2/@navigation"
         }, 

src/plone/restapi/tests/http-examples/content_get.resp

@@ -9,6 +9,9 @@ Content-Type: application/json
     "breadcrumbs": {
       "@id": "http://localhost:55001/plone/folder/my-document/@breadcrumbs"
     }, 
+    "layout": {
+      "@id": "http://localhost:55001/plone/folder/my-document/@layout"
+    }, 
     "navigation": {
       "@id": "http://localhost:55001/plone/folder/my-document/@navigation"
     }, 

src/plone/restapi/tests/http-examples/content_get_folder.resp

@@ -9,6 +9,9 @@ Content-Type: application/json
     "breadcrumbs": {
       "@id": "http://localhost:55001/plone/folder/@breadcrumbs"
     }, 
+    "layout": {
+      "@id": "http://localhost:55001/plone/folder/@layout"
+    }, 
     "navigation": {
       "@id": "http://localhost:55001/plone/folder/@navigation"
     }, 

src/plone/restapi/tests/http-examples/content_patch_representation.resp

@@ -9,6 +9,9 @@ Content-Type: application/json
     "breadcrumbs": {
       "@id": "http://localhost:55001/plone/folder/my-document/@breadcrumbs"
     }, 
+    "layout": {
+      "@id": "http://localhost:55001/plone/folder/my-document/@layout"
+    }, 
     "navigation": {
       "@id": "http://localhost:55001/plone/folder/my-document/@navigation"
     }, 

src/plone/restapi/tests/http-examples/content_post.resp

@@ -10,6 +10,9 @@ Location: http://localhost:55001/plone/folder/my-document
     "breadcrumbs": {
       "@id": "http://localhost:55001/plone/folder/my-document/@breadcrumbs"
     }, 
+    "layout": {
+      "@id": "http://localhost:55001/plone/folder/my-document/@layout"
+    }, 
     "navigation": {
       "@id": "http://localhost:55001/plone/folder/my-document/@navigation"
     }, 

src/plone/restapi/tests/http-examples/document.resp

@@ -9,6 +9,9 @@ Content-Type: application/json
     "breadcrumbs": {
       "@id": "http://localhost:55001/plone/front-page/@breadcrumbs"
     }, 
+    "layout": {
+      "@id": "http://localhost:55001/plone/front-page/@layout"
+    }, 
     "navigation": {
       "@id": "http://localhost:55001/plone/front-page/@navigation"
     }, 

src/plone/restapi/tests/http-examples/event.resp

@@ -9,6 +9,9 @@ Content-Type: application/json
     "breadcrumbs": {
       "@id": "http://localhost:55001/plone/event/@breadcrumbs"
     }, 
+    "layout": {
+      "@id": "http://localhost:55001/plone/event/@layout"
+    }, 
     "navigation": {
       "@id": "http://localhost:55001/plone/event/@navigation"
     }, 

src/plone/restapi/tests/http-examples/expansion.resp

@@ -9,6 +9,9 @@ Content-Type: application/json
     "breadcrumbs": {
       "@id": "http://localhost:55001/plone/front-page/@breadcrumbs"
     }, 
+    "layout": {
+      "@id": "http://localhost:55001/plone/front-page/@layout"
+    }, 
     "navigation": {
       "@id": "http://localhost:55001/plone/front-page/@navigation"
     }, 

src/plone/restapi/tests/http-examples/expansion_expanded.resp

@@ -15,6 +15,9 @@ Content-Type: application/json
         }
       ]
     }, 
+    "layout": {
+      "@id": "http://localhost:55001/plone/front-page/@layout"
+    }, 
     "navigation": {
       "@id": "http://localhost:55001/plone/front-page/@navigation"
     }, 

src/plone/restapi/tests/http-examples/expansion_expanded_full.resp

@@ -115,6 +115,9 @@ Content-Type: application/json
         }
       ]
     }, 
+    "layout": {
+      "@id": "http://localhost:55001/plone/front-page/@layout"
+    }, 
     "navigation": {
       "@id": "http://localhost:55001/plone/front-page/@navigation", 
       "items": [

src/plone/restapi/tests/http-examples/file.resp

@@ -9,6 +9,9 @@ Content-Type: application/json
     "breadcrumbs": {
       "@id": "http://localhost:55001/plone/file/@breadcrumbs"
     }, 
+    "layout": {
+      "@id": "http://localhost:55001/plone/file/@layout"
+    }, 
     "navigation": {
       "@id": "http://localhost:55001/plone/file/@navigation"
     }, 

src/plone/restapi/tests/http-examples/folder.resp

@@ -9,6 +9,9 @@ Content-Type: application/json
     "breadcrumbs": {
       "@id": "http://localhost:55001/plone/folder/@breadcrumbs"
     }, 
+    "layout": {
+      "@id": "http://localhost:55001/plone/folder/@layout"
+    }, 
     "navigation": {
       "@id": "http://localhost:55001/plone/folder/@navigation"
     }, 

src/plone/restapi/tests/http-examples/image.resp

@@ -9,6 +9,9 @@ Content-Type: application/json
     "breadcrumbs": {
       "@id": "http://localhost:55001/plone/image/@breadcrumbs"
     }, 
+    "layout": {
+      "@id": "http://localhost:55001/plone/image/@layout"
+    }, 
     "navigation": {
       "@id": "http://localhost:55001/plone/image/@navigation"
     }, 

src/plone/restapi/tests/http-examples/jwt_logged_in.resp

@@ -9,6 +9,9 @@ Content-Type: application/json
     "breadcrumbs": {
       "@id": "http://localhost:55001/plone/@breadcrumbs"
     }, 
+    "layout": {
+      "@id": "http://localhost:55001/plone/@layout"
+    }, 
     "navigation": {
       "@id": "http://localhost:55001/plone/@navigation"
     }

src/plone/restapi/tests/http-examples/link.resp

@@ -9,6 +9,9 @@ Content-Type: application/json
     "breadcrumbs": {
       "@id": "http://localhost:55001/plone/link/@breadcrumbs"
     }, 
+    "layout": {
+      "@id": "http://localhost:55001/plone/link/@layout"
+    }, 
     "navigation": {
       "@id": "http://localhost:55001/plone/link/@navigation"
     }, 

src/plone/restapi/tests/http-examples/newsitem.resp

@@ -9,6 +9,9 @@ Content-Type: application/json
     "breadcrumbs": {
       "@id": "http://localhost:55001/plone/newsitem/@breadcrumbs"
     }, 
+    "layout": {
+      "@id": "http://localhost:55001/plone/newsitem/@layout"
+    }, 
     "navigation": {
       "@id": "http://localhost:55001/plone/newsitem/@navigation"
     }, 

src/plone/restapi/tests/http-examples/search_fullobjects.resp

@@ -12,6 +12,9 @@ Content-Type: application/json
         "breadcrumbs": {
           "@id": "http://localhost:55001/plone/doc1/@breadcrumbs"
         }, 
+        "layout": {
+          "@id": "http://localhost:55001/plone/doc1/@layout"
+        }, 
         "navigation": {
           "@id": "http://localhost:55001/plone/doc1/@navigation"
         }, 

src/plone/restapi/tests/http-examples/siteroot.resp

@@ -9,6 +9,9 @@ Content-Type: application/json
     "breadcrumbs": {
       "@id": "http://localhost:55001/plone/@breadcrumbs"
     }, 
+    "layout": {
+      "@id": "http://localhost:55001/plone/@layout"
+    }, 
     "navigation": {
       "@id": "http://localhost:55001/plone/@navigation"
     }

src/plone/restapi/tests/http-examples/translations_link_on_post.resp

@@ -10,6 +10,9 @@ Location: http://localhost:55001/plone/de/mydocument
     "breadcrumbs": {
       "@id": "http://localhost:55001/plone/de/mydocument/@breadcrumbs"
     }, 
+    "layout": {
+      "@id": "http://localhost:55001/plone/de/mydocument/@layout"
+    }, 
     "navigation": {
       "@id": "http://localhost:55001/plone/de/mydocument/@navigation"
     },