Slots

docs/source/endpoints/tiles.md

@@ -0,0 +1,94 @@
+---
+myst:
+  html_meta:
+    "description": "A tile in Plone is an HTML snippet that can contain arbitrary content, such as text, images, or videos. The tiles endpoint is deprecated and will be removed in plone.restapi 9."
+    "property=og:description": "A tile in Plone is an HTML snippet that can contain arbitrary content, such as text, images, or videos. The tiles endpoint is deprecated and will be removed in plone.restapi 9."
+    "property=og:title": "Tiles"
+    "keywords": "Plone, plone.restapi, REST, API, Tiles"
+---
+
+# Tiles
+
+```{warning}
+The tiles endpoint is deprecated and will be removed in `plone.restapi` 9.
+```
+
+```{note}
+The tiles endpoint currently matches only partially, specifically the `GET` endpoints, the default Plone implementation.
+```
+
+A tile in Plone is an HTML snippet that can contain arbitrary content, such as text, images, or videos.
+
+
+## Listing available tiles
+
+```{note}
+This endpoint currently does not return any data.
+The functionality needs to be implemented.
+```
+
+List all available tiles types by sending a `GET` request to the `@tiles` endpoint on the portal root:
+
+```
+GET /plone/@tiles HTTP/1.1
+Accept: application/json
+Authorization: Basic YWRtaW46c2VjcmV0
+```
+
+The server responds with a {term}`200 OK` status and lists all available tiles:
+
+```
+HTTP/1.1 200 OK
+Content-Type: application/json
+[
+  {
+    "@id": "http://localhost:55001/plone/@tiles/title",
+    "title": "Title tile",
+    "description": "A field tile that will show the title of the content object",
+  },
+  {
+    "@id": "http://localhost:55001/plone/@tiles/description",
+    "title": "Description tile",
+    "description": "A field tile that will show the description of the content object",
+  },
+]
+```
+
+
+## Retrieve JSON schema of an individual tile
+
+```{note}
+This endpoint currently does not return any data.
+The functionality needs to be implemented.
+```
+
+Retrieve the JSON schema of a specific tile by calling the `@tiles` endpoint with the ID of the tile:
+
+```
+GET /plone/@tiles/title HTTP/1.1
+Accept: application/json
+Authorization: Basic YWRtaW46c2VjcmV0
+```
+
+The server responds with a JSON schema definition for that particular tile:
+
+```
+HTTP/1.1 200 OK
+Content-Type: application/json+schema
+
+{
+  "properties": {
+    "title": {
+      "description": "",
+      "title": "Title",
+      "type": "string"
+    },
+    ...
+  },
+  "required": [
+    "title",
+  ],
+  "title": "Title Tile",
+  "type": "object"
+}
+```

src/plone/restapi/configure.zcml

@@ -97,6 +97,7 @@
   <include package=".deserializer" />
   <include package=".types" />
   <include package=".search" />
+  <include package=".slots" />
   <include package=".cache" />
 
   <include package=".upgrades" />

src/plone/restapi/deserializer/blocks.py

@@ -143,6 +143,26 @@ def __call__(self, block):
         return block
 
 
+@adapter(IBlocks, IBrowserRequest)
+@implementer(IBlockFieldDeserializationTransformer)
+class VolatileSmartField(object):
+    """When deserializing block values, delete all block fields that start with `_v_`"""
+
+    order = float("inf")
+    block_type = None
+
+    def __init__(self, context, request):
+        self.context = context
+        self.request = request
+
+    def __call__(self, block):
+        keys = [k for k in block.keys() if k.startswith("_v_")]
+        for k in keys:
+            del block[k]
+
+        return block
+
+
 @adapter(IBlocks, IBrowserRequest)
 @implementer(IBlockFieldDeserializationTransformer)
 class ResolveUIDDeserializer(ResolveUIDDeserializerBase):

src/plone/restapi/deserializer/configure.zcml

@@ -21,6 +21,14 @@
   <adapter factory=".dxfields.DecimalFieldDeserializer" />
   <adapter factory=".blocks.BlocksJSONFieldDeserializer" />
 
