From 620808c844d4c5f4913017b8894bbfa19c59e23f Mon Sep 17 00:00:00 2001
From: Roman Kysil <roman.kysil@redturtle.it>
Date: Fri, 27 Sep 2024 12:01:30 +0200
Subject: [PATCH] Possibility to configure RestAPI caching operations.

---
 CHANGES.rst                   |  4 +++
 src/plone/rest/caching.py     | 59 +++++++++++++++++++++++++++++++++++
 src/plone/rest/configure.zcml |  6 ++++
 3 files changed, 69 insertions(+)
 create mode 100644 src/plone/rest/caching.py

diff --git a/CHANGES.rst b/CHANGES.rst
index 5fcd0b9..c7592d2 100644
--- a/CHANGES.rst
+++ b/CHANGES.rst
@@ -17,6 +17,10 @@ Internal:
 - Update configuration files.
   [plone devs] (93e1ab65)
 
+New features:
+
+- Add possibily to configure caching operations for RestAPI endpoints. @folix-01
+
 
 4.1.2 (2023-10-28)
 ------------------
diff --git a/src/plone/rest/caching.py b/src/plone/rest/caching.py
new file mode 100644
index 0000000..4001650
--- /dev/null
+++ b/src/plone/rest/caching.py
@@ -0,0 +1,59 @@
+"""Customized implementation of plone.app.caching.lookup.ContentItemLookup for plone.restapi Services"""
+
+from plone.app.caching.interfaces import IPloneCacheSettings
+from plone.app.caching.lookup import ContentItemLookup
+from plone.caching.interfaces import IRulesetLookup
+from plone.registry.interfaces import IRegistry
+from zope.component import queryUtility
+from zope.interface import implementer
+
+
+@implementer(IRulesetLookup)
+class RestContentItemLookup(ContentItemLookup):
+    """General lookup for RestAPI Services.
+
+    1. Look up the published name in the page template mapping (as
+       PageTemplateLookup does now) and return that if found
+
+    2. Attempt to look up a ruleset using z3c.caching.registry.lookup()
+       and return that if found (this is necessary because this adapter will
+       override the default lookup in most cases).
+
+    3. Get the name of the published object (i.e. the name of the view or
+       page template).
+
+    4. Find the parent of the published object, possibly a content object.
+
+       4.1. If the parent is a content object:
+       4.1.1. Get the default view of the parent content object
+       4.1.2. If the name of the published object is the same as the default
+              view of the parent:
+       4.1.2.1. Otherwise, look up the parent type in the content type mapping
+                and return that if found
+       4.1.2.2. Look up a ruleset on the parent object and return if that
+                matches
+    """
+
+    def __call__(self):
+        registry = queryUtility(IRegistry)
+
+        if registry is None:
+            return
+
+        ploneCacheSettings = registry.forInterface(IPloneCacheSettings, check=False)
+
+        # 2. Get the name of the published object
+        name = getattr(self.published, "__name__", None)
+
+        if name is None:
+            return
+
+        # 3. Look up the published name in the page template mapping
+        ruleset = (
+            ploneCacheSettings.templateRulesetMapping
+            and ploneCacheSettings.templateRulesetMapping.get(name, None)
+        ) or None
+        if ruleset is not None:
+            return ruleset
+
+        return super().__call__()
diff --git a/src/plone/rest/configure.zcml b/src/plone/rest/configure.zcml
index f2c4f93..8cc358a 100644
--- a/src/plone/rest/configure.zcml
+++ b/src/plone/rest/configure.zcml
@@ -33,4 +33,10 @@
       provides="plone.rest.interfaces.IShouldAllowAcquiredItemPublication"
       />
 
+  <adapter
+      factory=".caching.RestContentItemLookup"
+      for="plone.rest.interfaces.IService
+           *"
+      />
+
 </configure>