Enable global Control Panel search via plone.restapi searchable text - 1981

news/1981.bugfix.rst

@@ -0,0 +1 @@
+Added a single Control Panel API endpoint exposing searchable text for global settings search. Fixes #1981.

src/plone/restapi/controlpanels/__init__.py

@@ -3,6 +3,8 @@
 from zope.interface import implementer
 from zope.publisher.interfaces import NotFound
 
+import zope
+
 
 @implementer(IControlpanel)
 class RegistryConfigletPanel:
@@ -38,6 +40,23 @@ def __init__(self, context, request):
             self.title = self.configlet["title"]
             self.group = self._get_group_title()
 
+    def get_searchable_text(self):
+
+        text_parts = []
+
+        if self.title:
+            text_parts.append(self.title)
+
+        if self.group:
+            text_parts.append(self.group)
+
+        if self.schema is not None:
+            for name, field in zope.schema.getFields(self.schema).items():
+                if field.title:
+                    text_parts.append(field.title)
+
+        return [text for text in text_parts if text]
+
     def add(self, names):
         raise NotFound(self.context, names, self.request)
 

src/plone/restapi/controlpanels/interfaces.py

@@ -25,6 +25,13 @@ def update(names):
     def delete(names):
         """Remove controlpanel children by names"""
 
+    def get_searchable_text():
+        """Return searchable text for this controlpannel.
+
+        Schema-based control panels return text from field titles and descriptions.
+        Other control panels can return custom text.
+        """
+
 
 class IDexterityTypesControlpanel(IControlpanel):
     """Dexterity Types Control panel"""

src/plone/restapi/controlpanels/rules.py

@@ -25,6 +25,21 @@ class ContentRulesControlpanel(RegistryConfigletPanel):
     def publishTraverse(self, request, name):
         return self.context.restrictedTraverse("++rule++" + name)
 
+    def get_searchable_text(self):
+        text_parts = super().get_searchable_text()
+
+        cpanel = queryMultiAdapter(
+            (self.context, self.request), name="rules-controlpanel"
+        )
+        if cpanel:
+            registered_rules = cpanel.registeredRules()
+            for rule in registered_rules:
+                if isinstance(rule, dict):
+                    if rule.get("title"):
+                        text_parts.append(rule["title"])
+
+        return text_parts
+
     def add(self, names):
         data = json_body(self.request)
         rules = queryMultiAdapter((self.context, self.request), name="+rule")

src/plone/restapi/controlpanels/types.py

@@ -1,3 +1,4 @@
+from plone.dexterity.interfaces import IDexterityFTI
 from plone.i18n.normalizer import idnormalizer
 from plone.restapi.controlpanels import RegistryConfigletPanel
 from plone.restapi.controlpanels.interfaces import IDexterityTypesControlpanel
@@ -7,6 +8,7 @@
 from plone.restapi.interfaces import ISerializeToJson
 from zExceptions import BadRequest
 from zope.component import adapter
+from zope.component import getAllUtilitiesRegisteredFor
 from zope.component import queryMultiAdapter
 from zope.interface import alsoProvides
 from zope.interface import implementer
@@ -22,6 +24,17 @@ class DexterityTypesControlpanel(RegistryConfigletPanel):
     configlet_id = "dexterity-types"
     configlet_category_id = "plone-content"
 
+    def get_searchable_text(self):
+
+        text_parts = super().get_searchable_text()
+
+        ftis = getAllUtilitiesRegisteredFor(IDexterityFTI)
+        for fti in ftis:
+            if fti.Title():
+                text_parts.append(fti.Title())
+
+        return text_parts
+
     def add(self, names):
         data = json_body(self.request)
 

src/plone/restapi/serializer/controlpanels/__init__.py

@@ -26,7 +26,7 @@ def __init__(self, controlpanel):
         self.controlpanel = controlpanel
 
     def __call__(self):
-        return {
+        result = {
             "@id": "{}/{}/{}".format(
                 self.controlpanel.context.absolute_url(),
                 SERVICE_ID,
@@ -36,6 +36,17 @@ def __call__(self):
             "group": self.controlpanel.group,
         }
 
+        if hasattr(self.controlpanel, "get_searchable_text"):
+            result["searchable_text"] = self.controlpanel.get_searchable_text()
+        else:
+            if self.controlpanel.title:
+                result["searchable_text"] = [
+                    self.controlpanel.title,
+                    self.controlpanel.description,
+                ]
+
+        return result
+
 
 def get_jsonschema_for_controlpanel(controlpanel, context, request, form=None):
     """Build a complete JSON schema for the given controlpanel."""