+  <adapter factory=".slots.SlotDeserializer" />
+  <adapter factory=".slots.SlotDeserializerRoot" />
+  <adapter factory=".slots.SlotsDeserializer" />
+  <adapter
+      factory=".slots.SlotsDeserializerRoot"
+      provides="plone.restapi.interfaces.IDeserializeFromJson"
+      />
+
   <subscriber
       factory=".blocks.TextBlockDeserializer"
       provides="plone.restapi.interfaces.IBlockFieldDeserializationTransformer"

src/plone/restapi/deserializer/slots.py

@@ -0,0 +1,142 @@
+# -*- coding: utf-8 -*-
+
+""" Slots deserializers """
+
+from plone.restapi.deserializer import json_body
+from plone.restapi.interfaces import IBlockFieldDeserializationTransformer
+from plone.restapi.interfaces import IDeserializeFromJson
+from plone.restapi.slots import Slot
+from plone.restapi.slots.interfaces import ISlot
+from plone.restapi.slots.interfaces import ISlots
+from plone.restapi.slots.interfaces import ISlotStorage
+from Products.CMFCore.interfaces import IContentish
+from Products.CMFPlone.interfaces import IPloneSiteRoot
+from zope.component import adapter
+from zope.component import getMultiAdapter
+from zope.component import subscribers
+from zope.interface import implementer
+from zope.location.interfaces import ILocation
+from zope.publisher.interfaces.browser import IBrowserRequest
+
+import copy
+
+
+@adapter(IContentish, ISlot, IBrowserRequest)
+@implementer(IDeserializeFromJson)
+class SlotDeserializer(object):
+    """Deserializer of one slot for contentish objects"""
+
+    def __init__(self, context, slot, request):
+        self.context = context
+        self.slot = slot
+        self.request = request
+
+    def __call__(self, data=None):
+        if data is None:
+            data = json_body(self.request)
+
+        if not data:
+            return
+
+        incoming_blocks = copy.deepcopy(data["blocks"])
+
+        parent_block_ids = []
+        parent = ILocation(self.context).__parent__
+        if parent is not None:
+            engine = ISlots(parent)
+            parent_block_ids = list(
+                engine.get_data(self.slot.__name__, full=True)["blocks"].keys()
+            )
+
+        # don't keep blocks that are not in incoming data
+        for k in list(self.slot.blocks.keys()):
+            if not ((k in parent_block_ids) or (k in incoming_blocks.keys())):
+                del self.slot.blocks[k]
+
+        inherited = []
+        # don't store blocks that are inherited, keep only those that really exist
+        for k, v in list(incoming_blocks.items()):
+            if v.get("_v_inherit"):
+                del incoming_blocks[k]
+                if k in parent_block_ids:
+                    inherited.append(k)
+
+        slot = self.slot.__of__(self.context)
+
+        for id, block_value in incoming_blocks.items():
+            block_type = block_value.get("@type", "")
+
+            handlers = []
+            for h in subscribers(
+                (slot, self.request),
+                IBlockFieldDeserializationTransformer,
+            ):
+                if h.block_type == block_type or h.block_type is None:
+                    handlers.append(h)
+
+            for handler in sorted(handlers, key=lambda h: h.order):
+                if not getattr(handler, "disabled", False):
+                    block_value = handler(block_value)
+
+            incoming_blocks[id] = block_value
+
+        self.slot.blocks = incoming_blocks
+
+        # don't keep block ids in layout if they're nowhere in the inheritance tree
+        all_ids = parent_block_ids + list(self.slot.blocks.keys()) + inherited
+        layout = [b for b in data["blocks_layout"]["items"] if b in all_ids]
+        data["blocks_layout"]["items"] = layout
+        self.slot.blocks_layout = data["blocks_layout"]
+
+        self.slot.block_parent = data.get("block_parent", False)
+        self.slot._p_changed = True
+
+
+@adapter(IPloneSiteRoot, ISlot, IBrowserRequest)
+@implementer(IDeserializeFromJson)
+class SlotDeserializerRoot(SlotDeserializer):
+    """Deserializer of one slot for site root"""
+
+
+@adapter(IContentish, ISlotStorage, IBrowserRequest)
+@implementer(IDeserializeFromJson)
+class SlotsDeserializer(object):
+    """Default deserializer of slots"""
+
+    def __init__(self, context, storage, request):
+        self.context = context
+        self.storage = storage
+        self.request = request
+
+    def __call__(self, data=None):
+        if data is None:
+            data = json_body(self.request)
+
+        for name, slot in self.storage.items():
+            incoming_data = data.get(name, None)
+
+            # remove the existing slot data if the slot doesn't exist in new data
+            if not incoming_data:
+                # notify(BlocksRemovedEvent(dict(
+                #     context=self.context,
+                #     blocks=slot.blocks
+                # )))
+
+                self.storage[name].blocks = {}
+                self.storage[name].blocks_layout = {"items": []}
+
+        for name, incoming_data in data.items():
+            if name not in self.storage:
+                # create new slots when found in incoming data
+                self.storage[name] = Slot()
+
+            deserializer = getMultiAdapter(
+                (self.context, self.storage[name], self.request), IDeserializeFromJson
+            )
+            deserializer(incoming_data)
+
+
+@adapter(IPloneSiteRoot, ISlotStorage, IBrowserRequest)
+@implementer(IDeserializeFromJson)
+class SlotsDeserializerRoot(SlotsDeserializer):
+    """Deserializer of slots for site root"""

src/plone/restapi/interfaces.py

@@ -4,6 +4,7 @@
 
 from zope.interface import Attribute
 from zope.interface import Interface
+from zope.interface.interfaces import IObjectEvent
 from zope.publisher.interfaces.browser import IDefaultBrowserLayer
 
 
@@ -216,6 +217,14 @@ def __call__(value):
         """Extract text from the block value. Returns text"""
 
 
+class IBlocksRemovedEvent(IObjectEvent):
+    """A bunch of blocks have been removed"""
+
+
+class IBlockRemovedEvent(IObjectEvent):
+    """A block has been removed"""
+
+
 class IJSONSummarySerializerMetadata(Interface):
     """Configure JSONSummary serializer."""
 

src/plone/restapi/permissions.py

@@ -2,3 +2,5 @@
 # permissions. Granted to Anonymous (i.e. everyone) by default via rolemap.xml
 
 UseRESTAPI = "plone.restapi: Use REST API"
+
+ModifySlotsPermission = "plone.restapi: Modify slots information"

src/plone/restapi/permissions.zcml

@@ -17,5 +17,14 @@
       id="plone.restapi.getusers"
       title="plone.restapi: Access Plone user information"
       />
+  <permission
+      id="plone.restapi.GetSlots"
+      title="plone.restapi: Access slots information"
+      />
+
+  <permission
+      id="plone.restapi.ModifySlots"
+      title="plone.restapi: Modify slots information"
+      />
 
 </configure>

src/plone/restapi/profiles/default/controlpanel.xml

@@ -0,0 +1,20 @@
+<?xml version="1.0"?>
+<object
+  name="portal_controlpanel"
+  xmlns:i18n="http://xml.zope.org/namespaces/i18n"
+  i18n:domain="plone.restapi">
+
+  <configlet
+    title="Slots"
+    action_id="slots_settings"
+    appId="plone.restapi.slots"
+    category="Plone"
+    condition_expr=""
+    url_expr="string:${portal_url}/@@slots-controlpanel"
+    icon_expr="string:${portal_url}/++resource++plone.app.theming.gif"
+    visible="True"
+    i18n:attributes="title">
+    <permission>Manage portal</permission>
+  </configlet>
+
+</object>

src/plone/restapi/profiles/default/metadata.xml

@@ -1,4 +1,4 @@
 <?xml version="1.0"?>
 <metadata>
-  <version>0006</version>
+  <version>0007</version>
 </metadata>

src/plone/restapi/profiles/default/registry.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0"?>
+<registry>
+  <records interface="plone.restapi.slots.interfaces.ISlotSettings" />
+</registry>

src/plone/restapi/serializer/configure.zcml

@@ -112,6 +112,9 @@
 
   <include package=".controlpanels" />
 
+  <adapter factory=".slots.SlotSerializer" />
+  <adapter factory=".slots.SlotsSerializer" />
+
   <!-- Summary Serializer Metadata -->
   <utility
       factory=".summary.JSONSummarySerializerMetadata"